RubyGems - aspera-cli - Versions diffs - 4.27.5 → 4.28.0 - Mend

aspera-cli 4.27.5 → 4.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (139) hide show

checksums.yaml +4 -4
checksums.yaml.gz.sig +0 -0
data/CHANGELOG.md +160 -4
data/CONTRIBUTING.md +4 -2
data/README.md +1 -1
data/bin/asession +1 -1
data/docs/README.md +1086 -331
data/docs/test-mcp-with-ai.md +5 -3
data/lib/aspera/agent/direct.rb +15 -4
data/lib/aspera/agent/factory.rb +2 -1
data/lib/aspera/agent/node.rb +1 -1
data/lib/aspera/api/cos_node.rb +1 -1
data/lib/aspera/api/faspex.rb +1 -1
data/lib/aspera/api/node.rb +6 -2
data/lib/aspera/ascp/installation.rb +47 -11
data/lib/aspera/ascp/management.rb +89 -43
data/lib/aspera/cli/ascp_actions.rb +5 -19
data/lib/aspera/cli/bootstrapper.rb +1 -2
data/lib/aspera/cli/command_registry.rb +43 -3
data/lib/aspera/cli/command_spec.rb +3 -0
data/lib/aspera/cli/completion/ascli.bash +39 -5
data/lib/aspera/cli/completion/ascli.fish +16 -8
data/lib/aspera/cli/completion/ascli.ps1 +41 -0
data/lib/aspera/cli/completion/ascli.zsh +20 -4
data/lib/aspera/cli/completion_actions.rb +360 -0
data/lib/aspera/cli/error.rb +42 -0
data/lib/aspera/cli/extended_value.rb +30 -5
data/lib/aspera/cli/formatter.rb +118 -56
data/lib/aspera/cli/hints.rb +0 -1
data/lib/aspera/cli/http.rb +6 -5
data/lib/aspera/cli/info.rb +10 -4
data/lib/aspera/cli/mailer.rb +1 -1
data/lib/aspera/cli/mcp/http_servlet.rb +156 -0
data/lib/aspera/cli/mcp/secrets.rb +143 -0
data/lib/aspera/cli/mcp/tool.rb +231 -0
data/lib/aspera/cli/option_value.rb +9 -1
data/lib/aspera/cli/options.schema.yaml +390 -39
data/lib/aspera/cli/parser.rb +14 -5
data/lib/aspera/cli/plugins/aoc.rb +8 -11
data/lib/aspera/cli/plugins/base.rb +36 -15
data/lib/aspera/cli/plugins/config.rb +15 -44
data/lib/aspera/cli/plugins/console.rb +3 -1
data/lib/aspera/cli/plugins/factory.rb +1 -1
data/lib/aspera/cli/plugins/faspex5.rb +9 -19
data/lib/aspera/cli/plugins/faspio.rb +36 -5
data/lib/aspera/cli/plugins/httpgw.rb +1 -0
data/lib/aspera/cli/plugins/mcp.rb +177 -118
data/lib/aspera/cli/plugins/node.rb +14 -8
data/lib/aspera/cli/plugins/orchestrator.rb +351 -38
data/lib/aspera/cli/plugins/server.rb +3 -1
data/lib/aspera/cli/plugins/shares.rb +205 -35
data/lib/aspera/cli/preset_actions.rb +15 -7
data/lib/aspera/cli/preset_manager.rb +24 -2
data/lib/aspera/cli/prompt.rb +3 -1
data/lib/aspera/cli/result.rb +17 -4
data/lib/aspera/cli/runner.rb +133 -43
data/lib/aspera/cli/security.rb +134 -0
data/lib/aspera/cli/table_fitter.rb +116 -0
data/lib/aspera/cli/terminal_formatter.rb +23 -34
data/lib/aspera/cli/transfer_agent.rb +4 -1
data/lib/aspera/cli/vault_manager.rb +6 -5
data/lib/aspera/cli/version.rb +1 -1
data/lib/aspera/cli/web_secret.html.erb +61 -0
data/lib/aspera/cli/web_secret.rb +220 -0
data/lib/aspera/cli/wizard.rb +19 -9
data/lib/aspera/command_line_builder.rb +26 -0
data/lib/aspera/data_repository.rb +38 -24
data/lib/aspera/duration.rb +42 -0
data/lib/aspera/environment.rb +88 -24
data/lib/aspera/exec_spec.rb +6 -5
data/lib/aspera/faspex_gw.rb +98 -32
data/lib/aspera/faspex_postproc.rb +187 -44
data/lib/aspera/formatter_interface.rb +0 -1
data/lib/aspera/id_generator.rb +2 -1
data/lib/aspera/json_rpc/client.rb +51 -32
data/lib/aspera/json_rpc/version.rb +1 -0
data/lib/aspera/keychain/base.rb +5 -0
data/lib/aspera/keychain/encrypted_hash.rb +6 -2
data/lib/aspera/keychain/factory.rb +2 -3
data/lib/aspera/keychain/hashicorp_vault.rb +7 -4
data/lib/aspera/keychain/macos_security.rb +119 -13
data/lib/aspera/keychain/one_password_api.rb +8 -3
data/lib/aspera/keychain/one_password_base.rb +14 -9
data/lib/aspera/keychain/one_password_cli.rb +4 -2
data/lib/aspera/log.rb +3 -6
data/lib/aspera/markdown.rb +152 -115
data/lib/aspera/mime.rb +6 -0
data/lib/aspera/nagios.rb +3 -1
data/lib/aspera/node_emulator.rb +98 -101
data/lib/aspera/oauth/{base.rb → client/base.rb} +5 -4
data/lib/aspera/oauth/{boot.rb → client/boot.rb} +3 -2
data/lib/aspera/oauth/{factory.rb → client/factory.rb} +7 -0
data/lib/aspera/oauth/{generic.rb → client/generic.rb} +1 -1
data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +1 -1
data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +1 -1
data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +1 -1
data/lib/aspera/oauth/{web.rb → client/web.rb} +2 -2
data/lib/aspera/oauth/server/authorize.html.erb +34 -0
data/lib/aspera/oauth/server/pkce.rb +426 -0
data/lib/aspera/orchestrator_workflow_checker.rb +561 -0
data/lib/aspera/preview/terminal.rb +3 -2
data/lib/aspera/rainbow.rb +27 -1
data/lib/aspera/rest/aspera_errors.rb +51 -59
data/lib/aspera/rest/client.rb +21 -14
data/lib/aspera/rest/error_analyzer.rb +9 -0
data/lib/aspera/rest/list.rb +6 -6
data/lib/aspera/rest/util.rb +7 -1
data/lib/aspera/rest.rb +0 -1
data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +0 -2
data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4001 -0
data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +35 -35
data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
data/lib/aspera/schema/documentation.rb +50 -78
data/lib/aspera/schema/reader.rb +39 -11
data/lib/aspera/schema/registry.rb +8 -2
data/lib/aspera/secret_hider.rb +94 -15
data/lib/aspera/secret_strength.rb +114 -0
data/lib/aspera/servlet_helpers.rb +111 -0
data/lib/aspera/sync/args.schema.yaml +3 -1
data/lib/aspera/sync/conf.schema.yaml +16 -6
data/lib/aspera/sync/operations.rb +21 -1
data/lib/aspera/temp_file_manager.rb +79 -20
data/lib/aspera/transfer/parameters.rb +5 -0
data/lib/aspera/transfer/spec.rb +52 -12
data/lib/aspera/transfer/spec.schema.yaml +8 -5
data/lib/aspera/web_auth/index.html.erb +16 -0
data/lib/aspera/web_auth/server.rb +18 -10
data/lib/aspera/web_page.html.erb +262 -0
data/lib/aspera/web_page.rb +61 -0
data/lib/aspera/web_server_simple.rb +76 -10
data.tar.gz.sig +0 -0
metadata +47 -32
metadata.gz.sig +0 -0
data/lib/aspera/cli/mcp_tool.rb +0 -189
data/lib/aspera/oauth.rb +0 -9
data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
data/lib/aspera/web_auth/index.html +0 -147

