doorkeeper.rb 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. Doorkeeper.configure do
  2. # Change the ORM that doorkeeper will use (needs plugins)
  3. orm :active_record
  4. # This block will be called to check whether the resource owner is authenticated or not.
  5. resource_owner_authenticator do
  6. current_user || redirect_to(new_user_session_url)
  7. end
  8. resource_owner_from_credentials do |_routes|
  9. user = User.find_by(email: request.params[:username])
  10. user if !user&.otp_required_for_login? && user&.valid_password?(request.params[:password])
  11. end
  12. # If you want to restrict access to the web interface for adding oauth authorized applications, you need to declare the block below.
  13. admin_authenticator do
  14. current_user&.admin? || redirect_to(new_user_session_url)
  15. end
  16. # Authorization Code expiration time (default 10 minutes).
  17. # authorization_code_expires_in 10.minutes
  18. # Access token expiration time (default 2 hours).
  19. # If you want to disable expiration, set this to nil.
  20. access_token_expires_in nil
  21. # Assign a custom TTL for implicit grants.
  22. # custom_access_token_expires_in do |oauth_client|
  23. # oauth_client.application.additional_settings.implicit_oauth_expiration
  24. # end
  25. # Use a custom class for generating the access token.
  26. # https://github.com/doorkeeper-gem/doorkeeper#custom-access-token-generator
  27. # access_token_generator "::Doorkeeper::JWT"
  28. # The controller Doorkeeper::ApplicationController inherits from.
  29. # Defaults to ActionController::Base.
  30. # https://github.com/doorkeeper-gem/doorkeeper#custom-base-controller
  31. base_controller 'ApplicationController'
  32. # Reuse access token for the same resource owner within an application (disabled by default)
  33. # Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
  34. reuse_access_token
  35. # Issue access tokens with refresh token (disabled by default)
  36. # use_refresh_token
  37. # Provide support for an owner to be assigned to each registered application (disabled by default)
  38. # Optional parameter :confirmation => true (default false) if you want to enforce ownership of
  39. # a registered application
  40. # Note: you must also run the rails g doorkeeper:application_owner generator to provide the necessary support
  41. enable_application_owner
  42. # Define access token scopes for your provider
  43. # For more information go to
  44. # https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes
  45. default_scopes :read
  46. optional_scopes :write,
  47. :'write:accounts',
  48. :'write:blocks',
  49. :'write:conversations',
  50. :'write:favourites',
  51. :'write:filters',
  52. :'write:follows',
  53. :'write:lists',
  54. :'write:media',
  55. :'write:mutes',
  56. :'write:notifications',
  57. :'write:reports',
  58. :'write:statuses',
  59. :read,
  60. :'read:accounts',
  61. :'read:blocks',
  62. :'read:favourites',
  63. :'read:filters',
  64. :'read:follows',
  65. :'read:lists',
  66. :'read:mutes',
  67. :'read:notifications',
  68. :'read:search',
  69. :'read:statuses',
  70. :follow,
  71. :push,
  72. :'admin:read',
  73. :'admin:read:accounts',
  74. :'admin:read:reports',
  75. :'admin:write',
  76. :'admin:write:accounts',
  77. :'admin:write:reports'
  78. # Change the way client credentials are retrieved from the request object.
  79. # By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
  80. # falls back to the `:client_id` and `:client_secret` params from the `params` object.
  81. # Check out the wiki for more information on customization
  82. # client_credentials :from_basic, :from_params
  83. # Change the way access token is authenticated from the request object.
  84. # By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
  85. # falls back to the `:access_token` or `:bearer_token` params from the `params` object.
  86. # Check out the wiki for more information on customization
  87. # access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
  88. # Change the native redirect uri for client apps
  89. # 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
  90. # The value can be any string. Use nil to disable this feature. When disabled, clients must provide a valid URL
  91. # (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
  92. #
  93. # native_redirect_uri 'urn:ietf:wg:oauth:2.0:oob'
  94. # Forces the usage of the HTTPS protocol in non-native redirect uris (enabled
  95. # by default in non-development environments). OAuth2 delegates security in
  96. # communication to the HTTPS protocol so it is wise to keep this enabled.
  97. #
  98. force_ssl_in_redirect_uri false
  99. # Specify what grant flows are enabled in array of Strings. The valid
  100. # strings and the flows they enable are:
  101. #
  102. # "authorization_code" => Authorization Code Grant Flow
  103. # "implicit" => Implicit Grant Flow
  104. # "password" => Resource Owner Password Credentials Grant Flow
  105. # "client_credentials" => Client Credentials Grant Flow
  106. #
  107. # If not specified, Doorkeeper enables authorization_code and
  108. # client_credentials.
  109. #
  110. # implicit and password grant flows have risks that you should understand
  111. # before enabling:
  112. # http://tools.ietf.org/html/rfc6819#section-4.4.2
  113. # http://tools.ietf.org/html/rfc6819#section-4.4.3
  114. #
  115. grant_flows %w(authorization_code password client_credentials)
  116. # Under some circumstances you might want to have applications auto-approved,
  117. # so that the user skips the authorization step.
  118. # For example if dealing with a trusted application.
  119. skip_authorization do |resource_owner, client|
  120. client.application.superapp?
  121. end
  122. # WWW-Authenticate Realm (default "Doorkeeper").
  123. # realm "Doorkeeper"
  124. end