booth 0.0.1 → 0.0.2

data/lib/booth/userland/webauths/transitions/sudo/authentication_verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Booth
   module Userland
     module Webauths
@@ -7,7 +9,7 @@ module Booth
             include ::Booth::Concerns::Transition
 
             def self.applicable?(params:)
-              params.dig(:webauth, :rawId)
+              params.dig(:handshake, :rawId)
             end
 
             def call
@@ -20,7 +22,7 @@ module Booth
             private
 
             def do_verify_response
-              ::Booth::Webauth::AuthenticationVerification.call(
+              ::Booth::Core::Webauth::AuthenticationVerification.call(
                 request:,
                 credential_id: request.authentication.credential_id,
                 challenge: request.sudo.webauthn_challenge

data/lib/booth/userland.rb

@@ -1,167 +1,109 @@
+# frozen_string_literal: true
+
 module Booth
+  # This module handles user credentials and sessions.
+  # Use the class methods defined on this module in your Controllers.
+  #
+  # "Userland" indicates, that it is safe to expose these actions to the public.
+  # There are no administrative functions here (such as manually creating a new user would be).
+  # Those administrative things you would find in the "Adminland" namespace.
+  #
   module Userland
     def self.routes(...)
       ::Booth::Routes::Userland.call(...)
     end
 
+    # --------------------
+    # Registration Actions
+    # --------------------
+
+    def self.new_registration(...)
+      ::Booth::Userland::Registrations::New.call(...)
+    end
+
+    def self.create_registration(...)
+      ::Booth::Userland::Registrations::Create.call(...)
+    end
+
     # -------------
     # Login Actions
     # -------------
 
+    # Show a login form.
     def self.new_login(...)
       ::Booth::Userland::Logins::New.call(...)
     end
 
+    # Handle submitted login form data.
     def self.create_login(...)
       ::Booth::Userland::Logins::Create.call(...)
     end
 
+    # Logout a user.
     def self.destroy_login(...)
       ::Booth::Userland::Logins::Destroy.call(...)
     end
 
-    # ------------------
-    # Onboarding Actions
-    # ------------------
-
-    def self.show_onboarding(...)
-      ::Booth::Userland::Onboardings::Show.call(...)
-    end
-
-    def self.update_onboarding(...)
-      ::Booth::Userland::Onboardings::Update.call(...)
-    end
-
-    # Otp Actions
-
-    def self.show_otp(...)
-      ::Booth::Userland::Otps::Show.call(...)
-    end
-
-    def self.sudo_otp(...)
-      ::Booth::Userland::Otps::Sudo.call(...)
-    end
-
-    def self.edit_otp(...)
-      ::Booth::Userland::Otps::Edit.call(...)
-    end
-
-    def self.update_otp(...)
-      ::Booth::Userland::Otps::Update.call(...)
-    end
-
-    def self.destroy_otp(...)
-      ::Booth::Userland::Otps::Destroy.call(...)
-    end
-
-    # Password Actions
-
-    def self.show_password(...)
-      ::Booth::Userland::Passwords::Show.call(...)
-    end
-
-    def self.sudo_password(...)
-      ::Booth::Userland::Passwords::Sudo.call(...)
-    end
-
-    def self.edit_password(...)
-      ::Booth::Userland::Passwords::Edit.call(...)
-    end
-
-    def self.update_password(...)
-      ::Booth::Userland::Passwords::Update.call(...)
-    end
-
-    # GET `remove` is paired with POST `destroy``.
-    def self.remove_password(...)
-      ::Booth::Userland::Passwords::Remove.call(...)
-    end
-
-    def self.destroy_password(...)
-      ::Booth::Userland::Passwords::Destroy.call(...)
-    end
-
+    # ---------------
     # Webauth Actions
+    # ---------------
 
+    # List a user's currently configured Passkeys.
     def self.index_webauth(...)
       ::Booth::Userland::Webauths::Index.call(...)
     end
 
+    # Re-checks a user's Passkey for (temporarily elevated) authentication.
+    # I.e. proof that a user knows his Passkey, before allowing to change it.
     def self.sudo_webauth(...)
       ::Booth::Userland::Webauths::Sudo.call(...)
     end
 
+    # Show a form to add a Passkey.
     def self.new_webauth(...)
       ::Booth::Userland::Webauths::New.call(...)
     end
 
+    # Receive form data and create the Passkey.
     def self.create_webauth(...)
       ::Booth::Userland::Webauths::Create.call(...)
     end
 
+    # Remove a user's configured Passkey.
     def self.destroy_webauth(...)
       ::Booth::Userland::Webauths::Destroy.call(...)
     end
 
-    # Webauth Helpers
-
-    # def self.should_add_more_authenticators?(...)
-    #   ::Booth::Userland::Webauths::ShouldAddMoreAuthenticators.call(...)
-    # end
-
-    # def self.only_one_passwordless_authenticator?(...)
-    #   index_webauth(...).authenticators.select(&:supports_user_verification?).size == 1
-    # end
-
-    # Personal Contest Actions
-
-    def self.show_personal_contest(...)
-      ::Booth::Userland::PersonalContests::Show.call(...)
-    end
-
-    def self.update_personal_contest(...)
-      ::Booth::Userland::PersonalContests::Update.call(...)
-    end
-
-    # Password Reset Actions
-
-    def self.new_password_reset(...)
-      ::Booth::Userland::PasswordResets::New.call(...)
-    end
-
-    def self.create_password_reset(...)
-      ::Booth::Userland::PasswordResets::Create.call(...)
-    end
-
-    def self.show_password_reset(...)
-      ::Booth::Userland::PasswordResets::Show.call(...)
-    end
-
-    def self.update_password_reset(...)
-      ::Booth::Userland::PasswordResets::Update.call(...)
-    end
-
-    # Recovery Actions
+    # --------------
+    # Onboarding Actions
+    # --------------
 
-    def self.new_recovery(...)
-      ::Booth::Userland::Recoveries::New.call(...)
+    def self.show_onboarding(...)
+      ::Booth::Userland::Onboardings::Show.call(...)
     end
 
-    def self.create_recovery(...)
-      ::Booth::Userland::Recoveries::Create.call(...)
+    def self.update_onboarding(...)
+      ::Booth::Userland::Onboardings::Update.call(...)
     end
 
-    # Registration Actions
+    # --------------------
+    # Remote Login Actions
+    # --------------------
 
-    def self.new_registration(...)
-      ::Booth::Userland::Registrations::New.call(...)
+    # Show a code to the user for logging in somewhere else.
+    # Specifically, shows the code and the form to enter the manually type in the code.
+    def self.show_remote_login(...)
+      ::Booth::Userland::Remotes::Show.call(...)
     end
 
-    def self.create_registration(...)
-      ::Booth::Userland::Registrations::Create.call(...)
+    # Receives the entered code for logging in a remote.
+    def self.update_remote_login(...)
+      ::Booth::Userland::Remotes::Update.call(...)
     end
 
+    # ---------------
     # Session Actions
+    # ---------------
 
     def self.index_sessions(...)
       ::Booth::Userland::Sessions::Index.call(...)
@@ -183,7 +125,9 @@ module Booth
       ::Booth::Userland::Sessions::DestroyOneOrOther.call(...)
     end
 
+    # ---------------
     # General Helpers
+    # ---------------
 
     def self.extract_flash_messages(...)
       ::Booth::Userland::ExtractFlashMessages.call(...)

data/lib/booth/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Booth
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'
 end

data/lib/booth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ------------
 # Dependencies
 # ------------
@@ -8,18 +10,17 @@ require 'active_record'
 require 'active_support'
 
 # Gems
-require 'active_model_otp'
 require 'browser'
+require 'calls'
 require 'dry-initializer'
 require 'i18n'
-require 'pwned'
+require 'importmap-rails'
+require 'paint'
 require 'rqrcode'
 require 'tron'
 require 'warden'
 require 'webauthn'
 
-require_relative 'booth/method_object' # Extracted from a gem
-
 # -----
 # BOOTH
 # -----
@@ -29,239 +30,8 @@ require 'generators/booth/migration/migration_generator'
 
 # Global
 require_relative 'booth/logging'
-require_relative 'booth/logger'
-require_relative 'booth/errors'
 require_relative 'booth/configuration'
 require_relative 'booth/configure'
-require_relative 'booth/engine'
-
-# Syntax Checkers
-require_relative 'booth/syntaxes/contest_code'
-require_relative 'booth/syntaxes/email'
-require_relative 'booth/syntaxes/ip'
-require_relative 'booth/syntaxes/otp'
-require_relative 'booth/syntaxes/scope'
-require_relative 'booth/syntaxes/scope_comparison'
-require_relative 'booth/syntaxes/secret_key'
-require_relative 'booth/syntaxes/username'
-require_relative 'booth/syntaxes/uuid'
-
-# Helpers
-require_relative 'booth/concerns/action'
-require_relative 'booth/concerns/transition'
-require_relative 'booth/geolocation'
 require_relative 'booth/request'
-require_relative 'booth/routes/userland'
-require_relative 'booth/to_struct'
-require_relative 'booth/mode'
-require_relative 'booth/modes/base'
-require_relative 'booth/modes/username_and_password'
-require_relative 'booth/modes/username_and_webauth'
-require_relative 'booth/modes/username_password_and_otp'
-require_relative 'booth/modes/username_password_and_webauth'
-
-# Model dependencies
-require_relative 'booth/models/contests/scopes/recently_created'
-require_relative 'booth/models/contests/scopes/recently_responded'
 
-# Models
-require_relative 'booth/models/application_record'
-require_relative 'booth/models/audit'
-require_relative 'booth/models/authenticator'
-require_relative 'booth/models/concerns/modeable'
-require_relative 'booth/models/concerns/otpable'
-require_relative 'booth/models/concerns/passwordable'
-require_relative 'booth/models/contest'
-require_relative 'booth/models/credential'
-require_relative 'booth/models/onboarding'
-require_relative 'booth/models/password_reset'
-require_relative 'booth/models/recovery'
-require_relative 'booth/models/session'
-require_relative 'booth/models/user_agent'
-
-# Services
-require_relative 'booth/audits/register/added_otp'
-require_relative 'booth/audits/register/changed_otp'
-require_relative 'booth/audits/register/completed_onboarding'
-require_relative 'booth/audits/register/correct_otp'
-require_relative 'booth/audits/register/correct_password'
-require_relative 'booth/audits/register/requested_password_reset'
-require_relative 'booth/audits/register/logout'
-require_relative 'booth/audits/register/wrong_otp'
-require_relative 'booth/audits/register/wrong_password'
-require_relative 'booth/authenticators/confirm'
-require_relative 'booth/authenticators/credential_mode_after_confirmation'
-require_relative 'booth/authenticators/step'
-require_relative 'booth/contests/get'
-require_relative 'booth/contests/respond'
-require_relative 'booth/contests/set_for_login'
-require_relative 'booth/cooldowns/distance_of_time'
-require_relative 'booth/cooldowns/otp'
-require_relative 'booth/cooldowns/password'
-require_relative 'booth/cooldowns/password_reset'
-require_relative 'booth/cooldowns/strategies/exponential'
-require_relative 'booth/cooldowns/strategies/global'
-require_relative 'booth/cooldowns/strategies/result'
-require_relative 'booth/credentials/create_with_onboarding'
-require_relative 'booth/credentials/create'
-require_relative 'booth/credentials/find_by_username'
-require_relative 'booth/credentials/mode'
-require_relative 'booth/credentials/modes/otp_addable'
-require_relative 'booth/credentials/modes/otp_changeable'
-require_relative 'booth/credentials/modes/otp_manageable'
-require_relative 'booth/credentials/modes/otp_removable'
-require_relative 'booth/credentials/modes/password_addable'
-require_relative 'booth/credentials/modes/password_changeable'
-require_relative 'booth/credentials/modes/password_manageable'
-require_relative 'booth/credentials/modes/password_removable'
-require_relative 'booth/credentials/modes/webauth_addable'
-require_relative 'booth/credentials/modes/webauth_removable'
-require_relative 'booth/credentials/modes/webauth_manageable'
-require_relative 'booth/credentials/otp_authentication'
-require_relative 'booth/credentials/password_authentication'
-require_relative 'booth/credentials/webauth_challenge'
-require_relative 'booth/hooks/after_fetch'
-require_relative 'booth/hooks/before_logout'
-require_relative 'booth/hooks/serialize_from_session'
-require_relative 'booth/hooks/serialize_into_session'
-require_relative 'booth/onboardings/find'
-require_relative 'booth/onboardings/propagate_to_credential'
-require_relative 'booth/onboardings/step'
-require_relative 'booth/password_resets/create'
-require_relative 'booth/password_resets/find'
-require_relative 'booth/password_resets/propagate_to_credential'
-require_relative 'booth/password_resets/step'
-require_relative 'booth/recoveries/create'
-require_relative 'booth/requests/agent'
-require_relative 'booth/requests/authentication'
-require_relative 'booth/requests/ip'
-require_relative 'booth/requests/return_path'
-require_relative 'booth/requests/session'
-require_relative 'booth/requests/storage'
-require_relative 'booth/requests/storages/login'
-require_relative 'booth/requests/storages/otp'
-require_relative 'booth/requests/storages/password_reset'
-require_relative 'booth/requests/storages/password'
-require_relative 'booth/requests/storages/recovery'
-require_relative 'booth/requests/storages/registration'
-require_relative 'booth/requests/storages/webauth'
-require_relative 'booth/requests/sudo'
-require_relative 'booth/sessions/create_and_login'
-require_relative 'booth/sessions/historical_locations'
-require_relative 'booth/sessions/index'
-require_relative 'booth/sessions/revoke_all_others'
-require_relative 'booth/sessions/revoke'
-require_relative 'booth/sessions/to_passport'
-require_relative 'booth/webauth/authentication_verification'
-require_relative 'booth/webauth/demand_user_verification'
-require_relative 'booth/webauth/options_for_create'
-require_relative 'booth/webauth/options_for_get'
-
-# Userland Transitions
-require_relative 'booth/userland/logins/transitions/create/choose_username'
-require_relative 'booth/userland/logins/transitions/create/enter_otp'
-require_relative 'booth/userland/logins/transitions/create/skip_remotes'
-require_relative 'booth/userland/logins/transitions/create/verify_password'
-require_relative 'booth/userland/logins/transitions/create/webauth_authentication_initiation'
-require_relative 'booth/userland/logins/transitions/create/webauth_authentication_verification'
-require_relative 'booth/userland/logins/transitions/new/fallible' # Concern, needs to come first
-require_relative 'booth/userland/logins/transitions/new/already_logged_in'
-require_relative 'booth/userland/logins/transitions/new/mode_first_time'
-require_relative 'booth/userland/logins/transitions/new/mode_username_and_password'
-require_relative 'booth/userland/logins/transitions/new/mode_username_and_webauth'
-require_relative 'booth/userland/logins/transitions/new/mode_username_password_and_otp'
-require_relative 'booth/userland/logins/transitions/new/mode_username_password_and_webauth'
-require_relative 'booth/userland/logins/transitions/new/no_username_chosen'
-require_relative 'booth/userland/logins/transitions/new/remote_session_available'
-require_relative 'booth/userland/logins/transitions/new/timed_out'
-require_relative 'booth/userland/onboardings/transitions/update/choose_mode'
-require_relative 'booth/userland/onboardings/transitions/update/choose_password'
-require_relative 'booth/userland/onboardings/transitions/update/choose_webauth_nickname'
-require_relative 'booth/userland/onboardings/transitions/update/confirm_otp'
-require_relative 'booth/userland/onboardings/transitions/update/confirm_password'
-require_relative 'booth/userland/onboardings/transitions/update/register_otp'
-require_relative 'booth/userland/onboardings/transitions/update/reset_otp'
-require_relative 'booth/userland/onboardings/transitions/update/reset_password'
-require_relative 'booth/userland/onboardings/transitions/update/reset_webauth'
-require_relative 'booth/userland/onboardings/transitions/update/webauth_authentication_initiation'
-require_relative 'booth/userland/onboardings/transitions/update/webauth_authentication_verification'
-require_relative 'booth/userland/onboardings/transitions/update/webauth_registration_initiation'
-require_relative 'booth/userland/onboardings/transitions/update/webauth_registration_verification'
-require_relative 'booth/userland/otps/guards/manageable'
-require_relative 'booth/userland/otps/guards/sudo'
-require_relative 'booth/userland/otps/transitions/update/confirm'
-require_relative 'booth/userland/otps/transitions/update/register'
-require_relative 'booth/userland/otps/transitions/update/reset'
-require_relative 'booth/userland/password_resets/guards/logged_out'
-require_relative 'booth/userland/password_resets/transitions/update/choose_password'
-require_relative 'booth/userland/password_resets/transitions/update/confirm_password'
-require_relative 'booth/userland/password_resets/transitions/update/reset_password'
-require_relative 'booth/userland/passwords/guards/manageable'
-require_relative 'booth/userland/passwords/guards/removable'
-require_relative 'booth/userland/passwords/guards/sudo'
-require_relative 'booth/userland/passwords/transitions/remove/step'
-require_relative 'booth/userland/passwords/transitions/update/choose_password'
-require_relative 'booth/userland/passwords/transitions/update/confirm_password'
-require_relative 'booth/userland/sessions/transitions/destroy/enter_password'
-require_relative 'booth/userland/sessions/transitions/destroy/enter_webauth'
-require_relative 'booth/userland/sessions/transitions/destroy/verify_password'
-require_relative 'booth/userland/sessions/transitions/destroy/webauth_authentication_initiation'
-require_relative 'booth/userland/sessions/transitions/destroy/webauth_authentication_verification'
-require_relative 'booth/userland/sessions/transitions/show/enter_webauth'
-require_relative 'booth/userland/webauths/transitions/create/authentication_initiation'
-require_relative 'booth/userland/webauths/transitions/create/authentication_verification'
-require_relative 'booth/userland/webauths/transitions/create/choose_nickname'
-require_relative 'booth/userland/webauths/transitions/create/registration_initiation'
-require_relative 'booth/userland/webauths/transitions/create/registration_verification'
-require_relative 'booth/userland/webauths/transitions/create/reset'
-require_relative 'booth/userland/webauths/transitions/sudo/authentication_initiation'
-require_relative 'booth/userland/webauths/transitions/sudo/authentication_verification'
-
-# Userland Actions
-require_relative 'booth/userland'
-require_relative 'booth/userland/extract_flash_messages'
-require_relative 'booth/userland/logins/create'
-require_relative 'booth/userland/logins/destroy'
-require_relative 'booth/userland/logins/new'
-require_relative 'booth/userland/onboardings/show'
-require_relative 'booth/userland/onboardings/update'
-require_relative 'booth/userland/otps/destroy'
-require_relative 'booth/userland/otps/edit'
-require_relative 'booth/userland/otps/show'
-require_relative 'booth/userland/otps/sudo'
-require_relative 'booth/userland/otps/update'
-require_relative 'booth/userland/password_resets/create'
-require_relative 'booth/userland/password_resets/new'
-require_relative 'booth/userland/password_resets/show'
-require_relative 'booth/userland/password_resets/update'
-require_relative 'booth/userland/passwords/destroy'
-require_relative 'booth/userland/passwords/edit'
-require_relative 'booth/userland/passwords/remove'
-require_relative 'booth/userland/passwords/show'
-require_relative 'booth/userland/passwords/sudo'
-require_relative 'booth/userland/passwords/update'
-require_relative 'booth/userland/personal_contests/show'
-require_relative 'booth/userland/personal_contests/update'
-require_relative 'booth/userland/recoveries/create'
-require_relative 'booth/userland/recoveries/new'
-require_relative 'booth/userland/registrations/create'
-require_relative 'booth/userland/registrations/new'
-require_relative 'booth/userland/sessions/destroy_one_or_other'
-require_relative 'booth/userland/sessions/index'
-require_relative 'booth/userland/sessions/show'
-require_relative 'booth/userland/webauths/create'
-require_relative 'booth/userland/webauths/destroy'
-require_relative 'booth/userland/webauths/guards/manageable'
-require_relative 'booth/userland/webauths/guards/sudo'
-require_relative 'booth/userland/webauths/index'
-require_relative 'booth/userland/webauths/new'
-require_relative 'booth/userland/webauths/sudo'
-
-# Adminland Helpers
-require_relative 'booth/adminland'
-require_relative 'booth/adminland/recoveries/consume'
-require_relative 'booth/adminland/credentials/create'
-require_relative 'booth/adminland/onboardings/create'
-require_relative 'booth/adminland/onboardings/destroy'
-require_relative 'booth/adminland/onboardings/find'
-require_relative 'booth/adminland/onboardings/index'
+require_relative 'booth/engine'

data/lib/generators/booth/migration/migration_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
@@ -16,7 +18,6 @@ module Booth
       end
 
       def copy_migrations
-        migration_template 'create_booth_mode_types.erb', 'db/migrate/create_booth_mode_types.rb'
         migration_template 'create_booth_tables.erb', 'db/migrate/create_booth_tables.rb'
         migration_template 'add_credential_to_users.erb', 'db/migrate/add_credential_to_users.rb'
       end

data/lib/generators/booth/migration/templates/add_credential_to_users.erb

@@ -1,13 +1,15 @@
 class AddCredentialToUsers < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     # Booth assumes that you already have one or more tables for your users.
+    # Most likely one for admins and one for normal users.
 
     # Add a column to your users table holding a reference to the `booth_credentials` table.
     # Every user record belongs to one corresponding credential record.
-    # If your table is not called "users", you'll of course have to modify the table name below.
-    add_column :users, :credential_id, :uuid
-    add_index :users, :credential_id, unique: true
-    add_foreign_key :users, :booth_credentials, column: :credential_id, on_delete: :nullify
+
+    # If your table is not called "customers", you'll of course have to modify the table name below.
+    add_column :customers, :credential_id, :uuid
+    add_index :customers, :credential_id, unique: true
+    add_foreign_key :customers, :booth_credentials, column: :credential_id, on_delete: :nullify
 
     # If you have multiple, separate user tables, add a reference to them as well.
     # By the way, feel free to rename the column. It is yours.