data/lib/aspera/web_auth/server.rb CHANGED Viewed

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 require 'aspera/web_server_simple'
+require 'aspera/servlet_helpers'
+require 'aspera/web_page'
 require 'aspera/assert'
-require 'erb'
 module Aspera
   module WebAuth
     # servlet called on callback: it records the callback request
     class Servlet < WEBrick::HTTPServlet::AbstractServlet
+      include ServletHelpers
+      # ERB template of page displayed in browser after authentication
+      HTML_TEMPLATE_PATH = File.join(__dir__, 'index.html.erb')
+      private_constant :HTML_TEMPLATE_PATH
       # @param server [WEBrick::HTTPServer] the HTTP server instance
       # @param web_auth [Server] the Server instance to record the callback
       def initialize(server, web_auth)
@@ -20,12 +27,14 @@ module Aspera
       def service(request, response)
         Log.log.debug { "received request from browser #{request.request_method} #{request.path}" }
-        Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed) { "Unsupported method: #{req.request_method}" }
-        Aspera.assert_values(request.path, ['/'], type: WEBrick::HTTPStatus::NotFound) { "Unsupported path: #{req.request_method}" }
+        # Refuse requests of other web pages
+        check_request(request)
+        Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed) { "Unsupported method: #{request.request_method}" }
+        Aspera.assert_values(request.path, [@web_auth.expected_path], type: WEBrick::HTTPStatus::NotFound) { "Unsupported path: #{request.path}" }
         # response to browser
         response.status = 200
