@hivemagnus/hive-skills 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,157 @@
-# Temporary Holding Version
+# @hivemagnus/hive-skills
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`hive-skills` is the top-level Skills registry for Hermes Agents. It exposes a digest-verified HTTPS archive API, an OS-authenticated operator page, and a pull-side Hermes bridge. Hermes itself remains unmodified: each host gets a user systemd timer that syncs skill archives into `~/.hermes/skills/registry` and restarts the gateway only when content changes.
+
+The registry is intentionally small and local-first. SQLite records skills, releases, sessions, audit events, and deployment targets; archives live under the configured data directory. The initial catalog entry is **HiveMem**, based on the existing HiveMem Hermes plugin/skill source supplied at seed time.
+
+## Install with the Hive launcher
+
+Run `npx @hivemagnus/hive@^1.1.0 init --services all` to configure all four services,
+or select `--services skills` for this registry alone. The launcher generates private
+configuration, a strong session secret and TLS, and wires the Router's Skills panel.
+Skills OS/PAM administration remains separate from IAM sign-in. See the
+[launcher guide](../../packages/hive/README.md#include-hive-skills).
+
+## Install from npm
+
+Requires Linux, Node.js 24.22.1+ or 26.13.0+, TLS certificates, and `pamtester` for
+OS-backed sign-in. SQLite is provided by Node; there are no native npm add-ons.
+Agent deployment also needs Bash, OpenSSH, and permission to enable the target's user timer.
+
+```bash
+npm install --prefix /opt/hive-skills/runtime @hivemagnus/hive-skills@1.1.0
+/opt/hive-skills/runtime/node_modules/.bin/hive-skills --env-file /opt/hive-skills/skills.env
+```
+
+Or run `npx @hivemagnus/hive-skills --env-file skills.env`. The CLI accepts `start`
+(the default), `seed`, `check`, `env-schema`, `--help` and `--version`. `check` validates TLS,
+configuration and an existing database without creating or migrating state. `env-schema` prints
+configuration metadata without loading runtime configuration. Environment-file paths may be absolute;
+existing environment variables win. Without `--env-file`, the historical `./.env` lookup
+is retained. Help/version do not initialize storage. A fresh install starts with an empty
+catalog; startup never seeds or replaces existing records.
+
+Configure these values in a private environment file (mode 0600):
+
+```dotenv
+NODE_ENV=production
+HIVE_SKILLS_HOST=127.0.0.1
+HIVE_SKILLS_PORT=4030
+HIVE_SKILLS_PUBLIC_URL=https://hive.example.com:4030
+HIVE_SKILLS_DATA_DIR=/opt/hive-skills/shared/data
+HIVE_SKILLS_SESSION_SECRET=replace-with-at-least-32-random-characters
+HIVE_SKILLS_ADMIN_USERS=admin
+HIVE_SKILLS_PAM_SERVICE=login
+HIVE_SKILLS_TLS_KEY_FILE=/opt/hive-skills/tls/server.key
+HIVE_SKILLS_TLS_CERT_FILE=/opt/hive-skills/tls/server.crt
+```
+
+Generate the session secret with `openssl rand -hex 32`. Configure a bind address suitable
+for the network where the registry is exposed and a certificate covering its public URL.
+The service account needs write access to the data directory and read access to its TLS files.
+Keep the session secret unchanged on upgrades to preserve active sessions.
+
+The packaged deployment helper is selected automatically; set `HIVE_SKILLS_DEPLOY_SCRIPT` only
+for an intentional override. The package also ships `scripts/hermes-sync.mjs`,
+`scripts/archive-utils.mjs`, `scripts/deploy-hermes-agent.sh` and the bundled seed source.
+They work independently of the process working directory.
+
+For an existing systemd installation, follow the
+[npm migration runbook](../../docs/npm-deployments.md#optional-skills-registry).
+Preserve that installation's environment, database, archives, release channels, target policies,
+credentials and service account. Back up first; do not seed a production migration.
+
+## Bring up the registry server
+
+```bash
+cp .env.example .env
+# Set a real session secret and the certificate/key paths already managed by the server.
+npm install
+npm run build
+HIVE_SKILLS_DEPLOY_HOST=hive.example.com HIVE_SKILLS_ENV_FILE="$PWD/.env" bash scripts/deploy-hive-skills.sh
+```
+
+The service listens on a dedicated TLS port (default `4030`) and does not mint certificates itself. It uses the server's existing certificate and key specified in `.env`.
+
+`HIVE_SKILLS_SESSION_SECRET` (at least 32 characters) is required. Only a non-production instance bound to a loopback address falls back to an ephemeral random secret, with a warning; its sessions end on restart.
+
+`scripts/deploy-hive-skills.sh` preserves `/opt/hive-skills/shared/.env`, installs the PAM policy and `hive-skills.service`, and activates a health-gated release. New hosts require their own env file; existing hosts retain their own state. `HIVE_SKILLS_ADMIN_USERS` lists the OS accounts allowed to administer the registry (there is no default); authentication is checked through PAM against the host OS account, and the registry stores only a server-side session hash—never an OS password.
+
+## Seed HiveMem
+
+The bundled `registry-sources/hivemem` skill is the initial registry entry and documents the existing HiveMem plugin/tools. Seed it after build:
+
+```bash
+npm run seed
+```
+
+For an npm install, run the same explicit operation with its CLI:
+
+```bash
+/opt/hive-skills/runtime/node_modules/.bin/hive-skills seed --env-file /opt/hive-skills/skills.env
+```
+
+The command validates and archives the bundled source as `hivemem` release `1.0.0` and promotes it to stable. Set `HIVEMEM_ARCHIVE` to seed a separately packaged replacement instead. Releases are immutable; later release and catalog CRUD operations are available to the OS-admin through the API.
+
+## Hermes compatibility
+
+Install the client bridge on an agent host using its own SSH key and explicit target settings:
+
+```bash
+HIVE_SKILLS_PUBLIC_URL=https://hive.example.com:4030 \
+HIVE_SKILLS_TARGET_HOST=agent-host.example.com \
+HIVE_SKILLS_TARGET_USER=deploy \
+  scripts/deploy-hermes-agent.sh --target agent-1
+```
+
+That installs a `hive-skills-sync` systemd **user** service and timer for the target account. The timer pulls `/v1/agent/manifest` and downloads only changed archives with SHA-256 verification. It never edits Hermes core code. A registry admin can invoke the same deployment from the web page; the server queues a durable deployment job and records its completion status. No target OS password is stored in the network service environment.
+
+Releases may declare `minHermesVersion` and `maxHermesVersion` when published.
+The bridge detects the local `hermes --version`, supplies it to the manifest, and
+checks the returned range again before installation. Set
+`HIVE_SKILLS_HERMES_VERSION` in the target's private bridge environment only when
+the Hermes wrapper cannot report its version. A bounded release is omitted when
+the target version is missing or incompatible; unbounded existing releases remain
+backward compatible. Compatibility is evaluated locally per installation; separate
+registry installations do not synchronize Skills state.
+
+## API overview
+
+- `GET /healthz` – unauthenticated readiness
+- `GET /v1/skills` / `GET /v1/skills/:slug` – public catalog
+- `GET /v1/agent/manifest` – Hermes pull manifest
+- `GET /v1/skills/:slug/releases/:version/archive[?channel=canary]` – archive payload, only for the release currently promoted on that channel (default `stable`)
+- `POST /auth/login` – PAM-backed OS login
+- `POST /admin/skills`, `PATCH /admin/skills/:slug`, `DELETE /admin/skills/:slug`
+- `POST /admin/skills/:slug/releases`, `POST /admin/deployments/:target`
+
+Every write and deployment action is audit logged with the authenticated OS username.
+
+Skills is optional; each registry installation is independent.
+
+Deployment targets can be seeded at startup with `HIVE_SKILLS_TARGETS`, a
+comma-separated list of `name=user@host` entries (for example
+`agent-1=deploy@agent-host.example.com`). Manage them afterwards with `GET /admin/targets` and `PUT /admin/targets/:name`
+(`host`, `username`, `enabled`). Changing a target host/account or disabling it
+revokes its pull enrollment. Enroll again to assign a channel and optional skill
+list. Preserve `~/.config/hive-skills/bridge.env` on that target for its own
+`HIVE_SKILLS_TARGET` and `HIVE_SKILLS_TARGET_TOKEN`; the installer reads this
+optional file without replacing it. The manifest of a canary-enrolled target
+points at channel-scoped archive URLs. Unpromoted, superseded and withdrawn
+releases cannot be downloaded. Promoted archives remain public within the
+registry's network boundary: target skill lists select distribution, they are
+not an archive confidentiality boundary.
+
+## Package verification
+
+From the repository, after building, run `npm run check:skills-install`. It packs the package,
+installs it into an empty temporary directory, and verifies CLI startup/seed, HTTPS, catalog,
+manifest, archive digests, authorization boundaries, a real bridge pull, a repeated pull, and
+persistence after restart. All data and the bridge profile are temporary; gateway restart is
+replaced by a counter. No production registry, OS account or gateway is changed.
+
+Run `npm run check:skills-install -- --registry` to repeat this against the exact published
+version in `package.json`. CI also checks the package allowlist and npm 12 installation.
+The package publishes from `.github/workflows/publish.yml` alongside the other packages;
+configure its npm trusted publisher for that workflow and the `npm-publish` environment after
+the initial authenticated publication.