/config/initializers/doorkeeper.rb
Ruby | 123 lines | 35 code | 21 blank | 67 comment | 1 complexity | e85a84190eb7013e02b84ff3f2e85636 MD5 | raw file
- # frozen_string_literal: true
- Doorkeeper.configure do
- # Change the ORM that doorkeeper will use.
- # Currently supported options are :active_record, :mongoid2, :mongoid3, :mongo_mapper
- orm :active_record
- # Restore to pre-5.1 generator due to breaking change.
- # See https://gitlab.com/gitlab-org/gitlab/-/issues/244371
- default_generator_method :hex
- # This block will be called to check whether the resource owner is authenticated or not.
- resource_owner_authenticator do
- # Put your resource owner authentication logic here.
- if current_user
- current_user
- else
- # Ensure user is redirected to redirect_uri after login
- session[:user_return_to] = request.fullpath
- redirect_to(new_user_session_url)
- nil
- end
- end
- resource_owner_from_credentials do |routes|
- user = Gitlab::Auth.find_with_user_password(params[:username], params[:password], increment_failed_attempts: true)
- user unless user.try(:two_factor_enabled?)
- end
- # If you want to restrict access to the web interface for adding oauth authorized applications, you need to declare the block below.
- # admin_authenticator do
- # # Put your admin authentication logic here.
- # # Example implementation:
- # Admin.find_by_id(session[:admin_id]) || redirect_to(new_admin_session_url)
- # end
- # Authorization Code expiration time (default 10 minutes).
- # authorization_code_expires_in 10.minutes
- # Access token expiration time (default 2 hours).
- # Until 15.0, applications can opt-out of expiring tokens.
- # Removal issue: https://gitlab.com/gitlab-org/gitlab/-/issues/340848
- custom_access_token_expires_in do |context|
- context.client&.expire_access_tokens ? 2.hours : Float::INFINITY
- end
- # Reuse access token for the same resource owner within an application (disabled by default)
- # Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
- reuse_access_token
- # Issue access tokens with refresh token (disabled by default)
- use_refresh_token
- # 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
- # 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.
- #
- force_ssl_in_redirect_uri false
- # 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.
- forbid_redirect_uri { |uri| %w[data vbscript javascript].include?(uri.scheme.to_s.downcase) }
- # 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
- enable_application_owner confirmation: false
- # Define access token scopes for your provider
- # For more information go to
- # https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes
- default_scopes(*Gitlab::Auth::DEFAULT_SCOPES)
- optional_scopes(*Gitlab::Auth.optional_scopes)
- # 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_access_token_param, :from_bearer_authorization, :from_bearer_param
- # 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
- #
- grant_flows %w(authorization_code implicit password client_credentials)
- # Under some circumstances you might want to have applications auto-approved,
- # so that the user skips the authorization step.
- # For example if dealing with trusted a application.
- skip_authorization do |resource_owner, client|
- client.application.trusted?
- end
- # WWW-Authenticate Realm (default "Doorkeeper").
- # realm "Doorkeeper"
- base_controller '::Gitlab::BaseDoorkeeperController'
- # Allow Resource Owner Password Credentials Grant without client credentials,
- # this was disabled by default in Doorkeeper 5.5.
- #
- # We might want to disable this in the future, see https://gitlab.com/gitlab-org/gitlab/-/issues/323615
- skip_client_authentication_for_password_grant true
- end