-        response.content_type = 'text/html'
-        response.body = File.read("#{__dir__}/index.html").gsub('__ADD_INFO__', @web_auth.info_html)
+        WebPage.secure_headers(response)
+        response.body = WebPage.render(HTML_TEMPLATE_PATH, title: 'Authentication Complete', additional_info: @web_auth.additional_info)
         # continue internal processing
         @web_auth.signal_request(request)
         nil
@@ -36,7 +45,7 @@ module Aspera
     # then start a browser that will callback the local server upon authentication
     # store the final query
     class Server < WebServerSimple
-      attr_reader :info_html
+      attr_reader :additional_info, :expected_path
       # @param endpoint_url    [String] e.g. 'https://127.0.0.1:12345'
       # @param additional_info [String] Information in web page
@@ -47,8 +56,7 @@ module Aspera
         @cond = ConditionVariable.new
         @expected_path = uri.path.empty? ? '/' : uri.path
         @query = nil
-        @info_html = additional_info.to_s
-        @info_html = "<p>#{ERB::Util.html_escape(@info_html)}</p>" unless @info_html.empty?
+        @additional_info = additional_info
         # last argument (self) is provided to constructor of servlet
         mount(@expected_path, Servlet, self)
         # server runs in thread
@@ -70,8 +78,8 @@ module Aspera
       # wait for request on web server (main thread)
       # @return [Hash] the query
       def received_request
-        # wait for signal from thread
-        @mutex.synchronize { @cond.wait(@mutex) }
+        # wait for signal from thread, unless the request was already received (signal is not memorized)
+        @mutex.synchronize { @cond.wait(@mutex) while @query.nil? }
         # tell server thread to stop
         shutdown
         return @query

data/lib/aspera/web_page.html.erb ADDED Viewed

