devise.rb 14 KB

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