Module: Devise
- Defined in:
- lib/devise.rb,
lib/devise/rails.rb,
lib/devise/models.rb,
lib/devise/mapping.rb,
lib/devise/version.rb,
lib/devise/omniauth.rb,
lib/devise/delegator.rb,
lib/devise/failure_app.rb,
lib/devise/hooks/proxy.rb,
lib/devise/test_helpers.rb,
lib/devise/time_inflector.rb,
lib/devise/mailers/helpers.rb,
lib/devise/models/lockable.rb,
lib/devise/omniauth/config.rb,
lib/devise/strategies/base.rb,
lib/devise/token_generator.rb,
lib/devise/models/trackable.rb,
lib/devise/parameter_filter.rb,
lib/devise/models/confirmable.rb,
lib/devise/models/recoverable.rb,
lib/devise/models/timeoutable.rb,
lib/devise/models/validatable.rb,
lib/devise/controllers/helpers.rb,
lib/devise/models/omniauthable.rb,
lib/devise/models/registerable.rb,
lib/devise/models/rememberable.rb,
lib/devise/parameter_sanitizer.rb,
lib/devise/omniauth/url_helpers.rb,
lib/devise/models/authenticatable.rb,
lib/generators/devise/orm_helpers.rb,
lib/devise/controllers/sign_in_out.rb,
lib/devise/controllers/url_helpers.rb,
lib/devise/strategies/rememberable.rb,
lib/devise/controllers/rememberable.rb,
lib/devise/controllers/scoped_views.rb,
lib/devise/controllers/store_location.rb,
lib/devise/strategies/authenticatable.rb,
lib/generators/devise/views_generator.rb,
lib/generators/devise/devise_generator.rb,
lib/generators/devise/install_generator.rb,
lib/devise/models/database_authenticatable.rb,
lib/generators/devise/controllers_generator.rb,
lib/devise/strategies/database_authenticatable.rb
Defined Under Namespace
Modules: Controllers, Generators, Hooks, Mailers, Models, OmniAuth, Strategies, TestHelpers Classes: BaseSanitizer, CachingKeyGenerator, ConfirmationsController, Delegator, Engine, FailureApp, Getter, KeyGenerator, Mailer, Mapping, OmniauthCallbacksController, ParameterFilter, ParameterSanitizer, PasswordsController, RegistrationsController, TimeInflector, TokenGenerator, UnlocksController
Constant Summary collapse
- ALL =
Constants which holds devise configuration for extensions. Those should not be modified by the “end user” (this is why they are constants).
[]
- CONTROLLERS =
ActiveSupport::OrderedHash.new
- ROUTES =
ActiveSupport::OrderedHash.new
- STRATEGIES =
ActiveSupport::OrderedHash.new
- URL_HELPERS =
ActiveSupport::OrderedHash.new
- NO_INPUT =
Strategies that do not require user input.
[]
- TRUE_VALUES =
True values used to check params
[true, 1, '1', 't', 'T', 'true', 'TRUE']
- VERSION =
"1.0.0".freeze
- @@secret_key =
nil
- @@rememberable_options =
{}
- @@stretches =
10
- @@http_authentication_key =
nil
- @@authentication_keys =
[ :email ]
- @@request_keys =
[]
- @@case_insensitive_keys =
[ :email ]
- @@strip_whitespace_keys =
[]
- @@http_authenticatable =
false
- @@http_authenticatable_on_xhr =
true
- @@params_authenticatable =
true
- @@http_authentication_realm =
"Application"
- @@email_regexp =
/\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/
- @@password_length =
6..128
- @@remember_for =
2.weeks
- @@extend_remember_period =
false
- @@expire_all_remember_me_on_sign_out =
true
- @@allow_unconfirmed_access_for =
0.days
- @@confirm_within =
nil
- @@confirmation_keys =
[ :email ]
- @@reconfirmable =
false
- @@timeout_in =
30.minutes
- @@expire_auth_token_on_timeout =
false
- @@pepper =
nil
- @@scoped_views =
false
- @@lock_strategy =
:failed_attempts
- @@unlock_keys =
[ :email ]
- @@unlock_strategy =
:both
- @@maximum_attempts =
20
- @@unlock_in =
1.hour
- @@reset_password_keys =
[ :email ]
- @@reset_password_within =
6.hours
- @@default_scope =
nil
- @@mailer_sender =
nil
- @@skip_session_storage =
[]
["*/*", :html]
- @@sign_out_all_scopes =
true
- @@sign_out_via =
:get
- @@parent_controller =
"ApplicationController"
- @@parent_mailer =
"ActionMailer::Base"
- @@router_name =
nil
- @@omniauth_path_prefix =
nil
- @@clean_up_csrf_token_on_authentication =
true
- @@mappings =
ActiveSupport::OrderedHash.new
- @@omniauth_configs =
ActiveSupport::OrderedHash.new
- @@helpers =
Set.new
- @@warden_config =
nil
- @@warden_config_blocks =
[]
- @@paranoid =
false
- @@last_attempt_warning =
true
- @@token_generator =
nil
Class Method Summary collapse
-
.add_mapping(resource, options) ⇒ Object
Small method that adds a mapping to Devise.
-
.add_module(module_name, options = {}) ⇒ Object
Make Devise aware of an 3rd party Devise-module (like invitable).
- .available_router_name ⇒ Object
-
.bcrypt(klass, password) ⇒ Object
Digests the password using bcrypt.
-
.configure_warden! ⇒ Object
A method used internally to setup warden manager from the Rails initialize block.
-
.friendly_token ⇒ Object
Generate a friendly string randomly to be used as token.
-
.include_helpers(scope) ⇒ Object
Include helpers in the given scope to AC and AV.
-
.mailer ⇒ Object
Get the mailer class from the mailer reference object.
-
.mailer=(class_name) ⇒ Object
Set the mailer reference object to access the mailer.
-
.omniauth(provider, *args) ⇒ Object
Specify an OmniAuth provider.
- .omniauth_providers ⇒ Object
- .ref(arg) ⇒ Object
-
.regenerate_helpers! ⇒ Object
Regenerates url helpers considering Devise.mapping.
-
.secure_compare(a, b) ⇒ Object
constant-time comparison algorithm to prevent timing attacks.
-
.setup {|_self| ... } ⇒ Object
Default way to setup Devise.
-
.warden(&block) ⇒ Object
Sets warden configuration using a block that will be invoked on warden initialization.
Class Method Details
.add_mapping(resource, options) ⇒ Object
Small method that adds a mapping to Devise.
335 336 337 338 339 340 341 |
# File 'lib/devise.rb', line 335 def self.add_mapping(resource, ) mapping = Devise::Mapping.new(resource, ) @@mappings[mapping.name] = mapping @@default_scope ||= mapping.name @@helpers.each { |h| h.define_helpers(mapping) } mapping end |
.add_module(module_name, options = {}) ⇒ Object
Make Devise aware of an 3rd party Devise-module (like invitable). For convenience.
Options:
+model+ - String representing the load path to a custom *model* for this module (to autoload.)
+controller+ - Symbol representing the name of an existing or custom *controller* for this module.
+route+ - Symbol representing the named *route* helper for this module.
+strategy+ - Symbol representing if this module got a custom *strategy*.
+insert_at+ - Integer representing the order in which this module's model will be included
All values, except :model, accept also a boolean and will have the same name as the given module name.
Examples:
Devise.add_module(:party_module)
Devise.add_module(:party_module, strategy: true, controller: :sessions)
Devise.add_module(:party_module, model: 'party_module/model')
Devise.add_module(:party_module, insert_at: 0)
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'lib/devise.rb', line 363 def self.add_module(module_name, = {}) .assert_valid_keys(:strategy, :model, :controller, :route, :no_input, :insert_at) ALL.insert ([:insert_at] || -1), module_name if strategy = [:strategy] strategy = (strategy == true ? module_name : strategy) STRATEGIES[module_name] = strategy end if controller = [:controller] controller = (controller == true ? module_name : controller) CONTROLLERS[module_name] = controller end NO_INPUT << strategy if [:no_input] if route = [:route] case route when TrueClass key, value = module_name, [] when Symbol key, value = route, [] when Hash key, value = route.keys.first, route.values.flatten else raise ArgumentError, ":route should be true, a Symbol or a Hash" end URL_HELPERS[key] ||= [] URL_HELPERS[key].concat(value) URL_HELPERS[key].uniq! ROUTES[module_name] = key end if [:model] path = ([:model] == true ? "devise/models/#{module_name}" : [:model]) camelized = ActiveSupport::Inflector.camelize(module_name.to_s) Devise::Models.send(:autoload, camelized.to_sym, path) end Devise::Mapping.add_module module_name end |
.available_router_name ⇒ Object
315 316 317 |
# File 'lib/devise.rb', line 315 def self.available_router_name router_name || :main_app end |
.bcrypt(klass, password) ⇒ Object
Digests the password using bcrypt.
6 7 8 |
# File 'lib/devise/models/database_authenticatable.rb', line 6 def self.bcrypt(klass, password) ::BCrypt::Password.create("#{password}#{klass.pepper}", cost: klass.stretches).to_s end |
.configure_warden! ⇒ Object
A method used internally to setup warden manager from the Rails initialize block.
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/devise.rb', line 453 def self.configure_warden! #:nodoc: @@warden_configured ||= begin warden_config.failure_app = Devise::Delegator.new warden_config.default_scope = Devise.default_scope warden_config.intercept_401 = false Devise.mappings.each_value do |mapping| warden_config.scope_defaults mapping.name, strategies: mapping.strategies warden_config.serialize_into_session(mapping.name) do |record| mapping.to.serialize_into_session(record) end warden_config.serialize_from_session(mapping.name) do |key| # Previous versions contained an additional entry at the beginning of # key with the record's class name. args = key[-2, 2] mapping.to.serialize_from_session(*args) end end @@warden_config_blocks.map { |block| block.call Devise.warden_config } true end end |
.friendly_token ⇒ Object
Generate a friendly string randomly to be used as token.
480 481 482 |
# File 'lib/devise.rb', line 480 def self.friendly_token SecureRandom.urlsafe_base64(15).tr('lIO0', 'sxyz') end |
.include_helpers(scope) ⇒ Object
Include helpers in the given scope to AC and AV.
434 435 436 437 438 439 440 441 442 443 |
# File 'lib/devise.rb', line 434 def self.include_helpers(scope) ActiveSupport.on_load(:action_controller) do include scope::Helpers if defined?(scope::Helpers) include scope::UrlHelpers end ActiveSupport.on_load(:action_view) do include scope::UrlHelpers end end |
.mailer ⇒ Object
Get the mailer class from the mailer reference object.
324 325 326 |
# File 'lib/devise.rb', line 324 def self.mailer @@mailer_ref.get end |
.mailer=(class_name) ⇒ Object
Set the mailer reference object to access the mailer.
329 330 331 |
# File 'lib/devise.rb', line 329 def self.mailer=(class_name) @@mailer_ref = ref(class_name) end |
.omniauth(provider, *args) ⇒ Object
Specify an OmniAuth provider.
config.omniauth :github, APP_ID, APP_SECRET
427 428 429 430 431 |
# File 'lib/devise.rb', line 427 def self.omniauth(provider, *args) @@helpers << Devise::OmniAuth::UrlHelpers config = Devise::OmniAuth::Config.new(provider, args) @@omniauth_configs[config.strategy_name.to_sym] = config end |
.omniauth_providers ⇒ Object
319 320 321 |
# File 'lib/devise.rb', line 319 def self.omniauth_providers omniauth_configs.keys end |
.ref(arg) ⇒ Object
306 307 308 309 310 311 312 313 |
# File 'lib/devise.rb', line 306 def self.ref(arg) if defined?(ActiveSupport::Dependencies::ClassCache) ActiveSupport::Dependencies::reference(arg) Getter.new(arg) else ActiveSupport::Dependencies.ref(arg) end end |
.regenerate_helpers! ⇒ Object
Regenerates url helpers considering Devise.mapping
446 447 448 449 |
# File 'lib/devise.rb', line 446 def self.regenerate_helpers! Devise::Controllers::UrlHelpers.remove_helpers! Devise::Controllers::UrlHelpers.generate_helpers! end |
.secure_compare(a, b) ⇒ Object
constant-time comparison algorithm to prevent timing attacks
485 486 487 488 489 490 491 492 |
# File 'lib/devise.rb', line 485 def self.secure_compare(a, b) return false if a.blank? || b.blank? || a.bytesize != b.bytesize l = a.unpack "C#{a.bytesize}" res = 0 b.each_byte { |byte| res |= byte ^ l.shift } res == 0 end |
.setup {|_self| ... } ⇒ Object
Default way to setup Devise. Run rails generate devise_install to create a fresh initializer with all configuration values.
292 293 294 |
# File 'lib/devise.rb', line 292 def self.setup yield self end |
.warden(&block) ⇒ Object
419 420 421 |
# File 'lib/devise.rb', line 419 def self.warden(&block) @@warden_config_blocks << block end |