samagotchi 0.108.0 → 0.109.0

data/lib/samagotchi/web/server.rb

@@ -9,6 +9,9 @@ require "webrick"
 require_relative "app"
 require_relative "info_probe"
 require_relative "lan"
+require_relative "link_codes"
+require_relative "proxy_gate"
+require_relative "public_url"
 require_relative "qr"
 require_relative "running"
 require_relative "session_hub"
@@ -58,6 +61,10 @@ module Samagotchi
       # How long `chi web` waits for a server already on its port to answer.
       PROBE_TIMEOUT = 0.3
 
+      # The raw header names next to Rack's env (ProxyGate's identity check):
+      # chi web is the only WEBrick server chi runs.
+      WEBrick::HTTPRequest.prepend(ProxyGate::RawHeaderNames) unless WEBrick::HTTPRequest < ProxyGate::RawHeaderNames
+
       # `chi web`: one server serves every project, the scope is in the page
       # URL. If a chi web already runs on the port, print (and with --open,
       # open) its page for +dir+ and leave it be; else start one.
@@ -70,6 +77,7 @@ module Samagotchi
                       editor: Config::BY_KEY["web.editor"].default, new_token: false,
                       working_set: Config::BY_KEY["web.working_set"].default)
         rotate_token if new_token
+        public_url = public_url_setting
         setting = host_setting(host)
         lan = Lan.wanted?(setting) ? Lan.choose(setting) : nil
         host = resolve_host(setting)
@@ -85,6 +93,7 @@ module Samagotchi
           end
           puts "chi web already runs on port #{port} (pid #{found["pid"]}): #{url}"
           puts running_lan_lines(found["lan"], port) if found["lan"]
+          puts running_public_lines(public_url) if public_url
           puts lan_off_line(setting) if new_token && !found["lan"]
           open_url(url) if open_browser
           0
@@ -92,20 +101,21 @@ module Samagotchi
           warn in_use_message(port)
           1
         else
-          if new_token && !lan
+          if new_token && !lan && !public_url
             puts lan_off_line(setting)
             return 0
           end
           # The participants' grants: never served from a store others can read.
           Grants.check_permissions!(Grants.path)
           if start(port: port, host: host, url: url, open_browser: open_browser, markdown: markdown, view: view,
-                   annotate_presets: annotate_presets, editor: editor, lan: lan, working_set: working_set)
+                   annotate_presets: annotate_presets, editor: editor, lan: lan, working_set: working_set,
+                   public_url: public_url)
             0
           else
             1
           end
         end
-      rescue Lan::Error, Grants::Insecure => e
+      rescue Lan::Error, Grants::Insecure, PublicUrl::Invalid => e
         warn "Error: #{e.message}"
         1
       rescue Interrupt
@@ -120,11 +130,13 @@ module Samagotchi
       # @param lan [Lan::Choice, nil] also listen on this LAN address, where
       #   every request but this machine's needs the access token
       # @param token_path [String] the LAN access token's file
+      # @param public_url [PublicUrl, nil] behind an auth proxy
+      #   (web.public_url): every request needs the access token
       # @return [Boolean] false when the port was taken (said so on stderr)
       def self.start(port: nil, host: nil, url: nil, open_browser: false, state_dir: nil, manager: nil, markdown: false,
                      view: Config::BY_KEY["web.view"].default, annotate_presets: Config::BY_KEY["web.annotate_presets"].default, hub: nil, lan: nil,
                      editor: Config::BY_KEY["web.editor"].default, token_path: Token.path,
-                     working_set: Config::BY_KEY["web.working_set"].default)
+                     working_set: Config::BY_KEY["web.working_set"].default, public_url: nil)
         config_restart_unsubscribe = ConfigFile.watch_restart_settings!(process: :web) do |message|
           Samagotchi::Log.warn(:config, "restart_required", echo: "Warning: config: #{message}")
         end
@@ -133,14 +145,18 @@ module Samagotchi
         url ||= "http://#{url_host(host)}:#{port}/"
 
         hub ||= SessionHub.new(state_dir: state_dir || Session.default_state_dir, manager: manager || SessionManager)
