2023-07-12 07:47:08 +00:00
# frozen_string_literal: true
2016-03-07 11:42:33 +00:00
Doorkeeper . configure do
# Change the ORM that doorkeeper will use (needs plugins)
orm :active_record
# This block will be called to check whether the resource owner is authenticated or not.
resource_owner_authenticator do
2016-08-26 17:12:19 +00:00
current_user || redirect_to ( new_user_session_url )
2016-03-07 11:42:33 +00:00
end
2017-09-27 21:42:49 +00:00
resource_owner_from_credentials do | _routes |
2020-01-03 04:35:46 +00:00
user = User . authenticate_with_ldap ( email : request . params [ :username ] , password : request . params [ :password ] ) if Devise . ldap_authentication
user || = User . authenticate_with_pam ( email : request . params [ :username ] , password : request . params [ :password ] ) if Devise . pam_authentication
2019-11-30 18:44:59 +00:00
if user . nil?
user = User . find_by ( email : request . params [ :username ] )
2020-01-03 04:35:46 +00:00
user = nil unless user & . valid_password? ( request . params [ :password ] )
2019-11-30 18:44:59 +00:00
end
2020-01-03 04:35:46 +00:00
user unless user & . otp_required_for_login?
2016-03-11 15:47:36 +00:00
end
2024-02-13 18:11:47 +00:00
# Doorkeeper provides some administrative interfaces for managing OAuth
# Applications, allowing creation, edit, and deletion of applications from the
# server. At present, these administrative routes are not integrated into
# Mastodon, and as such, we've disabled them by always return a 403 forbidden
# response for them. This does not affect the ability for users to manage
# their own OAuth Applications.
2016-03-12 18:46:06 +00:00
admin_authenticator do
2024-02-13 18:11:47 +00:00
head 403
2016-03-12 18:46:06 +00:00
end
2016-03-07 11:42:33 +00:00
# Authorization Code expiration time (default 10 minutes).
# authorization_code_expires_in 10.minutes
# Access token expiration time (default 2 hours).
# If you want to disable expiration, set this to nil.
2016-03-16 17:29:52 +00:00
access_token_expires_in nil
2016-03-07 11:42:33 +00:00
# Assign a custom TTL for implicit grants.
# custom_access_token_expires_in do |oauth_client|
# oauth_client.application.additional_settings.implicit_oauth_expiration
# end
# Use a custom class for generating the access token.
# https://github.com/doorkeeper-gem/doorkeeper#custom-access-token-generator
# access_token_generator "::Doorkeeper::JWT"
2017-08-05 02:24:58 +00:00
# The controller Doorkeeper::ApplicationController inherits from.
# Defaults to ActionController::Base.
# https://github.com/doorkeeper-gem/doorkeeper#custom-base-controller
base_controller 'ApplicationController'
2016-03-07 11:42:33 +00:00
# Reuse access token for the same resource owner within an application (disabled by default)
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
2017-04-27 12:42:22 +00:00
reuse_access_token
2016-03-07 11:42:33 +00:00
# Issue access tokens with refresh token (disabled by default)
# use_refresh_token
2021-04-15 14:28:43 +00:00
# Forbids creating/updating applications with arbitrary scopes that are
# not in configuration, i.e. `default_scopes` or `optional_scopes`.
# (Disabled by default)
enforce_configured_scopes
2016-03-07 11:42:33 +00:00
# Provide support for an owner to be assigned to each registered application (disabled by default)
# Optional parameter :confirmation => true (default false) if you want to enforce ownership of
# a registered application
# Note: you must also run the rails g doorkeeper:application_owner generator to provide the necessary support
2017-08-22 16:33:57 +00:00
enable_application_owner
2016-03-07 11:42:33 +00:00
# Define access token scopes for your provider
# For more information go to
# https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes
2016-10-22 17:38:47 +00:00
default_scopes :read
2024-06-06 07:30:10 +00:00
optional_scopes :profile ,
:write ,
2018-07-05 16:31:35 +00:00
:'write:accounts' ,
:'write:blocks' ,
2019-11-13 22:02:10 +00:00
:'write:bookmarks' ,
2018-10-18 23:47:29 +00:00
:'write:conversations' ,
2018-07-05 16:31:35 +00:00
:'write:favourites' ,
:'write:filters' ,
:'write:follows' ,
:'write:lists' ,
:'write:media' ,
:'write:mutes' ,
:'write:notifications' ,
:'write:reports' ,
:'write:statuses' ,
:read ,
:'read:accounts' ,
:'read:blocks' ,
2019-11-13 22:02:10 +00:00
:'read:bookmarks' ,
2018-07-05 16:31:35 +00:00
:'read:favourites' ,
:'read:filters' ,
:'read:follows' ,
:'read:lists' ,
:'read:mutes' ,
:'read:notifications' ,
:'read:search' ,
:'read:statuses' ,
:follow ,
2019-06-20 00:52:34 +00:00
:push ,
:'admin:read' ,
:'admin:read:accounts' ,
:'admin:read:reports' ,
2022-11-17 09:50:21 +00:00
:'admin:read:domain_allows' ,
:'admin:read:domain_blocks' ,
:'admin:read:ip_blocks' ,
:'admin:read:email_domain_blocks' ,
:'admin:read:canonical_email_blocks' ,
2019-06-20 00:52:34 +00:00
:'admin:write' ,
:'admin:write:accounts' ,
2020-06-02 17:24:53 +00:00
:'admin:write:reports' ,
2022-11-17 09:50:21 +00:00
:'admin:write:domain_allows' ,
:'admin:write:domain_blocks' ,
:'admin:write:ip_blocks' ,
:'admin:write:email_domain_blocks' ,
:'admin:write:canonical_email_blocks' ,
2020-06-02 17:24:53 +00:00
:crypto
2016-03-07 11:42:33 +00:00
# Change the way client credentials are retrieved from the request object.
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
# falls back to the `:client_id` and `:client_secret` params from the `params` object.
# Check out the wiki for more information on customization
# client_credentials :from_basic, :from_params
# Change the way access token is authenticated from the request object.
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
# falls back to the `:access_token` or `:bearer_token` params from the `params` object.
# Check out the wiki for more information on customization
# access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
# Change the native redirect uri for client apps
# When clients register with the following redirect uri, they won't be redirected to any server and the authorization code will be displayed within the provider
# The value can be any string. Use nil to disable this feature. When disabled, clients must provide a valid URL
# (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
#
# native_redirect_uri 'urn:ietf:wg:oauth:2.0:oob'
# Forces the usage of the HTTPS protocol in non-native redirect uris (enabled
# by default in non-development environments). OAuth2 delegates security in
# communication to the HTTPS protocol so it is wise to keep this enabled.
#
2016-09-30 20:40:31 +00:00
force_ssl_in_redirect_uri false
2016-03-07 11:42:33 +00:00
2022-05-26 20:03:54 +00:00
# Specify what redirect URI's you want to block during Application creation.
# Any redirect URI is whitelisted by default.
#
# You can use this option in order to forbid URI's with 'javascript' scheme
# for example.
2024-04-19 20:32:26 +00:00
forbid_redirect_uri { | uri | %w( data vbscript javascript ) . include? ( uri . scheme . to_s . downcase ) }
2022-05-26 20:03:54 +00:00
2016-03-07 11:42:33 +00:00
# Specify what grant flows are enabled in array of Strings. The valid
# strings and the flows they enable are:
#
# "authorization_code" => Authorization Code Grant Flow
# "implicit" => Implicit Grant Flow
# "password" => Resource Owner Password Credentials Grant Flow
# "client_credentials" => Client Credentials Grant Flow
#
# If not specified, Doorkeeper enables authorization_code and
# client_credentials.
#
# implicit and password grant flows have risks that you should understand
# before enabling:
# http://tools.ietf.org/html/rfc6819#section-4.4.2
# http://tools.ietf.org/html/rfc6819#section-4.4.3
#
2016-03-11 15:47:36 +00:00
grant_flows %w( authorization_code password client_credentials )
2016-03-07 11:42:33 +00:00
# Under some circumstances you might want to have applications auto-approved,
# so that the user skips the authorization step.
# For example if dealing with a trusted application.
2023-11-09 09:43:26 +00:00
skip_authorization do | _resource_owner , client |
2016-10-02 20:55:09 +00:00
client . application . superapp?
2016-08-26 17:12:19 +00:00
end
2016-03-07 11:42:33 +00:00
# WWW-Authenticate Realm (default "Doorkeeper").
# realm "Doorkeeper"
end