devise.rb 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. # Use this hook to configure devise mailer, warden hooks and so forth.
  2. # Many of these configuration options can be set straight in your model.
  3. Devise.setup do |config|
  4. # The secret key used by Devise. Devise uses this key to generate
  5. # random tokens. Changing this key will render invalid all existing
  6. # confirmation, reset password and unlock tokens in the database.
  7. # Devise will use the `secret_key_base` as its `secret_key`
  8. # by default. You can change it below and use your own secret key.
  9. # config.secret_key = 'c588a4de1cff751381b6bce2957ffc210910b6527cb4b39aa0b0d328316771487f0fbaccf6f3719be06cff95ec71247f4e0da242be3905401561f9cf465f28eb'
  10. # ==> Mailer Configuration
  11. # Configure the e-mail address which will be shown in Devise::Mailer,
  12. # note that it will be overwritten if you use your own mailer class
  13. # with default "from" parameter.
  14. config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
  15. # Configure the class responsible to send e-mails.
  16. # config.mailer = 'Devise::Mailer'
  17. # Configure the parent class responsible to send e-mails.
  18. # config.parent_mailer = 'ActionMailer::Base'
  19. # ==> ORM configuration
  20. # Load and configure the ORM. Supports :active_record (default) and
  21. # :mongoid (bson_ext recommended) by default. Other ORMs may be
  22. # available as additional gems.
  23. require 'devise/orm/active_record'
  24. # ==> Configuration for any authentication mechanism
  25. # Configure which keys are used when authenticating a user. The default is
  26. # just :email. You can configure it to use [:username, :subdomain], so for
  27. # authenticating a user, both parameters are required. Remember that those
  28. # parameters are used only when authenticating and not when retrieving from
  29. # session. If you need permissions, you should implement that in a before filter.
  30. # You can also supply a hash where the value is a boolean determining whether
  31. # or not authentication should be aborted when the value is not present.
  32. # config.authentication_keys = [:email]
  33. # Configure parameters from the request object used for authentication. Each entry
  34. # given should be a request method and it will automatically be passed to the
  35. # find_for_authentication method and considered in your model lookup. For instance,
  36. # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
  37. # The same considerations mentioned for authentication_keys also apply to request_keys.
  38. # config.request_keys = []
  39. # Configure which authentication keys should be case-insensitive.
  40. # These keys will be downcased upon creating or modifying a user and when used
  41. # to authenticate or find a user. Default is :email.
  42. config.case_insensitive_keys = [:email]
  43. # Configure which authentication keys should have whitespace stripped.
  44. # These keys will have whitespace before and after removed upon creating or
  45. # modifying a user and when used to authenticate or find a user. Default is :email.
  46. config.strip_whitespace_keys = [:email]
  47. # Tell if authentication through request.params is enabled. True by default.
  48. # It can be set to an array that will enable params authentication only for the
  49. # given strategies, for example, `config.params_authenticatable = [:database]` will
  50. # enable it only for database (email + password) authentication.
  51. # config.params_authenticatable = true
  52. # Tell if authentication through HTTP Auth is enabled. False by default.
  53. # It can be set to an array that will enable http authentication only for the
  54. # given strategies, for example, `config.http_authenticatable = [:database]` will
  55. # enable it only for database authentication. The supported strategies are:
  56. # :database = Support basic authentication with authentication key + password
  57. # config.http_authenticatable = false
  58. # If 401 status code should be returned for AJAX requests. True by default.
  59. # config.http_authenticatable_on_xhr = true
  60. # The realm used in Http Basic Authentication. 'Application' by default.
  61. # config.http_authentication_realm = 'Application'
  62. # It will change confirmation, password recovery and other workflows
  63. # to behave the same regardless if the e-mail provided was right or wrong.
  64. # Does not affect registerable.
  65. # config.paranoid = true
  66. # By default Devise will store the user in session. You can skip storage for
  67. # particular strategies by setting this option.
  68. # Notice that if you are skipping storage for all authentication paths, you
  69. # may want to disable generating routes to Devise's sessions controller by
  70. # passing skip: :sessions to `devise_for` in your config/routes.rb
  71. config.skip_session_storage = [:http_auth]
  72. # By default, Devise cleans up the CSRF token on authentication to
  73. # avoid CSRF token fixation attacks. This means that, when using AJAX
  74. # requests for sign in and sign up, you need to get a new CSRF token
  75. # from the server. You can disable this option at your own risk.
  76. # config.clean_up_csrf_token_on_authentication = true
  77. # When false, Devise will not attempt to reload routes on eager load.
  78. # This can reduce the time taken to boot the app but if your application
  79. # requires the Devise mappings to be loaded during boot time the application
  80. # won't boot properly.
  81. # config.reload_routes = true
  82. # ==> Configuration for :database_authenticatable
  83. # For bcrypt, this is the cost for hashing the password and defaults to 11. If
  84. # using other algorithms, it sets how many times you want the password to be hashed.
  85. #
  86. # Limiting the stretches to just one in testing will increase the performance of
  87. # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
  88. # a value less than 10 in other environments. Note that, for bcrypt (the default
  89. # algorithm), the cost increases exponentially with the number of stretches (e.g.
  90. # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
  91. config.stretches = Rails.env.test? ? 1 : 11
  92. # Set up a pepper to generate the hashed password.
  93. # config.pepper = '8004555ec2d9a63235797813526a495087593aaad309d47b6037443b2b0b645663720a394446a78300a2b8b55625f7d87edeaedb7baf8a298a2025eacdfd297e'
  94. # Send a notification email when the user's password is changed
  95. # config.send_password_change_notification = false
  96. # ==> Configuration for :confirmable
  97. # A period that the user is allowed to access the website even without
  98. # confirming their account. For instance, if set to 2.days, the user will be
  99. # able to access the website for two days without confirming their account,
  100. # access will be blocked just in the third day. Default is 0.days, meaning
  101. # the user cannot access the website without confirming their account.
  102. # config.allow_unconfirmed_access_for = 2.days
  103. # A period that the user is allowed to confirm their account before their
  104. # token becomes invalid. For example, if set to 3.days, the user can confirm
  105. # their account within 3 days after the mail was sent, but on the fourth day
  106. # their account can't be confirmed with the token any more.
  107. # Default is nil, meaning there is no restriction on how long a user can take
  108. # before confirming their account.
  109. # config.confirm_within = 3.days
  110. # If true, requires any email changes to be confirmed (exactly the same way as
  111. # initial account confirmation) to be applied. Requires additional unconfirmed_email
  112. # db field (see migrations). Until confirmed, new email is stored in
  113. # unconfirmed_email column, and copied to email column on successful confirmation.
  114. config.reconfirmable = true
  115. # Defines which key will be used when confirming an account
  116. # config.confirmation_keys = [:email]
  117. # ==> Configuration for :rememberable
  118. # The time the user will be remembered without asking for credentials again.
  119. # config.remember_for = 2.weeks
  120. # Invalidates all the remember me tokens when the user signs out.
  121. config.expire_all_remember_me_on_sign_out = true
  122. # If true, extends the user's remember period when remembered via cookie.
  123. # config.extend_remember_period = false
  124. # Options to be passed to the created cookie. For instance, you can set
  125. # secure: true in order to force SSL only cookies.
  126. # config.rememberable_options = {}
  127. # ==> Configuration for :validatable
  128. # Range for password length.
  129. config.password_length = 6..128
  130. # Email regex used to validate email formats. It simply asserts that
  131. # one (and only one) @ exists in the given string. This is mainly
  132. # to give user feedback and not to assert the e-mail validity.
  133. config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
  134. # ==> Configuration for :timeoutable
  135. # The time you want to timeout the user session without activity. After this
  136. # time the user will be asked for credentials again. Default is 30 minutes.
  137. # config.timeout_in = 30.minutes
  138. # ==> Configuration for :lockable
  139. # Defines which strategy will be used to lock an account.
  140. # :failed_attempts = Locks an account after a number of failed attempts to sign in.
  141. # :none = No lock strategy. You should handle locking by yourself.
  142. # config.lock_strategy = :failed_attempts
  143. # Defines which key will be used when locking and unlocking an account
  144. # config.unlock_keys = [:email]
  145. # Defines which strategy will be used to unlock an account.
  146. # :email = Sends an unlock link to the user email
  147. # :time = Re-enables login after a certain amount of time (see :unlock_in below)
  148. # :both = Enables both strategies
  149. # :none = No unlock strategy. You should handle unlocking by yourself.
  150. # config.unlock_strategy = :both
  151. # Number of authentication tries before locking an account if lock_strategy
  152. # is failed attempts.
  153. # config.maximum_attempts = 20
  154. # Time interval to unlock the account if :time is enabled as unlock_strategy.
  155. # config.unlock_in = 1.hour
  156. # Warn on the last attempt before the account is locked.
  157. # config.last_attempt_warning = true
  158. # ==> Configuration for :recoverable
  159. #
  160. # Defines which key will be used when recovering the password for an account
  161. # config.reset_password_keys = [:email]
  162. # Time interval you can reset your password with a reset password key.
  163. # Don't put a too small interval or your users won't have the time to
  164. # change their passwords.
  165. config.reset_password_within = 6.hours
  166. # When set to false, does not sign a user in automatically after their password is
  167. # reset. Defaults to true, so a user is signed in automatically after a reset.
  168. # config.sign_in_after_reset_password = true
  169. # ==> Configuration for :encryptable
  170. # Allow you to use another hashing or encryption algorithm besides bcrypt (default).
  171. # You can use :sha1, :sha512 or algorithms from others authentication tools as
  172. # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
  173. # for default behavior) and :restful_authentication_sha1 (then you should set
  174. # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
  175. #
  176. # Require the `devise-encryptable` gem when using anything other than bcrypt
  177. # config.encryptor = :sha512
  178. # ==> Scopes configuration
  179. # Turn scoped views on. Before rendering "sessions/new", it will first check for
  180. # "users/sessions/new". It's turned off by default because it's slower if you
  181. # are using only default views.
  182. # config.scoped_views = false
  183. # Configure the default scope given to Warden. By default it's the first
  184. # devise role declared in your routes (usually :user).
  185. # config.default_scope = :user
  186. # Set this configuration to false if you want /users/sign_out to sign out
  187. # only the current scope. By default, Devise signs out all scopes.
  188. # config.sign_out_all_scopes = true
  189. # ==> Navigation configuration
  190. # Lists the formats that should be treated as navigational. Formats like
  191. # :html, should redirect to the sign in page when the user does not have
  192. # access, but formats like :xml or :json, should return 401.
  193. #
  194. # If you have any extra navigational formats, like :iphone or :mobile, you
  195. # should add them to the navigational formats lists.
  196. #
  197. # The "*/*" below is required to match Internet Explorer requests.
  198. # config.navigational_formats = ['*/*', :html]
  199. # The default HTTP method used to sign out a resource. Default is :delete.
  200. config.sign_out_via = :delete
  201. # ==> OmniAuth
  202. # Add a new OmniAuth provider. Check the wiki for more information on setting
  203. # up on your models and hooks.
  204. config.omniauth :twitter, ENV['TWITTER_CLIENT_ID'], ENV['TWITTER_CLIENT_SECRET']
  205. config.omniauth :mastodon, scope: 'read follow', credentials: lambda { |domain, callback_url|
  206. client = MastodonClient.where(domain: domain).first
  207. if client.nil?
  208. client = MastodonClient.obtain!(domain, callback_url)
  209. else
  210. still_valid = Rails.cache.fetch("client-status/#{client.id}") { client.still_valid? }
  211. unless still_valid
  212. client.destroy!
  213. client = MastodonClient.obtain!(domain, callback_url)
  214. end
  215. end
  216. [client.client_id, client.client_secret]
  217. }
  218. # ==> Warden configuration
  219. # If you want to use other strategies, that are not supported by Devise, or
  220. # change the failure app, you can configure them inside the config.warden block.
  221. #
  222. # config.warden do |manager|
  223. # manager.intercept_401 = false
  224. # manager.default_strategies(scope: :user).unshift :some_external_strategy
  225. # end
  226. # ==> Mountable engine configurations
  227. # When using Devise inside an engine, let's call it `MyEngine`, and this engine
  228. # is mountable, there are some extra configurations to be taken into account.
  229. # The following options are available, assuming the engine is mounted as:
  230. #
  231. # mount MyEngine, at: '/my_engine'
  232. #
  233. # The router that invoked `devise_for`, in the example above, would be:
  234. # config.router_name = :my_engine
  235. #
  236. # When using OmniAuth, Devise cannot automatically set OmniAuth path,
  237. # so you need to do it manually. For the users scope, it would be:
  238. # config.omniauth_path_prefix = '/my_engine/users/auth'
  239. end