Skip to main content

shipwright-license

Offline-verifiable license files for Shipwright products (Shipwright, Harbor, Engine Room). Licensed under Apache-2.0, so the open-source Engine Room core can verify licenses without pulling in proprietary code.

  • Format: compact JWS, alg: EdDSA (Ed25519), typ: shipwright-license+jwt, wrapped in -----BEGIN SHIPWRIGHT LICENSE----- armor.
  • Trust: verification uses only the trust-anchor key set compiled into the product. It never fetches keys.
  • Fail-safe: verify_license never raises for a bad license. It returns INVALID, and the product falls back to community features. A license problem never stops a product from serving and never touches data.
from shipwright_license import KeySet, verify_license

TRUST_ANCHORS = KeySet.from_mapping(
    {
        "lic-2026-01": "<base64url raw Ed25519 public key>",  # active
        "lic-2027-01": "<base64url raw Ed25519 public key>",  # next (pre-shipped for rotation)
    }
)

result = verify_license(
    open("/etc/shipwright/license.lic").read(),
    keyset=TRUST_ANCHORS,
    product="engine-room",
    # One id, or several while migrating ids (any match counts):
    appliance_id=[appliance_uuid, legacy_appliance_id],
)
if result.has_feature("ee.pool"):
    enable_pool(max_nodes=result.limit("max_nodes"))

States

State Meaning Licensed features
valid Signature good, within term on
expiring 30 days or fewer left on (show banner)
grace Past exp, within grace_days on (loud warning)
expired Past grace off
invalid Bad signature, key, audience, binding, header or claims off

Rejected header parameters

Only alg, kid and typ are accepted in the header. Any other parameter (for example jku, jwk, x5u, x5c or crit) makes the license invalid. alg must be exactly EdDSA.

The full specification is docs/license-format.md in the Admiralty repository.

Metadata

Release files for shipwright-license 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shipwright-license 0.2.0
File Size Uploaded Provenance Actions
shipwright_license-0.2.0.tar.gz 20.1 kB Without provenance Details for shipwright_license-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for shipwright-license 0.2.0
File Interpreter ABI Platform Actions
shipwright_license-0.2.0-py3-none-any.whl Python 3 none any Details for shipwright_license-0.2.0-py3-none-any.whl

Total release size: 38.0 kB

Release files / shipwright_license-0.2.0.tar.gz

Download URL shipwright_license-0.2.0.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e665d30ea19e04b207332d83f975d7cbc7d30cd93d6b46248b20fa1b3cb7998e
BLAKE2b-256 checksum
How to use checksums
62bc1cbeeedc723c489715ca8cd02c288512004e43d34d0ce4eb76e3d064dd21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / shipwright_license-0.2.0-py3-none-any.whl

Download URL shipwright_license-0.2.0-py3-none-any.whl
Size 17.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8792902bc3b867b1537a36e3b3310392f9549396befe45470ba87f79958e92fe
BLAKE2b-256 checksum
How to use checksums
eb22f38545f2eef6b249905eb196c196e69e8438e988ffd8cfdb226faacb60f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for shipwright-license 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page