rodauth 2.11.0 → 2.15.0

data/doc/path_class_methods.rdoc

@@ -0,0 +1,10 @@
+= Documentation for Path Class Methods Feature
+
+The path class methods feature allows for calling the *_path and *_url
+methods directly on the class, as opposed to an instance of the class.
+
+In order for the *_url methods to be used, you must use the base_url
+configuration so that determining the base URL doesn't depend on the
+submitted request, as the request will not be set when using the
+class method. Failure to do this will probably result in a NoMethodError
+being raised.

data/doc/release_notes/2.11.0.txt

@@ -23,7 +23,7 @@
   block.  Previously, you could only call configuration methods in
   the block that added the feature, and enabling a feature in a
   block that was already enabled in a previous block did not allow
-  the use of configuraton methods related to the feature.
+  the use of configuration methods related to the feature.
 
 * Passing a block when loading the rodauth plugin is now optional.
 

data/doc/release_notes/2.12.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* The following configuration methods have been added to the
+  active_sessions feature:
+
+  * active_sessions_insert_hash
+  * active_sessions_key
+  * active_sessions_update_hash
+  * update_current_session?
+
+  These methods allow you to control what gets inserted and
+  updated into the active_sessions_table, and to control
+  whether to perform updates.
+
+= Other Improvements
+
+* A typo was fixed in the default unlock account email.

data/doc/release_notes/2.13.0.txt

@@ -0,0 +1,19 @@
+= New Features
+
+* A set_error_reason configuration method has been added.  This method
+  is called whenever a error occurs in Rodauth, with a symbol
+  describing the error.  The default implementation of this method does
+  nothing, it has been added to make it easier for Rodauth users to
+  implement custom handling for specific error types.  See the Rodauth
+  documentation for this method to see the list of symbols this method
+  can be called with.
+
+= Other Improvements
+
+* When using active_sessions and jwt_refresh together, and allowing for
+  expired JWTs when refreshing, you can now call
+  rodauth.check_active_session before r.rodauth.  Previously, this
+  did not work, and you had to call rodauth.check_active_session
+  after r.rodauth.
+
+* The default templates now also support Bootstrap 5.

data/doc/release_notes/2.14.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* A remembered_session_id method has been added for getting the
+  account id from a valid remember token, without modifying the
+  session to log the account in.
+
+= Other Improvements
+
+* The jwt_refresh feature's support for allowing refresh with
+  an expired access token now works even if the Rodauth
+  configuration uses an incorrect prefix.
+
+* The internal account_in_unverified_grace_period? method now
+  returns false if an account has not been loaded and the
+  session has not been logged in. Previously, calling this
+  method in such cases would result in an exception being
+  raised.

data/doc/release_notes/2.15.0.txt

@@ -0,0 +1,48 @@
+= New Features
+
+* An internal_request feature has been added.  This feature allows
+  for interacting with Rodauth by calling methods, instead of having
+  to use a website or JSON API.  This feature is designed primarily
+  for administrative use, so that administrators can create accounts,
+  change passwords or logins for accounts, and handle similar actions
+  without the user of the account being involved.
+
+  For example, assuming you've loaded the change_password and
+  internal_request features, and that your Roda class that
+  is loading Rodauth is named App, you can change the password
+  for the account with id 1 using:
+
+    App.rodauth.change_password(account_id: 1, password: 'foobar')
+
+  The internal request methods are implemented as class methods
+  on the Rodauth::Auth subclass (the object returned by App.rodauth).
+  These methods call methods on a subclass of that class specific
+  to internal requests.
+
+  The reason the feature is named internal_request is that these
+  methods are implemented by submitting a request internally, that is
+  processed almost exactly the same way as Rodauth would process a
+  web request.
+
+  See the internal_request feature documentation for details on which
+  internal request methods are available and the options they take.
+
+* A path_class_methods feature has been added, that allows for calling
+  *_path and *_url as class methods.  If you would like to call the
+  *_url methods as class methods, make sure to use the base_url
+  configuration method to set the base URL so that it does not require
+  request-specific information.
+
+* Rodauth::Auth classes now have a configuration_name method that
+  returns the configuration name associated with the class. They also
+  have a configuration method that returns the configuration
+  associated with the class.
+
+* Rodauth::Feature now supports an internal_request_method method for
+  specifying which methods are supported as internal request methods.
+
+= Other Improvements
+
+* The default base_url configuration method will now use the domain
+  method to get the domain to use, instead of getting the domain
+  information directly from the request environment.

