devise.rb 18 KB

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