@@ -0,0 +1,262 @@
+<%# Layout of HTML pages: style and branding, see Aspera::WebPage. Variables: title, content (HTML of the card) %>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <%# Light and dark themes: the browser adapts form controls and scrollbars too %>
+    <meta name="color-scheme" content="light dark">
+    <link rel="icon" type="image/svg+xml"
+        href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Crect width='32' height='32' rx='6' fill='%230f62fe'/%3E%3Ctext x='16' y='22' font-family='monospace' font-size='18' font-weight='bold' fill='white' text-anchor='middle'%3E%3E_%3C/text%3E%3C/svg%3E">
+    <title><%= h title %></title>
+    <style>
+        /* Colors: light theme, overridden by the dark theme of the system or browser */
+        :root {
+            --page-bg-start: #f0f4f8;
+            --page-bg-end: #d9e2ec;
+            --card-bg: #ffffff;
+            --surface: #f4f4f4;
+            --border: #e0e0e0;
+            --shadow: 0 4px 24px rgba(0, 0, 0, 0.08), 0 1px 3px rgba(0, 0, 0, 0.04);
+            --text: #161616;
+            --text-secondary: #525252;
+            --text-muted: #8d8d8d;
+            --accent: #0f62fe;
+            --button-bg: #0f62fe;
+            --button-bg-hover: #0043ce;
+            --on-button: #ffffff;
+            --danger: #da1e28;
+            --danger-bg: #da1e28;
+            --success: #24a148;
+            --icon-bg: #edf5ff;
+            --icon-bg-ok: #defbe6;
+            --icon-bg-ko: #fff1f1;
+            --input-bg: #ffffff;
+            --input-border: #8d8d8d;
+        }
+        @media (prefers-color-scheme: dark) {
+            :root {
+                --page-bg-start: #121619;
+                --page-bg-end: #1d2226;
+                --card-bg: #21272a;
+                --surface: #2f353a;
+                --border: #42484e;
+                --shadow: 0 4px 24px rgba(0, 0, 0, 0.45), 0 1px 3px rgba(0, 0, 0, 0.3);
+                --text: #f2f4f8;
+                --text-secondary: #c1c7cd;
+                --text-muted: #878d96;
+                --accent: #78a9ff;
+                --button-bg: #0f62fe;
+                --button-bg-hover: #0050e6;
+                --on-button: #ffffff;
+                --danger: #ff8389;
+                --danger-bg: #da1e28;
+                --success: #42be65;
+                --icon-bg: rgba(69, 137, 255, 0.18);
+                --icon-bg-ok: rgba(66, 190, 101, 0.18);
+                --icon-bg-ko: rgba(250, 77, 86, 0.18);
+                --input-bg: #121619;
+                --input-border: #697077;
+            }
+        }
+        * {
+            box-sizing: border-box;
+            margin: 0;
+            padding: 0;
+        }
+        body {
+            font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+            background: linear-gradient(135deg, var(--page-bg-start) 0%, var(--page-bg-end) 100%);
+            min-height: 100vh;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            padding: 1.5rem;
+            color: var(--text);
+        }
+        .card {
+            background: var(--card-bg);
+            border-radius: 12px;
+            box-shadow: var(--shadow);
+            border: 1px solid var(--border);
+            max-width: 460px;
+            width: 100%;
+            padding: 2.25rem 2rem;
+            text-align: center;
+        }
+        .brand {
+            display: inline-flex;
+            align-items: center;
+            gap: 0.5rem;
+            margin-bottom: 1.5rem;
+            padding: 0.25rem 0.75rem;
+            background: var(--surface);
+            border-radius: 16px;
+            font-size: 0.8rem;
+            color: var(--text-secondary);
+            border: 1px solid var(--border);
+        }
+        .brand .badge {
+            font-weight: 700;
+            color: var(--accent);
+            font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;
+        }
+        /* Icons are drawn with currentColor */
+        .icon-circle {
+            width: 56px;
+            height: 56px;
+            border-radius: 50%;
+            margin: 0 auto 1.25rem;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            background: var(--icon-bg);
+            color: var(--accent);
+        }
+        .icon-circle.ok {
+            background: var(--icon-bg-ok);
+            color: var(--success);
+        }
+        .icon-circle.ko {
+            background: var(--icon-bg-ko);
+            color: var(--danger);
+        }
+        h1 {
+            font-size: 1.5rem;
+            font-weight: 600;
+            color: var(--text);
+            margin-bottom: 0.5rem;
+        }
+        p {
+            font-size: 0.95rem;
+            line-height: 1.5;
+            color: var(--text-secondary);
+            margin-top: 0.5rem;
+        }
+        .client {
+            font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;
+            font-weight: 600;
+            background: var(--surface);
+            padding: 0.15rem 0.4rem;
+            border-radius: 4px;
+            color: var(--text);
+            border: 1px solid var(--border);
+            word-break: break-all;
+        }
+        .actions {
+            display: flex;
+            gap: 0.75rem;
+            margin-top: 1.5rem;
+            justify-content: center;
+        }
+        button {
+            flex: 1;
+            padding: 0.75rem 1.25rem;
+            font-size: 0.95rem;
+            font-weight: 500;
+            border-radius: 6px;
+            cursor: pointer;
+            transition: background-color 0.15s ease, border-color 0.15s ease, color 0.15s ease;
+            border: 1px solid transparent;
+        }
+        .allow {
+            background: var(--button-bg);
+            color: var(--on-button);
+            border-color: var(--button-bg);
+        }
+        .allow:hover {
+            background: var(--button-bg-hover);
+            border-color: var(--button-bg-hover);
+        }
+        .deny {
+            background: var(--card-bg);
+            color: var(--danger);
+            border: 1px solid var(--danger);
+        }
+        .deny:hover {
+            background: var(--danger-bg);
+            border-color: var(--danger-bg);
+            color: var(--on-button);
+        }
+        .secret {
+            display: block;
+            margin-top: 1.25rem;
+            text-align: left;
+            font-size: 0.875rem;
+            color: var(--text-secondary);
+        }
+        .secret input {
+            display: block;
+            width: 100%;
+            margin-top: 0.35rem;
+            padding: 0.6rem 0.75rem;
+            font-size: 0.95rem;
+            background: var(--input-bg);
+            color: var(--text);
+            border: 1px solid var(--input-border);
+            border-radius: 6px;
+        }
+        .error {
+            color: var(--danger);
+            font-weight: 600;
+        }
+        .info-box {
+            background: var(--surface);
+            border-radius: 6px;
+            padding: 0.75rem 1rem;
+            margin-top: 1.25rem;
+            font-size: 0.875rem;
+            color: var(--text);
+            word-break: break-word;
+            border-left: 3px solid var(--accent);
+            text-align: left;
+        }
+        .footer {
+            margin-top: 1.5rem;
+            padding-top: 1rem;
+            border-top: 1px solid var(--surface);
+            font-size: 0.75rem;
+            color: var(--text-muted);
+        }
+    </style>
+</head>
+<body>
+    <div class="card">
+        <div class="brand">
+            <span class="badge">ascli</span>
+            <span>IBM Aspera CLI</span>
+        </div>
+<%= content %>
+        <div class="footer">
+            IBM Aspera Command-Line Interface
+        </div>
+    </div>
+</body>
+</html>