data/doc/remember.rdoc

@@ -69,6 +69,7 @@ generate_remember_key_value :: A random string to use as the remember key.
 get_remember_key :: Retrieve the remember key from the database.
 load_memory :: If the remember key cookie is included in the request, and the user is not currently logged in, check the remember keys table and autologin the user if the remember key cookie matches the current remember key for the account. This method needs to be called manually inside the Roda route block to autologin users.
 logged_in_via_remember_key? :: Whether the current session was logged in via a remember key.
+remembered_session_id :: The session_id which is validly remembered, if any.
 remember_key_value :: The current value of the remember key/token.
 remember_login :: Set the cookie containing the remember token, so that future sessions will be autologged in.
 remember_view :: The HTML to use for the change remember settings form.

data/lib/rodauth.rb

@@ -39,11 +39,11 @@ module Rodauth
     else
       json_opt != :only
     end
-    auth_class = (app.opts[:rodauths] ||= {})[opts[:name]] ||= opts[:auth_class] || Class.new(Auth)
+    auth_class = (app.opts[:rodauths] ||= {})[opts[:name]] ||= opts[:auth_class] || Class.new(Auth){@configuration_name = opts[:name]}
     if !auth_class.roda_class
       auth_class.roda_class = app
     elsif auth_class.roda_class != app
-      auth_class = app.opts[:rodauths][opts[:name]] = Class.new(auth_class)
+      auth_class = app.opts[:rodauths][opts[:name]] = Class.new(auth_class){@configuration_name = opts[:name]}
       auth_class.roda_class = app
     end
     auth_class.configure(&block) if block
@@ -107,6 +107,7 @@ module Rodauth
     attr_accessor :dependencies
     attr_accessor :routes
     attr_accessor :configuration
+    attr_reader :internal_request_methods
 
     def route(name=feature_name, default=name.to_s.tr('_', '-'), &block)
       route_meth = :"#{name}_route"
@@ -152,6 +153,10 @@ module Rodauth
       FEATURES[name] = feature
     end
 
+    def internal_request_method(name=feature_name)
+      (@internal_request_methods ||= []) << name
+    end
+
     def configuration_module_eval(&block)
       configuration.module_eval(&block)
     end
@@ -260,6 +265,8 @@ module Rodauth
       attr_reader :features
       attr_reader :routes
       attr_accessor :route_hash
+      attr_reader :configuration_name
+      attr_reader :configuration
     end
 
     def self.inherited(subclass)

data/lib/rodauth/features/active_sessions.rb

@@ -19,7 +19,12 @@ module Rodauth
     auth_value_method :session_inactivity_deadline, 86400
     auth_value_method(:session_lifetime_deadline, 86400*30)
 