-        if lan
-          Token.load_or_create(token_path)
-          lan_option = { ip: lan.ip, token: Token::Source.new(token_path) }
-        end
+        Token.load_or_create(token_path) if lan || public_url
+        lan_option = { ip: lan.ip, token: Token::Source.new(token_path) } if lan
+        public_token = Token::Source.new(token_path) if public_url
         app = App.new(manager: manager, state_dir: state_dir, markdown: markdown, view: view,
-                      annotate_presets: annotate_presets, editor: editor, hub: hub, lan: lan_option, working_set: working_set)
+                      annotate_presets: annotate_presets, editor: editor, hub: hub, lan: lan_option, working_set: working_set,
+                      public_url: public_url, public_token: public_token)
         Samagotchi::Log.info(:web, "start", url: "http://#{host}:#{port}", version: Samagotchi::VERSION)
         Samagotchi::Log.info(:web, "lan", ip: lan.ip, interface: lan.interface) if lan
+        if public_url
+          Samagotchi::Log.info(:web, "public_url", origin: public_url.origin, identity_header: public_url.identity_label,
+                                                   owner: public_url.owner ? "set" : "none")
+        end
         # Subscribed before the first scan, which makes the first check.
         hub.subscribe(method(:on_hub_event))
         hub.start
@@ -151,12 +167,15 @@ module Samagotchi
           record_running(running_path, port)
           puts "Chi Web on #{url} (public: #{File.expand_path("public", __dir__)})"
           puts lan_lines(ip: lan.ip, port: port, token: Token.read(token_path), others: lan.others, public: lan.public) if lan
+          puts public_lines(public_url, token: Token.read(token_path), codes: owner_codes(state_dir)) if public_url
           puts "Press Ctrl-C to stop."
           $stdout.flush # a log file isn't line-buffered
           if open_browser
+            # With web.public_url the page opens through the proxy.
+            open_target = public_url ? public_url.link(owner_codes(state_dir).issue(kind: :owner, ttl: LinkCodes::OWNER_TTL)) : url
             Thread.new do
               sleep 0.8
-              open_url(url)
+              open_url(open_target)
             end
           end
         end
@@ -224,6 +243,47 @@ module Samagotchi
         raise LanListenError, e.message
       end
 
+      # web.public_url as Server runs it, nil when unset.
+      # @raise [PublicUrl::Invalid]
+      def self.public_url_setting
+        PublicUrl.from_config(url: Samagotchi::Config.get("web.public_url"),
+                              identity_header: Samagotchi::Config.get("web.proxy.identity_header"),
+                              owner: Samagotchi::Config.get("web.proxy.owner"))
+      end
+
+      # What web.public_url adds to the start lines: the proxied link (the
+      # token in its fragment) and who the owner is. On this machine the
+      # page opens through the proxy too; a direct request takes the token
+      # as Authorization: Bearer only (no cookie for 127.0.0.1, which every
+      # local port would get).
+      def self.public_lines(public_url, token:, codes: owner_codes)
+        unless token
+          return ["Proxied: #{public_url.origin}/ (no access token: its file is gone; chi web --new-token makes one)"]
+        end
+
+        who = if public_url.identity_header.nil? then "token only, no identity header"
+              elsif public_url.owner then "owner #{public_url.owner} by #{public_url.identity_header}, and the token"
+              else "nobody is the owner by identity: web.proxy.owner is unset"
+              end
+        code = codes.issue(kind: :owner, ttl: LinkCodes::OWNER_TTL)
+        ["Proxied: #{public_url.link(code)}   ← opens chi web as you once, within #{LinkCodes::OWNER_TTL / 60} minutes " \
+         "(chi web again prints a new one)",
+         "         (#{who}; on this machine the page opens through the proxy too)"]
+      end
+
+      # The owner's one-time link codes, next to the grants.
+      def self.owner_codes(state_dir = nil) = LinkCodes.for_grants(Grants.path(state_dir: state_dir))
+
+      # A second chi web, when this machine's config has web.public_url: the
+      # link from this config and the token file, never from what answered
+      # on the port.
+      def self.running_public_lines(public_url, token_path: Token.path, codes: owner_codes)
+        return ["Proxied: #{public_url.origin}/"] unless Token.read(token_path)
+
+        ["Proxied: #{public_url.link(codes.issue(kind: :owner, ttl: LinkCodes::OWNER_TTL))}   (once, within " \
+         "#{LinkCodes::OWNER_TTL / 60} minutes)"]
+      end
+
       def self.host_setting(host)
         (host || Samagotchi::Config.get("web.host")).to_s.strip
       end

