devise.rb 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. Warden::Manager.after_set_user except: :fetch do |user, warden|
  2. if user.session_active?(warden.cookies.signed['_session_id'] || warden.raw_session['auth_id'])
  3. session_id = warden.cookies.signed['_session_id'] || warden.raw_session['auth_id']
  4. else
  5. session_id = user.activate_session(warden.request)
  6. end
  7. warden.cookies.signed['_session_id'] = {
  8. value: session_id,
  9. expires: 1.year.from_now,
  10. httponly: true,
  11. secure: (Rails.env.production? || ENV['LOCAL_HTTPS'] == 'true'),
  12. }
  13. end
  14. Warden::Manager.after_fetch do |user, warden|
  15. if user.session_active?(warden.cookies.signed['_session_id'] || warden.raw_session['auth_id'])
  16. warden.cookies.signed['_session_id'] = {
  17. value: warden.cookies.signed['_session_id'] || warden.raw_session['auth_id'],
  18. expires: 1.year.from_now,
  19. httponly: true,
  20. secure: (Rails.env.production? || ENV['LOCAL_HTTPS'] == 'true'),
  21. }
  22. else
  23. warden.logout
  24. throw :warden, message: :unauthenticated
  25. end
  26. end
  27. Warden::Manager.before_logout do |_, warden|
  28. SessionActivation.deactivate warden.cookies.signed['_session_id']
  29. warden.cookies.delete('_session_id')
  30. end
  31. module Devise
  32. mattr_accessor :pam_authentication
  33. @@pam_authentication = false
  34. mattr_accessor :pam_controlled_service
  35. @@pam_controlled_service = nil
  36. mattr_accessor :check_at_sign
  37. @@check_at_sign = false
  38. mattr_accessor :ldap_authentication
  39. @@ldap_authentication = false
  40. mattr_accessor :ldap_host
  41. @@ldap_host = nil
  42. mattr_accessor :ldap_port
  43. @@ldap_port = nil
  44. mattr_accessor :ldap_method
  45. @@ldap_method = nil
  46. mattr_accessor :ldap_base
  47. @@ldap_base = nil
  48. mattr_accessor :ldap_uid
  49. @@ldap_uid = nil
  50. mattr_accessor :ldap_bind_dn
  51. @@ldap_bind_dn = nil
  52. mattr_accessor :ldap_password
  53. @@ldap_password = nil
  54. mattr_accessor :ldap_tls_no_verify
  55. @@ldap_tls_no_verify = false
  56. mattr_accessor :ldap_search_filter
  57. @@ldap_search_filter = nil
  58. class Strategies::PamAuthenticatable
  59. def valid?
  60. super && ::Devise.pam_authentication
  61. end
  62. end
  63. end
  64. Devise.setup do |config|
  65. config.warden do |manager|
  66. manager.default_strategies(scope: :user).unshift :two_factor_ldap_authenticatable if Devise.ldap_authentication
  67. manager.default_strategies(scope: :user).unshift :two_factor_pam_authenticatable if Devise.pam_authentication
  68. manager.default_strategies(scope: :user).unshift :two_factor_authenticatable
  69. manager.default_strategies(scope: :user).unshift :two_factor_backupable
  70. end
  71. # The secret key used by Devise. Devise uses this key to generate
  72. # random tokens. Changing this key will render invalid all existing
  73. # confirmation, reset password and unlock tokens in the database.
  74. # Devise will use the `secret_key_base` on Rails 4+ applications as its `secret_key`
  75. # by default. You can change it below and use your own secret key.
  76. # config.secret_key = '2f86974c4dd7735170fd70fbf399f7a477ffd635ef240d07a22cf4bd7cd13dbae17c4383a2996d0c1e79a991ec18a91a17424c53e4771adb75a8b21904bd1403'
  77. # ==> Mailer Configuration
  78. # Configure the e-mail address which will be shown in Devise::Mailer,
  79. # note that it will be overwritten if you use your own mailer class
  80. # with default "from" parameter.
  81. # config.mailer_sender = ENV['SMTP_FROM_ADDRESS'] || 'notifications@localhost'
  82. # Configure the class responsible to send e-mails.
  83. config.mailer = 'UserMailer'
  84. # ==> ORM configuration
  85. # Load and configure the ORM. Supports :active_record (default) and
  86. # :mongoid (bson_ext recommended) by default. Other ORMs may be
  87. # available as additional gems.
  88. require 'devise/orm/active_record'
  89. # ==> Configuration for any authentication mechanism
  90. # Configure which keys are used when authenticating a user. The default is
  91. # just :email. You can configure it to use [:username, :subdomain], so for
  92. # authenticating a user, both parameters are required. Remember that those
  93. # parameters are used only when authenticating and not when retrieving from
  94. # session. If you need permissions, you should implement that in a before filter.
  95. # You can also supply a hash where the value is a boolean determining whether
  96. # or not authentication should be aborted when the value is not present.
  97. # config.authentication_keys = [:email]
  98. # Configure parameters from the request object used for authentication. Each entry
  99. # given should be a request method and it will automatically be passed to the
  100. # find_for_authentication method and considered in your model lookup. For instance,
  101. # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
  102. # The same considerations mentioned for authentication_keys also apply to request_keys.
  103. # config.request_keys = []
  104. # Configure which authentication keys should be case-insensitive.
  105. # These keys will be downcased upon creating or modifying a user and when used
  106. # to authenticate or find a user. Default is :email.
  107. config.case_insensitive_keys = [:email]
  108. # Configure which authentication keys should have whitespace stripped.
  109. # These keys will have whitespace before and after removed upon creating or
  110. # modifying a user and when used to authenticate or find a user. Default is :email.
  111. config.strip_whitespace_keys = [:email]
  112. # Tell if authentication through request.params is enabled. True by default.
  113. # It can be set to an array that will enable params authentication only for the
  114. # given strategies, for example, `config.params_authenticatable = [:database]` will
  115. # enable it only for database (email + password) authentication.
  116. # config.params_authenticatable = true
  117. # Tell if authentication through HTTP Auth is enabled. False by default.
  118. # It can be set to an array that will enable http authentication only for the
  119. # given strategies, for example, `config.http_authenticatable = [:database]` will
  120. # enable it only for database authentication. The supported strategies are:
  121. # :database = Support basic authentication with authentication key + password
  122. config.http_authenticatable = [:pam, :database]
  123. # If 401 status code should be returned for AJAX requests. True by default.
  124. # config.http_authenticatable_on_xhr = true
  125. # The realm used in Http Basic Authentication. 'Application' by default.
  126. # config.http_authentication_realm = 'Application'
  127. # It will change confirmation, password recovery and other workflows
  128. # to behave the same regardless if the e-mail provided was right or wrong.
  129. # Does not affect registerable.
  130. # See : https://github.com/plataformatec/devise/wiki/How-To:-Using-paranoid-mode,-avoid-user-enumeration-on-registerable
  131. config.paranoid = true
  132. # By default Devise will store the user in session. You can skip storage for
  133. # particular strategies by setting this option.
  134. # Notice that if you are skipping storage for all authentication paths, you
  135. # may want to disable generating routes to Devise's sessions controller by
  136. # passing skip: :sessions to `devise_for` in your config/routes.rb
  137. config.skip_session_storage = [:http_auth]
  138. # By default, Devise cleans up the CSRF token on authentication to
  139. # avoid CSRF token fixation attacks. This means that, when using AJAX
  140. # requests for sign in and sign up, you need to get a new CSRF token
  141. # from the server. You can disable this option at your own risk.
  142. # config.clean_up_csrf_token_on_authentication = true
  143. # ==> Configuration for :database_authenticatable
  144. # For bcrypt, this is the cost for hashing the password and defaults to 10. If
  145. # using other encryptors, it sets how many times you want the password re-encrypted.
  146. #
  147. # Limiting the stretches to just one in testing will increase the performance of
  148. # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
  149. # a value less than 10 in other environments. Note that, for bcrypt (the default
  150. # encryptor), the cost increases exponentially with the number of stretches (e.g.
  151. # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
  152. config.stretches = Rails.env.test? ? 1 : 10
  153. # Setup a pepper to generate the encrypted password.
  154. # config.pepper = '104d16705f794923e77c5e5167b52452d00646dc952a2d30b541c24086e647012c7b9625f253c51912e455981e503446772973d5f1638631196c819d7137fad4'
  155. # Send a notification to the original email when the user's email is changed.
  156. config.send_email_changed_notification = true
  157. # Send a notification email when the user's password is changed
  158. config.send_password_change_notification = true
  159. # ==> Configuration for :confirmable
  160. # A period that the user is allowed to access the website even without
  161. # confirming their account. For instance, if set to 2.days, the user will be
  162. # able to access the website for two days without confirming their account,
  163. # access will be blocked just in the third day. Default is 0.days, meaning
  164. # the user cannot access the website without confirming their account.
  165. # config.allow_unconfirmed_access_for = 2.days
  166. # A period that the user is allowed to confirm their account before their
  167. # token becomes invalid. For example, if set to 3.days, the user can confirm
  168. # their account within 3 days after the mail was sent, but on the fourth day
  169. # their account can't be confirmed with the token any more.
  170. # Default is nil, meaning there is no restriction on how long a user can take
  171. # before confirming their account.
  172. config.confirm_within = 2.days
  173. # If true, requires any email changes to be confirmed (exactly the same way as
  174. # initial account confirmation) to be applied. Requires additional unconfirmed_email
  175. # db field (see migrations). Until confirmed, new email is stored in
  176. # unconfirmed_email column, and copied to email column on successful confirmation.
  177. config.reconfirmable = true
  178. # Defines which key will be used when confirming an account
  179. # config.confirmation_keys = [:email]
  180. # ==> Configuration for :rememberable
  181. # The time the user will be remembered without asking for credentials again.
  182. config.remember_for = 1.year
  183. # Invalidates all the remember me tokens when the user signs out.
  184. config.expire_all_remember_me_on_sign_out = true
  185. # If true, extends the user's remember period when remembered via cookie.
  186. # config.extend_remember_period = false
  187. # Options to be passed to the created cookie. For instance, you can set
  188. # secure: true in order to force SSL only cookies.
  189. config.rememberable_options = { secure: true }
  190. # ==> Configuration for :validatable
  191. # Range for password length.
  192. config.password_length = 8..72
  193. # Email regex used to validate email formats. It simply asserts that
  194. # one (and only one) @ exists in the given string. This is mainly
  195. # to give user feedback and not to assert the e-mail validity.
  196. # config.email_regexp = /\A[^@]+@[^@]+\z/
  197. # ==> Configuration for :timeoutable
  198. # The time you want to timeout the user session without activity. After this
  199. # time the user will be asked for credentials again. Default is 30 minutes.
  200. # config.timeout_in = 30.minutes
  201. # ==> Configuration for :lockable
  202. # Defines which strategy will be used to lock an account.
  203. # :failed_attempts = Locks an account after a number of failed attempts to sign in.
  204. # :none = No lock strategy. You should handle locking by yourself.
  205. # config.lock_strategy = :failed_attempts
  206. # Defines which key will be used when locking and unlocking an account
  207. # config.unlock_keys = [:email]
  208. # Defines which strategy will be used to unlock an account.
  209. # :email = Sends an unlock link to the user email
  210. # :time = Re-enables login after a certain amount of time (see :unlock_in below)
  211. # :both = Enables both strategies
  212. # :none = No unlock strategy. You should handle unlocking by yourself.
  213. # config.unlock_strategy = :both
  214. # Number of authentication tries before locking an account if lock_strategy
  215. # is failed attempts.
  216. # config.maximum_attempts = 20
  217. # Time interval to unlock the account if :time is enabled as unlock_strategy.
  218. # config.unlock_in = 1.hour
  219. # Warn on the last attempt before the account is locked.
  220. # config.last_attempt_warning = true
  221. # ==> Configuration for :recoverable
  222. #
  223. # Defines which key will be used when recovering the password for an account
  224. # config.reset_password_keys = [:email]
  225. # Time interval you can reset your password with a reset password key.
  226. # Don't put a too small interval or your users won't have the time to
  227. # change their passwords.
  228. config.reset_password_within = 6.hours
  229. # When set to false, does not sign a user in automatically after their password is
  230. # reset. Defaults to true, so a user is signed in automatically after a reset.
  231. config.sign_in_after_reset_password = false
  232. # ==> Configuration for :encryptable
  233. # Allow you to use another encryption algorithm besides bcrypt (default). You can use
  234. # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
  235. # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
  236. # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
  237. # REST_AUTH_SITE_KEY to pepper).
  238. #
  239. # Require the `devise-encryptable` gem when using anything other than bcrypt
  240. # config.encryptor = :sha512
  241. # ==> Scopes configuration
  242. # Turn scoped views on. Before rendering "sessions/new", it will first check for
  243. # "users/sessions/new". It's turned off by default because it's slower if you
  244. # are using only default views.
  245. # config.scoped_views = false
  246. # Configure the default scope given to Warden. By default it's the first
  247. # devise role declared in your routes (usually :user).
  248. # config.default_scope = :user
  249. # Set this configuration to false if you want /users/sign_out to sign out
  250. # only the current scope. By default, Devise signs out all scopes.
  251. # config.sign_out_all_scopes = true
  252. # ==> Navigation configuration
  253. # Lists the formats that should be treated as navigational. Formats like
  254. # :html, should redirect to the sign in page when the user does not have
  255. # access, but formats like :xml or :json, should return 401.
  256. #
  257. # If you have any extra navigational formats, like :iphone or :mobile, you
  258. # should add them to the navigational formats lists.
  259. #
  260. # The "*/*" below is required to match Internet Explorer requests.
  261. # config.navigational_formats = ['*/*', :html]
  262. # The default HTTP method used to sign out a resource. Default is :delete.
  263. config.sign_out_via = :delete
  264. # ==> OmniAuth
  265. # Add a new OmniAuth provider. Check the wiki for more information on setting
  266. # up on your models and hooks.
  267. # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
  268. # ==> Warden configuration
  269. # If you want to use other strategies, that are not supported by Devise, or
  270. # change the failure app, you can configure them inside the config.warden block.
  271. #
  272. # config.warden do |manager|
  273. # manager.intercept_401 = false
  274. # manager.default_strategies(scope: :user).unshift :some_external_strategy
  275. # end
  276. # ==> Mountable engine configurations
  277. # When using Devise inside an engine, let's call it `MyEngine`, and this engine
  278. # is mountable, there are some extra configurations to be taken into account.
  279. # The following options are available, assuming the engine is mounted as:
  280. #
  281. # mount MyEngine, at: '/my_engine'
  282. #
  283. # The router that invoked `devise_for`, in the example above, would be:
  284. # config.router_name = :my_engine
  285. #
  286. # When using OmniAuth, Devise cannot automatically set OmniAuth path,
  287. # so you need to do it manually. For the users scope, it would be:
  288. # config.omniauth_path_prefix = '/my_engine/users/auth'
  289. if ENV['PAM_ENABLED'] == 'true'
  290. config.pam_authentication = true
  291. config.usernamefield = nil
  292. config.emailfield = 'email'
  293. config.check_at_sign = true
  294. config.pam_default_suffix = ENV.fetch('PAM_EMAIL_DOMAIN') { ENV['LOCAL_DOMAIN'] }
  295. config.pam_default_service = ENV.fetch('PAM_DEFAULT_SERVICE') { 'rpam' }
  296. config.pam_controlled_service = ENV.fetch('PAM_CONTROLLED_SERVICE') { nil }
  297. end
  298. if ENV['LDAP_ENABLED'] == 'true'
  299. config.ldap_authentication = true
  300. config.check_at_sign = true
  301. config.ldap_host = ENV.fetch('LDAP_HOST', 'localhost')
  302. config.ldap_port = ENV.fetch('LDAP_PORT', 389).to_i
  303. config.ldap_method = ENV.fetch('LDAP_METHOD', :simple_tls).to_sym
  304. config.ldap_base = ENV.fetch('LDAP_BASE')
  305. config.ldap_bind_dn = ENV.fetch('LDAP_BIND_DN')
  306. config.ldap_password = ENV.fetch('LDAP_PASSWORD')
  307. config.ldap_uid = ENV.fetch('LDAP_UID', 'cn')
  308. config.ldap_tls_no_verify = ENV['LDAP_TLS_NO_VERIFY'] == 'true'
  309. config.ldap_search_filter = ENV.fetch('LDAP_SEARCH_FILTER', '%{uid}=%{email}')
  310. end
  311. end