katalyst-koi 4.13.0 → 4.14.0

data/app/controllers/admin/sessions_controller.rb

@@ -4,14 +4,13 @@ module Admin
   class SessionsController < ApplicationController
     include Koi::Controller::HasWebauthn
 
-    skip_before_action :authenticate_admin, only: %i[new create]
+    before_action :redirect_authenticated, only: %i[new], if: :admin_signed_in?
+    before_action :authenticate_local_admin, only: %i[new], if: :authenticate_local_admins?
 
     layout "koi/login"
 
     def new
-      return redirect_to admin_dashboard_path if admin_signed_in?
-
-      render :new, locals: { admin_user: Admin::User.new }
+      render locals: { admin_user: Admin::User.new }
     end
 
     def create
@@ -20,12 +19,12 @@ module Admin
 
         session[:admin_user_id] = admin_user.id
 
-        redirect_to admin_dashboard_path, notice: I18n.t("koi.auth.login")
+        redirect_to(params[:redirect].presence || admin_dashboard_path, status: :see_other)
       else
         admin_user = Admin::User.new(session_params.slice(:email, :password))
         admin_user.errors.add(:email, "Invalid email or password")
 
-        render :new, status: :unprocessable_content, locals: { admin_user: }
+        render(:new, status: :unprocessable_content, locals: { admin_user: })
       end
     end
 
@@ -34,11 +33,15 @@ module Admin
 
       session[:admin_user_id] = nil
 
-      redirect_to admin_dashboard_path, notice: I18n.t("koi.auth.logout")
+      redirect_to new_admin_session_path
     end
 
     private
 
+    def redirect_authenticated
+      redirect_to(admin_dashboard_path, status: :see_other)
+    end
+
     def session_params
       params.require(:admin).permit(:email, :password, :response)
     end
@@ -65,6 +68,8 @@ module Admin
     end
 
     def record_sign_out!(admin_user)
+      return unless admin_user
+
       update_last_sign_in(admin_user)
 
       admin_user.current_sign_in_at = nil

data/app/controllers/admin/tokens_controller.rb

@@ -4,49 +4,54 @@ module Admin
   class TokensController < ApplicationController
     include Koi::Controller::JsonWebToken
 
-    skip_before_action :authenticate_admin, only: %i[show update]
+    before_action :set_admin, only: %i[create]
     before_action :set_token, only: %i[show update]
+    before_action :invalid_token, only: %i[show update], unless: :token_valid?
 
     def show
-      return redirect_to new_admin_session_path, notice: I18n.t("koi.auth.token_invalid") if @token.blank?
-
-      admin = Admin::User.find(@token[:admin_id])
-
-      if token_utilised?(admin, @token)
-        return redirect_to new_admin_session_path, notice: I18n.t("koi.auth.token_invalid")
-      end
-
-      render locals: { admin:, token: params[:token] }, layout: "koi/login"
+      render locals: { admin: @admin, token: params[:token] }, layout: "koi/login"
     end
 
     def create
-      admin = Admin::User.find(params[:id])
-      token = encode_token(admin_id: admin.id, exp: 5.minutes.from_now.to_i, iat: Time.current.to_i)
+      token = encode_token(admin_id: @admin.id, exp: 30.minutes.from_now.to_i, iat: Time.current.to_i)
 
       render locals: { token: }
     end
 
     def update
-      return redirect_to admin_dashboard_path, status: :see_other if admin_signed_in?
-
-      if @token.blank?
-        return redirect_to new_admin_session_path, status: :see_other, notice: I18n.t("koi.auth.token_invalid")
-      end
-
-      admin = Admin::User.find(@token[:admin_id])
-      sign_in_admin(admin)
+      sign_in_admin(@admin)
 
-      redirect_to admin_admin_user_path(admin)
+      redirect_to admin_admin_user_path(@admin), status: :see_other, notice: t("koi.auth.token_consumed")
     end
 
     private
 
+    def set_admin
+      @admin = Admin::User.find(params[:admin_user_id])
+    end
+
     def set_token
       @token = decode_token(params[:token])
+
+      # constant time token validation requires that we always try to retrieve a user
+      @admin = Admin::User.find_by(id: @token&.fetch(:admin_id) || "")
+    end
+
+    def token_valid?
+      return false unless @token.present? && @admin.present?
+
+      # Ensure that the user has not signed in since the token was generated
+      if @admin.current_sign_in_at.present?
+        @admin.current_sign_in_at.to_i < @token[:iat]
+      elsif @admin.last_sign_in_at.present?
+        @admin.last_sign_in_at.to_i < @token[:iat]
+      else
+        true # first sign in
+      end
     end
 