data/lib/aspera/web_page.rb ADDED Viewed

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'erb'
+module Aspera
+  # HTML pages of embedded web servers, sharing a layout: style and branding.
+  # The ERB template of each page is the content of the card of the layout, with its own variables.
+  module WebPage
+    # ERB template of the layout, with variables `title` and `content`
+    LAYOUT_PATH = File.join(__dir__, 'web_page.html.erb')
+    # Context of templates: variables as methods, and `h` to escape HTML
+    class Context
+      include ERB::Util
+      # @param variables [Hash{Symbol => Object}] Variables of the template
+      def initialize(variables)
+        variables.each { |name, value| define_singleton_method(name) { value } }
+      end
+      # @param template_path [String] Path of the ERB template
+      # @return [String] Result of the template
+      def render(template_path)
+        ERB.new(File.read(template_path)).result(template_binding)
+      end
+      private
+      # @return [Binding] Binding without local variables, so that they do not hide template variables
+      def template_binding = binding
+    end
+    # Headers of HTML pages: type, and protection against clickjacking, caching, and leak of the URL to other sites.
+    # Not `Referrer-Policy: no-referrer`: the browser would send `Origin: null` with a form, refused by ServletHelpers#check_request
+    HEADERS = {
+      'Content-Type'            => 'text/html; charset=utf-8',
+      'X-Frame-Options'         => 'DENY',
+      'Content-Security-Policy' => "frame-ancestors 'none'",
+      'Cache-Control'           => 'no-store',
+      'Referrer-Policy'         => 'same-origin'
+    }.freeze
+    private_constant :LAYOUT_PATH, :Context, :HEADERS
+    class << self
+      # Set the headers of an HTML page: type and security headers
+      # @param response [WEBrick::HTTPResponse]
+      # @return [nil]
+      def secure_headers(response)
+        HEADERS.each { |name, value| response[name] = value }
+        nil
+      end
+      # @param template_path [String] Path of the ERB template of the content of the page
+      # @param title         [String] Title of the page
+      # @param variables     [Hash]   Variables of the template of the content
+      # @return [String] HTML page
+      def render(template_path, title:, **variables)
+        content = Context.new(variables).render(template_path)
+        Context.new(title: title, content: content).render(LAYOUT_PATH)
+      end
+    end
+  end
+end

