doorkeeper 4.2.0 → 5.5.2
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of doorkeeper might be problematic. Click here for more details.
- checksums.yaml +5 -5
- data/CHANGELOG.md +1038 -0
- data/README.md +110 -348
- data/app/assets/stylesheets/doorkeeper/admin/application.css +2 -2
- data/app/controllers/doorkeeper/application_controller.rb +6 -7
- data/app/controllers/doorkeeper/application_metal_controller.rb +7 -11
- data/app/controllers/doorkeeper/applications_controller.rb +65 -20
- data/app/controllers/doorkeeper/authorizations_controller.rb +97 -17
- data/app/controllers/doorkeeper/authorized_applications_controller.rb +22 -3
- data/app/controllers/doorkeeper/token_info_controller.rb +16 -4
- data/app/controllers/doorkeeper/tokens_controller.rb +112 -35
- data/app/helpers/doorkeeper/dashboard_helper.rb +10 -6
- data/app/views/doorkeeper/applications/_delete_form.html.erb +4 -3
- data/app/views/doorkeeper/applications/_form.html.erb +33 -21
- data/app/views/doorkeeper/applications/edit.html.erb +1 -1
- data/app/views/doorkeeper/applications/index.html.erb +18 -6
- data/app/views/doorkeeper/applications/new.html.erb +1 -1
- data/app/views/doorkeeper/applications/show.html.erb +40 -16
- data/app/views/doorkeeper/authorizations/error.html.erb +1 -1
- data/app/views/doorkeeper/authorizations/form_post.html.erb +15 -0
- data/app/views/doorkeeper/authorizations/new.html.erb +7 -1
- data/app/views/doorkeeper/authorized_applications/_delete_form.html.erb +1 -2
- data/app/views/doorkeeper/authorized_applications/index.html.erb +0 -1
- data/app/views/layouts/doorkeeper/admin.html.erb +16 -14
- data/config/locales/en.yml +33 -9
- data/lib/doorkeeper/config/abstract_builder.rb +28 -0
- data/lib/doorkeeper/config/option.rb +82 -0
- data/lib/doorkeeper/config/validations.rb +53 -0
- data/lib/doorkeeper/config.rb +545 -143
- data/lib/doorkeeper/engine.rb +11 -5
- data/lib/doorkeeper/errors.rb +37 -10
- data/lib/doorkeeper/grant_flow/fallback_flow.rb +15 -0
- data/lib/doorkeeper/grant_flow/flow.rb +44 -0
- data/lib/doorkeeper/grant_flow/registry.rb +50 -0
- data/lib/doorkeeper/grant_flow.rb +45 -0
- data/lib/doorkeeper/grape/authorization_decorator.rb +6 -4
- data/lib/doorkeeper/grape/helpers.rb +24 -12
- data/lib/doorkeeper/helpers/controller.rb +49 -27
- data/lib/doorkeeper/models/access_grant_mixin.rb +100 -21
- data/lib/doorkeeper/models/access_token_mixin.rb +379 -75
- data/lib/doorkeeper/models/application_mixin.rb +72 -25
- data/lib/doorkeeper/models/concerns/accessible.rb +6 -0
- data/lib/doorkeeper/models/concerns/expirable.rb +20 -6
- data/lib/doorkeeper/models/concerns/orderable.rb +15 -0
- data/lib/doorkeeper/models/concerns/ownership.rb +4 -7
- data/lib/doorkeeper/models/concerns/resource_ownerable.rb +47 -0
- data/lib/doorkeeper/models/concerns/reusable.rb +19 -0
- data/lib/doorkeeper/models/concerns/revocable.rb +12 -18
- data/lib/doorkeeper/models/concerns/scopes.rb +12 -2
- data/lib/doorkeeper/models/concerns/secret_storable.rb +106 -0
- data/lib/doorkeeper/oauth/authorization/code.rb +48 -12
- data/lib/doorkeeper/oauth/authorization/context.rb +17 -0
- data/lib/doorkeeper/oauth/authorization/token.rb +66 -28
- data/lib/doorkeeper/oauth/authorization/uri_builder.rb +22 -18
- data/lib/doorkeeper/oauth/authorization_code_request.rb +64 -14
- data/lib/doorkeeper/oauth/base_request.rb +66 -0
- data/lib/doorkeeper/oauth/base_response.rb +31 -0
- data/lib/doorkeeper/oauth/client/credentials.rb +23 -10
- data/lib/doorkeeper/oauth/client.rb +10 -12
- data/lib/doorkeeper/oauth/client_credentials/creator.rb +47 -4
- data/lib/doorkeeper/oauth/client_credentials/issuer.rb +16 -9
- data/lib/doorkeeper/oauth/client_credentials/validator.rb +56 -0
- data/lib/doorkeeper/oauth/client_credentials_request.rb +11 -15
- data/lib/doorkeeper/oauth/code_request.rb +8 -12
- data/lib/doorkeeper/oauth/code_response.rb +28 -15
- data/lib/doorkeeper/oauth/error.rb +5 -3
- data/lib/doorkeeper/oauth/error_response.rb +41 -20
- data/lib/doorkeeper/oauth/forbidden_token_response.rb +10 -3
- data/lib/doorkeeper/oauth/helpers/scope_checker.rb +23 -18
- data/lib/doorkeeper/oauth/helpers/unique_token.rb +20 -3
- data/lib/doorkeeper/oauth/helpers/uri_checker.rb +53 -3
- data/lib/doorkeeper/oauth/hooks/context.rb +21 -0
- data/lib/doorkeeper/oauth/invalid_request_response.rb +43 -0
- data/lib/doorkeeper/oauth/invalid_token_response.rb +31 -5
- data/lib/doorkeeper/oauth/nonstandard.rb +39 -0
- data/lib/doorkeeper/oauth/password_access_token_request.rb +45 -13
- data/lib/doorkeeper/oauth/pre_authorization.rb +135 -26
- data/lib/doorkeeper/oauth/refresh_token_request.rb +61 -36
- data/lib/doorkeeper/oauth/scopes.rb +26 -12
- data/lib/doorkeeper/oauth/token.rb +25 -23
- data/lib/doorkeeper/oauth/token_introspection.rb +202 -0
- data/lib/doorkeeper/oauth/token_request.rb +8 -21
- data/lib/doorkeeper/oauth/token_response.rb +14 -10
- data/lib/doorkeeper/oauth.rb +13 -0
- data/lib/doorkeeper/orm/active_record/access_grant.rb +6 -4
- data/lib/doorkeeper/orm/active_record/access_token.rb +5 -25
- data/lib/doorkeeper/orm/active_record/application.rb +6 -15
- data/lib/doorkeeper/orm/active_record/mixins/access_grant.rb +68 -0
- data/lib/doorkeeper/orm/active_record/mixins/access_token.rb +59 -0
- data/lib/doorkeeper/orm/active_record/mixins/application.rb +198 -0
- data/lib/doorkeeper/orm/active_record/redirect_uri_validator.rb +66 -0
- data/lib/doorkeeper/orm/active_record/stale_records_cleaner.rb +33 -0
- data/lib/doorkeeper/orm/active_record.rb +37 -8
- data/lib/doorkeeper/rails/helpers.rb +14 -15
- data/lib/doorkeeper/rails/routes/abstract_router.rb +35 -0
- data/lib/doorkeeper/rails/routes/mapper.rb +3 -1
- data/lib/doorkeeper/rails/routes/mapping.rb +10 -8
- data/lib/doorkeeper/rails/routes/registry.rb +45 -0
- data/lib/doorkeeper/rails/routes.rb +42 -30
- data/lib/doorkeeper/rake/db.rake +40 -0
- data/lib/doorkeeper/rake/setup.rake +11 -0
- data/lib/doorkeeper/rake.rb +14 -0
- data/lib/doorkeeper/request/authorization_code.rb +12 -4
- data/lib/doorkeeper/request/client_credentials.rb +3 -3
- data/lib/doorkeeper/request/code.rb +1 -1
- data/lib/doorkeeper/request/password.rb +5 -14
- data/lib/doorkeeper/request/refresh_token.rb +6 -5
- data/lib/doorkeeper/request/strategy.rb +4 -2
- data/lib/doorkeeper/request/token.rb +1 -1
- data/lib/doorkeeper/request.rb +62 -29
- data/lib/doorkeeper/secret_storing/base.rb +64 -0
- data/lib/doorkeeper/secret_storing/bcrypt.rb +60 -0
- data/lib/doorkeeper/secret_storing/plain.rb +33 -0
- data/lib/doorkeeper/secret_storing/sha256_hash.rb +26 -0
- data/lib/doorkeeper/server.rb +9 -19
- data/lib/doorkeeper/stale_records_cleaner.rb +24 -0
- data/lib/doorkeeper/validations.rb +5 -2
- data/lib/doorkeeper/version.rb +12 -1
- data/lib/doorkeeper.rb +111 -56
- data/lib/generators/doorkeeper/application_owner_generator.rb +28 -13
- data/lib/generators/doorkeeper/confidential_applications_generator.rb +33 -0
- data/lib/generators/doorkeeper/enable_polymorphic_resource_owner_generator.rb +39 -0
- data/lib/generators/doorkeeper/install_generator.rb +19 -9
- data/lib/generators/doorkeeper/migration_generator.rb +27 -10
- data/lib/generators/doorkeeper/pkce_generator.rb +33 -0
- data/lib/generators/doorkeeper/previous_refresh_token_generator.rb +31 -19
- data/lib/generators/doorkeeper/templates/add_confidential_to_applications.rb.erb +13 -0
- data/lib/generators/doorkeeper/templates/add_owner_to_application_migration.rb.erb +9 -0
- data/lib/generators/doorkeeper/templates/{add_previous_refresh_token_to_access_tokens.rb → add_previous_refresh_token_to_access_tokens.rb.erb} +3 -1
- data/lib/generators/doorkeeper/templates/enable_pkce_migration.rb.erb +8 -0
- data/lib/generators/doorkeeper/templates/enable_polymorphic_resource_owner_migration.rb.erb +17 -0
- data/lib/generators/doorkeeper/templates/initializer.rb +410 -31
- data/lib/generators/doorkeeper/templates/migration.rb.erb +88 -0
- data/lib/generators/doorkeeper/views_generator.rb +8 -4
- data/vendor/assets/stylesheets/doorkeeper/bootstrap.min.css +4 -5
- metadata +132 -286
- data/.gitignore +0 -14
- data/.hound.yml +0 -13
- data/.rspec +0 -1
- data/.travis.yml +0 -20
- data/CONTRIBUTING.md +0 -47
- data/Gemfile +0 -14
- data/NEWS.md +0 -593
- data/RELEASING.md +0 -17
- data/Rakefile +0 -20
- data/app/validators/redirect_uri_validator.rb +0 -34
- data/doorkeeper.gemspec +0 -28
- data/lib/doorkeeper/oauth/client/methods.rb +0 -18
- data/lib/doorkeeper/oauth/client_credentials/validation.rb +0 -45
- data/lib/doorkeeper/oauth/request_concern.rb +0 -48
- data/lib/generators/doorkeeper/templates/add_owner_to_application_migration.rb +0 -7
- data/lib/generators/doorkeeper/templates/migration.rb +0 -68
- data/spec/controllers/application_metal_controller.rb +0 -10
- data/spec/controllers/applications_controller_spec.rb +0 -58
- data/spec/controllers/authorizations_controller_spec.rb +0 -189
- data/spec/controllers/protected_resources_controller_spec.rb +0 -300
- data/spec/controllers/token_info_controller_spec.rb +0 -52
- data/spec/controllers/tokens_controller_spec.rb +0 -88
- data/spec/dummy/Rakefile +0 -7
- data/spec/dummy/app/controllers/application_controller.rb +0 -3
- data/spec/dummy/app/controllers/custom_authorizations_controller.rb +0 -7
- data/spec/dummy/app/controllers/full_protected_resources_controller.rb +0 -12
- data/spec/dummy/app/controllers/home_controller.rb +0 -17
- data/spec/dummy/app/controllers/metal_controller.rb +0 -11
- data/spec/dummy/app/controllers/semi_protected_resources_controller.rb +0 -11
- data/spec/dummy/app/helpers/application_helper.rb +0 -5
- data/spec/dummy/app/models/user.rb +0 -5
- data/spec/dummy/app/views/home/index.html.erb +0 -0
- data/spec/dummy/app/views/layouts/application.html.erb +0 -14
- data/spec/dummy/config/application.rb +0 -23
- data/spec/dummy/config/boot.rb +0 -9
- data/spec/dummy/config/database.yml +0 -15
- data/spec/dummy/config/environment.rb +0 -5
- data/spec/dummy/config/environments/development.rb +0 -29
- data/spec/dummy/config/environments/production.rb +0 -62
- data/spec/dummy/config/environments/test.rb +0 -44
- data/spec/dummy/config/initializers/active_record_belongs_to_required_by_default.rb +0 -6
- data/spec/dummy/config/initializers/backtrace_silencers.rb +0 -7
- data/spec/dummy/config/initializers/doorkeeper.rb +0 -96
- data/spec/dummy/config/initializers/secret_token.rb +0 -9
- data/spec/dummy/config/initializers/session_store.rb +0 -8
- data/spec/dummy/config/initializers/wrap_parameters.rb +0 -14
- data/spec/dummy/config/locales/doorkeeper.en.yml +0 -5
- data/spec/dummy/config/routes.rb +0 -52
- data/spec/dummy/config.ru +0 -4
- data/spec/dummy/db/migrate/20111122132257_create_users.rb +0 -9
- data/spec/dummy/db/migrate/20120312140401_add_password_to_users.rb +0 -5
- data/spec/dummy/db/migrate/20151223192035_create_doorkeeper_tables.rb +0 -60
- data/spec/dummy/db/migrate/20151223200000_add_owner_to_application.rb +0 -7
- data/spec/dummy/db/migrate/20160320211015_add_previous_refresh_token_to_access_tokens.rb +0 -11
- data/spec/dummy/db/schema.rb +0 -67
- data/spec/dummy/public/404.html +0 -26
- data/spec/dummy/public/422.html +0 -26
- data/spec/dummy/public/500.html +0 -26
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/script/rails +0 -6
- data/spec/factories.rb +0 -28
- data/spec/generators/application_owner_generator_spec.rb +0 -22
- data/spec/generators/install_generator_spec.rb +0 -31
- data/spec/generators/migration_generator_spec.rb +0 -20
- data/spec/generators/templates/routes.rb +0 -3
- data/spec/generators/views_generator_spec.rb +0 -27
- data/spec/helpers/doorkeeper/dashboard_helper_spec.rb +0 -24
- data/spec/lib/config_spec.rb +0 -334
- data/spec/lib/doorkeeper_spec.rb +0 -28
- data/spec/lib/models/expirable_spec.rb +0 -51
- data/spec/lib/models/revocable_spec.rb +0 -59
- data/spec/lib/models/scopes_spec.rb +0 -43
- data/spec/lib/oauth/authorization/uri_builder_spec.rb +0 -42
- data/spec/lib/oauth/authorization_code_request_spec.rb +0 -80
- data/spec/lib/oauth/client/credentials_spec.rb +0 -47
- data/spec/lib/oauth/client/methods_spec.rb +0 -54
- data/spec/lib/oauth/client_credentials/creator_spec.rb +0 -44
- data/spec/lib/oauth/client_credentials/issuer_spec.rb +0 -86
- data/spec/lib/oauth/client_credentials/validation_spec.rb +0 -54
- data/spec/lib/oauth/client_credentials_integration_spec.rb +0 -27
- data/spec/lib/oauth/client_credentials_request_spec.rb +0 -104
- data/spec/lib/oauth/client_spec.rb +0 -39
- data/spec/lib/oauth/code_request_spec.rb +0 -45
- data/spec/lib/oauth/code_response_spec.rb +0 -34
- data/spec/lib/oauth/error_response_spec.rb +0 -61
- data/spec/lib/oauth/error_spec.rb +0 -23
- data/spec/lib/oauth/forbidden_token_response_spec.rb +0 -23
- data/spec/lib/oauth/helpers/scope_checker_spec.rb +0 -64
- data/spec/lib/oauth/helpers/unique_token_spec.rb +0 -20
- data/spec/lib/oauth/helpers/uri_checker_spec.rb +0 -104
- data/spec/lib/oauth/invalid_token_response_spec.rb +0 -28
- data/spec/lib/oauth/password_access_token_request_spec.rb +0 -90
- data/spec/lib/oauth/pre_authorization_spec.rb +0 -155
- data/spec/lib/oauth/refresh_token_request_spec.rb +0 -154
- data/spec/lib/oauth/scopes_spec.rb +0 -122
- data/spec/lib/oauth/token_request_spec.rb +0 -98
- data/spec/lib/oauth/token_response_spec.rb +0 -85
- data/spec/lib/oauth/token_spec.rb +0 -116
- data/spec/lib/request/strategy_spec.rb +0 -53
- data/spec/lib/server_spec.rb +0 -52
- data/spec/models/doorkeeper/access_grant_spec.rb +0 -36
- data/spec/models/doorkeeper/access_token_spec.rb +0 -394
- data/spec/models/doorkeeper/application_spec.rb +0 -179
- data/spec/requests/applications/applications_request_spec.rb +0 -94
- data/spec/requests/applications/authorized_applications_spec.rb +0 -30
- data/spec/requests/endpoints/authorization_spec.rb +0 -72
- data/spec/requests/endpoints/token_spec.rb +0 -64
- data/spec/requests/flows/authorization_code_errors_spec.rb +0 -66
- data/spec/requests/flows/authorization_code_spec.rb +0 -156
- data/spec/requests/flows/client_credentials_spec.rb +0 -58
- data/spec/requests/flows/implicit_grant_errors_spec.rb +0 -32
- data/spec/requests/flows/implicit_grant_spec.rb +0 -61
- data/spec/requests/flows/password_spec.rb +0 -115
- data/spec/requests/flows/refresh_token_spec.rb +0 -174
- data/spec/requests/flows/revoke_token_spec.rb +0 -157
- data/spec/requests/flows/skip_authorization_spec.rb +0 -59
- data/spec/requests/protected_resources/metal_spec.rb +0 -14
- data/spec/requests/protected_resources/private_api_spec.rb +0 -81
- data/spec/routing/custom_controller_routes_spec.rb +0 -71
- data/spec/routing/default_routes_spec.rb +0 -35
- data/spec/routing/scoped_routes_spec.rb +0 -31
- data/spec/spec_helper.rb +0 -2
- data/spec/spec_helper_integration.rb +0 -59
- data/spec/support/dependencies/factory_girl.rb +0 -2
- data/spec/support/helpers/access_token_request_helper.rb +0 -11
- data/spec/support/helpers/authorization_request_helper.rb +0 -41
- data/spec/support/helpers/config_helper.rb +0 -9
- data/spec/support/helpers/model_helper.rb +0 -67
- data/spec/support/helpers/request_spec_helper.rb +0 -76
- data/spec/support/helpers/url_helper.rb +0 -55
- data/spec/support/http_method_shim.rb +0 -24
- data/spec/support/orm/active_record.rb +0 -3
- data/spec/support/shared/controllers_shared_context.rb +0 -69
- data/spec/support/shared/models_shared_examples.rb +0 -52
- data/spec/validators/redirect_uri_validator_spec.rb +0 -78
data/lib/doorkeeper/config.rb
CHANGED
@@ -1,213 +1,531 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "doorkeeper/config/abstract_builder"
|
4
|
+
require "doorkeeper/config/option"
|
5
|
+
require "doorkeeper/config/validations"
|
6
|
+
|
1
7
|
module Doorkeeper
|
8
|
+
# Defines a MissingConfiguration error for a missing Doorkeeper configuration
|
9
|
+
#
|
2
10
|
class MissingConfiguration < StandardError
|
3
11
|
def initialize
|
4
|
-
super(
|
12
|
+
super("Configuration for doorkeeper missing. Do you have doorkeeper initializer?")
|
5
13
|
end
|
6
14
|
end
|
7
15
|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
end
|
16
|
+
# Doorkeeper option DSL could be reused in extensions to build their own
|
17
|
+
# configurations. To use the Option DSL gems need to define `builder_class` method
|
18
|
+
# that returns configuration Builder class. This exception raises when they don't
|
19
|
+
# define it.
|
20
|
+
#
|
21
|
+
class MissingConfigurationBuilderClass < StandardError; end
|
22
|
+
|
23
|
+
class << self
|
24
|
+
def configure(&block)
|
25
|
+
@config = Config::Builder.new(&block).build
|
26
|
+
setup_orm_adapter
|
27
|
+
setup_orm_models
|
28
|
+
setup_application_owner if @config.enable_application_owner?
|
29
|
+
@config
|
30
|
+
end
|
14
31
|
|
15
|
-
|
16
|
-
|
17
|
-
|
32
|
+
# @return [Doorkeeper::Config] configuration instance
|
33
|
+
#
|
34
|
+
def configuration
|
35
|
+
@config || (raise MissingConfiguration)
|
36
|
+
end
|
37
|
+
|
38
|
+
alias config configuration
|
18
39
|
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
[
|
24
|
-
trying to load it.
|
40
|
+
def setup_orm_adapter
|
41
|
+
@orm_adapter = "doorkeeper/orm/#{configuration.orm}".classify.constantize
|
42
|
+
rescue NameError => e
|
43
|
+
raise e, "ORM adapter not found (#{configuration.orm})", <<-ERROR_MSG.strip_heredoc
|
44
|
+
[DOORKEEPER] ORM adapter not found (#{configuration.orm}), or there was an error
|
45
|
+
trying to load it.
|
25
46
|
|
26
|
-
You probably need to add the related gem for this adapter to work with
|
27
|
-
doorkeeper.
|
47
|
+
You probably need to add the related gem for this adapter to work with
|
48
|
+
doorkeeper.
|
28
49
|
ERROR_MSG
|
29
|
-
|
50
|
+
end
|
30
51
|
|
31
|
-
|
32
|
-
|
33
|
-
|
52
|
+
def setup_orm_models
|
53
|
+
@orm_adapter.initialize_models!
|
54
|
+
end
|
34
55
|
|
35
|
-
|
36
|
-
|
56
|
+
def setup_application_owner
|
57
|
+
@orm_adapter.initialize_application_owner!
|
58
|
+
end
|
37
59
|
end
|
38
60
|
|
39
61
|
class Config
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
62
|
+
# Default Doorkeeper configuration builder
|
63
|
+
class Builder < AbstractBuilder
|
64
|
+
# Provide support for an owner to be assigned to each registered
|
65
|
+
# application (disabled by default)
|
66
|
+
# Optional parameter confirmation: true (default false) if you want
|
67
|
+
# to enforce ownership of a registered application
|
68
|
+
#
|
69
|
+
# @param opts [Hash] the options to confirm if an application owner
|
70
|
+
# is present
|
71
|
+
# @option opts[Boolean] :confirmation (false)
|
72
|
+
# Set confirm_application_owner variable
|
50
73
|
def enable_application_owner(opts = {})
|
51
|
-
@config.instance_variable_set(
|
74
|
+
@config.instance_variable_set(:@enable_application_owner, true)
|
52
75
|
confirm_application_owner if opts[:confirmation].present? && opts[:confirmation]
|
53
76
|
end
|
54
77
|
|
55
78
|
def confirm_application_owner
|
56
|
-
@config.instance_variable_set(
|
79
|
+
@config.instance_variable_set(:@confirm_application_owner, true)
|
57
80
|
end
|
58
81
|
|
82
|
+
# Define default access token scopes for your provider
|
83
|
+
#
|
84
|
+
# @param scopes [Array] Default set of access (OAuth::Scopes.new)
|
85
|
+
# token scopes
|
59
86
|
def default_scopes(*scopes)
|
60
|
-
@config.instance_variable_set(
|
87
|
+
@config.instance_variable_set(:@default_scopes, OAuth::Scopes.from_array(scopes))
|
61
88
|
end
|
62
89
|
|
90
|
+
# Define default access token scopes for your provider
|
91
|
+
#
|
92
|
+
# @param scopes [Array] Optional set of access (OAuth::Scopes.new)
|
93
|
+
# token scopes
|
63
94
|
def optional_scopes(*scopes)
|
64
|
-
@config.instance_variable_set(
|
95
|
+
@config.instance_variable_set(:@optional_scopes, OAuth::Scopes.from_array(scopes))
|
96
|
+
end
|
97
|
+
|
98
|
+
# Define scopes_by_grant_type to limit certain scope to certain grant_type
|
99
|
+
# @param { Hash } with grant_types as keys.
|
100
|
+
# Default set to {} i.e. no limitation on scopes usage
|
101
|
+
def scopes_by_grant_type(hash = {})
|
102
|
+
@config.instance_variable_set(:@scopes_by_grant_type, hash)
|
65
103
|
end
|
66
104
|
|
105
|
+
# Change the way client credentials are retrieved from the request object.
|
106
|
+
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
|
107
|
+
# falls back to the `:client_id` and `:client_secret` params from the
|
108
|
+
# `params` object.
|
109
|
+
#
|
110
|
+
# @param methods [Array] Define client credentials
|
67
111
|
def client_credentials(*methods)
|
68
|
-
@config.instance_variable_set(
|
112
|
+
@config.instance_variable_set(:@client_credentials_methods, methods)
|
69
113
|
end
|
70
114
|
|
115
|
+
# Change the way access token is authenticated from the request object.
|
116
|
+
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
|
117
|
+
# falls back to the `:access_token` or `:bearer_token` params from the
|
118
|
+
# `params` object.
|
119
|
+
#
|
120
|
+
# @param methods [Array] Define access token methods
|
71
121
|
def access_token_methods(*methods)
|
72
|
-
@config.instance_variable_set(
|
122
|
+
@config.instance_variable_set(:@access_token_methods, methods)
|
73
123
|
end
|
74
124
|
|
75
|
-
|
76
|
-
|
125
|
+
# Issue access tokens with refresh token (disabled if not set)
|
126
|
+
def use_refresh_token(enabled = true, &block)
|
127
|
+
@config.instance_variable_set(
|
128
|
+
:@refresh_token_enabled,
|
129
|
+
block || enabled,
|
130
|
+
)
|
77
131
|
end
|
78
132
|
|
79
|
-
|
80
|
-
|
133
|
+
# Reuse access token for the same resource owner within an application
|
134
|
+
# (disabled by default)
|
135
|
+
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
|
136
|
+
def reuse_access_token
|
137
|
+
@config.instance_variable_set(:@reuse_access_token, true)
|
81
138
|
end
|
82
139
|
|
83
|
-
|
84
|
-
|
140
|
+
# TODO: maybe make it more generic for other flows too?
|
141
|
+
# Only allow one valid access token obtained via client credentials
|
142
|
+
# per client. If a new access token is obtained before the old one
|
143
|
+
# expired, the old one gets revoked (disabled by default)
|
144
|
+
def revoke_previous_client_credentials_token
|
145
|
+
@config.instance_variable_set(:@revoke_previous_client_credentials_token, true)
|
85
146
|
end
|
86
147
|
|
87
|
-
|
88
|
-
|
148
|
+
# Use an API mode for applications generated with --api argument
|
149
|
+
# It will skip applications controller, disable forgery protection
|
150
|
+
def api_only
|
151
|
+
@config.instance_variable_set(:@api_only, true)
|
89
152
|
end
|
90
153
|
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
)
|
154
|
+
# Enables polymorphic Resource Owner association for Access Grant and
|
155
|
+
# Access Token models. Requires additional database columns to be setup.
|
156
|
+
def use_polymorphic_resource_owner
|
157
|
+
@config.instance_variable_set(:@polymorphic_resource_owner, true)
|
95
158
|
end
|
96
159
|
|
97
|
-
|
98
|
-
|
160
|
+
# Forbids creating/updating applications with arbitrary scopes that are
|
161
|
+
# not in configuration, i.e. `default_scopes` or `optional_scopes`.
|
162
|
+
# (disabled by default)
|
163
|
+
def enforce_configured_scopes
|
164
|
+
@config.instance_variable_set(:@enforce_configured_scopes, true)
|
99
165
|
end
|
100
|
-
end
|
101
166
|
|
102
|
-
|
103
|
-
#
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
#
|
109
|
-
#
|
110
|
-
# If the +:as+ option is defined, the builder method will be the specified
|
111
|
-
# option while the config attribute will be the +name+ parameter.
|
112
|
-
#
|
113
|
-
# If you want to introduce another level of config DSL you can
|
114
|
-
# define +builder_class+ parameter.
|
115
|
-
# Builder should take a block as the initializer parameter and respond to function +build+
|
116
|
-
# that returns the value of the config attribute.
|
117
|
-
#
|
118
|
-
# ==== Options
|
119
|
-
#
|
120
|
-
# * [:+as+] Set the builder method that goes inside +configure+ block
|
121
|
-
# * [+:default+] The default value in case no option was set
|
122
|
-
#
|
123
|
-
# ==== Examples
|
167
|
+
# Enforce request content type as the spec requires:
|
168
|
+
# disabled by default for backward compatibility.
|
169
|
+
def enforce_content_type
|
170
|
+
@config.instance_variable_set(:@enforce_content_type, true)
|
171
|
+
end
|
172
|
+
|
173
|
+
# Allow optional hashing of input tokens before persisting them.
|
174
|
+
# Will be used for hashing of input token and grants.
|
124
175
|
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
176
|
+
# @param using
|
177
|
+
# Provide a different secret storage implementation class for tokens
|
178
|
+
# @param fallback
|
179
|
+
# Provide a fallback secret storage implementation class for tokens
|
180
|
+
# or use :plain to fallback to plain tokens
|
181
|
+
def hash_token_secrets(using: nil, fallback: nil)
|
182
|
+
default = "::Doorkeeper::SecretStoring::Sha256Hash"
|
183
|
+
configure_secrets_for :token,
|
184
|
+
using: using || default,
|
185
|
+
fallback: fallback
|
186
|
+
end
|
187
|
+
|
188
|
+
# Allow optional hashing of application secrets before persisting them.
|
189
|
+
# Will be used for hashing of input token and grants.
|
129
190
|
#
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
block ? block : args.first
|
142
|
-
end
|
143
|
-
|
144
|
-
@config.instance_variable_set(:"@#{attribute}", value)
|
145
|
-
end
|
146
|
-
end
|
191
|
+
# @param using
|
192
|
+
# Provide a different secret storage implementation for applications
|
193
|
+
# @param fallback
|
194
|
+
# Provide a fallback secret storage implementation for applications
|
195
|
+
# or use :plain to fallback to plain application secrets
|
196
|
+
def hash_application_secrets(using: nil, fallback: nil)
|
197
|
+
default = "::Doorkeeper::SecretStoring::Sha256Hash"
|
198
|
+
configure_secrets_for :application,
|
199
|
+
using: using || default,
|
200
|
+
fallback: fallback
|
201
|
+
end
|
147
202
|
|
148
|
-
|
149
|
-
if instance_variable_defined?(:"@#{attribute}")
|
150
|
-
instance_variable_get(:"@#{attribute}")
|
151
|
-
else
|
152
|
-
options[:default]
|
153
|
-
end
|
154
|
-
end
|
203
|
+
private
|
155
204
|
|
156
|
-
|
157
|
-
|
205
|
+
# Configure the secret storing functionality
|
206
|
+
def configure_secrets_for(type, using:, fallback:)
|
207
|
+
raise ArgumentError, "Invalid type #{type}" if %i[application token].exclude?(type)
|
208
|
+
|
209
|
+
@config.instance_variable_set(:"@#{type}_secret_strategy", using.constantize)
|
210
|
+
|
211
|
+
if fallback.nil?
|
212
|
+
return
|
213
|
+
elsif fallback.to_sym == :plain
|
214
|
+
fallback = "::Doorkeeper::SecretStoring::Plain"
|
215
|
+
end
|
158
216
|
|
159
|
-
|
160
|
-
base.send(:private, :option)
|
217
|
+
@config.instance_variable_set(:"@#{type}_secret_fallback_strategy", fallback.constantize)
|
161
218
|
end
|
162
219
|
end
|
163
220
|
|
221
|
+
# Replace with `default: Builder` when we drop support of Rails < 5.2
|
222
|
+
mattr_reader(:builder_class) { Builder }
|
223
|
+
|
164
224
|
extend Option
|
225
|
+
include Validations
|
165
226
|
|
166
227
|
option :resource_owner_authenticator,
|
167
228
|
as: :authenticate_resource_owner,
|
168
229
|
default: (lambda do |_routes|
|
169
|
-
logger.warn(
|
230
|
+
::Rails.logger.warn(
|
231
|
+
I18n.t("doorkeeper.errors.messages.resource_owner_authenticator_not_configured"),
|
232
|
+
)
|
233
|
+
|
170
234
|
nil
|
171
235
|
end)
|
236
|
+
|
172
237
|
option :admin_authenticator,
|
173
238
|
as: :authenticate_admin,
|
174
|
-
default:
|
239
|
+
default: (lambda do |_routes|
|
240
|
+
::Rails.logger.warn(
|
241
|
+
I18n.t("doorkeeper.errors.messages.admin_authenticator_not_configured"),
|
242
|
+
)
|
243
|
+
|
244
|
+
head :forbidden
|
245
|
+
end)
|
246
|
+
|
175
247
|
option :resource_owner_from_credentials,
|
176
248
|
default: (lambda do |_routes|
|
177
|
-
warn(
|
249
|
+
::Rails.logger.warn(
|
250
|
+
I18n.t("doorkeeper.errors.messages.credential_flow_not_configured"),
|
251
|
+
)
|
252
|
+
|
178
253
|
nil
|
179
254
|
end)
|
180
255
|
|
256
|
+
# Hooks for authorization
|
257
|
+
option :before_successful_authorization, default: ->(_controller, _context = nil) {}
|
258
|
+
option :after_successful_authorization, default: ->(_controller, _context = nil) {}
|
259
|
+
# Hooks for strategies responses
|
260
|
+
option :before_successful_strategy_response, default: ->(_request) {}
|
261
|
+
option :after_successful_strategy_response, default: ->(_request, _response) {}
|
262
|
+
# Allows to customize Token Introspection response
|
263
|
+
option :custom_introspection_response, default: ->(_token, _context) { {} }
|
264
|
+
|
181
265
|
option :skip_authorization, default: ->(_routes) {}
|
182
266
|
option :access_token_expires_in, default: 7200
|
183
|
-
option :custom_access_token_expires_in, default: ->(
|
267
|
+
option :custom_access_token_expires_in, default: ->(_context) { nil }
|
184
268
|
option :authorization_code_expires_in, default: 600
|
185
269
|
option :orm, default: :active_record
|
186
|
-
option :native_redirect_uri, default:
|
187
|
-
option :
|
188
|
-
option :
|
270
|
+
option :native_redirect_uri, default: "urn:ietf:wg:oauth:2.0:oob", deprecated: true
|
271
|
+
option :grant_flows, default: %w[authorization_code client_credentials]
|
272
|
+
option :handle_auth_errors, default: :render
|
273
|
+
option :token_lookup_batch_size, default: 10_000
|
274
|
+
# Sets the token_reuse_limit
|
275
|
+
# It will be used only when reuse_access_token option in enabled
|
276
|
+
# By default it will be 100
|
277
|
+
# It will be used for token reusablity to some threshold percentage
|
278
|
+
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/1189
|
279
|
+
option :token_reuse_limit, default: 100
|
280
|
+
|
281
|
+
# Don't require client authentication for password grants. If client credentials
|
282
|
+
# are present they will still be validated, and the grant rejected if the credentials
|
283
|
+
# are invalid.
|
284
|
+
#
|
285
|
+
# This is discouraged. Spec says that password grants always require a client.
|
286
|
+
#
|
287
|
+
# See https://github.com/doorkeeper-gem/doorkeeper/issues/1412#issuecomment-632750422
|
288
|
+
# and https://github.com/doorkeeper-gem/doorkeeper/pull/1420
|
289
|
+
#
|
290
|
+
# Since many applications use this unsafe behavior in the wild, this is kept as a
|
291
|
+
# not-recommended option. You should be aware that you are not following the OAuth
|
292
|
+
# spec, and understand the security implications of doing so.
|
293
|
+
option :skip_client_authentication_for_password_grant,
|
294
|
+
default: false
|
295
|
+
|
296
|
+
option :active_record_options,
|
297
|
+
default: {},
|
298
|
+
deprecated: { message: "Customize Doorkeeper models instead" }
|
299
|
+
|
300
|
+
# Hook to allow arbitrary user-client authorization
|
301
|
+
option :authorize_resource_owner_for_client,
|
302
|
+
default: ->(_client, _resource_owner) { true }
|
303
|
+
|
304
|
+
# Allows to customize OAuth grant flows that +each+ application support.
|
305
|
+
# You can configure a custom block (or use a class respond to `#call`) that must
|
306
|
+
# return `true` in case Application instance supports requested OAuth grant flow
|
307
|
+
# during the authorization request to the server. This configuration +doesn't+
|
308
|
+
# set flows per application, it only allows to check if application supports
|
309
|
+
# specific grant flow.
|
310
|
+
#
|
311
|
+
# For example you can add an additional database column to `oauth_applications` table,
|
312
|
+
# say `t.array :grant_flows, default: []`, and store allowed grant flows that can
|
313
|
+
# be used with this application there. Then when authorization requested Doorkeeper
|
314
|
+
# will call this block to check if specific Application (passed with client_id and/or
|
315
|
+
# client_secret) is allowed to perform the request for the specific grant type
|
316
|
+
# (authorization, password, client_credentials, etc).
|
317
|
+
#
|
318
|
+
# Example of the block:
|
319
|
+
#
|
320
|
+
# ->(flow, client) { client.grant_flows.include?(flow) }
|
321
|
+
#
|
322
|
+
# In case this option invocation result is `false`, Doorkeeper server returns
|
323
|
+
# :unauthorized_client error and stops the request.
|
324
|
+
#
|
325
|
+
# @param allow_grant_flow_for_client [Proc] Block or any object respond to #call
|
326
|
+
# @return [Boolean] `true` if allow or `false` if forbid the request
|
327
|
+
#
|
328
|
+
option :allow_grant_flow_for_client, default: ->(_grant_flow, _client) { true }
|
329
|
+
|
330
|
+
# Allows to forbid specific Application redirect URI's by custom rules.
|
331
|
+
# Doesn't forbid any URI by default.
|
332
|
+
#
|
333
|
+
# @param forbid_redirect_uri [Proc] Block or any object respond to #call
|
334
|
+
#
|
335
|
+
option :forbid_redirect_uri, default: ->(_uri) { false }
|
336
|
+
|
337
|
+
# WWW-Authenticate Realm (default "Doorkeeper").
|
338
|
+
#
|
339
|
+
# @param realm [String] ("Doorkeeper") Authentication realm
|
340
|
+
#
|
341
|
+
option :realm, default: "Doorkeeper"
|
342
|
+
|
343
|
+
# Forces the usage of the HTTPS protocol in non-native redirect uris
|
344
|
+
# (enabled by default in non-development environments). OAuth2
|
345
|
+
# delegates security in communication to the HTTPS protocol so it is
|
346
|
+
# wise to keep this enabled.
|
347
|
+
#
|
348
|
+
# @param [Boolean] boolean_or_block value for the parameter, true by default in
|
349
|
+
# non-development environment
|
350
|
+
#
|
351
|
+
# @yield [uri] Conditional usage of SSL redirect uris.
|
352
|
+
# @yieldparam [URI] Redirect URI
|
353
|
+
# @yieldreturn [Boolean] Indicates necessity of usage of the HTTPS protocol
|
354
|
+
# in non-native redirect uris
|
355
|
+
#
|
189
356
|
option :force_ssl_in_redirect_uri, default: !Rails.env.development?
|
190
|
-
|
357
|
+
|
358
|
+
# Use a custom class for generating the access token.
|
359
|
+
# https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-access-token-generator
|
360
|
+
#
|
361
|
+
# @param access_token_generator [String]
|
362
|
+
# the name of the access token generator class
|
363
|
+
#
|
191
364
|
option :access_token_generator,
|
192
|
-
default:
|
365
|
+
default: "Doorkeeper::OAuth::Helpers::UniqueToken"
|
366
|
+
|
367
|
+
# Default access token generator is a SecureRandom class from Ruby stdlib.
|
368
|
+
# This option defines which method will be used to generate a unique token value.
|
369
|
+
#
|
370
|
+
# @param access_token_generator [String]
|
371
|
+
# the name of the access token generator class
|
372
|
+
#
|
373
|
+
option :default_generator_method, default: :urlsafe_base64
|
374
|
+
|
375
|
+
# The controller Doorkeeper::ApplicationController inherits from.
|
376
|
+
# Defaults to ActionController::Base.
|
377
|
+
# https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-controllers
|
378
|
+
#
|
379
|
+
# @param base_controller [String] the name of the base controller
|
193
380
|
option :base_controller,
|
194
|
-
default:
|
381
|
+
default: (lambda do
|
382
|
+
api_only ? "ActionController::API" : "ActionController::Base"
|
383
|
+
end)
|
384
|
+
|
385
|
+
# The controller Doorkeeper::ApplicationMetalController inherits from.
|
386
|
+
# Defaults to ActionController::API.
|
387
|
+
#
|
388
|
+
# @param base_metal_controller [String] the name of the base controller
|
389
|
+
option :base_metal_controller,
|
390
|
+
default: "ActionController::API"
|
195
391
|
|
196
|
-
|
392
|
+
option :access_token_class,
|
393
|
+
default: "Doorkeeper::AccessToken"
|
394
|
+
|
395
|
+
option :access_grant_class,
|
396
|
+
default: "Doorkeeper::AccessGrant"
|
397
|
+
|
398
|
+
option :application_class,
|
399
|
+
default: "Doorkeeper::Application"
|
400
|
+
|
401
|
+
# Allows to set blank redirect URIs for Applications in case
|
402
|
+
# server configured to use URI-less grant flows.
|
403
|
+
#
|
404
|
+
option :allow_blank_redirect_uri,
|
405
|
+
default: (lambda do |grant_flows, _application|
|
406
|
+
grant_flows.exclude?("authorization_code") &&
|
407
|
+
grant_flows.exclude?("implicit")
|
408
|
+
end)
|
409
|
+
|
410
|
+
# Configure protection of token introspection request.
|
411
|
+
# By default this configuration allows to introspect a token by
|
412
|
+
# another token of the same application, or to introspect the token
|
413
|
+
# that belongs to authorized client, or access token has been introspected
|
414
|
+
# is a public one (doesn't belong to any client)
|
415
|
+
#
|
416
|
+
# You can define any custom rule you need or just disable token
|
417
|
+
# introspection at all.
|
418
|
+
#
|
419
|
+
# @param token [Doorkeeper::AccessToken]
|
420
|
+
# token to be introspected
|
421
|
+
#
|
422
|
+
# @param authorized_client [Doorkeeper::Application]
|
423
|
+
# authorized client (if request is authorized using Basic auth with
|
424
|
+
# Client Credentials for example)
|
425
|
+
#
|
426
|
+
# @param authorized_token [Doorkeeper::AccessToken]
|
427
|
+
# Bearer token used to authorize the request
|
428
|
+
#
|
429
|
+
option :allow_token_introspection,
|
430
|
+
default: (lambda do |token, authorized_client, authorized_token|
|
431
|
+
if authorized_token
|
432
|
+
authorized_token.application == token&.application
|
433
|
+
elsif token.application
|
434
|
+
authorized_client == token.application
|
435
|
+
else
|
436
|
+
true
|
437
|
+
end
|
438
|
+
end)
|
439
|
+
|
440
|
+
attr_reader :reuse_access_token,
|
441
|
+
:token_secret_fallback_strategy,
|
442
|
+
:application_secret_fallback_strategy
|
443
|
+
|
444
|
+
# Doorkeeper Access Token model class.
|
445
|
+
#
|
446
|
+
# @return [ActiveRecord::Base, Mongoid::Document, Sequel::Model]
|
447
|
+
#
|
448
|
+
def access_token_model
|
449
|
+
@access_token_model ||= access_token_class.constantize
|
450
|
+
end
|
451
|
+
|
452
|
+
# Doorkeeper Access Grant model class.
|
453
|
+
#
|
454
|
+
# @return [ActiveRecord::Base, Mongoid::Document, Sequel::Model]
|
455
|
+
#
|
456
|
+
def access_grant_model
|
457
|
+
@access_grant_model ||= access_grant_class.constantize
|
458
|
+
end
|
459
|
+
|
460
|
+
# Doorkeeper Application model class.
|
461
|
+
#
|
462
|
+
# @return [ActiveRecord::Base, Mongoid::Document, Sequel::Model]
|
463
|
+
#
|
464
|
+
def application_model
|
465
|
+
@application_model ||= application_class.constantize
|
466
|
+
end
|
467
|
+
|
468
|
+
def api_only
|
469
|
+
@api_only ||= false
|
470
|
+
end
|
471
|
+
|
472
|
+
def enforce_content_type
|
473
|
+
@enforce_content_type ||= false
|
474
|
+
end
|
197
475
|
|
198
476
|
def refresh_token_enabled?
|
199
|
-
@refresh_token_enabled
|
200
|
-
|
477
|
+
if defined?(@refresh_token_enabled)
|
478
|
+
@refresh_token_enabled
|
479
|
+
else
|
480
|
+
false
|
481
|
+
end
|
482
|
+
end
|
483
|
+
|
484
|
+
def resolve_controller(name)
|
485
|
+
config_option = public_send(:"#{name}_controller")
|
486
|
+
controller_name = if config_option.respond_to?(:call)
|
487
|
+
instance_exec(&config_option)
|
488
|
+
else
|
489
|
+
config_option
|
490
|
+
end
|
491
|
+
|
492
|
+
controller_name.constantize
|
493
|
+
end
|
494
|
+
|
495
|
+
def revoke_previous_client_credentials_token?
|
496
|
+
option_set? :revoke_previous_client_credentials_token
|
497
|
+
end
|
498
|
+
|
499
|
+
def enforce_configured_scopes?
|
500
|
+
option_set? :enforce_configured_scopes
|
201
501
|
end
|
202
502
|
|
203
503
|
def enable_application_owner?
|
204
|
-
|
205
|
-
|
504
|
+
option_set? :enable_application_owner
|
505
|
+
end
|
506
|
+
|
507
|
+
def polymorphic_resource_owner?
|
508
|
+
option_set? :polymorphic_resource_owner
|
206
509
|
end
|
207
510
|
|
208
511
|
def confirm_application_owner?
|
209
|
-
|
210
|
-
|
512
|
+
option_set? :confirm_application_owner
|
513
|
+
end
|
514
|
+
|
515
|
+
def raise_on_errors?
|
516
|
+
handle_auth_errors == :raise
|
517
|
+
end
|
518
|
+
|
519
|
+
def application_secret_hashed?
|
520
|
+
instance_variable_defined?(:"@application_secret_strategy")
|
521
|
+
end
|
522
|
+
|
523
|
+
def token_secret_strategy
|
524
|
+
@token_secret_strategy ||= ::Doorkeeper::SecretStoring::Plain
|
525
|
+
end
|
526
|
+
|
527
|
+
def application_secret_strategy
|
528
|
+
@application_secret_strategy ||= ::Doorkeeper::SecretStoring::Plain
|
211
529
|
end
|
212
530
|
|
213
531
|
def default_scopes
|
@@ -222,41 +540,125 @@ doorkeeper.
|
|
222
540
|
@scopes ||= default_scopes + optional_scopes
|
223
541
|
end
|
224
542
|
|
543
|
+
def scopes_by_grant_type
|
544
|
+
@scopes_by_grant_type ||= {}
|
545
|
+
end
|
546
|
+
|
225
547
|
def client_credentials_methods
|
226
|
-
@
|
548
|
+
@client_credentials_methods ||= %i[from_basic from_params]
|
227
549
|
end
|
228
550
|
|
229
551
|
def access_token_methods
|
230
|
-
@access_token_methods ||= [
|
552
|
+
@access_token_methods ||= %i[
|
553
|
+
from_bearer_authorization
|
554
|
+
from_access_token_param
|
555
|
+
from_bearer_param
|
556
|
+
]
|
557
|
+
end
|
558
|
+
|
559
|
+
def enabled_grant_flows
|
560
|
+
@enabled_grant_flows ||= calculate_grant_flows.map { |name| Doorkeeper::GrantFlow.get(name) }.compact
|
561
|
+
end
|
562
|
+
|
563
|
+
def authorization_response_flows
|
564
|
+
@authorization_response_flows ||= enabled_grant_flows.select(&:handles_response_type?) +
|
565
|
+
deprecated_authorization_flows
|
566
|
+
end
|
567
|
+
|
568
|
+
def token_grant_flows
|
569
|
+
@token_grant_flows ||= calculate_token_grant_flows
|
231
570
|
end
|
232
571
|
|
233
572
|
def authorization_response_types
|
234
|
-
|
573
|
+
authorization_response_flows.map(&:response_type_matches)
|
235
574
|
end
|
236
575
|
|
237
576
|
def token_grant_types
|
238
|
-
|
577
|
+
token_grant_flows.map(&:grant_type_matches)
|
239
578
|
end
|
240
579
|
|
241
|
-
|
580
|
+
# [NOTE]: deprecated and will be removed soon
|
581
|
+
def deprecated_token_grant_types_resolver
|
582
|
+
@deprecated_token_grant_types ||= calculate_token_grant_types
|
583
|
+
end
|
242
584
|
|
243
|
-
#
|
244
|
-
|
245
|
-
|
585
|
+
# [NOTE]: deprecated and will be removed soon
|
586
|
+
def deprecated_authorization_flows
|
587
|
+
response_types = calculate_authorization_response_types
|
588
|
+
|
589
|
+
if response_types.any?
|
590
|
+
::Kernel.warn <<~WARNING
|
591
|
+
Please, don't patch Doorkeeper::Config#calculate_authorization_response_types method.
|
592
|
+
Register your custom grant flows using the public API:
|
593
|
+
`Doorkeeper::GrantFlow.register(grant_flow_name, **options)`.
|
594
|
+
WARNING
|
595
|
+
end
|
596
|
+
|
597
|
+
response_types.map do |response_type|
|
598
|
+
Doorkeeper::GrantFlow::FallbackFlow.new(response_type, response_type_matches: response_type)
|
599
|
+
end
|
600
|
+
end
|
601
|
+
|
602
|
+
# [NOTE]: deprecated and will be removed soon
|
246
603
|
def calculate_authorization_response_types
|
247
|
-
|
248
|
-
types << 'code' if grant_flows.include? 'authorization_code'
|
249
|
-
types << 'token' if grant_flows.include? 'implicit'
|
250
|
-
types
|
604
|
+
[]
|
251
605
|
end
|
252
606
|
|
253
|
-
#
|
254
|
-
# request endpoint, and return them in array.
|
255
|
-
#
|
607
|
+
# [NOTE]: deprecated and will be removed soon
|
256
608
|
def calculate_token_grant_types
|
257
|
-
types = grant_flows - [
|
258
|
-
types <<
|
609
|
+
types = grant_flows - ["implicit"]
|
610
|
+
types << "refresh_token" if refresh_token_enabled?
|
259
611
|
types
|
260
612
|
end
|
613
|
+
|
614
|
+
# Calculates grant flows configured by the user in Doorkeeper
|
615
|
+
# configuration considering registered aliases that is exposed
|
616
|
+
# to single or multiple other flows.
|
617
|
+
#
|
618
|
+
def calculate_grant_flows
|
619
|
+
configured_flows = grant_flows.map(&:to_s)
|
620
|
+
aliases = Doorkeeper::GrantFlow.aliases.keys.map(&:to_s)
|
621
|
+
|
622
|
+
flows = configured_flows - aliases
|
623
|
+
aliases.each do |flow_alias|
|
624
|
+
next unless configured_flows.include?(flow_alias)
|
625
|
+
|
626
|
+
flows.concat(Doorkeeper::GrantFlow.expand_alias(flow_alias))
|
627
|
+
end
|
628
|
+
|
629
|
+
flows.flatten.uniq
|
630
|
+
end
|
631
|
+
|
632
|
+
def allow_blank_redirect_uri?(application = nil)
|
633
|
+
if allow_blank_redirect_uri.respond_to?(:call)
|
634
|
+
allow_blank_redirect_uri.call(grant_flows, application)
|
635
|
+
else
|
636
|
+
allow_blank_redirect_uri
|
637
|
+
end
|
638
|
+
end
|
639
|
+
|
640
|
+
def allow_grant_flow_for_client?(grant_flow, client)
|
641
|
+
return true unless option_defined?(:allow_grant_flow_for_client)
|
642
|
+
|
643
|
+
allow_grant_flow_for_client.call(grant_flow, client)
|
644
|
+
end
|
645
|
+
|
646
|
+
def option_defined?(name)
|
647
|
+
instance_variable_defined?("@#{name}")
|
648
|
+
end
|
649
|
+
|
650
|
+
private
|
651
|
+
|
652
|
+
# Helper to read boolearized configuration option
|
653
|
+
def option_set?(instance_key)
|
654
|
+
var = instance_variable_get("@#{instance_key}")
|
655
|
+
!!(defined?(var) && var)
|
656
|
+
end
|
657
|
+
|
658
|
+
def calculate_token_grant_flows
|
659
|
+
flows = enabled_grant_flows.select(&:handles_grant_type?)
|
660
|
+
flows << Doorkeeper::GrantFlow.get("refresh_token") if refresh_token_enabled?
|
661
|
+
flows
|
662
|
+
end
|
261
663
|
end
|
262
664
|
end
|