forked from OpenNeo/impress
Emi Matchu
e2d763e3c3
Ahh okay, the NeoPass spec says to pass the `client_id` and `client_secret` as POST form data when exchanging the code for the access token, but the default behavior of our client is to pass it as an `Authorization` header instead. In this change, we set an option to change that behavior, and also add a lot of comments about this and the other options!
372 lines
18 KiB
Ruby
372 lines
18 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# Assuming you have not yet modified this file, each configuration option below
|
|
# is set to its default value. Note that some are commented out while others
|
|
# are not: uncommented lines are intended to protect your configuration from
|
|
# breaking changes in upgrades (i.e., in the event that future versions of
|
|
# Devise change the default values for those options).
|
|
#
|
|
# Use this hook to configure devise mailer, warden hooks and so forth.
|
|
# Many of these configuration options can be set straight in your model.
|
|
Devise.setup do |config|
|
|
# The secret key used by Devise. Devise uses this key to generate
|
|
# random tokens. Changing this key will render invalid all existing
|
|
# confirmation, reset password and unlock tokens in the database.
|
|
# Devise will use the `secret_key_base` as its `secret_key`
|
|
# by default. You can change it below and use your own secret key.
|
|
# config.secret_key = '7b36608c10cf3a8d38525a5156792c538b81587fee5c166d5a767f9c0c811ece063655cbbf58ce125643ef15c19e7cda01b46a37a9f85ecac3fb6825891a798b'
|
|
|
|
# ==> Controller configuration
|
|
# Configure the parent class to the devise controllers.
|
|
# config.parent_controller = 'DeviseController'
|
|
|
|
# ==> Mailer Configuration
|
|
# Configure the e-mail address which will be shown in Devise::Mailer,
|
|
# note that it will be overwritten if you use your own mailer class
|
|
# with default "from" parameter.
|
|
config.mailer_sender = 'matchu@openneo.net'
|
|
|
|
# Configure the class responsible to send e-mails.
|
|
# config.mailer = 'Devise::Mailer'
|
|
|
|
# Configure the parent class responsible to send e-mails.
|
|
# config.parent_mailer = 'ActionMailer::Base'
|
|
|
|
# ==> ORM configuration
|
|
# Load and configure the ORM. Supports :active_record (default) and
|
|
# :mongoid (bson_ext recommended) by default. Other ORMs may be
|
|
# available as additional gems.
|
|
require 'devise/orm/active_record'
|
|
|
|
# ==> Configuration for any authentication mechanism
|
|
# Configure which keys are used when authenticating a user. The default is
|
|
# just :email. You can configure it to use [:username, :subdomain], so for
|
|
# authenticating a user, both parameters are required. Remember that those
|
|
# parameters are used only when authenticating and not when retrieving from
|
|
# session. If you need permissions, you should implement that in a before filter.
|
|
# You can also supply a hash where the value is a boolean determining whether
|
|
# or not authentication should be aborted when the value is not present.
|
|
config.authentication_keys = [:name]
|
|
|
|
# Configure parameters from the request object used for authentication. Each entry
|
|
# given should be a request method and it will automatically be passed to the
|
|
# find_for_authentication method and considered in your model lookup. For instance,
|
|
# if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
|
|
# The same considerations mentioned for authentication_keys also apply to request_keys.
|
|
# config.request_keys = []
|
|
|
|
# Configure which authentication keys should be case-insensitive.
|
|
# These keys will be downcased upon creating or modifying a user and when used
|
|
# to authenticate or find a user. Default is :email.
|
|
config.case_insensitive_keys = [:name]
|
|
|
|
# Configure which authentication keys should have whitespace stripped.
|
|
# These keys will have whitespace before and after removed upon creating or
|
|
# modifying a user and when used to authenticate or find a user. Default is :email.
|
|
config.strip_whitespace_keys = [:name]
|
|
|
|
# Tell if authentication through request.params is enabled. True by default.
|
|
# It can be set to an array that will enable params authentication only for the
|
|
# given strategies, for example, `config.params_authenticatable = [:database]` will
|
|
# enable it only for database (email + password) authentication.
|
|
# config.params_authenticatable = true
|
|
|
|
# Tell if authentication through HTTP Auth is enabled. False by default.
|
|
# It can be set to an array that will enable http authentication only for the
|
|
# given strategies, for example, `config.http_authenticatable = [:database]` will
|
|
# enable it only for database authentication.
|
|
# For API-only applications to support authentication "out-of-the-box", you will likely want to
|
|
# enable this with :database unless you are using a custom strategy.
|
|
# The supported strategies are:
|
|
# :database = Support basic authentication with authentication key + password
|
|
# config.http_authenticatable = false
|
|
|
|
# If 401 status code should be returned for AJAX requests. True by default.
|
|
# config.http_authenticatable_on_xhr = true
|
|
|
|
# The realm used in Http Basic Authentication. 'Application' by default.
|
|
# config.http_authentication_realm = 'Application'
|
|
|
|
# It will change confirmation, password recovery and other workflows
|
|
# to behave the same regardless if the e-mail provided was right or wrong.
|
|
# Does not affect registerable.
|
|
# config.paranoid = true
|
|
|
|
# By default Devise will store the user in session. You can skip storage for
|
|
# particular strategies by setting this option.
|
|
# Notice that if you are skipping storage for all authentication paths, you
|
|
# may want to disable generating routes to Devise's sessions controller by
|
|
# passing skip: :sessions to `devise_for` in your config/routes.rb
|
|
config.skip_session_storage = [:http_auth]
|
|
|
|
# By default, Devise cleans up the CSRF token on authentication to
|
|
# avoid CSRF token fixation attacks. This means that, when using AJAX
|
|
# requests for sign in and sign up, you need to get a new CSRF token
|
|
# from the server. You can disable this option at your own risk.
|
|
# config.clean_up_csrf_token_on_authentication = true
|
|
|
|
# When false, Devise will not attempt to reload routes on eager load.
|
|
# This can reduce the time taken to boot the app but if your application
|
|
# requires the Devise mappings to be loaded during boot time the application
|
|
# won't boot properly.
|
|
# config.reload_routes = true
|
|
|
|
# ==> Configuration for :database_authenticatable
|
|
# For bcrypt, this is the cost for hashing the password and defaults to 12. If
|
|
# using other algorithms, it sets how many times you want the password to be hashed.
|
|
# The number of stretches used for generating the hashed password are stored
|
|
# with the hashed password. This allows you to change the stretches without
|
|
# invalidating existing passwords.
|
|
#
|
|
# Limiting the stretches to just one in testing will increase the performance of
|
|
# your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
|
|
# a value less than 10 in other environments. Note that, for bcrypt (the default
|
|
# algorithm), the cost increases exponentially with the number of stretches (e.g.
|
|
# a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
|
|
# NOTE: This value is unused with our custom HmacSha256 encryptor.
|
|
config.stretches = Rails.env.test? ? 1 : 12
|
|
|
|
# Set up a pepper to generate the hashed password.
|
|
# config.pepper = 'd05e1a10eb22387de6a48784ec214daa6c69b482836e1a833028de28c8833e7f3ba529b8a341a0b0b6f467c0fdd193b74031316affc58ca752405a02b9e3da69'
|
|
|
|
# Send a notification to the original email when the user's email is changed.
|
|
# config.send_email_changed_notification = false
|
|
|
|
# Send a notification email when the user's password is changed.
|
|
# config.send_password_change_notification = false
|
|
|
|
# ==> Configuration for :confirmable
|
|
# A period that the user is allowed to access the website even without
|
|
# confirming their account. For instance, if set to 2.days, the user will be
|
|
# able to access the website for two days without confirming their account,
|
|
# access will be blocked just in the third day.
|
|
# You can also set it to nil, which will allow the user to access the website
|
|
# without confirming their account.
|
|
# Default is 0.days, meaning the user cannot access the website without
|
|
# confirming their account.
|
|
# config.allow_unconfirmed_access_for = 2.days
|
|
|
|
# A period that the user is allowed to confirm their account before their
|
|
# token becomes invalid. For example, if set to 3.days, the user can confirm
|
|
# their account within 3 days after the mail was sent, but on the fourth day
|
|
# their account can't be confirmed with the token any more.
|
|
# Default is nil, meaning there is no restriction on how long a user can take
|
|
# before confirming their account.
|
|
# config.confirm_within = 3.days
|
|
|
|
# If true, requires any email changes to be confirmed (exactly the same way as
|
|
# initial account confirmation) to be applied. Requires additional unconfirmed_email
|
|
# db field (see migrations). Until confirmed, new email is stored in
|
|
# unconfirmed_email column, and copied to email column on successful confirmation.
|
|
config.reconfirmable = true
|
|
|
|
# Defines which key will be used when confirming an account
|
|
# config.confirmation_keys = [:email]
|
|
|
|
# ==> Configuration for :rememberable
|
|
# The time the user will be remembered without asking for credentials again.
|
|
# config.remember_for = 2.weeks
|
|
|
|
# Invalidates all the remember me tokens when the user signs out.
|
|
config.expire_all_remember_me_on_sign_out = true
|
|
|
|
# If true, extends the user's remember period when remembered via cookie.
|
|
# config.extend_remember_period = false
|
|
|
|
# Options to be passed to the created cookie. For instance, you can set
|
|
# secure: true in order to force SSL only cookies.
|
|
# config.rememberable_options = {}
|
|
|
|
# ==> Configuration for :validatable
|
|
# Range for password length.
|
|
config.password_length = 6..128
|
|
|
|
# Email regex used to validate email formats. It simply asserts that
|
|
# one (and only one) @ exists in the given string. This is mainly
|
|
# to give user feedback and not to assert the e-mail validity.
|
|
config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
|
|
|
|
# ==> Configuration for :timeoutable
|
|
# The time you want to timeout the user session without activity. After this
|
|
# time the user will be asked for credentials again. Default is 30 minutes.
|
|
# config.timeout_in = 30.minutes
|
|
|
|
# ==> Configuration for :lockable
|
|
# Defines which strategy will be used to lock an account.
|
|
# :failed_attempts = Locks an account after a number of failed attempts to sign in.
|
|
# :none = No lock strategy. You should handle locking by yourself.
|
|
# config.lock_strategy = :failed_attempts
|
|
|
|
# Defines which key will be used when locking and unlocking an account
|
|
# config.unlock_keys = [:email]
|
|
|
|
# Defines which strategy will be used to unlock an account.
|
|
# :email = Sends an unlock link to the user email
|
|
# :time = Re-enables login after a certain amount of time (see :unlock_in below)
|
|
# :both = Enables both strategies
|
|
# :none = No unlock strategy. You should handle unlocking by yourself.
|
|
# config.unlock_strategy = :both
|
|
|
|
# Number of authentication tries before locking an account if lock_strategy
|
|
# is failed attempts.
|
|
# config.maximum_attempts = 20
|
|
|
|
# Time interval to unlock the account if :time is enabled as unlock_strategy.
|
|
# config.unlock_in = 1.hour
|
|
|
|
# Warn on the last attempt before the account is locked.
|
|
# config.last_attempt_warning = true
|
|
|
|
# ==> Configuration for :recoverable
|
|
#
|
|
# Defines which key will be used when recovering the password for an account
|
|
# config.reset_password_keys = [:email]
|
|
|
|
# Time interval you can reset your password with a reset password key.
|
|
# Don't put a too small interval or your users won't have the time to
|
|
# change their passwords.
|
|
config.reset_password_within = 6.hours
|
|
|
|
# When set to false, does not sign a user in automatically after their password is
|
|
# reset. Defaults to true, so a user is signed in automatically after a reset.
|
|
# config.sign_in_after_reset_password = true
|
|
|
|
# ==> Configuration for :encryptable
|
|
# Allow you to use another hashing or encryption algorithm besides bcrypt (default).
|
|
# You can use :sha1, :sha512 or algorithms from others authentication tools as
|
|
# :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
|
|
# for default behavior) and :restful_authentication_sha1 (then you should set
|
|
# stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
|
|
#
|
|
# Require the `devise-encryptable` gem when using anything other than bcrypt
|
|
# NOTE: Our encryptor is included at the bottom of this file! It's cute and small.
|
|
config.encryptor = :hmac_sha256
|
|
|
|
# ==> Scopes configuration
|
|
# Turn scoped views on. Before rendering "sessions/new", it will first check for
|
|
# "users/sessions/new". It's turned off by default because it's slower if you
|
|
# are using only default views.
|
|
# config.scoped_views = false
|
|
|
|
# Configure the default scope given to Warden. By default it's the first
|
|
# devise role declared in your routes (usually :user).
|
|
# config.default_scope = :user
|
|
|
|
# Set this configuration to false if you want /users/sign_out to sign out
|
|
# only the current scope. By default, Devise signs out all scopes.
|
|
# config.sign_out_all_scopes = true
|
|
|
|
# ==> Navigation configuration
|
|
# Lists the formats that should be treated as navigational. Formats like
|
|
# :html should redirect to the sign in page when the user does not have
|
|
# access, but formats like :xml or :json, should return 401.
|
|
#
|
|
# If you have any extra navigational formats, like :iphone or :mobile, you
|
|
# should add them to the navigational formats lists.
|
|
#
|
|
# The "*/*" below is required to match Internet Explorer requests.
|
|
# config.navigational_formats = ['*/*', :html, :turbo_stream]
|
|
|
|
# The default HTTP method used to sign out a resource. Default is :delete.
|
|
config.sign_out_via = :delete
|
|
|
|
# ==> OmniAuth
|
|
# Add a new OmniAuth provider. Check the wiki for more information on setting
|
|
# up on your models and hooks.
|
|
config.omniauth :openid_connect, {
|
|
name: :neopass,
|
|
|
|
# We'll request only basic info, and we'll "discover" most of the server's
|
|
# configuration by reading its `/.well-known/openid_configuation` endpoint.
|
|
scope: [:openid, :email],
|
|
response_type: :code,
|
|
issuer: Rails.configuration.neopass_origin,
|
|
discovery: true,
|
|
|
|
# Here's the client info registered with the NeoPass team! They generated
|
|
# a Client ID and a Client Secret for us; and we provided them with a
|
|
# redirect URL, which must match the one used here, or the initial auth
|
|
# request will be rejected.
|
|
client_options: {
|
|
identifier: "19ea1361-f0b1-48f2-9405-b570c655afd9",
|
|
secret: Rails.application.credentials.dig(:neopass, :client_secret),
|
|
redirect_uri: Rails.configuration.neopass_redirect_uri,
|
|
},
|
|
|
|
# Specify that the client ID and secret should be passed as POST form data,
|
|
# rather than the default of an `Authorization` header. This is necessary
|
|
# to match the NeoPass specification; if we use the header instead, it will
|
|
# tell us their record of the Dress to Impress client isn't configured to
|
|
# allow this!
|
|
#
|
|
# NOTE: This isn't a documented supported value for `client_auth_method`
|
|
# here. The `omniauth_openid_connect` docs say it must be `:basic` or
|
|
# `:jwks`, but as far as I can tell, the value gets passed to
|
|
# `Rack::OAuth2::Client#access_token!`, which uses an `Authorization`
|
|
# header if the value is `:basic`, or POST form data if the value is
|
|
# anything else. So this option isn't stable, but it works for now!
|
|
client_auth_method: :request_body,
|
|
}
|
|
|
|
# Output OmniAuth debug info to the server logs.
|
|
#
|
|
# TODO: We should perhaps evaluate whether these logs contain sensitive
|
|
# information in production? I wouldn't think so, and it will be useful
|
|
# for debugging NeoPass, but let's keep an eye on that! Consider
|
|
# setting this to only be true in development mode, if we're not
|
|
# actively using it anymore.
|
|
OmniAuth.config.logger = Rails.logger
|
|
|
|
# ==> Warden configuration
|
|
# If you want to use other strategies, that are not supported by Devise, or
|
|
# change the failure app, you can configure them inside the config.warden block.
|
|
#
|
|
# config.warden do |manager|
|
|
# manager.intercept_401 = false
|
|
# manager.default_strategies(scope: :user).unshift :some_external_strategy
|
|
# end
|
|
|
|
# ==> Mountable engine configurations
|
|
# When using Devise inside an engine, let's call it `MyEngine`, and this engine
|
|
# is mountable, there are some extra configurations to be taken into account.
|
|
# The following options are available, assuming the engine is mounted as:
|
|
#
|
|
# mount MyEngine, at: '/my_engine'
|
|
#
|
|
# The router that invoked `devise_for`, in the example above, would be:
|
|
# config.router_name = :my_engine
|
|
#
|
|
# When using OmniAuth, Devise cannot automatically set OmniAuth path,
|
|
# so you need to do it manually. For the users scope, it would be:
|
|
# config.omniauth_path_prefix = '/my_engine/users/auth'
|
|
|
|
# ==> Hotwire/Turbo configuration
|
|
# When using Devise with Hotwire/Turbo, the http status for error responses
|
|
# and some redirects must match the following. The default in Devise for existing
|
|
# apps is `200 OK` and `302 Found respectively`, but new apps are generated with
|
|
# these new defaults that match Hotwire/Turbo behavior.
|
|
# Note: These might become the new default in future versions of Devise.
|
|
config.responder.error_status = :unprocessable_entity
|
|
config.responder.redirect_status = :see_other
|
|
|
|
# ==> Configuration for :registerable
|
|
|
|
# When set to false, does not sign a user in automatically after their password is
|
|
# changed. Defaults to true, so a user is signed in automatically after changing a password.
|
|
# config.sign_in_after_change_password = true
|
|
end
|
|
|
|
require 'openssl'
|
|
module Devise
|
|
module Encryptable
|
|
module Encryptors
|
|
class HmacSha256 < Base
|
|
def self.digest(password, stretches, salt, pepper)
|
|
hmac = OpenSSL::HMAC.new(salt, 'SHA256')
|
|
hmac << password
|
|
hmac.hexdigest
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|