+    auth_value_methods :update_current_session?
+
     auth_methods(
+      :active_sessions_insert_hash,
+      :active_sessions_key,
+      :active_sessions_update_hash,
       :add_active_session,
       :currently_active_session?,
       :handle_duplicate_active_session_id,
@@ -36,8 +41,8 @@ module Rodauth
       ds = active_sessions_ds.
         where(active_sessions_session_id_column => compute_hmac(session_id))
 
-      if session_inactivity_deadline
-        ds.update(active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP) == 1
+      if update_current_session?
+        ds.update(active_sessions_update_hash) == 1
       else
         ds.count == 1
       end
@@ -52,16 +57,15 @@ module Rodauth
     def no_longer_active_session
       clear_session
       set_redirect_error_status inactive_session_error_status
+      set_error_reason :inactive_session
       set_redirect_error_flash active_sessions_error_flash
       redirect active_sessions_redirect
     end
 
     def add_active_session
-      key = random_key
+      key = generate_active_sessions_key
       set_session_value(session_id_session_key, key)
-      if e = raises_uniqueness_violation? do
-          active_sessions_ds.insert(active_sessions_account_id_column => session_value, active_sessions_session_id_column => compute_hmac(key))
-        end
+      if e = raises_uniqueness_violation?{active_sessions_ds.insert(active_sessions_insert_hash)}
         handle_duplicate_active_session_id(e)
       end
       nil
@@ -104,7 +108,7 @@ module Rodauth
     def after_refresh_token
       super if defined?(super)
       if prev_key = session[session_id_session_key]
-        key = random_key
+        key = generate_active_sessions_key
         set_session_value(session_id_session_key, key)
         active_sessions_ds.
           where(active_sessions_session_id_column => compute_hmac(prev_key)).
@@ -126,6 +130,20 @@ module Rodauth
       super
     end
 
+    attr_reader :active_sessions_key
+
+    def generate_active_sessions_key
+      @active_sessions_key = random_key
+    end
+
+    def active_sessions_insert_hash
+      {active_sessions_account_id_column => session_value, active_sessions_session_id_column => compute_hmac(active_sessions_key)}
+    end
+
+    def active_sessions_update_hash
+      {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
+    end
+
     def session_inactivity_deadline_condition
       if deadline = session_inactivity_deadline
         Sequel[active_sessions_last_use_column] < Sequel.date_sub(Sequel::CURRENT_TIMESTAMP, seconds: deadline)
@@ -145,6 +163,10 @@ module Rodauth
       Sequel.|(*[cond, cond2].compact)
     end
 
+    def update_current_session?
+      !!session_inactivity_deadline
+    end
+
     def active_sessions_ds
       db[active_sessions_table].
         where(active_sessions_account_id_column=>session_value)
@@ -155,4 +177,3 @@ module Rodauth
     end
   end
 end
-

data/lib/rodauth/features/base.rb

@@ -100,6 +100,7 @@ module Rodauth
       :set_notice_flash,
       :set_notice_now_flash,
       :set_redirect_error_flash,
+      :set_error_reason,
       :set_title,
       :translate,
       :update_session
@@ -114,6 +115,10 @@ module Rodauth
       :around_rodauth
     )
 
+    internal_request_method :account_exists?
+    internal_request_method :account_id_for_login
+    internal_request_method :internal_request_eval
+
     configuration_module_eval do
       def auth_class_eval(&block)
         auth.class_eval(&block)
@@ -294,6 +299,7 @@ module Rodauth
 
     def login_required
       set_redirect_error_status(login_required_error_status)
+      set_error_reason :login_required
       set_redirect_error_flash require_login_error_flash
       redirect require_login_redirect
     end
@@ -443,7 +449,9 @@ module Rodauth
     end
 
     def base_url
-      request.base_url
+      url = String.new("#{request.scheme}://#{domain}")
+      url << ":#{request.port}" if request.port != Rack::Request::DEFAULT_PORTS[request.scheme]
+      url
     end
 
     def domain
@@ -539,6 +547,11 @@ module Rodauth
     def set_response_error_status(status)
       response.status = status
     end
+    
+    def set_response_error_reason_status(reason, status)
+      set_error_reason(reason)
+      set_response_error_status(status)
+    end
 
     def throw_error(field, error)
       set_field_error(field, error)
@@ -550,6 +563,14 @@ module Rodauth
       throw_error(field, error)
     end
 
+    def set_error_reason(reason)
+    end
+
+    def throw_error_reason(reason, status, field, message)
+      set_error_reason(reason)
+      throw_error_status(status, field, message)
+    end
+
     def use_date_arithmetic?
       set_deadline_values?
     end
@@ -719,6 +740,10 @@ module Rodauth
       end
     end
 
+    def internal_request?
+      false
+    end
+
     def set_session_value(key, value)
       session[key] = value
     end

data/lib/rodauth/features/change_login.rb

@@ -19,6 +19,8 @@ module Rodauth
 
     auth_methods :change_login
 
+    internal_request_method
+
     route do |r|
       require_account
       before_change_login_route
@@ -30,7 +32,7 @@ module Rodauth
       r.post do
         catch_error do
           if change_login_requires_password? && !password_match?(param(password_param))
-            throw_error_status(invalid_password_error_status, password_param, invalid_password_message)
+            throw_error_reason(:invalid_password, invalid_password_error_status, password_param, invalid_password_message)
           end
 
           login = param(login_param)
@@ -39,7 +41,7 @@ module Rodauth
           end
 
           if require_login_confirmation? && login != param(login_confirm_param)
-            throw_error_status(unmatched_field_error_status, login_param, logins_do_not_match_message)
+            throw_error_reason(:logins_do_not_match, unmatched_field_error_status, login_param, logins_do_not_match_message)
           end
 
           transaction do
@@ -65,7 +67,7 @@ module Rodauth
 
     def change_login(login)
       if account_ds.get(login_column).downcase == login.downcase
-        @login_requirement_message = same_as_current_login_message
+        set_login_requirement_error_message(:same_as_current_login, same_as_current_login_message)
         return false
       end
 
@@ -82,7 +84,7 @@ module Rodauth
       updated = nil
       raised = raises_uniqueness_violation?{updated = update_account({login_column=>login}, account_ds.exclude(login_column=>login)) == 1}
       if raised
-        @login_requirement_message = already_an_account_with_this_login_message
+        set_login_requirement_error_message(:already_an_account_with_this_login, already_an_account_with_this_login_message)
       end
       updated && !raised
     end

data/lib/rodauth/features/change_password.rb

@@ -22,6 +22,8 @@ module Rodauth
       :invalid_previous_password_message
     )
 