data/lib/samagotchi/worker_sidecar.rb

@@ -70,14 +70,15 @@ module Samagotchi
     def initialize(port:, bind: nil, session_id: nil, started_at: nil, version: nil, input_format: nil, features: [],
                    epoch: nil) = super
 
-    # Written whole or not at all; input_format and epoch only when they
-    # name one.
+    # Written whole or not at all, readable by this user only (0600: no
+    # other account learns the worker's port from it); input_format and
+    # epoch only when they name one.
     def write(session_dir)
       FileUtils.mkdir_p(session_dir)
       record = to_h.transform_keys(&:to_s)
       record.delete("input_format") if input_format.nil?
       record.delete("epoch") if epoch.nil?
-      AtomicFile.write(self.class.path(session_dir), "#{JSON.pretty_generate(record)}\n")
+      AtomicFile.write(self.class.path(session_dir), "#{JSON.pretty_generate(record)}\n", perm: 0o600)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samagotchi
 version: !ruby/object:Gem::Version
-  version: 0.108.0
+  version: 0.109.0
 platform: ruby
 authors:
 - Dmitry Dedov
@@ -497,6 +497,7 @@ files:
 - lib/samagotchi/prompt_literal_guard.rb
 - lib/samagotchi/prompt_note.rb
 - lib/samagotchi/prompt_warmup.rb
+- lib/samagotchi/proxy_trace.rb
 - lib/samagotchi/question_answer.rb
 - lib/samagotchi/question_asked.rb
 - lib/samagotchi/question_desk.rb
@@ -697,6 +698,7 @@ files:
 - lib/samagotchi/web/grants.rb
 - lib/samagotchi/web/info_probe.rb
 - lib/samagotchi/web/lan.rb
+- lib/samagotchi/web/link_codes.rb
 - lib/samagotchi/web/markdown_renderer.rb
 - lib/samagotchi/web/participant_access.rb
 - lib/samagotchi/web/participant_review.rb
@@ -704,6 +706,7 @@ files:
 - lib/samagotchi/web/participant_view.rb
 - lib/samagotchi/web/participants_admin.rb
 - lib/samagotchi/web/principal.rb
+- lib/samagotchi/web/proxy_gate.rb
 - lib/samagotchi/web/public/activity.js
 - lib/samagotchi/web/public/annotate_actions.js
 - lib/samagotchi/web/public/annotate_bar.js
@@ -711,6 +714,7 @@ files:
 - lib/samagotchi/web/public/annotations.js
 - lib/samagotchi/web/public/answer_refs.js
 - lib/samagotchi/web/public/app.js
+- lib/samagotchi/web/public/auth_lost.js
 - lib/samagotchi/web/public/bubbles.js
 - lib/samagotchi/web/public/card.js
 - lib/samagotchi/web/public/cards_place.js
@@ -799,6 +803,7 @@ files:
 - lib/samagotchi/web/public/timing.js
 - lib/samagotchi/web/public/toast_place.js
 - lib/samagotchi/web/public/toasts.js
+- lib/samagotchi/web/public/token_fragment.js
 - lib/samagotchi/web/public/tokens.css
 - lib/samagotchi/web/public/toolkit_chip.js
 - lib/samagotchi/web/public/turn_events.js
@@ -815,6 +820,7 @@ files:
 - lib/samagotchi/web/public/working_set.js
 - lib/samagotchi/web/public/working_set_rail.js
 - lib/samagotchi/web/public/working_set_view.js
+- lib/samagotchi/web/public_url.rb
 - lib/samagotchi/web/qr.rb
 - lib/samagotchi/web/running.rb
 - lib/samagotchi/web/server.rb