diff --git a/README.md b/README.md index 4d7e893..c5f9563 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ Each person has a role on each aircraft, and a role is a set of permissions (`ap | Correct or delete any flight, imports, exports, restore from history | | | | ✓ | | Edit or delete the aircraft, manage people and share links | | | | ✓ | -Owner always has every permission. Only an Owner can give the Owner role, nobody changes their own, and every aircraft keeps an Owner. Administrators can do everything on every aircraft and manage users, roles, component types, airports, templates, settings, off-site backup, procedures and audits. Anyone can create an aircraft and becomes its Owner. Controllers declare the permission each action needs (`requires_permission`); a write with none declared is refused. +Owner always has every permission. Only an Owner can give the Owner role, nobody changes their own, and every aircraft keeps an Owner. Administrators can do everything on every aircraft and manage users, roles, component types, airports, templates, settings, off-site backup, procedures and audits. Whoever adds an aircraft becomes its Owner (who can add aircraft is an admin setting: administrators only by default). Controllers declare the permission each action needs (`requires_permission`); a write with none declared is refused. Users who aren't on an aircraft get a 404 for it, identical to a missing record. @@ -202,7 +202,7 @@ Users who aren't on an aircraft get a 404 for it, identical to a missing record. Differences from the original: - Integer primary keys instead of UUIDs. Share tokens are 32-character random strings. - Logbook entries and inspection records don't keep many-to-many links to components. An inspection record or AD compliance can reference one component. -- Accounts are created only by an admin, by the first-run setup, by someone opening an admin's invitation link (with a password, or SSO), or at first SSO sign-in when `OIDC_AUTO_CREATE_USERS` is on. Invitations from an aircraft's Access page and signing invitations are for existing accounts. +- Accounts are created only by an admin, by the first-run setup, by someone opening an admin's invitation link (with a password, or SSO), by an outside mechanic from an Owner's signing invitation (for its address), or at first SSO sign-in when `OIDC_AUTO_CREATE_USERS` is on. Invitations from an aircraft's Access page are for existing accounts. Who can add aircraft, and so become an Owner, is an admin setting (administrators only by default). ### Not yet ported diff --git a/app/controllers/admin/settings_controller.rb b/app/controllers/admin/settings_controller.rb index a595519..20517fe 100644 --- a/app/controllers/admin/settings_controller.rb +++ b/app/controllers/admin/settings_controller.rb @@ -2,18 +2,18 @@ class Admin::SettingsController < ApplicationController before_action :require_admin! def edit - @values = %w[max_upload_mb backups_kept offsite_backups_kept documents_claude_text].index_with { Setting.integer(_1) } + @values = %w[max_upload_mb backups_kept offsite_backups_kept documents_claude_text anyone_adds_aircraft].index_with { Setting.integer(_1) } end def update - submitted = params.fetch(:settings, {}).permit(:max_upload_mb, :backups_kept, :offsite_backups_kept, :documents_claude_text).to_h + submitted = params.fetch(:settings, {}).permit(:max_upload_mb, :backups_kept, :offsite_backups_kept, :documents_claude_text, :anyone_adds_aircraft).to_h records = Setting.update_integers(submitted) @errors = records.flat_map { _1.errors.full_messages } if @errors.empty? Rails.logger.info("[settings] #{current_user.email_address} changed #{submitted.inspect}") redirect_to edit_admin_settings_path, notice: t("flash.admin_settings.settings_saved") else - @values = %w[max_upload_mb backups_kept offsite_backups_kept documents_claude_text].index_with { Setting.integer(_1) }.merge(submitted) + @values = %w[max_upload_mb backups_kept offsite_backups_kept documents_claude_text anyone_adds_aircraft].index_with { Setting.integer(_1) }.merge(submitted) render :edit, status: :unprocessable_entity end end diff --git a/app/controllers/aircraft_controller.rb b/app/controllers/aircraft_controller.rb index 6851a55..0dc25cc 100644 --- a/app/controllers/aircraft_controller.rb +++ b/app/controllers/aircraft_controller.rb @@ -1,6 +1,7 @@ class AircraftController < ApplicationController include AircraftScoped skip_before_action :set_aircraft, :authorize_permission!, only: %i[index new create] + before_action :require_aircraft_adder!, only: %i[new create] requires_permission :edit_aircraft, only: %i[edit update] requires_permission :delete_aircraft, only: :destroy requires_permission :update_hours, only: :update_hours diff --git a/app/controllers/aircraft_imports_controller.rb b/app/controllers/aircraft_imports_controller.rb index 33fe850..6eb72d2 100644 --- a/app/controllers/aircraft_imports_controller.rb +++ b/app/controllers/aircraft_imports_controller.rb @@ -2,6 +2,7 @@ # create an aircraft with all its records. The archive is checked right away; # the import itself runs in the background (AircraftImportJob). class AircraftImportsController < ApplicationController + before_action :require_aircraft_adder!, only: %i[new create] before_action :set_import, only: :show def new; end diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index c5c08bb..d28aa1a 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -44,6 +44,11 @@ class ApplicationController < ActionController::Base redirect_to new_setup_path if !User.exists? && !is_a?(SetupController) end + # Adding or importing an aircraft (User#can_add_aircraft?). + def require_aircraft_adder! + redirect_to root_path, alert: t("flash.aircraft.ask_an_administrator") unless current_user.can_add_aircraft? + end + def require_admin! redirect_to root_path, alert: t("flash.application.admins_only") unless current_user&.admin? end diff --git a/app/controllers/invited_signings_controller.rb b/app/controllers/invited_signings_controller.rb index 7d02bae..6457eed 100644 --- a/app/controllers/invited_signings_controller.rb +++ b/app/controllers/invited_signings_controller.rb @@ -1,17 +1,19 @@ -# The invited signer's side: sign in with their account for the invited -# address, add a certificate if needed, review the entry and sign it. The -# invitation gives access to that one entry only. It doesn't make accounts: -# only an administrator (or an administrator's invitation) does. +# The invited signer's side: sign in (or, from an Owner's invitation, create an +# account for the invited address: SigningInvitation#creates_account?), add a +# certificate if needed, review the entry and sign it. The invitation gives +# access to that one entry only. class InvitedSigningsController < ApplicationController include EntrySigning - allow_unauthenticated_access only: :show + allow_unauthenticated_access only: %i[show account] before_action :set_invitation + rate_limit to: 10, within: 15.minutes, only: :account, with: -> { redirect_to new_session_path, alert: t("flash.invited_signings.try_again_later") } def show @entry = @invitation.logbook_entry @aircraft = @entry.aircraft unless authenticated? session[:return_to_after_authenticating] = request.url + session[:signing_token] = params[:token] # for an account made by signing in with SSO return render(:welcome) end return render(:wrong_account) unless current_user.email_address == @invitation.email @@ -20,6 +22,24 @@ class InvitedSigningsController < ApplicationController render :new end + # Creating an account for the invited email address (an Owner's invitation). + def account + return redirect_to(invited_signing_path(params[:token])) if authenticated? + if User.exists?(email_address: @invitation.email) || !Sso.password_login? || !@invitation.creates_account? + return redirect_to invited_signing_path(params[:token]), alert: t("flash.invited_signings.sign_in_to_continue") + end + user = User.new(params.permit(:name, :password, :password_confirmation).merge(email_address: @invitation.email)) + if user.save + reset_session + start_new_session_for user + redirect_to invited_signing_path(params[:token]), notice: t("flash.invited_signings.account_created_add_your") + else + @entry = @invitation.logbook_entry + @account_errors = user.errors.full_messages + render :welcome, status: :unprocessable_entity + end + end + def create @entry = @invitation.logbook_entry @aircraft = @entry.aircraft diff --git a/app/controllers/signing_invitations_controller.rb b/app/controllers/signing_invitations_controller.rb index 3c25f66..a7fbdef 100644 --- a/app/controllers/signing_invitations_controller.rb +++ b/app/controllers/signing_invitations_controller.rb @@ -23,7 +23,7 @@ class SigningInvitationsController < ApplicationController end log_event("logbook", t("flash.signing_invitations.signature_requested_from_entry", email: @invitation.email, date: l(@entry.date, format: :app))) notice = t("flash.signing_invitations.invitation_sent_to_the", email: @invitation.email, days: SigningInvitation::VALID_FOR.in_days.to_i) - notice = "#{notice} #{t('flash.signing_invitations.no_account_yet')}" unless invitee + notice = "#{notice} #{t('flash.signing_invitations.no_account_yet')}" unless invitee || @invitation.creates_account? redirect_to aircraft_logbook_entry_path(@aircraft, @entry), notice: notice else render :new, status: :unprocessable_entity diff --git a/app/controllers/sso_controller.rb b/app/controllers/sso_controller.rb index 74d6228..351f286 100644 --- a/app/controllers/sso_controller.rb +++ b/app/controllers/sso_controller.rb @@ -7,9 +7,10 @@ # users edit their email. Otherwise, sign in with a password once and link # from the profile page. # -# Someone without an account gets one only from an administrator's -# invitation they opened first (AccessInvitation, accepted at once), or for -# anyone the provider lets in when OIDC_AUTO_CREATE_USERS is on. +# Someone without an account gets one only from an invitation they opened +# first that can make one (an administrator's AccessInvitation, accepted at +# once; an Owner's SigningInvitation, for its address), or for anyone the +# provider lets in when OIDC_AUTO_CREATE_USERS is on. class SsoController < ApplicationController allow_unauthenticated_access only: %i[callback failure] before_action :require_sso @@ -89,7 +90,7 @@ class SsoController < ApplicationController email = auth.info&.email.to_s.strip.downcase return if email.blank? || User.exists?(email_address: email) invitation = invitation_making_account(email) - return unless invitation || Sso.auto_create_users? + return unless invitation || signing_invitation_making_account?(email) || Sso.auto_create_users? User.transaction do # The random password is never shown; a password reset can set a real one. user = User.create!(email_address: email, name: auth.info&.name.presence, sso_uid: auth.uid, password: SecureRandom.base58(40)) @@ -100,6 +101,13 @@ class SsoController < ApplicationController nil end + # A signing invitation opened in this browser before signing in, from an + # Owner, for this email address. + def signing_invitation_making_account?(email) + invitation = SigningInvitation.find_usable(session[:signing_token]) + invitation.present? && invitation.creates_account? && invitation.email == email + end + # The invitation opened in this browser before signing in, when it can # make an account (an administrator's) for this email address. def invitation_making_account(email) diff --git a/app/models/setting.rb b/app/models/setting.rb index 9311b84..1598c64 100644 --- a/app/models/setting.rb +++ b/app/models/setting.rb @@ -10,6 +10,9 @@ class Setting < ApplicationRecord "backups_kept" => { default: 14, in: 1..365 }, "offsite_backups_kept" => { default: 30, in: 1..365 }, "documents_claude_text" => { default: 0, in: 0..1 }, + # Who can add aircraft (and so become an Owner, who invites people): 0 + # administrators only, 1 everyone. + "anyone_adds_aircraft" => { default: 0, in: 0..1 }, "logbook_templates_seeded" => { default: 0, in: 0..1 } # internal flag }.freeze LABELS = LabelSet.new("setting.keys", INTEGERS.keys) @@ -20,6 +23,7 @@ class Setting < ApplicationRecord class << self def max_upload_mb = integer("max_upload_mb") def max_upload_bytes = max_upload_mb.megabytes + def anyone_adds_aircraft? = integer("anyone_adds_aircraft") == 1 def integer(key) definition = INTEGERS.fetch(key) diff --git a/app/models/signing_invitation.rb b/app/models/signing_invitation.rb index c0f57ad..9f53eb7 100644 --- a/app/models/signing_invitation.rb +++ b/app/models/signing_invitation.rb @@ -22,4 +22,12 @@ class SigningInvitation < ApplicationRecord def self.find_usable(token) = where(token_digest: digest(token), used_at: nil).where("expires_at > ?", Time.current).first def aircraft = logbook_entry.aircraft + + # Whether the mechanic can make an account for the invited address with it: + # when it's from an Owner of the aircraft or an administrator (still, when + # it's used). Who can become an Owner is up to the administrator (Admin → + # Settings, who can add aircraft); others' invitations need an account. + def creates_account? + invited_by.present? && !invited_by.disabled? && (invited_by.admin? || invited_by.role_for(aircraft)&.owner?) || false + end end diff --git a/app/models/user.rb b/app/models/user.rb index 0f10089..9bc5979 100644 --- a/app/models/user.rb +++ b/app/models/user.rb @@ -121,6 +121,10 @@ class User < ApplicationRecord aircraft_roles.includes(:role).find_by(aircraft: aircraft)&.role end + # Adding an aircraft (or importing one) makes you its Owner: administrators, + # or everyone when Admin → Settings allows it. + def can_add_aircraft? = admin? || Setting.anyone_adds_aircraft? + # Administrators can do everything on every aircraft. def can?(permission, aircraft) admin? || role_for(aircraft)&.can?(permission) || false diff --git a/app/views/admin/settings/edit.html.erb b/app/views/admin/settings/edit.html.erb index f3545c2..f5f1b73 100644 --- a/app/views/admin/settings/edit.html.erb +++ b/app/views/admin/settings/edit.html.erb @@ -38,6 +38,14 @@
<%= t(".with_off_site_backup_to") %>
+<%= t(".who_can_add_aircraft_hint") %>
+<%= t(".no_aircraft_yet") %>
-<%= link_to t(".add_your_first_aircraft"), new_aircraft_path, class: "btn-primary" %>
+ <% if current_user.can_add_aircraft? %> +<%= link_to t(".add_your_first_aircraft"), new_aircraft_path, class: "btn-primary" %>
+ <% else %> +<%= t(".ask_an_administrator") %>
+ <% end %><%= t(".no_account_yet", email: @invitation.email) %>
+ <% else %> + <% if Sso.enabled? %> + <%= button_to t(".continue_with", provider: Sso.label), "/auth/#{Sso::PROVIDER}", class: "btn-secondary w-full justify-center", data: { turbo: false } %> + <% end %> + <% if Sso.password_login? %> + <%= form_with url: account_invited_signing_path(params[:token]), class: "card card-body space-y-3" do %> +<%= t(".at_least_characters_not_one_html", min: User::PASSWORD_MIN) %>
<%= t(".asks_you_to_sign_a_html", owner: (@invitation.invited_by&.display_name || t(".the_owner")), tail_number: @entry.aircraft.tail_number, date: (fmt_date(@entry.date)), log_type: (LogbookEntry::LOG_TYPES[@entry.log_type])) %>
<% if @invitation.message.present? %>“<%= @invitation.message %>”
<% end %><%= t(".the_link_works_once_until_html", link: (link_to t(".review_and_sign_the_entry"), @url), to_date: (fmt_date(@invitation.expires_at.to_date))) %>
-<%= t(".you_ll_sign_in_or_html", email: @invitation.email) %>
+<%= t(@invitation.creates_account? ? ".sign_in_or_create_html" : ".you_ll_sign_in_or_html", email: @invitation.email) %>
diff --git a/app/views/signing_invitation_mailer/invite.text.erb b/app/views/signing_invitation_mailer/invite.text.erb index d9fdd83..01141bb 100644 --- a/app/views/signing_invitation_mailer/invite.text.erb +++ b/app/views/signing_invitation_mailer/invite.text.erb @@ -7,4 +7,4 @@ <%= raw t(".review_and_sign_it_here_text", to_date: (fmt_date(@invitation.expires_at.to_date))) %> <%= @url %> -<%= raw t(".you_ll_sign_in_or_text", email: @invitation.email) %> +<%= raw t(@invitation.creates_account? ? ".sign_in_or_create_text" : ".you_ll_sign_in_or_text", email: @invitation.email) %> diff --git a/config/locales/en.yml b/config/locales/en.yml index 81dfa4c..fa37d6a 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -285,6 +285,7 @@ en: backups_kept: Database backups kept offsite_backups_kept: Database copies kept in Google Drive documents_claude_text: Read scanned documents with Claude + anyone_adds_aircraft: Who can add aircraft logbook_templates_seeded: Built-in logbook templates added recordkeeping_policy: fillable: @@ -838,6 +839,7 @@ en: inspection_record_updated_2: 'Inspection record updated: %{name}' inspection_record_deleted_2: 'Inspection record deleted: %{name}' aircraft: + ask_an_administrator: Only an administrator can add aircraft here; ask one to add it and make you its Owner. added: "%{tail_number} added." aircraft_updated: Aircraft updated. deleted: "%{tail_number} deleted." @@ -869,6 +871,9 @@ en: wrong_code: That setup code isn't right. It's in the server's log, on the line starting "Setup code". try_again_later: Too many tries. Wait a few minutes and try again. invited_signings: + try_again_later: Too many tries; wait a few minutes. + sign_in_to_continue: Sign in to continue. + account_created_add_your: Account created. Add your certificate, then sign. signed: Signed. %{label} %{signer_name}, %{certificate_label} %{certificate_number}. flight_imports: imported_flights: @@ -1729,6 +1734,11 @@ en: a_verified_copy_of_the_html: 'A verified copy of the database is made nightly in storage/backups; this many of the newest are kept. Back up off the server too: %{link}.' with_off_site_backup_to: With off-site backup to Google Drive, this many of the newest nightly database copies are kept there. Uploaded files are copied once and kept. document_search: Document search + aircraft: Aircraft + who_can_add_aircraft: Who can add aircraft + administrators_only: Administrators only + everyone: Everyone + who_can_add_aircraft_hint: Adding an aircraft (or importing a .sam.zip) makes you its Owner, and Owners can invite people, including outside mechanics who then make their own account. With administrators only, an administrator adds each aircraft and gives it its Owners. text_in_documents_is_read_html: Text in documents is read so search can find it. PDFs that contain text are read directly either way. Claude is used only when an ANTHROPIC_API_KEY is set%{blank}, and costs API credit per page. save_settings: Save Settings cancel: Cancel @@ -1838,6 +1848,7 @@ en: import_from_a_sam_zip: Import from a .sam.zip archive add_aircraft: "+ Add Aircraft" no_aircraft_yet: No aircraft yet. + ask_an_administrator: An administrator adds aircraft and gives you a role on them. add_your_first_aircraft: Add your first aircraft photo_of: Photo of %{tail_number} tach_html: Tach %{tach_time} @@ -2700,6 +2711,14 @@ en: you_ve_been_asked_to_html: You've been asked to sign the %{date} %{log_type} log entry for %{tail_number}. First, sign in as %{email}. i_have_an_account_sign: 'I have an account: sign in' no_account_yet: There's no account for %{email} yet. Ask the aircraft's owner to have the administrator add you (or invite you), then open this link again. + continue_with: Continue with %{provider} + or_create_an_account: Or create an account + email: Email + your_name: Your name + password: Password + at_least_characters_not_one_html: At least %{min} characters; not one known from a data breach. + confirm_password: Confirm password + create_account: Create account wrong_account: sign_a_logbook_entry: Sign a logbook entry wrong_account: Wrong account @@ -3523,18 +3542,20 @@ en: asks_you_to_sign_a_html: "%{owner} asks you to sign a logbook entry for %{tail_number} (%{date}, %{log_type} log)." review_and_sign_the_entry: Review and sign the entry the_link_works_once_until_html: "%{link} (the link works once, until %{to_date})." + sign_in_or_create_html: You'll sign in or create an account for %{email}, add your certificate, and sign with your password. you_ll_sign_in_or_html: You'll sign in with your account for %{email} (if you don't have one, ask the owner to have the administrator add you first), add your certificate, and sign with your password. asks_you_to_sign_a_2_html: "%{owner} asks you to sign a logbook entry for %{tail_number} (%{date}, %{log_type} log)." review_and_sign_it_here_html: 'Review and sign it here (the link works once, until %{to_date}):' asks_you_to_sign_a_2_text: "%{owner} asks you to sign a logbook entry for %{tail_number} (%{date}, %{log_type} log)." review_and_sign_it_here_text: 'Review and sign it here (the link works once, until %{to_date}):' + sign_in_or_create_text: You'll sign in or create an account for %{email}, add your certificate, and sign with your password. you_ll_sign_in_or_text: You'll sign in with your account for %{email} (if you don't have one, ask the owner to have the administrator add you first), add your certificate, and sign with your password. the_owner: The owner subject: Please sign a logbook entry for %{tail_number} signing_invitations: new: ask_someone_to_sign: Ask someone to sign - for_a_mechanic_who_did: 'For a mechanic who did the work: they get a one-time link by email, sign in with their own account, add their certificate, and sign this entry with their own password. They see only this entry. They need an account first: the administrator adds it, or invites them.' + for_a_mechanic_who_did: 'For a mechanic who did the work: they get a one-time link by email, sign in with their own account, add their certificate, and sign this entry with their own password. They see only this entry. Invited by an Owner, they can create their account from the link; otherwise they need one first.' log_html: "%{date} · %{log_type} log · %{truncate}" their_email: Their email message_optional: Message (optional) diff --git a/config/routes.rb b/config/routes.rb index f838574..936f933 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -137,6 +137,7 @@ Rails.application.routes.draw do post "join/:token/accept", to: "joins#accept", as: :accept_join post "join/:token/account", to: "joins#account", as: :account_join post "sign/:token", to: "invited_signings#create" + post "sign/:token/account", to: "invited_signings#account", as: :account_invited_signing # Calendar feed of what's coming due (secret link; calendar apps can't sign in). get "calendar/:token.ics", to: "calendar_feeds#show", as: :calendar_feed, constraints: { token: /[A-Za-z0-9]{32}/ }, diff --git a/docs/authentik.md b/docs/authentik.md index 799fa17..7b6268d 100644 --- a/docs/authentik.md +++ b/docs/authentik.md @@ -77,7 +77,7 @@ For domain-level forward auth, Authentik matches each line as a regular expressi ^https://aircraft\.example\.com/assets/.+$ ^https://aircraft\.example\.com/shared/[A-Za-z0-9]{32}(/report)?$ ^https://aircraft\.example\.com/rails/active_storage/(blobs/redirect|disk)/.+$ -^https://aircraft\.example\.com/sign/[A-Za-z0-9_-]{43}$ +^https://aircraft\.example\.com/sign/[A-Za-z0-9_-]{43}(/account)?$ ^https://aircraft\.example\.com/session(/new|/two_factor)?(\?.*)?$ ^https://aircraft\.example\.com/profile/certificates(\?.*)?$ ^https://aircraft\.example\.com/profile/two_factor(/new|/recovery_codes)?(\?.*)?$ @@ -93,14 +93,14 @@ What each group is for: | `/assets/…` | Styles and scripts for share pages and the signing pages | Static files with no data | | `/shared/