DOCSEARCHbyAlgolia
Submit Docs

Polykey Documentation

website·Indexed 31 days ago

https://polykey.com/docs

Documentation for Polykey, a decentralized secret management system. Includes reference guides for the Polykey CLI, core architecture (Kademlia DHT, QUIC, and JSON-RPC), and specifications for Vaults, Gestalts, and Identities. Provides development guides for CI/CD, Docker image publishing, and the PSP-1 specification.

Tokens
59.3K
Snippets
258
Records
512
Agent score
62%

What's inside Polykey

  1. Overview of Polykey secrets management

    Polykey is an open-source, peer-to-peer secrets management system designed for individuals, teams, and software agents. It operates as a local-first network where each agent runs as a node. Secrets (such as passwords, private keys, tokens, and credit card info) are stored in encrypted, version-controlled vaults that function like a secure virtual filesystem. Data is end-to-end encrypted in transit and encrypted at rest using XChaCha20-Poly1305, with X25519 for key exchange and Ed25519 for signatures.

  2. Overview of JSON Web X (JWX) standards in Polykey

    Polykey utilizes the JSON Web X (JWX) family of standards to ensure interoperability, flexibility, and security across cryptographic implementations. The core standards used include:

    • JSON Web Token (JWT): Packages claims in a structured format.
    • JSON Web Algorithm (JWA): Defines the cryptographic algorithms used.
    • JSON Web Signature (JWS): Ensures message integrity and authenticity via signing.
    • JSON Web Encryption (JWE): Ensures data confidentiality via encryption.
    • JSON Web Key (JWK): Represents cryptographic keys in JSON format.

  3. Overview of the PSP-1 Capability Model

    PSP-1 defines a portable, verifiable capability model used by Polykey to express delegated authority through identity-bound Grants and Presentations.

    Key architectural concepts include:

    • Capability Programs: Monotone programs evaluated by Capability Enforcement Points (CEPs). They are normalized into a Program Canonical Form (PCF) and deterministically encoded to create stable content identifiers.
    • Delegation via Attenuation: Authority is delegated by syntactic attenuation. Derived Grants can only add checks or shrink action/resource scopes; they can never broaden authority.
    • Verification: CEPs verify Proof-of-Possession (PoP), channel binding, and syntactic attenuation along delegation chains to determine if enforcement should proceed.

  4. Overview of Polykey secret management

    Polykey is a secure alternative to traditional .env files and dotenv libraries. It separates secret management from the codebase to prevent sensitive data (like API keys and database passwords) from being stored in plaintext or accidentally committed to public repositories.

  5. Overview of Polykey secret management

    Polykey is a secret management system designed to replace traditional .env files (like those used with dotenv libraries) by separating secrets from the codebase. This prevents sensitive data, such as API keys and database passwords, from being stored in plaintext or accidentally committed to public repositories. Polykey uses the XChaCha20-Poly1305-IETF encryption algorithm via the Libsodium library to ensure secrets are secure at rest and in transit, providing high performance and protection against nonce collisions.

  6. Overview of Polykey secret management

    Polykey is a secure alternative to traditional .env files (like those used by dotenv). It separates secret management from the codebase to prevent sensitive data—such as API keys and database passwords—from being stored in plaintext or accidentally committed to public repositories.

  7. Overview of Polykey CLI

    The Polykey CLI is the primary interface for the Polykey system, designed for developers and system administrators to manage secrets efficiently during software development and deployment. It is built to be used by human operators and is also scriptable for integration into other tools. The CLI is open-source and available on GitHub.

  8. Overview of Polykey secret management

    Polykey is a secure alternative to traditional .env files (like those used with dotenv). It separates secret management from the codebase to prevent sensitive data—such as API keys and database passwords—from being stored in plaintext or accidentally committed to public repositories.

  9. Overview of the Polykey Audit system

    The Audit system in Polykey tracks and retrieves events occurring within the Polykey agent for security monitoring, troubleshooting, and compliance. Events are stored in a structured format within the node's database and are designed to be tamper-resistant and accessible only to authorized users.

  10. Overview of Polykey secret management

    Polykey is a secure alternative to traditional .env files (like those used with dotenv). It separates secret management from the codebase to prevent sensitive data—such as API keys and database passwords—from being stored in plaintext or accidentally committed to public repositories.

  11. Overview of Polykey secrets management

    Polykey is a secure alternative to traditional .env files and dotenv libraries. It separates secret management from the codebase to prevent sensitive data (like API keys and database passwords) from being stored in plaintext or accidentally committed to public repositories. It uses the XChaCha20-Poly1305-IETF encryption algorithm via the Libsodium library to ensure confidentiality and authentication for secrets at rest and in transit.

  12. Overview of Polykey secret management

    Polykey is a secure alternative to traditional .env files (like those used with dotenv libraries) for managing environment variables and secrets. It separates secret management from the codebase, ensuring sensitive data is not stored in plaintext within project repositories. Polykey uses the XChaCha20-Poly1305-IETF encryption algorithm via the Libsodium library to secure secrets at rest and in transit, providing high performance and protection against nonce collisions.