mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-08-08 06:55:21 +02:00
OAuth
This commit is contained in:
parent
cdad31812a
commit
755afffec8
12 changed files with 989 additions and 8 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -94,9 +94,7 @@ node_modules/
|
||||||
*.roo*
|
*.roo*
|
||||||
# OS specific
|
# OS specific
|
||||||
# Task files
|
# Task files
|
||||||
.taskmaster/docs
|
.taskmaster/
|
||||||
.taskmaster/config.json
|
|
||||||
.taskmaster/templates
|
|
||||||
tasks.json
|
tasks.json
|
||||||
tasks/
|
tasks/
|
||||||
*.mcp.json
|
*.mcp.json
|
||||||
|
|
4
Gemfile
4
Gemfile
|
@ -47,6 +47,10 @@ gem "image_processing", ">= 1.2"
|
||||||
gem "ostruct"
|
gem "ostruct"
|
||||||
gem "bcrypt", "~> 3.1"
|
gem "bcrypt", "~> 3.1"
|
||||||
gem "jwt"
|
gem "jwt"
|
||||||
|
|
||||||
|
# OAuth & API Security
|
||||||
|
gem "doorkeeper"
|
||||||
|
gem "rack-attack", "~> 6.6"
|
||||||
gem "faraday"
|
gem "faraday"
|
||||||
gem "faraday-retry"
|
gem "faraday-retry"
|
||||||
gem "faraday-multipart"
|
gem "faraday-multipart"
|
||||||
|
|
|
@ -155,6 +155,8 @@ GEM
|
||||||
irb (~> 1.10)
|
irb (~> 1.10)
|
||||||
reline (>= 0.3.8)
|
reline (>= 0.3.8)
|
||||||
docile (1.4.1)
|
docile (1.4.1)
|
||||||
|
doorkeeper (5.8.2)
|
||||||
|
railties (>= 5)
|
||||||
dotenv (3.1.8)
|
dotenv (3.1.8)
|
||||||
dotenv-rails (3.1.8)
|
dotenv-rails (3.1.8)
|
||||||
dotenv (= 3.1.8)
|
dotenv (= 3.1.8)
|
||||||
|
@ -364,6 +366,8 @@ GEM
|
||||||
raabro (1.4.0)
|
raabro (1.4.0)
|
||||||
racc (1.8.1)
|
racc (1.8.1)
|
||||||
rack (3.1.16)
|
rack (3.1.16)
|
||||||
|
rack-attack (6.7.0)
|
||||||
|
rack (>= 1.0, < 4)
|
||||||
rack-mini-profiler (3.3.1)
|
rack-mini-profiler (3.3.1)
|
||||||
rack (>= 1.2.0)
|
rack (>= 1.2.0)
|
||||||
rack-session (2.1.1)
|
rack-session (2.1.1)
|
||||||
|
@ -596,6 +600,7 @@ DEPENDENCIES
|
||||||
climate_control
|
climate_control
|
||||||
csv
|
csv
|
||||||
debug
|
debug
|
||||||
|
doorkeeper
|
||||||
dotenv-rails
|
dotenv-rails
|
||||||
erb_lint
|
erb_lint
|
||||||
faker
|
faker
|
||||||
|
@ -623,6 +628,7 @@ DEPENDENCIES
|
||||||
plaid
|
plaid
|
||||||
propshaft
|
propshaft
|
||||||
puma (>= 5.0)
|
puma (>= 5.0)
|
||||||
|
rack-attack (~> 6.6)
|
||||||
rack-mini-profiler
|
rack-mini-profiler
|
||||||
rails (~> 7.2.2)
|
rails (~> 7.2.2)
|
||||||
rails-settings-cached
|
rails-settings-cached
|
||||||
|
|
|
@ -38,5 +38,8 @@ module Maybe
|
||||||
config.lookbook.preview_display_options = {
|
config.lookbook.preview_display_options = {
|
||||||
theme: [ "light", "dark" ] # available in view as params[:theme]
|
theme: [ "light", "dark" ] # available in view as params[:theme]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Enable Rack::Attack middleware for API rate limiting
|
||||||
|
config.middleware.use Rack::Attack
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
526
config/initializers/doorkeeper.rb
Normal file
526
config/initializers/doorkeeper.rb
Normal file
|
@ -0,0 +1,526 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
Doorkeeper.configure do
|
||||||
|
# Change the ORM that doorkeeper will use (requires ORM extensions installed).
|
||||||
|
# Check the list of supported ORMs here: https://github.com/doorkeeper-gem/doorkeeper#orms
|
||||||
|
orm :active_record
|
||||||
|
|
||||||
|
# This block will be called to check whether the resource owner is authenticated or not.
|
||||||
|
resource_owner_authenticator do
|
||||||
|
Current.user || redirect_to(new_session_url)
|
||||||
|
end
|
||||||
|
|
||||||
|
# If you didn't skip applications controller from Doorkeeper routes in your application routes.rb
|
||||||
|
# file then you need to declare this block in order to restrict access to the web interface for
|
||||||
|
# adding oauth authorized applications. In other case it will return 403 Forbidden response
|
||||||
|
# every time somebody will try to access the admin web interface.
|
||||||
|
#
|
||||||
|
admin_authenticator do
|
||||||
|
# Put your admin authentication logic here.
|
||||||
|
# Example implementation:
|
||||||
|
|
||||||
|
if Current.user
|
||||||
|
head :forbidden unless Current.user.admin?
|
||||||
|
else
|
||||||
|
redirect_to new_session_url
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# You can use your own model classes if you need to extend (or even override) default
|
||||||
|
# Doorkeeper models such as `Application`, `AccessToken` and `AccessGrant.
|
||||||
|
#
|
||||||
|
# By default Doorkeeper ActiveRecord ORM uses its own classes:
|
||||||
|
#
|
||||||
|
# access_token_class "Doorkeeper::AccessToken"
|
||||||
|
# access_grant_class "Doorkeeper::AccessGrant"
|
||||||
|
# application_class "Doorkeeper::Application"
|
||||||
|
#
|
||||||
|
# Don't forget to include Doorkeeper ORM mixins into your custom models:
|
||||||
|
#
|
||||||
|
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken - for access token
|
||||||
|
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessGrant - for access grant
|
||||||
|
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::Application - for application (OAuth2 clients)
|
||||||
|
#
|
||||||
|
# For example:
|
||||||
|
#
|
||||||
|
# access_token_class "MyAccessToken"
|
||||||
|
#
|
||||||
|
# class MyAccessToken < ApplicationRecord
|
||||||
|
# include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken
|
||||||
|
#
|
||||||
|
# self.table_name = "hey_i_wanna_my_name"
|
||||||
|
#
|
||||||
|
# def destroy_me!
|
||||||
|
# destroy
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Enables polymorphic Resource Owner association for Access Tokens and Access Grants.
|
||||||
|
# By default this option is disabled.
|
||||||
|
#
|
||||||
|
# Make sure you properly setup you database and have all the required columns (run
|
||||||
|
# `bundle exec rails generate doorkeeper:enable_polymorphic_resource_owner` and execute Rails
|
||||||
|
# migrations).
|
||||||
|
#
|
||||||
|
# If this option enabled, Doorkeeper will store not only Resource Owner primary key
|
||||||
|
# value, but also it's type (class name). See "Polymorphic Associations" section of
|
||||||
|
# Rails guides: https://guides.rubyonrails.org/association_basics.html#polymorphic-associations
|
||||||
|
#
|
||||||
|
# [NOTE] If you apply this option on already existing project don't forget to manually
|
||||||
|
# update `resource_owner_type` column in the database and fix migration template as it will
|
||||||
|
# set NOT NULL constraint for Access Grants table.
|
||||||
|
#
|
||||||
|
# use_polymorphic_resource_owner
|
||||||
|
|
||||||
|
# If you are planning to use Doorkeeper in Rails 5 API-only application, then you might
|
||||||
|
# want to use API mode that will skip all the views management and change the way how
|
||||||
|
# Doorkeeper responds to a requests.
|
||||||
|
#
|
||||||
|
# api_only
|
||||||
|
|
||||||
|
# Enforce token request content type to application/x-www-form-urlencoded.
|
||||||
|
# It is not enabled by default to not break prior versions of the gem.
|
||||||
|
#
|
||||||
|
# enforce_content_type
|
||||||
|
|
||||||
|
# Authorization Code expiration time (default: 10 minutes).
|
||||||
|
#
|
||||||
|
# authorization_code_expires_in 10.minutes
|
||||||
|
|
||||||
|
# Access token expiration time (default: 2 hours).
|
||||||
|
# If you set this to `nil` Doorkeeper will not expire the token and omit expires_in in response.
|
||||||
|
# It is RECOMMENDED to set expiration time explicitly.
|
||||||
|
# Prefer access_token_expires_in 100.years or similar,
|
||||||
|
# which would be functionally equivalent and avoid the risk of unexpected behavior by callers.
|
||||||
|
#
|
||||||
|
access_token_expires_in 1.year
|
||||||
|
|
||||||
|
# Assign custom TTL for access tokens. Will be used instead of access_token_expires_in
|
||||||
|
# option if defined. In case the block returns `nil` value Doorkeeper fallbacks to
|
||||||
|
# +access_token_expires_in+ configuration option value. If you really need to issue a
|
||||||
|
# non-expiring access token (which is not recommended) then you need to return
|
||||||
|
# Float::INFINITY from this block.
|
||||||
|
#
|
||||||
|
# `context` has the following properties available:
|
||||||
|
#
|
||||||
|
# * `client` - the OAuth client application (see Doorkeeper::OAuth::Client)
|
||||||
|
# * `grant_type` - the grant type of the request (see Doorkeeper::OAuth)
|
||||||
|
# * `scopes` - the requested scopes (see Doorkeeper::OAuth::Scopes)
|
||||||
|
# * `resource_owner` - authorized resource owner instance (if present)
|
||||||
|
#
|
||||||
|
# custom_access_token_expires_in do |context|
|
||||||
|
# context.client.additional_settings.implicit_oauth_expiration
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Use a custom class for generating the access token.
|
||||||
|
# See https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-access-token-generator
|
||||||
|
#
|
||||||
|
# access_token_generator '::Doorkeeper::JWT'
|
||||||
|
|
||||||
|
# The controller +Doorkeeper::ApplicationController+ inherits from.
|
||||||
|
# Defaults to +ActionController::Base+ unless +api_only+ is set, which changes the default to
|
||||||
|
# +ActionController::API+. The return value of this option must be a stringified class name.
|
||||||
|
# See https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-controllers
|
||||||
|
#
|
||||||
|
# base_controller 'ApplicationController'
|
||||||
|
|
||||||
|
# Reuse access token for the same resource owner within an application (disabled by default).
|
||||||
|
#
|
||||||
|
# This option protects your application from creating new tokens before old **valid** one becomes
|
||||||
|
# expired so your database doesn't bloat. Keep in mind that when this option is enabled Doorkeeper
|
||||||
|
# doesn't update existing token expiration time, it will create a new token instead if no active matching
|
||||||
|
# token found for the application, resources owner and/or set of scopes.
|
||||||
|
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
|
||||||
|
#
|
||||||
|
# You can not enable this option together with +hash_token_secrets+.
|
||||||
|
#
|
||||||
|
# reuse_access_token
|
||||||
|
|
||||||
|
# In case you enabled `reuse_access_token` option Doorkeeper will try to find matching
|
||||||
|
# token using `matching_token_for` Access Token API that searches for valid records
|
||||||
|
# in batches in order not to pollute the memory with all the database records. By default
|
||||||
|
# Doorkeeper uses batch size of 10 000 records. You can increase or decrease this value
|
||||||
|
# depending on your needs and server capabilities.
|
||||||
|
#
|
||||||
|
# token_lookup_batch_size 10_000
|
||||||
|
|
||||||
|
# Set a limit for token_reuse if using reuse_access_token option
|
||||||
|
#
|
||||||
|
# This option limits token_reusability to some extent.
|
||||||
|
# If not set then access_token will be reused unless it expires.
|
||||||
|
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/1189
|
||||||
|
#
|
||||||
|
# This option should be a percentage(i.e. (0,100])
|
||||||
|
#
|
||||||
|
# token_reuse_limit 100
|
||||||
|
|
||||||
|
# Only allow one valid access token obtained via client credentials
|
||||||
|
# per client. If a new access token is obtained before the old one
|
||||||
|
# expired, the old one gets revoked (disabled by default)
|
||||||
|
#
|
||||||
|
# When enabling this option, make sure that you do not expect multiple processes
|
||||||
|
# using the same credentials at the same time (e.g. web servers spanning
|
||||||
|
# multiple machines and/or processes).
|
||||||
|
#
|
||||||
|
# revoke_previous_client_credentials_token
|
||||||
|
|
||||||
|
# Only allow one valid access token obtained via authorization code
|
||||||
|
# per client. If a new access token is obtained before the old one
|
||||||
|
# expired, the old one gets revoked (disabled by default)
|
||||||
|
#
|
||||||
|
# revoke_previous_authorization_code_token
|
||||||
|
|
||||||
|
# Require non-confidential clients to use PKCE when using an authorization code
|
||||||
|
# to obtain an access_token (disabled by default)
|
||||||
|
#
|
||||||
|
force_pkce
|
||||||
|
|
||||||
|
# Hash access and refresh tokens before persisting them.
|
||||||
|
# This will disable the possibility to use +reuse_access_token+
|
||||||
|
# since plain values can no longer be retrieved.
|
||||||
|
#
|
||||||
|
# Note: If you are already a user of doorkeeper and have existing tokens
|
||||||
|
# in your installation, they will be invalid without adding 'fallback: :plain'.
|
||||||
|
#
|
||||||
|
hash_token_secrets
|
||||||
|
# By default, token secrets will be hashed using the
|
||||||
|
# +Doorkeeper::Hashing::SHA256+ strategy.
|
||||||
|
#
|
||||||
|
# If you wish to use another hashing implementation, you can override
|
||||||
|
# this strategy as follows:
|
||||||
|
#
|
||||||
|
# hash_token_secrets using: '::Doorkeeper::Hashing::MyCustomHashImpl'
|
||||||
|
#
|
||||||
|
# Keep in mind that changing the hashing function will invalidate all existing
|
||||||
|
# secrets, if there are any.
|
||||||
|
|
||||||
|
# Hash application secrets before persisting them.
|
||||||
|
#
|
||||||
|
hash_application_secrets
|
||||||
|
#
|
||||||
|
# By default, applications will be hashed
|
||||||
|
# with the +Doorkeeper::SecretStoring::SHA256+ strategy.
|
||||||
|
#
|
||||||
|
# If you wish to use bcrypt for application secret hashing, uncomment
|
||||||
|
# this line instead:
|
||||||
|
#
|
||||||
|
# hash_application_secrets using: '::Doorkeeper::SecretStoring::BCrypt'
|
||||||
|
|
||||||
|
# When the above option is enabled, and a hashed token or secret is not found,
|
||||||
|
# you can allow to fall back to another strategy. For users upgrading
|
||||||
|
# doorkeeper and wishing to enable hashing, you will probably want to enable
|
||||||
|
# the fallback to plain tokens.
|
||||||
|
#
|
||||||
|
# This will ensure that old access tokens and secrets
|
||||||
|
# will remain valid even if the hashing above is enabled.
|
||||||
|
#
|
||||||
|
# This can be done by adding 'fallback: plain', e.g. :
|
||||||
|
#
|
||||||
|
# hash_application_secrets using: '::Doorkeeper::SecretStoring::BCrypt', fallback: :plain
|
||||||
|
|
||||||
|
# Issue access tokens with refresh token (disabled by default), you may also
|
||||||
|
# pass a block which accepts `context` to customize when to give a refresh
|
||||||
|
# token or not. Similar to +custom_access_token_expires_in+, `context` has
|
||||||
|
# the following properties:
|
||||||
|
#
|
||||||
|
# `client` - the OAuth client application (see Doorkeeper::OAuth::Client)
|
||||||
|
# `grant_type` - the grant type of the request (see Doorkeeper::OAuth)
|
||||||
|
# `scopes` - the requested scopes (see Doorkeeper::OAuth::Scopes)
|
||||||
|
#
|
||||||
|
use_refresh_token
|
||||||
|
|
||||||
|
# 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://doorkeeper.gitbook.io/guides/ruby-on-rails/scopes
|
||||||
|
#
|
||||||
|
default_scopes :read_accounts
|
||||||
|
optional_scopes :read_transactions, :read_balances
|
||||||
|
|
||||||
|
# Allows to restrict only certain scopes for grant_type.
|
||||||
|
# By default, all the scopes will be available for all the grant types.
|
||||||
|
#
|
||||||
|
# Keys to this hash should be the name of grant_type and
|
||||||
|
# values should be the array of scopes for that grant type.
|
||||||
|
# Note: scopes should be from configured_scopes (i.e. default or optional)
|
||||||
|
#
|
||||||
|
# scopes_by_grant_type password: [:write], client_credentials: [:update]
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# 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 https://github.com/doorkeeper-gem/doorkeeper/wiki/Changing-how-clients-are-authenticated
|
||||||
|
# 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 https://github.com/doorkeeper-gem/doorkeeper/wiki/Changing-how-clients-are-authenticated
|
||||||
|
# for more information on customization
|
||||||
|
#
|
||||||
|
# access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
#
|
||||||
|
# Callable objects such as proc, lambda, block or any object that responds to
|
||||||
|
# #call can be used in order to allow conditional checks (to allow non-SSL
|
||||||
|
# redirects to localhost for example).
|
||||||
|
#
|
||||||
|
# force_ssl_in_redirect_uri !Rails.env.development?
|
||||||
|
#
|
||||||
|
# force_ssl_in_redirect_uri { |uri| uri.host != 'localhost' }
|
||||||
|
|
||||||
|
# Specify what redirect URI's you want to block during Application creation.
|
||||||
|
# Any redirect URI is allowed by default.
|
||||||
|
#
|
||||||
|
# You can use this option in order to forbid URI's with 'javascript' scheme
|
||||||
|
# for example.
|
||||||
|
#
|
||||||
|
# forbid_redirect_uri { |uri| uri.scheme.to_s.downcase == 'javascript' }
|
||||||
|
|
||||||
|
# Allows to set blank redirect URIs for Applications in case Doorkeeper configured
|
||||||
|
# to use URI-less OAuth grant flows like Client Credentials or Resource Owner
|
||||||
|
# Password Credentials. The option is on by default and checks configured grant
|
||||||
|
# types, but you **need** to manually drop `NOT NULL` constraint from `redirect_uri`
|
||||||
|
# column for `oauth_applications` database table.
|
||||||
|
#
|
||||||
|
# You can completely disable this feature with:
|
||||||
|
#
|
||||||
|
# allow_blank_redirect_uri false
|
||||||
|
#
|
||||||
|
# Or you can define your custom check:
|
||||||
|
#
|
||||||
|
# allow_blank_redirect_uri do |grant_flows, client|
|
||||||
|
# client.superapp?
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Specify how authorization errors should be handled.
|
||||||
|
# By default, doorkeeper renders json errors when access token
|
||||||
|
# is invalid, expired, revoked or has invalid scopes.
|
||||||
|
#
|
||||||
|
# If you want to render error response yourself (i.e. rescue exceptions),
|
||||||
|
# set +handle_auth_errors+ to `:raise` and rescue Doorkeeper::Errors::InvalidToken
|
||||||
|
# or following specific errors:
|
||||||
|
#
|
||||||
|
# Doorkeeper::Errors::TokenForbidden, Doorkeeper::Errors::TokenExpired,
|
||||||
|
# Doorkeeper::Errors::TokenRevoked, Doorkeeper::Errors::TokenUnknown
|
||||||
|
#
|
||||||
|
# handle_auth_errors :raise
|
||||||
|
#
|
||||||
|
# If you want to redirect back to the client application in accordance with
|
||||||
|
# https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1, you can set
|
||||||
|
# +handle_auth_errors+ to :redirect
|
||||||
|
#
|
||||||
|
# handle_auth_errors :redirect
|
||||||
|
|
||||||
|
# Customize token introspection response.
|
||||||
|
# Allows to add your own fields to default one that are required by the OAuth spec
|
||||||
|
# for the introspection response. It could be `sub`, `aud` and so on.
|
||||||
|
# This configuration option can be a proc, lambda or any Ruby object responds
|
||||||
|
# to `.call` method and result of it's invocation must be a Hash.
|
||||||
|
#
|
||||||
|
# custom_introspection_response do |token, context|
|
||||||
|
# {
|
||||||
|
# "sub": "Z5O3upPC88QrAjx00dis",
|
||||||
|
# "aud": "https://protected.example.net/resource",
|
||||||
|
# "username": User.find(token.resource_owner_id).username
|
||||||
|
# }
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# or
|
||||||
|
#
|
||||||
|
# custom_introspection_response CustomIntrospectionResponder
|
||||||
|
|
||||||
|
# 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:
|
||||||
|
# https://datatracker.ietf.org/doc/html/rfc6819#section-4.4.2
|
||||||
|
# https://datatracker.ietf.org/doc/html/rfc6819#section-4.4.3
|
||||||
|
#
|
||||||
|
# grant_flows %w[authorization_code client_credentials]
|
||||||
|
|
||||||
|
# Allows to customize OAuth grant flows that +each+ application support.
|
||||||
|
# You can configure a custom block (or use a class respond to `#call`) that must
|
||||||
|
# return `true` in case Application instance supports requested OAuth grant flow
|
||||||
|
# during the authorization request to the server. This configuration +doesn't+
|
||||||
|
# set flows per application, it only allows to check if application supports
|
||||||
|
# specific grant flow.
|
||||||
|
#
|
||||||
|
# For example you can add an additional database column to `oauth_applications` table,
|
||||||
|
# say `t.array :grant_flows, default: []`, and store allowed grant flows that can
|
||||||
|
# be used with this application there. Then when authorization requested Doorkeeper
|
||||||
|
# will call this block to check if specific Application (passed with client_id and/or
|
||||||
|
# client_secret) is allowed to perform the request for the specific grant type
|
||||||
|
# (authorization, password, client_credentials, etc).
|
||||||
|
#
|
||||||
|
# Example of the block:
|
||||||
|
#
|
||||||
|
# ->(flow, client) { client.grant_flows.include?(flow) }
|
||||||
|
#
|
||||||
|
# In case this option invocation result is `false`, Doorkeeper server returns
|
||||||
|
# :unauthorized_client error and stops the request.
|
||||||
|
#
|
||||||
|
# @param allow_grant_flow_for_client [Proc] Block or any object respond to #call
|
||||||
|
# @return [Boolean] `true` if allow or `false` if forbid the request
|
||||||
|
#
|
||||||
|
# allow_grant_flow_for_client do |grant_flow, client|
|
||||||
|
# # `grant_flows` is an Array column with grant
|
||||||
|
# # flows that application supports
|
||||||
|
#
|
||||||
|
# client.grant_flows.include?(grant_flow)
|
||||||
|
# end
|
||||||
|
|
||||||
|
# If you need arbitrary Resource Owner-Client authorization you can enable this option
|
||||||
|
# and implement the check your need. Config option must respond to #call and return
|
||||||
|
# true in case resource owner authorized for the specific application or false in other
|
||||||
|
# cases.
|
||||||
|
#
|
||||||
|
# By default all Resource Owners are authorized to any Client (application).
|
||||||
|
#
|
||||||
|
# authorize_resource_owner_for_client do |client, resource_owner|
|
||||||
|
# resource_owner.admin? || client.owners_allowlist.include?(resource_owner)
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Allows additional data fields to be sent while granting access to an application,
|
||||||
|
# and for this additional data to be included in subsequently generated access tokens.
|
||||||
|
# The 'authorizations/new' page will need to be overridden to include this additional data
|
||||||
|
# in the request params when granting access. The access grant and access token models
|
||||||
|
# will both need to respond to these additional data fields, and have a database column
|
||||||
|
# to store them in.
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# You have a multi-tenanted platform and want to be able to grant access to a specific
|
||||||
|
# tenant, rather than all the tenants a user has access to. You can use this config
|
||||||
|
# option to specify that a ':tenant_id' will be passed when authorizing. This tenant_id
|
||||||
|
# will be included in the access tokens. When a request is made with one of these access
|
||||||
|
# tokens, you can check that the requested data belongs to the specified tenant.
|
||||||
|
#
|
||||||
|
# Default value is an empty Array: []
|
||||||
|
# custom_access_token_attributes [:tenant_id]
|
||||||
|
|
||||||
|
# Hook into the strategies' request & response life-cycle in case your
|
||||||
|
# application needs advanced customization or logging:
|
||||||
|
#
|
||||||
|
# before_successful_strategy_response do |request|
|
||||||
|
# puts "BEFORE HOOK FIRED! #{request}"
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# after_successful_strategy_response do |request, response|
|
||||||
|
# puts "AFTER HOOK FIRED! #{request}, #{response}"
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Hook into Authorization flow in order to implement Single Sign Out
|
||||||
|
# or add any other functionality. Inside the block you have an access
|
||||||
|
# to `controller` (authorizations controller instance) and `context`
|
||||||
|
# (Doorkeeper::OAuth::Hooks::Context instance) which provides pre auth
|
||||||
|
# or auth objects with issued token based on hook type (before or after).
|
||||||
|
#
|
||||||
|
# before_successful_authorization do |controller, context|
|
||||||
|
# Rails.logger.info(controller.request.params.inspect)
|
||||||
|
#
|
||||||
|
# Rails.logger.info(context.pre_auth.inspect)
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# after_successful_authorization do |controller, context|
|
||||||
|
# controller.session[:logout_urls] <<
|
||||||
|
# Doorkeeper::Application
|
||||||
|
# .find_by(controller.request.params.slice(:redirect_uri))
|
||||||
|
# .logout_uri
|
||||||
|
#
|
||||||
|
# Rails.logger.info(context.auth.inspect)
|
||||||
|
# Rails.logger.info(context.issued_token)
|
||||||
|
# end
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
#
|
||||||
|
# skip_authorization do |resource_owner, client|
|
||||||
|
# client.superapp? or resource_owner.admin?
|
||||||
|
# end
|
||||||
|
|
||||||
|
# Configure custom constraints for the Token Introspection request.
|
||||||
|
# By default this configuration option allows to introspect a token by another
|
||||||
|
# token of the same application, OR to introspect the token that belongs to
|
||||||
|
# authorized client (from authenticated client) OR when token doesn't
|
||||||
|
# belong to any client (public token). Otherwise requester has no access to the
|
||||||
|
# introspection and it will return response as stated in the RFC.
|
||||||
|
#
|
||||||
|
# Block arguments:
|
||||||
|
#
|
||||||
|
# @param token [Doorkeeper::AccessToken]
|
||||||
|
# token to be introspected
|
||||||
|
#
|
||||||
|
# @param authorized_client [Doorkeeper::Application]
|
||||||
|
# authorized client (if request is authorized using Basic auth with
|
||||||
|
# Client Credentials for example)
|
||||||
|
#
|
||||||
|
# @param authorized_token [Doorkeeper::AccessToken]
|
||||||
|
# Bearer token used to authorize the request
|
||||||
|
#
|
||||||
|
# In case the block returns `nil` or `false` introspection responses with 401 status code
|
||||||
|
# when using authorized token to introspect, or you'll get 200 with { "active": false } body
|
||||||
|
# when using authorized client to introspect as stated in the
|
||||||
|
# RFC 7662 section 2.2. Introspection Response.
|
||||||
|
#
|
||||||
|
# Using with caution:
|
||||||
|
# Keep in mind that these three parameters pass to block can be nil as following case:
|
||||||
|
# `authorized_client` is nil if and only if `authorized_token` is present, and vice versa.
|
||||||
|
# `token` will be nil if and only if `authorized_token` is present.
|
||||||
|
# So remember to use `&` or check if it is present before calling method on
|
||||||
|
# them to make sure you doesn't get NoMethodError exception.
|
||||||
|
#
|
||||||
|
# You can define your custom check:
|
||||||
|
#
|
||||||
|
# allow_token_introspection do |token, authorized_client, authorized_token|
|
||||||
|
# if authorized_token
|
||||||
|
# # customize: require `introspection` scope
|
||||||
|
# authorized_token.application == token&.application ||
|
||||||
|
# authorized_token.scopes.include?("introspection")
|
||||||
|
# elsif token.application
|
||||||
|
# # `protected_resource` is a new database boolean column, for example
|
||||||
|
# authorized_client == token.application || authorized_client.protected_resource?
|
||||||
|
# else
|
||||||
|
# # public token (when token.application is nil, token doesn't belong to any application)
|
||||||
|
# true
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# Or you can completely disable any token introspection:
|
||||||
|
#
|
||||||
|
# allow_token_introspection false
|
||||||
|
#
|
||||||
|
# If you need to block the request at all, then configure your routes.rb or web-server
|
||||||
|
# like nginx to forbid the request.
|
||||||
|
|
||||||
|
# WWW-Authenticate Realm (default: "Doorkeeper").
|
||||||
|
#
|
||||||
|
# realm "Doorkeeper"
|
||||||
|
end
|
66
config/initializers/rack_attack.rb
Normal file
66
config/initializers/rack_attack.rb
Normal file
|
@ -0,0 +1,66 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
class Rack::Attack
|
||||||
|
# Enable Rack::Attack
|
||||||
|
enabled = Rails.env.production? || Rails.env.staging?
|
||||||
|
|
||||||
|
# Throttle requests to the OAuth token endpoint
|
||||||
|
throttle("oauth/token", limit: 10, period: 1.minute) do |request|
|
||||||
|
request.ip if request.path == "/oauth/token"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Throttle API requests per access token
|
||||||
|
throttle("api/requests", limit: 100, period: 1.hour) do |request|
|
||||||
|
if request.path.start_with?("/api/")
|
||||||
|
# Extract access token from Authorization header
|
||||||
|
auth_header = request.get_header("HTTP_AUTHORIZATION")
|
||||||
|
if auth_header&.start_with?("Bearer ")
|
||||||
|
token = auth_header.split(" ").last
|
||||||
|
"api_token:#{Digest::SHA256.hexdigest(token)}"
|
||||||
|
else
|
||||||
|
# Fall back to IP-based limiting for unauthenticated requests
|
||||||
|
"api_ip:#{request.ip}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# More permissive throttling for API requests by IP (for development/testing)
|
||||||
|
throttle("api/ip", limit: 200, period: 1.hour) do |request|
|
||||||
|
request.ip if request.path.start_with?("/api/")
|
||||||
|
end
|
||||||
|
|
||||||
|
# Block requests that appear to be malicious
|
||||||
|
blocklist("block malicious requests") do |request|
|
||||||
|
# Block requests with suspicious user agents
|
||||||
|
suspicious_user_agents = [
|
||||||
|
/sqlmap/i,
|
||||||
|
/nmap/i,
|
||||||
|
/nikto/i,
|
||||||
|
/masscan/i
|
||||||
|
]
|
||||||
|
|
||||||
|
user_agent = request.user_agent
|
||||||
|
suspicious_user_agents.any? { |pattern| user_agent =~ pattern } if user_agent
|
||||||
|
end
|
||||||
|
|
||||||
|
# Configure response for throttled requests
|
||||||
|
self.throttled_responder = lambda do |request|
|
||||||
|
[
|
||||||
|
429, # status
|
||||||
|
{
|
||||||
|
"Content-Type" => "application/json",
|
||||||
|
"Retry-After" => "60"
|
||||||
|
},
|
||||||
|
[{ error: "Rate limit exceeded. Try again later." }.to_json]
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Configure response for blocked requests
|
||||||
|
self.blocklisted_responder = lambda do |request|
|
||||||
|
[
|
||||||
|
403, # status
|
||||||
|
{ "Content-Type" => "application/json" },
|
||||||
|
[{ error: "Request blocked." }.to_json]
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
155
config/locales/doorkeeper.en.yml
Normal file
155
config/locales/doorkeeper.en.yml
Normal file
|
@ -0,0 +1,155 @@
|
||||||
|
en:
|
||||||
|
activerecord:
|
||||||
|
attributes:
|
||||||
|
doorkeeper/application:
|
||||||
|
name: 'Name'
|
||||||
|
redirect_uri: 'Redirect URI'
|
||||||
|
errors:
|
||||||
|
models:
|
||||||
|
doorkeeper/application:
|
||||||
|
attributes:
|
||||||
|
redirect_uri:
|
||||||
|
fragment_present: 'cannot contain a fragment.'
|
||||||
|
invalid_uri: 'must be a valid URI.'
|
||||||
|
unspecified_scheme: 'must specify a scheme.'
|
||||||
|
relative_uri: 'must be an absolute URI.'
|
||||||
|
secured_uri: 'must be an HTTPS/SSL URI.'
|
||||||
|
forbidden_uri: 'is forbidden by the server.'
|
||||||
|
scopes:
|
||||||
|
not_match_configured: "doesn't match configured on the server."
|
||||||
|
|
||||||
|
doorkeeper:
|
||||||
|
applications:
|
||||||
|
confirmations:
|
||||||
|
destroy: 'Are you sure?'
|
||||||
|
buttons:
|
||||||
|
edit: 'Edit'
|
||||||
|
destroy: 'Destroy'
|
||||||
|
submit: 'Submit'
|
||||||
|
cancel: 'Cancel'
|
||||||
|
authorize: 'Authorize'
|
||||||
|
form:
|
||||||
|
error: 'Whoops! Check your form for possible errors'
|
||||||
|
help:
|
||||||
|
confidential: 'Application will be used where the client secret can be kept confidential. Native mobile apps and Single Page Apps are considered non-confidential.'
|
||||||
|
redirect_uri: 'Use one line per URI'
|
||||||
|
blank_redirect_uri: "Leave it blank if you configured your provider to use Client Credentials, Resource Owner Password Credentials or any other grant type that doesn't require redirect URI."
|
||||||
|
scopes: 'Separate scopes with spaces. Leave blank to use the default scopes.'
|
||||||
|
edit:
|
||||||
|
title: 'Edit application'
|
||||||
|
index:
|
||||||
|
title: 'Your applications'
|
||||||
|
new: 'New Application'
|
||||||
|
name: 'Name'
|
||||||
|
callback_url: 'Callback URL'
|
||||||
|
confidential: 'Confidential?'
|
||||||
|
actions: 'Actions'
|
||||||
|
confidentiality:
|
||||||
|
'yes': 'Yes'
|
||||||
|
'no': 'No'
|
||||||
|
new:
|
||||||
|
title: 'New Application'
|
||||||
|
show:
|
||||||
|
title: 'Application: %{name}'
|
||||||
|
application_id: 'UID'
|
||||||
|
secret: 'Secret'
|
||||||
|
secret_hashed: 'Secret hashed'
|
||||||
|
scopes: 'Scopes'
|
||||||
|
confidential: 'Confidential'
|
||||||
|
callback_urls: 'Callback urls'
|
||||||
|
actions: 'Actions'
|
||||||
|
not_defined: 'Not defined'
|
||||||
|
|
||||||
|
authorizations:
|
||||||
|
buttons:
|
||||||
|
authorize: 'Authorize'
|
||||||
|
deny: 'Deny'
|
||||||
|
error:
|
||||||
|
title: 'An error has occurred'
|
||||||
|
new:
|
||||||
|
title: 'Authorization required'
|
||||||
|
prompt: 'Authorize %{client_name} to use your account?'
|
||||||
|
able_to: 'This application will be able to'
|
||||||
|
show:
|
||||||
|
title: 'Authorization code'
|
||||||
|
form_post:
|
||||||
|
title: 'Submit this form'
|
||||||
|
|
||||||
|
authorized_applications:
|
||||||
|
confirmations:
|
||||||
|
revoke: 'Are you sure?'
|
||||||
|
buttons:
|
||||||
|
revoke: 'Revoke'
|
||||||
|
index:
|
||||||
|
title: 'Your authorized applications'
|
||||||
|
application: 'Application'
|
||||||
|
created_at: 'Created At'
|
||||||
|
date_format: '%Y-%m-%d %H:%M:%S'
|
||||||
|
|
||||||
|
pre_authorization:
|
||||||
|
status: 'Pre-authorization'
|
||||||
|
|
||||||
|
errors:
|
||||||
|
messages:
|
||||||
|
# Common error messages
|
||||||
|
invalid_request:
|
||||||
|
unknown: 'The request is missing a required parameter, includes an unsupported parameter value, or is otherwise malformed.'
|
||||||
|
missing_param: 'Missing required parameter: %{value}.'
|
||||||
|
request_not_authorized: 'Request need to be authorized. Required parameter for authorizing request is missing or invalid.'
|
||||||
|
invalid_code_challenge: 'Code challenge is required.'
|
||||||
|
invalid_redirect_uri: "The requested redirect uri is malformed or doesn't match client redirect URI."
|
||||||
|
unauthorized_client: 'The client is not authorized to perform this request using this method.'
|
||||||
|
access_denied: 'The resource owner or authorization server denied the request.'
|
||||||
|
invalid_scope: 'The requested scope is invalid, unknown, or malformed.'
|
||||||
|
invalid_code_challenge_method:
|
||||||
|
zero: 'The authorization server does not support PKCE as there are no accepted code_challenge_method values.'
|
||||||
|
one: 'The code_challenge_method must be %{challenge_methods}.'
|
||||||
|
other: 'The code_challenge_method must be one of %{challenge_methods}.'
|
||||||
|
server_error: 'The authorization server encountered an unexpected condition which prevented it from fulfilling the request.'
|
||||||
|
temporarily_unavailable: 'The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.'
|
||||||
|
|
||||||
|
# Configuration error messages
|
||||||
|
credential_flow_not_configured: 'Resource Owner Password Credentials flow failed due to Doorkeeper.configure.resource_owner_from_credentials being unconfigured.'
|
||||||
|
resource_owner_authenticator_not_configured: 'Resource Owner find failed due to Doorkeeper.configure.resource_owner_authenticator being unconfigured.'
|
||||||
|
admin_authenticator_not_configured: 'Access to admin panel is forbidden due to Doorkeeper.configure.admin_authenticator being unconfigured.'
|
||||||
|
|
||||||
|
# Access grant errors
|
||||||
|
unsupported_response_type: 'The authorization server does not support this response type.'
|
||||||
|
unsupported_response_mode: 'The authorization server does not support this response mode.'
|
||||||
|
|
||||||
|
# Access token errors
|
||||||
|
invalid_client: 'Client authentication failed due to unknown client, no client authentication included, or unsupported authentication method.'
|
||||||
|
invalid_grant: 'The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.'
|
||||||
|
unsupported_grant_type: 'The authorization grant type is not supported by the authorization server.'
|
||||||
|
|
||||||
|
invalid_token:
|
||||||
|
revoked: "The access token was revoked"
|
||||||
|
expired: "The access token expired"
|
||||||
|
unknown: "The access token is invalid"
|
||||||
|
revoke:
|
||||||
|
unauthorized: "You are not authorized to revoke this token"
|
||||||
|
|
||||||
|
forbidden_token:
|
||||||
|
missing_scope: 'Access to this resource requires scope "%{oauth_scopes}".'
|
||||||
|
|
||||||
|
flash:
|
||||||
|
applications:
|
||||||
|
create:
|
||||||
|
notice: 'Application created.'
|
||||||
|
destroy:
|
||||||
|
notice: 'Application deleted.'
|
||||||
|
update:
|
||||||
|
notice: 'Application updated.'
|
||||||
|
authorized_applications:
|
||||||
|
destroy:
|
||||||
|
notice: 'Application revoked.'
|
||||||
|
|
||||||
|
layouts:
|
||||||
|
admin:
|
||||||
|
title: 'Doorkeeper'
|
||||||
|
nav:
|
||||||
|
oauth2_provider: 'OAuth2 Provider'
|
||||||
|
applications: 'Applications'
|
||||||
|
home: 'Home'
|
||||||
|
application:
|
||||||
|
title: 'OAuth authorization required'
|
|
@ -2,6 +2,7 @@ require "sidekiq/web"
|
||||||
require "sidekiq/cron/web"
|
require "sidekiq/cron/web"
|
||||||
|
|
||||||
Rails.application.routes.draw do
|
Rails.application.routes.draw do
|
||||||
|
use_doorkeeper
|
||||||
# MFA routes
|
# MFA routes
|
||||||
resource :mfa, controller: "mfa", only: [ :new, :create ] do
|
resource :mfa, controller: "mfa", only: [ :new, :create ] do
|
||||||
get :verify
|
get :verify
|
||||||
|
@ -180,6 +181,8 @@ Rails.application.routes.draw do
|
||||||
get :accept, on: :member
|
get :accept, on: :member
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
resources :currencies, only: %i[show]
|
resources :currencies, only: %i[show]
|
||||||
|
|
||||||
resources :impersonation_sessions, only: [ :create ] do
|
resources :impersonation_sessions, only: [ :create ] do
|
||||||
|
|
99
db/migrate/20250612150749_create_doorkeeper_tables.rb
Normal file
99
db/migrate/20250612150749_create_doorkeeper_tables.rb
Normal file
|
@ -0,0 +1,99 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
class CreateDoorkeeperTables < ActiveRecord::Migration[7.2]
|
||||||
|
def change
|
||||||
|
create_table :oauth_applications do |t|
|
||||||
|
t.string :name, null: false
|
||||||
|
t.string :uid, null: false
|
||||||
|
# Remove `null: false` or use conditional constraint if you are planning to use public clients.
|
||||||
|
t.string :secret, null: false
|
||||||
|
|
||||||
|
# Remove `null: false` if you are planning to use grant flows
|
||||||
|
# that doesn't require redirect URI to be used during authorization
|
||||||
|
# like Client Credentials flow or Resource Owner Password.
|
||||||
|
t.text :redirect_uri, null: false
|
||||||
|
t.string :scopes, null: false, default: ''
|
||||||
|
t.boolean :confidential, null: false, default: true
|
||||||
|
t.timestamps null: false
|
||||||
|
end
|
||||||
|
|
||||||
|
add_index :oauth_applications, :uid, unique: true
|
||||||
|
|
||||||
|
create_table :oauth_access_grants do |t|
|
||||||
|
t.references :resource_owner, null: false
|
||||||
|
t.references :application, null: false
|
||||||
|
t.string :token, null: false
|
||||||
|
t.integer :expires_in, null: false
|
||||||
|
t.text :redirect_uri, null: false
|
||||||
|
t.string :scopes, null: false, default: ''
|
||||||
|
t.datetime :created_at, null: false
|
||||||
|
t.datetime :revoked_at
|
||||||
|
end
|
||||||
|
|
||||||
|
add_index :oauth_access_grants, :token, unique: true
|
||||||
|
add_foreign_key(
|
||||||
|
:oauth_access_grants,
|
||||||
|
:oauth_applications,
|
||||||
|
column: :application_id
|
||||||
|
)
|
||||||
|
|
||||||
|
create_table :oauth_access_tokens do |t|
|
||||||
|
t.references :resource_owner, index: true
|
||||||
|
|
||||||
|
# Remove `null: false` if you are planning to use Password
|
||||||
|
# Credentials Grant flow that doesn't require an application.
|
||||||
|
t.references :application, null: false
|
||||||
|
|
||||||
|
# If you use a custom token generator you may need to change this column
|
||||||
|
# from string to text, so that it accepts tokens larger than 255
|
||||||
|
# characters. More info on custom token generators in:
|
||||||
|
# https://github.com/doorkeeper-gem/doorkeeper/tree/v3.0.0.rc1#custom-access-token-generator
|
||||||
|
#
|
||||||
|
# t.text :token, null: false
|
||||||
|
t.string :token, null: false
|
||||||
|
|
||||||
|
t.string :refresh_token
|
||||||
|
t.integer :expires_in
|
||||||
|
t.string :scopes
|
||||||
|
t.datetime :created_at, null: false
|
||||||
|
t.datetime :revoked_at
|
||||||
|
|
||||||
|
# The authorization server MAY issue a new refresh token, in which case
|
||||||
|
# *the client MUST discard the old refresh token* and replace it with the
|
||||||
|
# new refresh token. The authorization server MAY revoke the old
|
||||||
|
# refresh token after issuing a new refresh token to the client.
|
||||||
|
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-6
|
||||||
|
#
|
||||||
|
# Doorkeeper implementation: if there is a `previous_refresh_token` column,
|
||||||
|
# refresh tokens will be revoked after a related access token is used.
|
||||||
|
# If there is no `previous_refresh_token` column, previous tokens are
|
||||||
|
# revoked as soon as a new access token is created.
|
||||||
|
#
|
||||||
|
# Comment out this line if you want refresh tokens to be instantly
|
||||||
|
# revoked after use.
|
||||||
|
t.string :previous_refresh_token, null: false, default: ""
|
||||||
|
end
|
||||||
|
|
||||||
|
add_index :oauth_access_tokens, :token, unique: true
|
||||||
|
|
||||||
|
# See https://github.com/doorkeeper-gem/doorkeeper/issues/1592
|
||||||
|
if ActiveRecord::Base.connection.adapter_name == "SQLServer"
|
||||||
|
execute <<~SQL.squish
|
||||||
|
CREATE UNIQUE NONCLUSTERED INDEX index_oauth_access_tokens_on_refresh_token ON oauth_access_tokens(refresh_token)
|
||||||
|
WHERE refresh_token IS NOT NULL
|
||||||
|
SQL
|
||||||
|
else
|
||||||
|
add_index :oauth_access_tokens, :refresh_token, unique: true
|
||||||
|
end
|
||||||
|
|
||||||
|
add_foreign_key(
|
||||||
|
:oauth_access_tokens,
|
||||||
|
:oauth_applications,
|
||||||
|
column: :application_id
|
||||||
|
)
|
||||||
|
|
||||||
|
# Uncomment below to ensure a valid reference to the resource owner's table
|
||||||
|
# add_foreign_key :oauth_access_grants, <model>, column: :resource_owner_id
|
||||||
|
# add_foreign_key :oauth_access_tokens, <model>, column: :resource_owner_id
|
||||||
|
end
|
||||||
|
end
|
57
db/schema.rb
generated
57
db/schema.rb
generated
|
@ -10,7 +10,7 @@
|
||||||
#
|
#
|
||||||
# It's strongly recommended that you check this file into your version control system.
|
# It's strongly recommended that you check this file into your version control system.
|
||||||
|
|
||||||
ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
ActiveRecord::Schema[7.2].define(version: 2025_06_12_150749) do
|
||||||
# These are extensions that must be enabled in order to support this database
|
# These are extensions that must be enabled in order to support this database
|
||||||
enable_extension "pgcrypto"
|
enable_extension "pgcrypto"
|
||||||
enable_extension "plpgsql"
|
enable_extension "plpgsql"
|
||||||
|
@ -30,7 +30,7 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.decimal "balance", precision: 19, scale: 4
|
t.decimal "balance", precision: 19, scale: 4
|
||||||
t.string "currency"
|
t.string "currency"
|
||||||
t.boolean "is_active", default: true, null: false
|
t.boolean "is_active", default: true, null: false
|
||||||
t.virtual "classification", type: :string, as: "\nCASE\n WHEN ((accountable_type)::text = ANY ((ARRAY['Loan'::character varying, 'CreditCard'::character varying, 'OtherLiability'::character varying])::text[])) THEN 'liability'::text\n ELSE 'asset'::text\nEND", stored: true
|
t.virtual "classification", type: :string, as: "\nCASE\n WHEN ((accountable_type)::text = ANY (ARRAY[('Loan'::character varying)::text, ('CreditCard'::character varying)::text, ('OtherLiability'::character varying)::text])) THEN 'liability'::text\n ELSE 'asset'::text\nEND", stored: true
|
||||||
t.uuid "import_id"
|
t.uuid "import_id"
|
||||||
t.uuid "plaid_account_id"
|
t.uuid "plaid_account_id"
|
||||||
t.boolean "scheduled_for_deletion", default: false
|
t.boolean "scheduled_for_deletion", default: false
|
||||||
|
@ -199,7 +199,12 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.boolean "excluded", default: false
|
t.boolean "excluded", default: false
|
||||||
t.string "plaid_id"
|
t.string "plaid_id"
|
||||||
t.jsonb "locked_attributes", default: {}
|
t.jsonb "locked_attributes", default: {}
|
||||||
|
t.index ["account_id", "date"], name: "index_entries_on_account_id_and_date"
|
||||||
t.index ["account_id"], name: "index_entries_on_account_id"
|
t.index ["account_id"], name: "index_entries_on_account_id"
|
||||||
|
t.index ["amount"], name: "index_entries_on_amount"
|
||||||
|
t.index ["date"], name: "index_entries_on_date"
|
||||||
|
t.index ["entryable_id", "entryable_type"], name: "index_entries_on_entryable"
|
||||||
|
t.index ["excluded"], name: "index_entries_on_excluded"
|
||||||
t.index ["import_id"], name: "index_entries_on_import_id"
|
t.index ["import_id"], name: "index_entries_on_import_id"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -210,6 +215,7 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.date "date", null: false
|
t.date "date", null: false
|
||||||
t.datetime "created_at", null: false
|
t.datetime "created_at", null: false
|
||||||
t.datetime "updated_at", null: false
|
t.datetime "updated_at", null: false
|
||||||
|
t.index ["date", "from_currency", "to_currency"], name: "index_exchange_rates_on_date_and_currencies"
|
||||||
t.index ["from_currency", "to_currency", "date"], name: "index_exchange_rates_on_base_converted_date_unique", unique: true
|
t.index ["from_currency", "to_currency", "date"], name: "index_exchange_rates_on_base_converted_date_unique", unique: true
|
||||||
t.index ["from_currency"], name: "index_exchange_rates_on_from_currency"
|
t.index ["from_currency"], name: "index_exchange_rates_on_from_currency"
|
||||||
t.index ["to_currency"], name: "index_exchange_rates_on_to_currency"
|
t.index ["to_currency"], name: "index_exchange_rates_on_to_currency"
|
||||||
|
@ -228,8 +234,6 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.boolean "data_enrichment_enabled", default: false
|
t.boolean "data_enrichment_enabled", default: false
|
||||||
t.boolean "early_access", default: false
|
t.boolean "early_access", default: false
|
||||||
t.boolean "auto_sync_on_login", default: true, null: false
|
t.boolean "auto_sync_on_login", default: true, null: false
|
||||||
t.datetime "latest_sync_activity_at", default: -> { "CURRENT_TIMESTAMP" }
|
|
||||||
t.datetime "latest_sync_completed_at", default: -> { "CURRENT_TIMESTAMP" }
|
|
||||||
end
|
end
|
||||||
|
|
||||||
create_table "holdings", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
|
create_table "holdings", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
|
||||||
|
@ -408,6 +412,48 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.index ["chat_id"], name: "index_messages_on_chat_id"
|
t.index ["chat_id"], name: "index_messages_on_chat_id"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
create_table "oauth_access_grants", force: :cascade do |t|
|
||||||
|
t.bigint "resource_owner_id", null: false
|
||||||
|
t.bigint "application_id", null: false
|
||||||
|
t.string "token", null: false
|
||||||
|
t.integer "expires_in", null: false
|
||||||
|
t.text "redirect_uri", null: false
|
||||||
|
t.string "scopes", default: "", null: false
|
||||||
|
t.datetime "created_at", null: false
|
||||||
|
t.datetime "revoked_at"
|
||||||
|
t.index ["application_id"], name: "index_oauth_access_grants_on_application_id"
|
||||||
|
t.index ["resource_owner_id"], name: "index_oauth_access_grants_on_resource_owner_id"
|
||||||
|
t.index ["token"], name: "index_oauth_access_grants_on_token", unique: true
|
||||||
|
end
|
||||||
|
|
||||||
|
create_table "oauth_access_tokens", force: :cascade do |t|
|
||||||
|
t.bigint "resource_owner_id"
|
||||||
|
t.bigint "application_id", null: false
|
||||||
|
t.string "token", null: false
|
||||||
|
t.string "refresh_token"
|
||||||
|
t.integer "expires_in"
|
||||||
|
t.string "scopes"
|
||||||
|
t.datetime "created_at", null: false
|
||||||
|
t.datetime "revoked_at"
|
||||||
|
t.string "previous_refresh_token", default: "", null: false
|
||||||
|
t.index ["application_id"], name: "index_oauth_access_tokens_on_application_id"
|
||||||
|
t.index ["refresh_token"], name: "index_oauth_access_tokens_on_refresh_token", unique: true
|
||||||
|
t.index ["resource_owner_id"], name: "index_oauth_access_tokens_on_resource_owner_id"
|
||||||
|
t.index ["token"], name: "index_oauth_access_tokens_on_token", unique: true
|
||||||
|
end
|
||||||
|
|
||||||
|
create_table "oauth_applications", force: :cascade do |t|
|
||||||
|
t.string "name", null: false
|
||||||
|
t.string "uid", null: false
|
||||||
|
t.string "secret", null: false
|
||||||
|
t.text "redirect_uri", null: false
|
||||||
|
t.string "scopes", default: "", null: false
|
||||||
|
t.boolean "confidential", default: true, null: false
|
||||||
|
t.datetime "created_at", null: false
|
||||||
|
t.datetime "updated_at", null: false
|
||||||
|
t.index ["uid"], name: "index_oauth_applications_on_uid", unique: true
|
||||||
|
end
|
||||||
|
|
||||||
create_table "other_assets", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
|
create_table "other_assets", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
|
||||||
t.datetime "created_at", null: false
|
t.datetime "created_at", null: false
|
||||||
t.datetime "updated_at", null: false
|
t.datetime "updated_at", null: false
|
||||||
|
@ -606,6 +652,7 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
t.datetime "created_at", null: false
|
t.datetime "created_at", null: false
|
||||||
t.datetime "updated_at", null: false
|
t.datetime "updated_at", null: false
|
||||||
t.index ["tag_id"], name: "index_taggings_on_tag_id"
|
t.index ["tag_id"], name: "index_taggings_on_tag_id"
|
||||||
|
t.index ["taggable_id", "taggable_type"], name: "index_taggings_on_taggable_id_and_type"
|
||||||
t.index ["taggable_type", "taggable_id"], name: "index_taggings_on_taggable"
|
t.index ["taggable_type", "taggable_id"], name: "index_taggings_on_taggable"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -737,6 +784,8 @@ ActiveRecord::Schema[7.2].define(version: 2025_06_10_181219) do
|
||||||
add_foreign_key "invitations", "users", column: "inviter_id"
|
add_foreign_key "invitations", "users", column: "inviter_id"
|
||||||
add_foreign_key "merchants", "families"
|
add_foreign_key "merchants", "families"
|
||||||
add_foreign_key "messages", "chats"
|
add_foreign_key "messages", "chats"
|
||||||
|
add_foreign_key "oauth_access_grants", "oauth_applications", column: "application_id"
|
||||||
|
add_foreign_key "oauth_access_tokens", "oauth_applications", column: "application_id"
|
||||||
add_foreign_key "plaid_accounts", "plaid_items"
|
add_foreign_key "plaid_accounts", "plaid_items"
|
||||||
add_foreign_key "plaid_items", "families"
|
add_foreign_key "plaid_items", "families"
|
||||||
add_foreign_key "rejected_transfers", "transactions", column: "inflow_transaction_id"
|
add_foreign_key "rejected_transfers", "transactions", column: "inflow_transaction_id"
|
||||||
|
|
49
test/integration/oauth_basic_test.rb
Normal file
49
test/integration/oauth_basic_test.rb
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class OauthBasicTest < ActionDispatch::IntegrationTest
|
||||||
|
test "oauth authorization endpoint requires authentication" do
|
||||||
|
oauth_app = Doorkeeper::Application.create!(
|
||||||
|
name: "Test API Client",
|
||||||
|
redirect_uri: "https://client.example.com/callback",
|
||||||
|
scopes: "read_accounts"
|
||||||
|
)
|
||||||
|
|
||||||
|
get "/oauth/authorize?client_id=#{oauth_app.uid}&redirect_uri=#{CGI.escape(oauth_app.redirect_uri)}&response_type=code&scope=read_accounts"
|
||||||
|
|
||||||
|
# Should redirect to login page when not authenticated
|
||||||
|
assert_redirected_to new_session_path
|
||||||
|
end
|
||||||
|
|
||||||
|
test "oauth token endpoint exists and handles requests" do
|
||||||
|
post "/oauth/token", params: {
|
||||||
|
grant_type: "authorization_code",
|
||||||
|
code: "invalid_code",
|
||||||
|
redirect_uri: "https://example.com/callback",
|
||||||
|
client_id: "invalid_client"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Should return 401 for invalid client (correct OAuth behavior)
|
||||||
|
assert_response :unauthorized
|
||||||
|
response_body = JSON.parse(response.body)
|
||||||
|
assert_equal "invalid_client", response_body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "oauth applications can be created" do
|
||||||
|
assert_difference("Doorkeeper::Application.count") do
|
||||||
|
Doorkeeper::Application.create!(
|
||||||
|
name: "Test App",
|
||||||
|
redirect_uri: "https://example.com/callback",
|
||||||
|
scopes: "read_accounts"
|
||||||
|
)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "doorkeeper configuration is properly set up" do
|
||||||
|
# Test that Doorkeeper is configured and working
|
||||||
|
assert Doorkeeper.configuration.present?, "Doorkeeper configuration should exist"
|
||||||
|
assert_equal 1.year, Doorkeeper.configuration.access_token_expires_in
|
||||||
|
assert_equal "read_accounts", Doorkeeper.configuration.default_scopes.first.to_s
|
||||||
|
end
|
||||||
|
end
|
23
test/integration/rack_attack_test.rb
Normal file
23
test/integration/rack_attack_test.rb
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class RackAttackTest < ActionDispatch::IntegrationTest
|
||||||
|
test "rack attack is configured" do
|
||||||
|
# Verify Rack::Attack is enabled in middleware stack
|
||||||
|
middleware_classes = Rails.application.middleware.map(&:klass)
|
||||||
|
assert_includes middleware_classes, Rack::Attack, "Rack::Attack should be in middleware stack"
|
||||||
|
end
|
||||||
|
|
||||||
|
test "oauth token endpoint has rate limiting configured" do
|
||||||
|
# Test that the throttle is configured (we don't need to trigger it)
|
||||||
|
throttles = Rack::Attack.throttles.keys
|
||||||
|
assert_includes throttles, "oauth/token", "OAuth token endpoint should have rate limiting"
|
||||||
|
end
|
||||||
|
|
||||||
|
test "api requests have rate limiting configured" do
|
||||||
|
# Test that API rate limiting is configured
|
||||||
|
throttles = Rack::Attack.throttles.keys
|
||||||
|
assert_includes throttles, "api/requests", "API requests should have rate limiting"
|
||||||
|
end
|
||||||
|
end
|
Loading…
Add table
Add a link
Reference in a new issue