-    def token_utilised?(admin, token)
-      admin.current_sign_in_at.present? || (admin.last_sign_in_at.present? && admin.last_sign_in_at.to_i > token[:iat])
+    def invalid_token
+      redirect_to(new_admin_session_path, status: :see_other, notice: I18n.t("koi.auth.token_invalid"))
     end
 
     def sign_in_admin(admin)

data/app/controllers/concerns/koi/controller/is_admin_controller.rb

@@ -31,9 +31,6 @@ module Koi
         helper :all
 
         layout -> { turbo_frame_layout || "koi/application" }
-
-        before_action :authenticate_local_admin, if: -> { Koi::Controller::IsAdminController.authenticate_local_admins }
-        before_action :authenticate_admin, unless: :admin_signed_in?
       end
 
       class << self
@@ -47,10 +44,14 @@ module Koi
 
         session[:admin_user_id] =
           Admin::User.where(email: %W[#{ENV.fetch('USER', nil)}@katalyst.com.au admin@katalyst.com.au]).first&.id
+
+        flash.delete(:redirect) if (redirect = flash[:redirect])
+
+        redirect_to(redirect || admin_dashboard_path, status: :see_other)
       end
 
-      def authenticate_admin
-        redirect_to new_admin_session_path, status: :temporary_redirect
+      def authenticate_local_admins?
+        IsAdminController.authenticate_local_admins
       end
 
       def turbo_frame_layout

data/app/views/admin/admin_users/show.html.erb

@@ -17,7 +17,7 @@
                   method: :delete,
                   form:   { data: { turbo_confirm: "Are you sure?" } } %>
   <% end %>
-  <%= button_to "Generate login link", invite_admin_admin_user_path(admin), class: "button button--primary", form: { id: "invite" } %>
+  <%= button_to "Generate login link", admin_admin_user_tokens_path(admin), class: "button button--primary", form: { id: "invite" } %>
 </div>
 
 <h2>Authentication</h2>

data/app/views/admin/sessions/new.html.erb

@@ -7,19 +7,22 @@
         webauthn_authentication_options_value: { publicKey: webauthn_auth_options },
       },
     ) do |f| %>
+  <% (redirect = flash[:redirect] || params[:redirect]) && flash.delete(:redirect) %>
   <% unless flash.empty? %>
     <div class="govuk-error-summary">
       <ul class="govuk-error-summary__list">
-        <% flash.each do |_, message| %>
+        <% flash.each do |type, message| %>
           <%= tag.li message %>
         <% end %>
       </ul>
     </div>
   <% end %>
   <%= f.govuk_fieldset legend: nil do %>
-    <%= f.govuk_email_field :email, autofocus: true, autocomplete: "email" %>
-    <%= f.govuk_password_field :password, autocomplete: "current-password" %>
+    <%# note, autocomplete off is ignored by browsers but required by PCI-DSS %>
+    <%= f.govuk_email_field :email, autofocus: true, autocomplete: "off" %>
+    <%= f.govuk_password_field :password, autocomplete: "off" %>
     <%= f.hidden_field :response, data: { webauthn_authentication_target: "response" } %>
+    <%= hidden_field_tag(:redirect, redirect) %>
   <% end %>
   <div class="actions-group">
     <%= f.admin_save "Log in" %>

data/app/views/admin/tokens/create.turbo_stream.erb

@@ -1,6 +1,6 @@
 <%= turbo_stream.replace "invite" do %>
   <div class="action copy-to-clipboard govuk-input__wrapper" data-controller="clipboard" data-clipboard-supported-class="clipboard--supported">
-    <%= text_field_tag :invite_link, admin_token_url(token), readonly: true, data: { clipboard_target: "source" } %>
+    <%= text_field_tag :invite_link, admin_session_token_url(token), readonly: true, data: { clipboard_target: "source" } %>
     <button class="govuk-input__suffix clipboard-button" aria-hidden="true" data-action="clipboard#copy">
       Copy link
     </button>

data/app/views/admin/tokens/show.html.erb

@@ -1,7 +1,6 @@
 <%= render "layouts/koi/navigation_header" %>
 
-<%= form_with(url: accept_admin_session_path) do |form| %>
-  <%= tag.input name: :token, type: :hidden, value: token %>
+<%= form_with(url: admin_session_token_path(token), method: :patch) do |form| %>
   <p>Welcome to Koi Admin</p>
   <%= render Koi::SummaryListComponent.new(model: admin, class: "item-table") do |builder| %>
     <%= builder.text :name %>

data/app/views/layouts/koi/application.html.erb

@@ -9,6 +9,7 @@
 
   <!-- META -->
   <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
   <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=0.6667">
   <meta name="robots" content="noindex,nofollow">
   <%= Koi::Release.meta_tags(self) %>

