devise.rb 13 KB
Newer Older
1 2
# frozen_string_literal: true

danielgrippi's avatar
danielgrippi committed
3
#   Copyright (c) 2010-2011, Diaspora Inc.  This file is
Raphael's avatar
Raphael committed
4
#   licensed under the Affero General Public License version 3 or later.  See
Raphael's avatar
Raphael committed
5
#   the COPYRIGHT file.
6

7 8 9 10 11 12 13 14
class ActionController::Responder
  def to_mobile
    default_render
  rescue ActionView::MissingTemplate => e
    navigation_behavior(e)
  end
end

Jonne Haß's avatar
Jonne Haß committed
15 16
# Use this hook to configure devise mailer, warden hooks and so forth.
# Many of these configuration options can be set straight in your model.
17
Devise.setup do |config|
lislis's avatar
lislis committed
18 19 20 21 22
  config.warden do |manager|
    manager.default_strategies(scope: :user).unshift :two_factor_authenticatable
    manager.default_strategies(scope: :user).unshift :two_factor_backupable
  end

Jonne Haß's avatar
Jonne Haß committed
23 24 25 26
  # 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.
  config.secret_key = AppConfig.secret_token
27

Jonne Haß's avatar
Jonne Haß committed
28 29 30 31
  # ==> 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.
Jonne Haß's avatar
Jonne Haß committed
32 33
  if AppConfig.mail.sender_address.present?
    config.mailer_sender = AppConfig.mail.sender_address
Jonne Haß's avatar
Jonne Haß committed
34
  elsif AppConfig.mail.enable?
35 36
    unless Rails.env == 'test'
      Rails.logger.warn("No smtp sender address set, mail may fail.")
Jonne Haß's avatar
Jonne Haß committed
37
      warn "WARNING: No smtp sender address set, mail may fail."
38
    end
Jonne Haß's avatar
Jonne Haß committed
39
    config.mailer_sender = "please-change-me@config-diaspora-yml.com"
40 41
  end

42 43 44
  # Configure the class responsible to send e-mails.
  config.mailer = "DiasporaDeviseMailer"

Jonne Haß's avatar
Jonne Haß committed
45 46 47 48 49 50
  # ==> 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'

51
  # ==> Configuration for any authentication mechanism
Jonne Haß's avatar
Jonne Haß committed
52
  # Configure which keys are used when authenticating a user. The default is
53
  # just :email. You can configure it to use [:username, :subdomain], so for
Jonne Haß's avatar
Jonne Haß committed
54
  # authenticating a user, both parameters are required. Remember that those
55 56
  # parameters are used only when authenticating and not when retrieving from
  # session. If you need permissions, you should implement that in a before filter.
Jonne Haß's avatar
Jonne Haß committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70
  # 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 = [ :username ]

  # 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.
71
  config.case_insensitive_keys = %i(email unconfirmed_email username)
Jonne Haß's avatar
Jonne Haß committed
72 73 74 75

  # 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.
76
  config.strip_whitespace_keys = %i(email unconfirmed_email username)
77 78

  # Tell if authentication through request.params is enabled. True by default.
Jonne Haß's avatar
Jonne Haß committed
79 80 81
  # 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.
82 83
  # config.params_authenticatable = true

Jonne Haß's avatar
Jonne Haß committed
84 85 86 87 88 89 90 91 92
  # 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. The supported strategies are:
  # :database      = Support basic authentication with authentication key + password
  # config.http_authenticatable = false

  # If http headers should be returned for AJAX requests. True by default.
  # config.http_authenticatable_on_xhr = true
93

Jonne Haß's avatar
Jonne Haß committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
  # 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
114 115 116 117

  # ==> 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.
Jonne Haß's avatar
Jonne Haß committed
118 119 120 121
  #
  # 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.
122
  config.stretches = Rails.env.test? ? 1 : 10
123 124 125

  # Setup a pepper to generate the encrypted password.
  config.pepper = "065eb8798b181ff0ea2c5c16aee0ff8b70e04e2ee6bd6e08b49da46924223e39127d5335e466207d42bf2a045c12be5f90e92012a4f05f7fc6d9f3c875f4c95b"
Jonne Haß's avatar
Jonne Haß committed
126