data/lib/aspera/web_server_simple.rb CHANGED Viewed

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require 'delegate'
+require 'ipaddr'
 require 'webrick'
 require 'aspera/log'
 require 'aspera/assert'
@@ -15,9 +17,67 @@ module Aspera
     PKCS12_EXT = %w[p12 pfx].map { |i| ".#{i}" }.freeze
     CLOCK_SKEW_OFFSET_SEC = 5
-    private_constant :GENERIC_ISSUER, :ONE_YEAR_SECONDS, :PKCS12_EXT, :CLOCK_SKEW_OFFSET_SEC
+    private_constant :PARAMS, :DEFAULT_URL, :GENERIC_ISSUER, :ONE_YEAR_SECONDS, :PKCS12_EXT, :CLOCK_SKEW_OFFSET_SEC
+    # Logger of WEBrick: its information messages (version, start, shutdown) at debug level, the server logs its URL
+    class WebrickLogger < SimpleDelegator
+      def info(message = nil, &block) = debug(message, &block)
+      def info? = debug?
+    end
+    private_constant :WebrickLogger
+    # @return [URI] URL of the server, with the port it listens on: any free port if `0` was given
+    attr_reader :uri
     class << self
+      # @param host [String] Host name or IP address the server listens on
+      # @return [Boolean] `true` if the server is reachable from the local host only
+      def loopback?(host)
+        return true if host.eql?('localhost')
+        address = IPAddr.new(host)
+        # Older versions of ipaddr do not see IPv4-mapped IPv6 addresses (::ffff:127.0.0.1) as loopback
+        address = address.native if address.ipv4_mapped?
+        address.loopback?
+      rescue IPAddr::Error
+        false
+      end
+      # @param parameters [Hash] Parameters of a command that starts a server (symbol keys): `url`, `cert`, `key`, `chain`, others are for the servlet
+      # @return [URI] URL of the server: `url`, or `DEFAULT_URL`
+      def url(parameters) = URI.parse(parameters.fetch(:url, DEFAULT_URL))
+      # @param parameters [Hash] Parameters of a command that starts a server, see `url`
+      # @return [Hash] Parameters of the servlet: other than `url`, `cert`, `key`, `chain`
+      def servlet_parameters(parameters) = parameters.except(:url, *PARAMS)
+      # Start a server with one servlet on the path of `url`, until signal INT or TERM.
+      # A server without protection reachable from the network is refused, see `assert_protected`.
+      # @param parameters [Hash]      Parameters of the command, see `url`
+      # @param servlet    [Class]     Servlet
+      # @param protected  [Boolean]   `true` if requests are authenticated or restricted
+      # @param what       [String]    Parameters that protect the server, for the error message
+      # @param type       [Exception] Exception to raise
+      # @yieldreturn [Array] Arguments of the servlet, evaluated once parameters are checked
+      def serve(parameters, servlet, protected:, what:, type: ParameterError)
+        uri = url(parameters)
+        assert_protected(uri.hostname, protected: protected, what: what, type: type)
+        server = new(uri, **parameters.slice(*PARAMS))
+        server.mount(uri.path, servlet, *yield)
+        server.start
+      end
+      # Refuse a server without protection reachable from the network: anyone could call it
+      # @param host      [String]    Host name or IP address the server listens on
+      # @param protected [Boolean]   `true` if requests are authenticated or restricted
+      # @param what      [String]    Parameters that protect the server, for the error message
+      # @param type      [Exception] Exception to raise
+      # @raise [Exception] if not protected and `host` is not a loopback address
+      def assert_protected(host, protected:, what:, type: ParameterError)
+        Aspera.assert(protected || loopback?(host), type: type) do
+          "#{what} is required when the server listens on an address that is not loopback (localhost, 127.0.0.0/8, ::1): #{host}"
+        end
+      end
       # Generate or fill and self sign certificate
       def self_signed_cert(private_key, digest: 'SHA256')
         cert = OpenSSL::X509::Certificate.new