+    internal_request_method
+
     route do |r|
       require_account
       before_change_password_route
@@ -33,16 +35,16 @@ module Rodauth
       r.post do
         catch_error do
           if change_password_requires_password? && !password_match?(param(password_param))
-            throw_error_status(invalid_password_error_status, password_param, invalid_previous_password_message)
+            throw_error_reason(:invalid_previous_password, invalid_password_error_status, password_param, invalid_previous_password_message)
           end
 
           password = param(new_password_param)
           if require_password_confirmation? && password != param(password_confirm_param)
-            throw_error_status(unmatched_field_error_status, new_password_param, passwords_do_not_match_message)
+            throw_error_reason(:passwords_do_not_match, unmatched_field_error_status, new_password_param, passwords_do_not_match_message)
           end
 
           if password_match?(password) 
-            throw_error_status(invalid_field_error_status, new_password_param, same_as_existing_password_message)
+            throw_error_reason(:same_as_existing_password, invalid_field_error_status, new_password_param, same_as_existing_password_message)
           end
 
           unless password_meets_requirements?(password)

data/lib/rodauth/features/close_account.rb

@@ -24,6 +24,8 @@ module Rodauth
       :delete_account
     )
 
+    internal_request_method
+
     route do |r|
       require_account
       before_close_account_route
@@ -35,7 +37,7 @@ module Rodauth
       r.post do
         catch_error do
           if close_account_requires_password? && !password_match?(param(password_param))
-            throw_error_status(invalid_password_error_status, password_param, invalid_password_message)
+            throw_error_reason(:invalid_password, invalid_password_error_status, password_param, invalid_password_message)
           end
 
           transaction do

data/lib/rodauth/features/confirm_password.rb

@@ -40,7 +40,7 @@ module Rodauth
           set_notice_flash confirm_password_notice_flash
           redirect confirm_password_redirect
         else
-          set_response_error_status(invalid_password_error_status)
+          set_response_error_reason_status(:invalid_password, invalid_password_error_status)
           set_field_error(password_param, invalid_password_message)
           set_error_flash confirm_password_error_flash
           confirm_password_view
@@ -53,6 +53,7 @@ module Rodauth
 
       if require_password_authentication? && has_password?
         set_redirect_error_status(password_authentication_required_error_status)
+        set_error_reason :password_authentication_required
         set_redirect_error_flash password_authentication_required_error_flash
         set_session_value(confirm_password_redirect_session_key, request.fullpath)
         redirect password_authentication_required_redirect
@@ -89,4 +90,3 @@ module Rodauth
     end
   end
 end
-