127
  # ==> Configuration for :confirmable
Jonne Haß's avatar
Jonne Haß committed
128 129 130 131 132
  # A period that the user is allowed to access the website even without
  # confirming his account. For instance, if set to 2.days, the user will be
  # able to access the website for two days without confirming his account,
  # access will be blocked just in the third day. Default is 0.days, meaning
  # the user cannot access the website without confirming his account.
Jonne Haß's avatar
Jonne Haß committed
133
  # config.allow_unconfirmed_access_for = 2.days
134

Jonne Haß's avatar
Jonne Haß committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  # 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 ]

152 153
  # ==> Configuration for :rememberable
  # The time the user will be remembered without asking for credentials again.
154
  config.remember_for = 2.weeks
Jonne Haß's avatar
Jonne Haß committed
155

Jonne Haß's avatar
Jonne Haß committed
156 157 158 159 160 161 162
  # 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 = {}

163
  # ==> Configuration for :validatable
Jonne Haß's avatar
Jonne Haß committed
164 165
  # Range for password length. Default is 8..128.
  config.password_length = 6..128
166

Jonne Haß's avatar
Jonne Haß committed
167 168 169 170
  # 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[^@]+@[^@]+\z/
171 172 173

  # ==> Configuration for :timeoutable
  # The time you want to timeout the user session without activity. After this
Jonne Haß's avatar
Jonne Haß committed
174 175 176 177 178
  # time the user will be asked for credentials again. Default is 30 minutes.
  # config.timeout_in = 30.minutes

  # If true, expires auth token on session timeout.
  # config.expire_auth_token_on_timeout = false
179 180 181 182 183 184 185

  # ==> 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

Jonne Haß's avatar
Jonne Haß committed
186 187 188
  # Defines which key will be used when locking and unlocking an account
  # config.unlock_keys = [ :email ]

189 190 191 192 193 194 195 196 197 198 199 200 201 202
  # 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

Jonne Haß's avatar
Jonne Haß committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  # ==> 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 = 2.days

  # ==> 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).
  #
  # Require the `devise-encryptable` gem when using anything other than bcrypt
  # config.encryptor = :sha512
222 223 224

  # ==> Scopes configuration
  # Turn scoped views on. Before rendering "sessions/new", it will first check for
Jonne Haß's avatar
Jonne Haß committed
225
  # "users/sessions/new". It's turned off by default because it's slower if you
226
  # are using only default views.
Jonne Haß's avatar
Jonne Haß committed
227
  # config.scoped_views = false
228

Jonne Haß's avatar
Jonne Haß committed
229 230
  # Configure the default scope given to Warden. By default it's the first
  # devise role declared in your routes (usually :user).
231
  config.default_scope = :user
232

Jonne Haß's avatar
Jonne Haß committed
233 234 235 236
  # 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

237 238 239 240
  # ==> 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.
Jonne Haß's avatar
Jonne Haß committed
241
  #
242
  # If you have any extra navigational formats, like :iphone or :mobile, you
Jonne Haß's avatar
Jonne Haß committed
243 244 245 246 247 248 249
  # should add them to the navigational formats lists.
  #
  # The "*/*" below is required to match Internet Explorer requests.
  config.navigational_formats = ['*/*', :html, :mobile]

  # The default HTTP method used to sign out a resource. Default is :delete.
  config.sign_out_via = :delete
250

Jonne Haß's avatar
Jonne Haß committed
251 252 253 254
  # ==> OmniAuth
  # Add a new OmniAuth provider. Check the wiki for more information on setting
  # up on your models and hooks.
  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
255

256
  # ==> Warden configuration
Jonne Haß's avatar
Jonne Haß committed
257 258
  # 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.
259 260
  #
  # config.warden do |manager|
Jonne Haß's avatar
Jonne Haß committed
261 262
  #   manager.intercept_401 = false
  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
263
  # end
Jonne Haß's avatar
Jonne Haß committed
264

Jonne Haß's avatar
Jonne Haß committed
265 266 267 268 269 270 271 272 273 274 275 276 277
  # ==> 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'
lislis's avatar
lislis committed
278 279 280 281

  # if a user enables 2fa this would log them in without requiring them
  # to enter a token
  config.sign_in_after_reset_password = false
282
end