gitlab-org--gitlab-foss/config/initializers/devise.rb

268 lines
12 KiB
Ruby
Raw Normal View History

2011-10-08 17:36:38 -04:00
# Use this hook to configure devise mailer, warden hooks and so forth. The first
# four configuration values can also be set straight in your models.
Devise.setup do |config|
config.warden do |manager|
2015-03-27 20:54:44 -04:00
manager.default_strategies(scope: :user).unshift :two_factor_authenticatable
2015-03-31 15:42:17 -04:00
manager.default_strategies(scope: :user).unshift :two_factor_backupable
end
2011-10-08 17:36:38 -04:00
# ==> Mailer Configuration
# Configure the class responsible to send e-mails.
config.mailer = "DeviseMailer"
2011-10-08 17:36:38 -04:00
# ==> 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.
2017-02-21 18:33:53 -05:00
config.authentication_keys = [:login]
2011-10-08 17:36:38 -04:00
# 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 = [:email, :email_confirmation]
2011-10-08 17:36:38 -04:00
# 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.
2017-02-21 18:33:53 -05:00
config.strip_whitespace_keys = [:email]
2011-10-08 17:36:38 -04:00
# Tell if authentication through request.params is enabled. True by default.
# config.params_authenticatable = true
# Tell if authentication through HTTP Basic Auth is enabled. False by default.
# config.http_authenticatable = false
# If http headers 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"
config.reconfirmable = true
2011-10-08 17:36:38 -04:00
# 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
2011-10-08 17:36:38 -04:00
# ==> Configuration for :database_authenticatable
# For bcrypt, this is the cost for hashing the password and defaults to 10. If
# using other encryptors, it sets how many times you want the password re-encrypted.
#
# 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.
config.stretches = Rails.env.test? ? 1 : 10
# Setup a pepper to generate the encrypted password.
# config.pepper = "2ef62d549c4ff98a5d3e0ba211e72cff592060247e3bbbb9f499af1222f876f53d39b39b823132affb32858168c79c1d7741d26499901b63c6030a42129924ef"
# ==> Configuration for :confirmable
2013-12-01 05:53:00 -05:00
# The time you want to give a user to confirm their account. During this time
# they will be able to access your application without confirming. Default is 0.days
# When allow_unconfirmed_access_for is zero, the user won't be able to sign in without confirming.
2011-10-08 17:36:38 -04:00
# You can use this to let your user access some features of your application
# without confirming the account, but blocking it after a certain period
# (ie 2 days).
# config.allow_unconfirmed_access_for = 2.days
2011-10-08 17:36:38 -04:00
# 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
# If true, a valid remember token can be re-used between multiple browsers.
# config.remember_across_browsers = 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.
2011-10-08 17:36:38 -04:00
# config.cookie_options = {}
# Send a notification email when the user's password is changed
config.send_password_change_notification = true
2011-10-08 17:36:38 -04:00
# ==> Configuration for :validatable
# Range for password length. Default is 6..128.
config.password_length = 8..128
2011-10-08 17:36:38 -04:00
# Email regex used to validate email formats. It simply asserts that
# an 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[^@]+@[^@]+\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.
2012-07-06 03:05:31 -04:00
config.lock_strategy = :failed_attempts
2011-10-08 17:36:38 -04:00
# Defines which key will be used when locking and unlocking an account
2017-02-21 18:33:53 -05:00
config.unlock_keys = [:email]
2011-10-08 17:36:38 -04:00
# 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.
2015-12-14 16:34:46 -05:00
config.unlock_strategy = :both
2011-10-08 17:36:38 -04:00
# Number of authentication tries before locking an account if lock_strategy
# is failed attempts.
2012-07-06 03:05:31 -04:00
config.maximum_attempts = 10
2011-10-08 17:36:38 -04:00
# Time interval to unlock the account if :time is enabled as unlock_strategy.
2012-07-06 03:05:31 -04:00
config.unlock_in = 10.minutes
2011-10-08 17:36:38 -04:00
# ==> 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.
# When someone else invites you to GitLab this time is also used so it should be pretty long.
config.reset_password_within = 2.days
2011-10-08 17:36:38 -04:00
# 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 = false
2011-10-08 17:36:38 -04:00
# ==> Configuration for :encryptable
# Allow you to use another encryption algorithm besides bcrypt (default). You can use
# :sha1, :sha512 or encryptors 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)
# config.encryptor = :sha512
2012-07-06 02:50:24 -04:00
# Authentication through token does not store user in session and needs
2011-10-08 17:36:38 -04:00
# to be supplied on each request. Useful if you are using the token as API token.
2012-07-06 02:50:24 -04:00
config.skip_session_storage << :token_auth
2011-10-08 17:36:38 -04:00
# ==> 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 # now have an :email scope as well, so set the default
2011-10-08 17:36:38 -04:00
# Configure sign_out behavior.
# Sign_out action can be scoped (i.e. /users/sign_out affects only :user scope).
# The default is true, which means any logout action will sign out all active 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 :"*/*" and "*/*" formats below is required to match Internet
# Explorer requests.
config.navigational_formats = [:"*/*", "*/*", :html, :zip]
2011-10-08 17:36:38 -04:00
# The default HTTP method used to sign out a resource. Default is :delete.
config.sign_out_via = :get
2011-10-08 17:36:38 -04:00
# ==> OmniAuth
# To configure a new OmniAuth provider copy and edit omniauth.rb.sample
# selecting the provider you require.
# Check the wiki for more information on setting up on your models
2012-01-21 13:36:14 -05:00
2011-10-08 17:36:38 -04:00
# ==> 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.failure_app = Gitlab::DeviseFailure
# manager.intercept_401 = false
# manager.default_strategies(scope: :user).unshift :some_external_strategy
# end
2012-09-12 00:48:22 -04:00
if Gitlab::Auth::LDAP::Config.enabled?
Gitlab::Auth::LDAP::Config.providers.each do |provider|
ldap_config = Gitlab::Auth::LDAP::Config.new(provider)
config.omniauth(provider, ldap_config.omniauth_options)
end
2012-09-12 00:48:22 -04:00
end
2012-12-14 20:19:21 -05:00
Gitlab.config.omniauth.providers.each do |provider|
provider_arguments = []
%w[app_id app_secret].each do |argument|
provider_arguments << provider[argument] if provider[argument]
end
case provider['args']
when Array
# An Array from the configuration will be expanded.
provider_arguments.concat provider['args']
when Hash
2015-11-11 23:25:31 -05:00
# Add procs for handling SLO
if provider['name'] == 'cas3'
provider['args'][:on_single_sign_out] = lambda do |request|
2015-11-11 23:25:31 -05:00
ticket = request.params[:session_index]
raise "Service Ticket not found." unless Gitlab::Auth::OAuth::Session.valid?(:cas3, ticket)
Gitlab::Auth::OAuth::Session.destroy(:cas3, ticket)
2015-11-11 23:25:31 -05:00
true
end
end
if provider['name'] == 'authentiq'
provider['args'][:remote_sign_out_handler] = lambda do |request|
authentiq_session = request.params['sid']
if Gitlab::Auth::OAuth::Session.valid?(:authentiq, authentiq_session)
Gitlab::Auth::OAuth::Session.destroy(:authentiq, authentiq_session)
true
else
false
end
end
end
2015-11-11 23:25:31 -05:00
if provider['name'] == 'shibboleth'
provider['args'][:fail_with_empty_uid] = true
end
# A Hash from the configuration will be passed as is.
2015-08-31 06:59:52 -04:00
provider_arguments << provider['args'].symbolize_keys
end
config.omniauth provider['name'].to_sym, *provider_arguments
2012-09-12 00:48:22 -04:00
end
end