Owners can invite mechanics again; who adds aircraft is an admin setting

- Admin → Settings → Who can add aircraft: administrators only (the
  default) or everyone. Adding an aircraft or importing a .sam.zip makes
  you its Owner, so this decides who can become one.
- A signing invitation from an Owner of the aircraft (or an
  administrator) lets the outside mechanic create an account for the
  invited address again, with a password or by signing in with SSO;
  checked when it's used. Others' signing invitations still need an
  existing account, and say so.
- Docs: who makes accounts, the new setting.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-15 19:09:49 -05:00
1 parent 19bc3efa19
commit 9a20c91f5e
30 files changed
+219 -40

No files matched your search

+2 -2
View File
@@ -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
+3 -3
View File
@@ -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
+1
View File
@@ -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
@@ -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
@@ -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
+25 -5
View File
@@ -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
@@ -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
+12 -4
View File
@@ -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)
+4
View File
@@ -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)
+8
View File
@@ -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
+4
View File
@@ -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
+8
View File
@@ -38,6 +38,14 @@
<p class="hint"><%= t(".with_off_site_backup_to") %></p>
</div>
<h2 class="card-title pt-2"><%= t(".aircraft") %></h2>
<div>
<%= label_tag "settings[anyone_adds_aircraft]", t(".who_can_add_aircraft"), class: "label" %>
<%= select_tag "settings[anyone_adds_aircraft]", options_for_select([ [ t(".administrators_only"), 0 ], [ t(".everyone"), 1 ] ], @values["anyone_adds_aircraft"].to_i),
id: "settings_anyone_adds_aircraft", class: "input" %>
<p class="hint"><%= t(".who_can_add_aircraft_hint") %></p>
</div>
<h2 class="card-title pt-2"><%= t(".document_search") %></h2>
<div>
<%= label_tag "settings[documents_claude_text]", t(".read_scanned_documents_with"), class: "label" %>
+7 -1
View File
@@ -1,16 +1,22 @@
<% content_for :title, t(".fleet") %>
<div class="mb-5 flex items-center justify-between">
<h1 class="text-2xl font-bold tracking-tight"><%= t(".fleet") %></h1>
<% if current_user.can_add_aircraft? %>
<div class="flex gap-2">
<%= more_menu do %><%= link_to t(".import_from_a_sam_zip"), new_aircraft_import_path, class: "menu-item" %><% end %>
<%= link_to t(".add_aircraft"), new_aircraft_path, class: "btn-primary" %>
</div>
<% end %>
</div>
<% if @aircraft_list.empty? %>
<div class="card card-body text-center">
<p class="text-slate-600"><%= t(".no_aircraft_yet") %></p>
<p class="mt-3"><%= link_to t(".add_your_first_aircraft"), new_aircraft_path, class: "btn-primary" %></p>
<% if current_user.can_add_aircraft? %>
<p class="mt-3"><%= link_to t(".add_your_first_aircraft"), new_aircraft_path, class: "btn-primary" %></p>
<% else %>
<p class="mt-2 text-sm text-slate-500"><%= t(".ask_an_administrator") %></p>
<% end %>
</div>
<% else %>
<div class="grid gap-4 sm:grid-cols-2 lg:grid-cols-3">
+17 -1
View File
@@ -5,7 +5,23 @@
<div class="card card-body space-y-3">
<%= link_to t(".i_have_an_account_sign"), new_session_path, class: "btn-primary w-full justify-center" %>
</div>
<% unless User.exists?(email_address: @invitation.email) %>
<% if User.exists?(email_address: @invitation.email) %>
<% elsif !@invitation.creates_account? %>
<p class="text-sm text-slate-600"><%= t(".no_account_yet", email: @invitation.email) %></p>
<% 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 %>
<h2 class="card-title"><%= t(".or_create_an_account") %></h2>
<% if @account_errors.present? %><div class="rounded-md bg-red-50 p-2 text-sm text-red-700" role="alert"><%= @account_errors.to_sentence %></div><% end %>
<div><label class="label" for="invited_email"><%= t(".email") %></label><input id="invited_email" class="input" value="<%= @invitation.email %>" disabled></div>
<div><%= label_tag :name, t(".your_name"), class: "label" %><%= text_field_tag :name, params[:name], class: "input", required: true, autocomplete: "name" %></div>
<div><%= label_tag :password, t(".password"), class: "label" %><%= password_field_tag :password, nil, class: "input", required: true, autocomplete: "new-password", minlength: User::PASSWORD_MIN, maxlength: 72 %><p class="hint"><%= t(".at_least_characters_not_one_html", min: User::PASSWORD_MIN) %></p></div>
<div><%= label_tag :password_confirmation, t(".confirm_password"), class: "label" %><%= password_field_tag :password_confirmation, nil, class: "input", required: true, autocomplete: "new-password" %></div>
<%= submit_tag t(".create_account"), class: "btn-secondary" %>
<% end %>
<% end %>
<% end %>
</div>
@@ -1,4 +1,4 @@
<p><%= 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])) %></p>
<% if @invitation.message.present? %><p><em>“<%= @invitation.message %>”</em></p><% end %>
<p><%= 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))) %></p>
<p style="color:#64748b;font-size:12px"><%= t(".you_ll_sign_in_or_html", email: @invitation.email) %></p>
<p style="color:#64748b;font-size:12px"><%= t(@invitation.creates_account? ? ".sign_in_or_create_html" : ".you_ll_sign_in_or_html", email: @invitation.email) %></p>
@@ -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) %>
+22 -1
View File
@@ -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 <strong>%{tach_time}</strong>
@@ -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 <strong>%{email}</strong>.
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 <strong>%{tail_number}</strong> (%{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)
+1
View File
@@ -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}/ },
+4 -4
View File
@@ -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/<token>`, `/shared/<token>/report` | Read-only share links (Access & Sharing) | Only with a valid, unexpired, unrevoked 32-character token, and only what that link's level shows |
| `/rails/active_storage/blobs/redirect/…`, `/rails/active_storage/disk/…` | The aircraft picture and shared documents on share pages | A file only to someone holding its signed link (from a page they could see). Disk links expire after a few minutes; redirect links don't, so a forwarded link keeps working |
| `/sign/<token>` | Outside mechanics signing an entry from an emailed invitation (with an account they already have) | Only with a valid, unused invitation token (43 characters, 14-day expiry, stored as a fingerprint) |
| `/sign/<token>`, `/sign/<token>/account` | Outside mechanics signing an entry from an emailed invitation (creating their account from an Owner's invitation) | Only with a valid, unused invitation token (43 characters, 14-day expiry, stored as a fingerprint) |
| `/session`, `/session/new`, `/session/two_factor` | The app's own sign-in, for invited mechanics | The sign-in page. Protected by rate limits, the account lockout (10 failures lock an account for 15 minutes) and optional authenticator codes. A signed-in app account still can't reach any other page through the proxy |
| `/profile/certificates` | Invited mechanics adding their certificate before signing | Adding a certificate to their own account; it only returns to a `/sign/…` page |
| `/profile/two_factor…` | Invited mechanics setting up an authenticator app | Their own two-factor setup |
| `/help/records` | The "How signing works" link on the signing form | The signing instructions, for signed-in accounts |
| `/calendar/<token>.ics` | Calendar apps fetching the due-items feed (Profile → Calendar feed) | The due list of that user's aircraft, only with their secret 32-character token; making a new link retires the old one |
New accounts come only from an administrator or an administrator's invitation: opening the invitation link, then **Continue with Authentik**, makes the account and accepts it. With `OIDC_AUTO_CREATE_USERS=true` instead, anyone Authentik lets in gets an account (with no aircraft) without an invitation.
New accounts come only from an administrator, an administrator's invitation (opening the link, then **Continue with Authentik**, makes the account and accepts it) or an Owner's signing invitation (for its address). With `OIDC_AUTO_CREATE_USERS=true` instead, anyone Authentik lets in gets an account (with no aircraft) without an invitation.
Invitation links (`/join/…`) are deliberately not on the list: behind forward auth, someone with only an app account still couldn't get past the proxy to use the app, so invited people need an Authentik account anyway. They sign in to Authentik, then open the link and accept it.
@@ -114,7 +114,7 @@ In a private window:
1. `https://aircraft.example.com/` should go to Authentik.
2. A share link should open without signing in, styled, with the aircraft picture.
3. A signing invitation should let you sign in (with an existing account), add a certificate and sign.
3. An Owner's signing invitation should let you create an account (or sign in), add a certificate and sign.
4. After that, `https://aircraft.example.com/aircraft` in the same window should still go to Authentik.
### Client addresses
+3 -2
View File
@@ -6,7 +6,7 @@ Admins see the **Admin** menu (on a phone, under ☰). Admins can see and edit e
**Users** lists every account.
- **+ New User**: name, email and a starting password. Tick **Administrator** to make them an admin. Then give them a role on aircraft: **Edit** → **Aircraft access** lists their role on every aircraft, to add, change or remove (an aircraft's Owner can also do it from **More → Access & sharing**, and anyone can add their own aircraft).
- **+ New User**: name, email and a starting password. Tick **Administrator** to make them an admin. Then give them a role on aircraft: **Edit** → **Aircraft access** lists their role on every aircraft, to add, change or remove (an aircraft's Owner can also do it from **More → Access & sharing**).
- **Edit** to change details or reset a password when email isn't set up.
- **Locked** marks an account locked for 15 minutes after 10 failed sign-ins in a row (the user is emailed). **Unlock** clears it straight away, once you know it was really them.
- **2FA** marks someone using an authenticator app. **Reset 2FA** turns it off for a user who lost their phone and recovery codes. Confirm it's really them first (call them); they can then set it up again.
@@ -28,7 +28,7 @@ To give someone a role on any aircraft, open them in **Admin → Users**: **Airc
## Invitations
**Admin → Invitations → New invitation** makes a link someone opens to create their own account (or accept with the one they have) and get roles on aircraft. New accounts are only ever made by an administrator: here, from **Users**, or by an administrator's invitation (invitations from an aircraft's Access page are for people who already have an account, and so are signing invitations). An invitation has a label for you, optionally an email address (then only that address can use it, and the link is emailed to it when email is set up) and a name, how many times it works (empty for unlimited, e.g. for a flying club), when it expires (empty for never), and a role on any of the aircraft (none at all gives just an account). The link is shown once, when it's made; copy it then.
**Admin → Invitations → New invitation** makes a link someone opens to create their own account (or accept with the one they have) and get roles on aircraft. New accounts are made by an administrator (here, or from **Users**), by an administrator's invitation, or by an outside mechanic from an Owner's signing invitation (**Ask someone to sign**). Invitations from an aircraft's Access page are for people who already have an account. Since Owners can bring in mechanics, **Settings → Who can add aircraft** decides who can become one. An invitation has a label for you, optionally an email address (then only that address can use it, and the link is emailed to it when email is set up) and a name, how many times it works (empty for unlimited, e.g. for a flying club), when it expires (empty for never), and a role on any of the aircraft (none at all gives just an account). The link is shown once, when it's made; copy it then.
Where someone already has a role on an aircraft, an invitation leaves it as it is. An invitation never gives more than whoever made it can give when it's used. **Revoke** stops a link working; people who already used it keep their access. With single sign-on, **Continue with** on the invitation page signs them in and makes their account. `OIDC_AUTO_CREATE_USERS=true` in the server's settings instead gives an account to anyone the provider lets in, without an invitation; leave it off to keep accounts to administrators and their invitations.
@@ -61,6 +61,7 @@ If single sign-on is broken and `PASSWORD_LOGIN=false` is set, remove that setti
- **Uploads**: the largest file anyone can upload. A proxy in front of the app may have its own smaller limit.
- **Backups**: how many nightly database copies to keep, on the server and in Google Drive.
- **Who can add aircraft**: administrators only (the default), or everyone. Adding an aircraft, or importing a .sam.zip, makes you its Owner, and an Owner's signing invitations let outside mechanics make their own account; with administrators only, you add each aircraft and give it its Owners.
- **Document search**: read scanned documents with Tesseract (free, on the server) or Claude (better on handwriting, needs `ANTHROPIC_API_KEY`, costs API credit). PDFs with text are read directly either way.
## About
+1 -1
View File
@@ -123,7 +123,7 @@ POST /api/v1/aircraft/12/draft_batches
- **One entry per logbook.** Items are grouped by `log` (`AC`, `ENG`, `PROP` or `OTHER`) into one unsigned entry each, their texts in order, so a visit that touched the engine and the airframe makes two entries, signed one after the other.
- **Inspections** (`completes_inspections`): each needs its `result`, `approved` (airworthy) or `discrepancies` (a list was given to the owner), and the draft needs `aircraft_hours`. The entry recording it is an inspection entry, in the logbook named by `log`, else the airframe log if an item is for it.
- **Nothing is resolved until it's signed.** The squawks the items resolve and the inspections they complete are held until **every** entry of the draft is signed; then they're resolved and recorded, attributed to the person who signed last, and linked to the entry that described the work. A draft never clears a squawk on its own. The signer sees what signing will do before they sign.
- **The signer.** Anyone with access to the aircraft and a certificate in their profile can sign, from each entry's `sign_url`. Give `signer.email` for someone else (a mechanic who isn't on the aircraft): each entry then gets an `invitation_url`, a link that lets that person sign that entry with their account for that address, for 14 days. They need an account first (the administrator adds it, or invites them). Pass the link on yourself (for example inside Redmine), or set `send_email: true` to have SAM email it.
- **The signer.** Anyone with access to the aircraft and a certificate in their profile can sign, from each entry's `sign_url`. Give `signer.email` for someone else (a mechanic who isn't on the aircraft): each entry then gets an `invitation_url`, a link that lets that person sign that entry with their account for that address, for 14 days. When the integration acts for an Owner of the aircraft, the link also lets them create that account; otherwise they need one first. Pass the link on yourself (for example inside Redmine), or set `send_email: true` to have SAM email it.
The answer (`201`):
+1 -1
View File
@@ -30,7 +30,7 @@ What you can do depends on your role on each aircraft. These are the built-in ro
| Correct or delete any flight, imports, exports, restore from history | | | | ✓ |
| Edit the aircraft, manage people and share links | | | | ✓ |
Administrators can do everything on every aircraft, and manage users, roles, settings, procedures and audits for the whole app. Anyone can add an aircraft and becomes its Owner. You only see aircraft you have a role on; administrators see all of them.
Administrators can do everything on every aircraft, and manage users, roles, settings, procedures and audits for the whole app. Whoever adds an aircraft becomes its Owner; the administrator decides who can (Admin → Settings: administrators only, or everyone). You only see aircraft you have a role on; administrators see all of them.
## Finding your way around
+1 -1
View File
@@ -21,7 +21,7 @@ A signed entry can't be edited or deleted. Open it and choose **More → Correct
## Someone else did the work
The owner can choose **More → Ask someone to sign** on the entry. The mechanic gets a one-time email link (valid for 14 days), signs in with their own account (the administrator adds it first, or invites them), adds their certificate and signs.
The owner can choose **More → Ask someone to sign** on the entry. The mechanic gets a one-time email link (valid for 14 days), signs in with their own account (or creates one for that address, when an Owner sent the invitation), adds their certificate and signs.
If they prefer paper, print the entry (**Print for logbook**), have it signed in ink, and keep the paper with the logbooks (scan it into Documents).
+43
View File
@@ -0,0 +1,43 @@
require "test_helper"
# Who can add aircraft (Admin → Settings): adding or importing one makes you
# its Owner, who can bring in outside mechanics, so by default only
# administrators can.
class AddingAircraftTest < ActionDispatch::IntegrationTest
setup do
@user = create_user("user@example.com")
@admin = create_user("admin@example.com", admin: true)
end
test "by default only administrators add or import aircraft" do
sign_in @user
get root_path
assert_select "a[href=?]", new_aircraft_path, 0
assert_select "a[href=?]", new_aircraft_import_path, 0
assert_includes response.body, "An administrator adds aircraft"
get new_aircraft_path
assert_redirected_to root_path
post aircraft_index_path, params: { aircraft: { tail_number: "N1", tach_time: 50 } }
assert_not Aircraft.exists?(tail_number: "N1")
get new_aircraft_import_path
assert_redirected_to root_path
sign_in @admin
post aircraft_index_path, params: { aircraft: { tail_number: "N1", tach_time: 50 } }
assert_equal "owner", @admin.role_for(Aircraft.find_by!(tail_number: "N1")).key
end
test "an administrator can let everyone add aircraft" do
sign_in @admin
get edit_admin_settings_path
assert_select "select[name='settings[anyone_adds_aircraft]'] option[selected]", text: "Administrators only"
patch admin_settings_path, params: { settings: { anyone_adds_aircraft: 1 } }
assert Setting.anyone_adds_aircraft?
sign_in @user
get root_path
assert_select "a[href=?]", new_aircraft_path
post aircraft_index_path, params: { aircraft: { tail_number: "N2", tach_time: 50 } }
assert_equal "owner", @user.role_for(Aircraft.find_by!(tail_number: "N2")).key
end
end
@@ -4,6 +4,7 @@ class AircraftArchiveFlowTest < ActionDispatch::IntegrationTest
include ActiveJob::TestHelper
setup do
Setting.update_integers("anyone_adds_aircraft" => 1) # anyone may add aircraft here
@owner = create_user("owner@example.com")
@pilot = create_user("pilot@example.com")
@a = create_aircraft(owner: @owner, pilot: @pilot, tail_number: "N12345", make: "Cessna")
+21 -11
View File
@@ -159,7 +159,6 @@ class ElectronicSignaturesTest < ActionDispatch::IntegrationTest
post aircraft_logbook_entry_signing_invitations_path(@a, @entry), params: { signing_invitation: { email: "Outside@Example.com", message: "Thanks!" } }
end
end
assert_match "They don't have an account here yet", flash[:notice]
mail = ActionMailer::Base.deliveries.last
assert_equal [ "outside@example.com" ], mail.to
path = mail.text_part.body.to_s[%r{http://example\.com(/sign/[\w-]+)}, 1]
@@ -167,16 +166,8 @@ class ElectronicSignaturesTest < ActionDispatch::IntegrationTest
get path
assert_includes response.body, "sign in as <strong>outside@example.com</strong>"
assert_includes response.body, "no account for outside@example.com yet" # a signing link doesn't make accounts
post "#{path}/account", params: { name: "Olive Outside", password: "longpassword1", password_confirmation: "longpassword1" }
assert_response :not_found
assert_not User.exists?(email_address: "outside@example.com")
# The administrator adds their account; they sign in and come back to the link.
User.create!(email_address: "outside@example.com", name: "Olive Outside", password: "longpassword1")
get path
post session_path, params: { email_address: "outside@example.com", password: "longpassword1" }
assert_redirected_to "http://www.example.com#{path}"
post "#{path}/account", params: { name: "Olive Outside", password: "longpassword1", password_confirmation: "longpassword1" } # an Owner's invitation
assert_redirected_to path
follow_redirect!
assert_select "form[action='#{certificates_path(return_to: path)}']" # add a certificate first
post certificates_path(return_to: path), params: { user_certificate: { kind: "IA", number: "2222222" } }
@@ -223,4 +214,23 @@ class ElectronicSignaturesTest < ActionDispatch::IntegrationTest
patch enable_admin_user_path(@mech)
refute @mech.reload.disabled?
end
test "a signing invitation from someone who isn't an Owner doesn't make accounts" do
mechanic = create_user("shop@example.com")
@a.roles.create!(user: mechanic, role: "mechanic")
sign_in mechanic
perform_enqueued_jobs do
post aircraft_logbook_entry_signing_invitations_path(@a, @entry), params: { signing_invitation: { email: "outside2@example.com" } }
end
assert_match "They don't have an account here yet", flash[:notice]
path = ActionMailer::Base.deliveries.last.text_part.body.to_s[%r{http://example\.com(/sign/[\w-]+)}, 1]
assert_match "if you don't have one, ask the owner", ActionMailer::Base.deliveries.last.text_part.body.to_s
delete session_path
get path
assert_includes response.body, "no account for outside2@example.com yet"
assert_select "form[action$='/account']", 0
post "#{path}/account", params: { name: "X", password: "longpassword1", password_confirmation: "longpassword1" }
assert_not User.exists?(email_address: "outside2@example.com")
end
end
+1
View File
@@ -41,6 +41,7 @@ class MalformedInputTest < ActionDispatch::IntegrationTest
end
test "text where a file belongs, or a tampered upload reference, is turned away politely" do
Setting.update_integers("anyone_adds_aircraft" => 1) # anyone may add aircraft here
post import_aircraft_oil_analyses_path(@a), params: { report: "not a file" }
assert_redirected_to new_aircraft_oil_analysis_path(@a)
post aircraft_imports_path, params: { archive: "not a file" }
+1
View File
@@ -31,6 +31,7 @@ class PagesTest < ActionDispatch::IntegrationTest
end
test "owner can render every page" do
Setting.update_integers("anyone_adds_aircraft" => 1) # anyone may add aircraft here
a = @a
paths = [
root_path, aircraft_path(a), new_aircraft_path, edit_aircraft_path(a),
+1
View File
@@ -21,6 +21,7 @@ class SetupTest < ActionDispatch::IntegrationTest
end
test "create aircraft makes creator the owner" do
Setting.update_integers("anyone_adds_aircraft" => 1) # anyone may add aircraft here
user = create_user
sign_in user
post aircraft_index_path, params: { aircraft: { tail_number: "N1", tach_time: 50 } }
+18
View File
@@ -169,4 +169,22 @@ class SsoTest < ActionDispatch::IntegrationTest
assert_not User.exists?(email_address: "someone.else@example.com")
assert_equal 0, invitation.reload.uses_count
end
test "an Owner's signing invitation makes the mechanic's account by signing in with SSO, for its address only" do
ENV.delete("OIDC_AUTO_CREATE_USERS")
owner = create_user("owner3@example.com")
aircraft = create_aircraft(owner: owner, tail_number: "N888CD")
entry = aircraft.logbook_entries.create!(date: Date.new(2026, 10, 1), log_type: "AC", entry_type: "MAINTENANCE", aircraft_hours_at_entry: 1000, text: "Oil changed.")
invitation = entry.signing_invitations.create!(email: "mech@example.com", invited_by: owner)
get invited_signing_path(invitation.token)
mock(uid: "sub-other", email: "not.mech@example.com")
sso_sign_in
assert_not User.exists?(email_address: "not.mech@example.com")
get invited_signing_path(invitation.token)
mock(uid: "sub-mech", email: "mech@example.com", name: "Mo Mechanic")
sso_sign_in
assert_equal "sub-mech", User.find_by!(email_address: "mech@example.com").sso_uid
end
end