data/app/views/layouts/koi/frame.html.erb

@@ -1,5 +1,9 @@
 <html>
 <head>
+  <%# Workaround for https://github.com/hotwired/turbo-rails/issues/669 %>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
   <%# include all turbo-track elements so turbo knows it can cache frame visits %>
   <%= stylesheet_link_tag Koi.config.admin_stylesheet, "data-turbo-track": "reload" %>
   <%= javascript_importmap_tags "koi/admin" %>

data/config/locales/koi.en.yml

@@ -9,9 +9,8 @@ en:
       admin: "%e %B %Y"
   koi:
     auth:
-      login: "You have been logged in"
-      logout: "You have been logged out"
       token_invalid: "Token invalid or consumed already"
+      token_consumed: "Please create a password or passkey"
     labels:
       new: New
       search: Search

data/config/routes.rb

@@ -3,22 +3,19 @@
 Rails.application.routes.draw do
   namespace :admin do
     resource :session, only: %i[new create destroy] do
-      post :accept, to: "tokens#update"
+      # JWT tokens contain periods
+      resources :tokens, param: :token, only: %i[show update], token: /[^\/]+/
     end
 
     resources :url_rewrites
     resources :admin_users do
       resources :credentials, only: %i[new create destroy]
-      post :invite, on: :member, to: "tokens#create"
+      resources :tokens, only: %i[create]
       get :archived, on: :collection
       put :archive, on: :collection
       put :restore, on: :collection
     end
 
-    # JWT tokens have dots(represents the 3 parts of data) in them, so we need to allow them in the URL
-    # can by pass if we use token as a query param
-    get "token/:token", to: "tokens#show", as: :token, token: /[^\/]+/
-
     resource :cache, only: %i[destroy]
     resource :dashboard, only: %i[show]
 
@@ -26,10 +23,8 @@ Rails.application.routes.draw do
   end
 
   scope :admin do
-    constraints ->(req) { req.session[:admin_user_id].present? } do
-      mount Katalyst::Content::Engine, at: "content"
-      mount Katalyst::Navigation::Engine, at: "navigation"
-      mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
-    end
+    mount Katalyst::Content::Engine, at: "content"
+    mount Katalyst::Navigation::Engine, at: "navigation"
+    mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
   end
 end

data/lib/generators/koi/admin_controller/templates/controller_spec.rb.tt

@@ -124,6 +124,7 @@ RSpec.describe <%= controller_class_name %>Controller do
 
   describe "DELETE /admin/<%= plural_name %>/:id" do
     let(:action) { delete polymorphic_path([:admin, model]) }
+    let!(:model) { create(:<%= singular_name %>) }
 
     it_behaves_like "requires admin"
 
@@ -131,5 +132,9 @@ RSpec.describe <%= controller_class_name %>Controller do
       action
       expect(response).to redirect_to(polymorphic_path([:admin, <%= class_name %>]))
     end
+
+    it "deletes the <%= singular_name %>" do
+      expect { action }.to change(<%= class_name %>, :count).by(-1)
+    end
   end
 end

data/lib/koi/engine.rb

@@ -58,6 +58,7 @@ module Koi
     end
 
     initializer "koi.middleware" do |app|
+      app.middleware.use Koi::Middleware::AdminAuthentication
       app.middleware.use ::ActionDispatch::Static, root.join("public").to_s
       app.middleware.insert_before Rack::Sendfile, Koi::Middleware::UrlRedirect
     end

data/lib/koi/middleware/admin_authentication.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Koi
+  module Middleware
+    class AdminAuthentication
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env["PATH_INFO"].starts_with?("/admin")
+          admin_call(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def admin_call(env)
+        request = ActionDispatch::Request.new(env)
+        session = ActionDispatch::Request::Session.find(request)
+
+        if requires_authentication?(request) && !authenticated?(session)
+          # Set the redirection path for returning the user to their requested path after login
+          if request.get?
+            request.flash[:redirect] = request.fullpath
+            request.commit_flash
+          end
+
+          [303, { "Location" => "/admin/session/new" }, []]
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def requires_authentication?(request)
+        !request.path.starts_with?("/admin/session")
+      end
+
+      def authenticated?(session)
+        session[:admin_user_id].present?
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 4.14.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -457,6 +457,7 @@ files:
 - lib/koi/form_builder.rb
 - lib/koi/menu.rb
 - lib/koi/menu/builder.rb
+- lib/koi/middleware/admin_authentication.rb
 - lib/koi/middleware/url_redirect.rb
 - lib/koi/release.rb
 - spec/factories/admins.rb
@@ -481,7 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Koi CMS admin framework