diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index fa9699b8..00000000 --- a/.prettierrc +++ /dev/null @@ -1,7 +0,0 @@ -{ - "semi": true, - "trailingComma": "all", - "singleQuote": true, - "printWidth": 80, - "tabWidth": 2 -} diff --git a/README.md b/README.md index f3392d53..4fc37565 100644 --- a/README.md +++ b/README.md @@ -16,22 +16,41 @@ ## What is Polykey? -**Polykey is an open-source, peer-to-peer system** that addresses the critical challenge in cybersecurity: **the secure sharing and delegation of authority**, in the form of secrets like keys, tokens, certificates, and passwords. - -It allows users including developers, organizations, and machines—to **store these secrets in encrypted vaults on their own devices, and share them directly with trusted parties.** - -- **All data is end-to-end encrypted**, both in transit and at rest, eliminating the risk associated with third-party storage. -- **Polykey provides a command line interface**, desktop and mobile GUI, and a web-based control plane for organizational management. -- By treating secrets as tokenized authority, it offers a fresh approach to **managing and delegating authority in zero-trust architectures** without adding burdensome policy complexity - a pervasive issue in existing zero-trust systems. -- Unlike complex self-hosted secrets management systems that require specialized skills and infrastructure, Polykey is **installed and running directly from the end-user device**. -- It is built to **automatically navigate network complexities** like NAT traversal, connecting securely to other nodes without manual configuration. +**Polykey is an open-source, peer-to-peer system** that addresses the critical +challenge in cybersecurity: **the secure sharing and delegation of authority**, +in the form of secrets like keys, tokens, certificates, and passwords. + +It allows users including developers, organizations, and machines—to **store +these secrets in encrypted vaults on their own devices, and share them directly +with trusted parties.** + +- **All data is end-to-end encrypted**, both in transit and at rest, eliminating + the risk associated with third-party storage. +- **Polykey provides a command line interface**, desktop and mobile GUI, and a + web-based control plane for organizational management. +- By treating secrets as tokenized authority, it offers a fresh approach to + **managing and delegating authority in zero-trust architectures** without + adding burdensome policy complexity - a pervasive issue in existing zero-trust + systems. +- Unlike complex self-hosted secrets management systems that require specialized + skills and infrastructure, Polykey is **installed and running directly from + the end-user device**. +- It is built to **automatically navigate network complexities** like NAT + traversal, connecting securely to other nodes without manual configuration. **Key features:** -- **Decentralized Encrypted Storage** - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes. -- **Secure Peer-to-Peer Communication** - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub). -- **Secure Computational Workflows** - Share static secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure. Create dynamic (short-lived) smart-tokens with embedded policy for more sophisticated zero-trust authority verification. -- With Polykey Enterprise, you can create private networks of Polykey nodes and apply mandatory policy governing node behaviour. +- **Decentralized Encrypted Storage** - No storage of secrets on third parties, + secrets are stored on your device and synchronised point-to-point between + Polykey nodes. +- **Secure Peer-to-Peer Communication** - Polykey bootstraps TLS keys by + federating trusted social identities (e.g. GitHub). +- **Secure Computational Workflows** - Share static secrets (passwords, keys, + tokens and certificates) with people, between teams, and across machine + infrastructure. Create dynamic (short-lived) smart-tokens with embedded policy + for more sophisticated zero-trust authority verification. +- With Polykey Enterprise, you can create private networks of Polykey nodes and + apply mandatory policy governing node behaviour. ## Table of Contents @@ -46,7 +65,8 @@ It allows users including developers, organizations, and machines—to **store t ## Installation -Note that JavaScript libraries are not packaged in Nix. Only JavaScript applications are. +Note that JavaScript libraries are not packaged in Nix. Only JavaScript +applications are. Building the package: @@ -114,7 +134,8 @@ When calling commands in development, use this style: npm run polykey -- p1 p2 p3 ``` -The `--` is necessary to make `npm` understand that the parameters are for your own executable, and not parameters to `npm`. +The `--` is necessary to make `npm` understand that the parameters are for your +own executable, and not parameters to `npm`. ### Docs Generation @@ -137,4 +158,5 @@ git push --tags ## License -Polykey-CLI is licensed under the GPLv3, you may read the terms of the license [here](LICENSE). +Polykey-CLI is licensed under the GPLv3, you may read the terms of the license +[here](LICENSE). diff --git a/npmDepsHash b/npmDepsHash index f609c318..df6221a1 100644 --- a/npmDepsHash +++ b/npmDepsHash @@ -1 +1 @@ -sha256-aPi3zvTpqF8gN+cEz5A+F1fjN6jB4alkxhoLcFomr8c= +sha256-AmceWTFRZhQwgCaeNYxbx472oAfSczYh5E1Bw/xEGs0= diff --git a/package-lock.json b/package-lock.json index 25dae757..79d3ef5e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "@fast-check/jest": "^2.1.1", "@matrixai/errors": "^2.1.3", "@matrixai/exec": "^1.0.3", - "@matrixai/lint": "^0.2.6", + "@matrixai/lint": "^0.2.11", "@matrixai/logger": "^4.0.3", "@swc/core": "1.3.82", "@swc/jest": "^0.2.29", @@ -2100,9 +2100,9 @@ } }, "node_modules/@matrixai/lint": { - "version": "0.2.6", - "resolved": "https://registry.npmjs.org/@matrixai/lint/-/lint-0.2.6.tgz", - "integrity": "sha512-Cbx6SCTAqSt7lTKkaXL7wB+KbkiXYpQ0LdV5fPcnzEfG0sCuG8dbJcwzgHT5Qn7ubG71BBLUVFjHY1EGADzT8g==", + "version": "0.2.11", + "resolved": "https://registry.npmjs.org/@matrixai/lint/-/lint-0.2.11.tgz", + "integrity": "sha512-Q/atLaVExgQbd7b/sXCvTAIus0M+egxr6fjHFNzpUZGY3Gu+UkYQrel/440JnvZ+fK8fq9GTHewpa14H08AcRw==", "dev": true, "dependencies": { "@eslint/compat": "^1.2.5", diff --git a/package.json b/package.json index 4b45b67c..8b3a30c9 100644 --- a/package.json +++ b/package.json @@ -136,7 +136,7 @@ "sodium-native": "*" }, "devDependencies": { - "@matrixai/lint" : "^0.2.6", + "@matrixai/lint" : "^0.2.11", "@matrixai/errors": "^2.1.3", "@matrixai/logger": "^4.0.3", "@matrixai/exec": "^1.0.3",