@@ -46,18 +106,19 @@ module Aspera
       end
     end
-    # @param url   [URI]    Local address where server will listen (use scheme, host and port only)
+    # @param uri   [URI]    Local address where server will listen (use scheme, host and port only), port `0` for any free port
     # @param cert  [String] Path to certificate file, either with extension .p12 or .pfx, else assumed PEM
     # @param key   [String] Path to key file (PEM) or passphrase (pkcs12)
     # @param chain [String] Path to certificate chain file (PEM only)
     def initialize(uri, cert: nil, key: nil, chain: nil)
       Aspera.assert_type(uri, URI)
-      @uri = uri
+      @uri = uri.dup
       # see https://www.rubydoc.info/stdlib/webrick/WEBrick/Config
       webrick_options = {
-        BindAddress: @uri.host,
+        # without brackets of IPv6 address
+        BindAddress: @uri.hostname,
         Port:        @uri.port,
-        Logger:      Log.log,
+        Logger:      WebrickLogger.new(Log.log),
         AccessLog:   [[self, WEBrick::AccessLog::COMMON_LOG_FORMAT]] # replace default access log to call local method "<<" below
       }
       case @uri.scheme
@@ -92,7 +153,7 @@ module Aspera
           else
             OpenSSL::X509::Certificate.new(File.read(cert))
           end
-          webrick_options[:SSLExtraChainCert] = read_chain_file(chain) unless chain.nil?
+          webrick_options[:SSLExtraChainCert] = self.class.read_chain_file(chain) unless chain.nil?
           Aspera.assert(webrick_options[:SSLCertificate].public_key.to_der == webrick_options[:SSLPrivateKey].public_key.to_der, type: Error) { 'key and cert do not match' }
         end
       end
@@ -100,14 +161,19 @@ module Aspera
       # self signed certificate generates characters on STDERR
       # see create_self_signed_cert in webrick/ssl.rb
       Log.capture_stderr { super(webrick_options) }
+      @uri.port = config[:Port]
     end
-    # blocking
+    # Serve requests until #shutdown.
+    # In the main thread, signals INT and TERM call #shutdown.
+    # In another thread, signals are left to the application, which calls #shutdown, e.g. INT interrupts the main thread.
     def start
       Log.log.info { "Listening on #{@uri}" }
-      # kill (-TERM) for graceful shutdown
-      handler = proc { shutdown }
-      %i{INT TERM}.each { |sig| trap(sig, &handler) }
+      if Thread.current.equal?(Thread.main)
+        # kill (-TERM) for graceful shutdown
+        handler = proc { shutdown }
+        %i{INT TERM}.each { |sig| trap(sig, &handler) }
+      end
       super
     end

data.tar.gz.sig CHANGED Viewed

Binary file