@3sixty/vault-models 0.0.0-stage → 0.20.0-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2024 IOTA Stiftung.
+
+   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,25 @@
-# Temporary Holding Version
+# 3Sixty Vault Models
 
-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.
+This package defines the shared contracts, enums, and factory helpers used by vault connectors, so applications can integrate key and secret operations through a consistent model.
+
+## Installation
+
+```shell
+npm install @3sixty/vault-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-vault](https://github.com/iotaledger/twin-vault/tree/next/packages/vault-models) repository.

package/dist/es/factories/vaultConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating vault connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const VaultConnectorFactory = Factory.createFactory("vault");
+//# sourceMappingURL=vaultConnectorFactory.js.map

package/dist/es/factories/vaultConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultConnectorFactory.js","sources":["../../../src/factories/vaultConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAkB,OAAO,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IVaultConnector } from \"../models/IVaultConnector.js\";\n\n/**\n * Factory for creating vault connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VaultConnectorFactory = Factory.createFactory<IVaultConnector>(\"vault\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,8 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/vaultConnectorFactory.js";
+export * from "./models/IVaultConnector.js";
+export * from "./models/vaultEncryptionType.js";
+export * from "./models/vaultKeyType.js";
+export * from "./utils/vaultConnectorHelper.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/vaultConnectorFactory.js\";\nexport * from \"./models/IVaultConnector.js\";\nexport * from \"./models/vaultEncryptionType.js\";\nexport * from \"./models/vaultKeyType.js\";\nexport * from \"./utils/vaultConnectorHelper.js\";\n"]}

package/dist/es/models/IVaultConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IVaultConnector.js.map

package/dist/es/models/IVaultConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVaultConnector.js","sources":["../../../src/models/IVaultConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { VaultEncryptionType } from \"./vaultEncryptionType.js\";\nimport type { VaultKeyType } from \"./vaultKeyType.js\";\n\n/**\n * Interface describing a vault securely storing data.\n */\nexport interface IVaultConnector extends IComponent {\n\t/**\n\t * Generate a new key and store it in the vault.\n\t * @param name The name of the key to generate and store in the vault.\n\t * @param type The type of key to create.\n\t * @returns The public key for the key pair.\n\t */\n\tcreateKey(name: string, type: VaultKeyType): Promise<Uint8Array>;\n\n\t/**\n\t * Add an existing key to the vault.\n\t * @param name The name of the key to add to the vault.\n\t * @param type The type of key to add.\n\t * @param privateKey The private key.\n\t * @param publicKey The public key, can be undefined if the key type is symmetric.\n\t * @returns A promise that resolves when the key has been stored.\n\t */\n\taddKey(\n\t\tname: string,\n\t\ttype: VaultKeyType,\n\t\tprivateKey: Uint8Array,\n\t\tpublicKey?: Uint8Array\n\t): Promise<void>;\n\n\t/**\n\t * Get a key from the vault.\n\t * @param name The name of the key to get from the vault.\n\t * @param components Which key components to return, defaults to \"both\".\n\t * @returns The key, publicKey can be undefined if key is symmetric, privateKey can be undefined if only public was requested.\n\t * @throws GeneralError if \"private\" is requested for a symmetric key.\n\t */\n\tgetKey(\n\t\tname: string,\n\t\tcomponents?: \"public\" | \"private\" | \"both\"\n\t): Promise<{\n\t\t/**\n\t\t * The type of the key e.g. Ed25519.\n\t\t */\n\t\ttype: VaultKeyType;\n\n\t\t/**\n\t\t * The private key, undefined if only public component was requested.\n\t\t */\n\t\tprivateKey?: Uint8Array;\n\n\t\t/**\n\t\t * The public key, which can be undefined if key type is symmetric or only private was requested.\n\t\t */\n\t\tpublicKey?: Uint8Array;\n\t}>;\n\n\t/**\n\t * Check if a key exists in the vault.\n\t * @param name The name of the key to check.\n\t * @returns True if the key exists, false otherwise.\n\t */\n\tkeyExists(name: string): Promise<boolean>;\n\n\t/**\n\t * Get the type of a key from the vault without retrieving the key material.\n\t * @param name The name of the key.\n\t * @returns The key type.\n\t * @throws NotFoundError if the key does not exist.\n\t */\n\tgetKeyType(name: string): Promise<VaultKeyType>;\n\n\t/**\n\t * Rename a key in the vault.\n\t * @param name The name of the key to rename.\n\t * @param newName The new name of the key.\n\t * @returns A promise that resolves when the key has been renamed.\n\t */\n\trenameKey(name: string, newName: string): Promise<void>;\n\n\t/**\n\t * Remove a key from the vault.\n\t * @param name The name of the key to remove from the vault.\n\t * @returns A promise that resolves when the key has been removed.\n\t */\n\tremoveKey(name: string): Promise<void>;\n\n\t/**\n\t * Sign the data using a key in the vault.\n\t * @param name The name of the key to use for signing.\n\t * @param data The data to sign.\n\t * @returns The signature for the data.\n\t */\n\tsign(name: string, data: Uint8Array): Promise<Uint8Array>;\n\n\t/**\n\t * Verify the signature of the data using a key in the vault.\n\t * @param name The name of the key to use for verification.\n\t * @param data The data that was signed.\n\t * @param signature The signature to verify.\n\t * @returns True if the verification is successful.\n\t */\n\tverify(name: string, data: Uint8Array, signature: Uint8Array): Promise<boolean>;\n\n\t/**\n\t * Encrypt the data using a key in the vault.\n\t * @param name The name of the key to use for encryption.\n\t * @param encryptionType The type of encryption to use.\n\t * @param data The data to encrypt.\n\t * @returns The encrypted data.\n\t */\n\tencrypt(name: string, encryptionType: VaultEncryptionType, data: Uint8Array): Promise<Uint8Array>;\n\n\t/**\n\t * Decrypt the data using a key in the vault.\n\t * @param name The name of the key to use for decryption.\n\t * @param encryptionType The type of encryption to use.\n\t * @param encryptedData The data to decrypt.\n\t * @returns The decrypted data.\n\t */\n\tdecrypt(\n\t\tname: string,\n\t\tencryptionType: VaultEncryptionType,\n\t\tencryptedData: Uint8Array\n\t): Promise<Uint8Array>;\n\n\t/**\n\t * Store a secret in the vault.\n\t * @param name The name of the secret in the vault to set.\n\t * @param data The secret to add to the vault.\n\t * @returns A promise that resolves when the secret has been stored.\n\t */\n\tsetSecret<T>(name: string, data: T): Promise<void>;\n\n\t/**\n\t * Check if a secret exists in the vault.\n\t * @param name The name of the secret to check.\n\t * @returns True if the secret exists, false otherwise.\n\t */\n\tsecretExists(name: string): Promise<boolean>;\n\n\t/**\n\t * Get a secret from the vault.\n\t * @param name The name of the secret in the vault to get.\n\t * @returns The secret from the vault.\n\t * @throws Error if the secret is not found.\n\t */\n\tgetSecret<T>(name: string): Promise<T>;\n\n\t/**\n\t * Remove a secret from the vault.\n\t * @param name The name of the secret in the vault to remove.\n\t * @returns A promise that resolves when the secret has been removed.\n\t * @throws Error if the secret is not found.\n\t */\n\tremoveSecret(name: string): Promise<void>;\n}\n"]}

package/dist/es/models/vaultEncryptionType.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The names of the vault encryption types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const VaultEncryptionType = {
+    /**
+     * The ChaCha20Poly1305. (symmetric)
+     */
+    ChaCha20Poly1305: 0
+};
+//# sourceMappingURL=vaultEncryptionType.js.map

package/dist/es/models/vaultEncryptionType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultEncryptionType.js","sources":["../../../src/models/vaultEncryptionType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,gBAAgB,EAAE,CAAC;CACV,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The names of the vault encryption types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VaultEncryptionType = {\n\t/**\n\t * The ChaCha20Poly1305. (symmetric)\n\t */\n\tChaCha20Poly1305: 0\n} as const;\n\n/**\n * Vault encryption types.\n */\nexport type VaultEncryptionType = (typeof VaultEncryptionType)[keyof typeof VaultEncryptionType];\n"]}

package/dist/es/models/vaultKeyType.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The names of the vault key types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const VaultKeyType = {
+    /**
+     * Ed25519. (asymmetric)
+     */
+    Ed25519: 0,
+    /**
+     * The ChaCha20Poly1305. (symmetric)
+     */
+    ChaCha20Poly1305: 2
+};
+//# sourceMappingURL=vaultKeyType.js.map

package/dist/es/models/vaultKeyType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultKeyType.js","sources":["../../../src/models/vaultKeyType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,OAAO,EAAE,CAAC;IAEV;;OAEG;IACH,gBAAgB,EAAE,CAAC;CACV,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The names of the vault key types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VaultKeyType = {\n\t/**\n\t * Ed25519. (asymmetric)\n\t */\n\tEd25519: 0,\n\n\t/**\n\t * The ChaCha20Poly1305. (symmetric)\n\t */\n\tChaCha20Poly1305: 2\n} as const;\n\n/**\n * Vault key types.\n */\nexport type VaultKeyType = (typeof VaultKeyType)[keyof typeof VaultKeyType];\n"]}

package/dist/es/utils/vaultConnectorHelper.js

@@ -0,0 +1,57 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Guards, UnauthorizedError } from "@3sixty/core";
+import { Jwt } from "@3sixty/web";
+/**
+ * Helpers for vault connectors.
+ */
+export class VaultConnectorHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "VaultConnectorHelper";
+    /**
+     * Sign a JWT using vault connector.
+     * @param vaultConnector The vault connector to use.
+     * @param keyName The name of the key to sign with.
+     * @param header The header to sign.
+     * @param payload The payload to sign.
+     * @returns The token.
+     */
+    static async jwtSigner(vaultConnector, keyName, header, payload) {
+        Guards.object(VaultConnectorHelper.CLASS_NAME, "vaultConnector", vaultConnector);
+        Guards.stringValue(VaultConnectorHelper.CLASS_NAME, "keyName", keyName);
+        Guards.object(VaultConnectorHelper.CLASS_NAME, "header", header);
+        Guards.object(VaultConnectorHelper.CLASS_NAME, "payload", payload);
+        const signingBytes = Jwt.toSigningBytes(header, payload);
+        const signatureBytes = await vaultConnector.sign(keyName, signingBytes);
+        return Jwt.tokenFromBytes(signingBytes, signatureBytes);
+    }
+    /**
+     * Verify a JWT using a vault connector.
+     * @param vaultConnector The vault connector to use.
+     * @param keyName The name of the key to verify with.
+     * @param token The token to verify.
+     * @returns The header and payload if verification successful.
+     */
+    static async jwtVerifier(vaultConnector, keyName, token) {
+        Guards.object(VaultConnectorHelper.CLASS_NAME, "vaultConnector", vaultConnector);
+        Guards.stringValue(VaultConnectorHelper.CLASS_NAME, "keyName", keyName);
+        Guards.stringValue(VaultConnectorHelper.CLASS_NAME, "token", token);
+        const { signingBytes, signature } = Jwt.tokenToBytes(token);
+        const verified = await vaultConnector.verify(keyName, signingBytes, signature);
+        if (!verified) {
+            throw new UnauthorizedError(VaultConnectorHelper.CLASS_NAME, "invalidSignature");
+        }
+        return Jwt.fromSigningBytes(signingBytes);
+    }
+    /**
+     * Build a key name from parts.
+     * @param keyParts The parts of the key.
+     * @returns The constructed key name.
+     */
+    static buildKeyName(...keyParts) {
+        return keyParts.join("/");
+    }
+}
+//# sourceMappingURL=vaultConnectorHelper.js.map

package/dist/es/utils/vaultConnectorHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaultConnectorHelper.js","sources":["../../../src/utils/vaultConnectorHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzD,OAAO,EAAE,GAAG,EAAqC,MAAM,aAAa,CAAC;AAGrE;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,sBAAsB,CAAC;IAEnE;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5B,cAA+B,EAC/B,OAAe,EACf,MAAkB,EAClB,OAAoB;QAEpB,MAAM,CAAC,MAAM,CACZ,oBAAoB,CAAC,UAAU,EAC/B,gBAAgB,EAChB,cAAc,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,GAAG,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxE,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,cAA+B,EAC/B,OAAe,EACf,KAAa;QAKb,MAAM,CAAC,MAAM,CACZ,oBAAoB,CAAC,UAAU,EAC/B,gBAAgB,EAChB,cAAc,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACxE,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEpE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAE5D,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QAC/E,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,IAAI,iBAAiB,CAAC,oBAAoB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QAClF,CAAC;QAED,OAAO,GAAG,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,GAAG,QAAkB;QAC/C,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Guards, UnauthorizedError } from \"@3sixty/core\";\n\nimport { Jwt, type IJwtHeader, type IJwtPayload } from \"@3sixty/web\";\nimport type { IVaultConnector } from \"../models/IVaultConnector.js\";\n\n/**\n * Helpers for vault connectors.\n */\nexport class VaultConnectorHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"VaultConnectorHelper\";\n\n\t/**\n\t * Sign a JWT using vault connector.\n\t * @param vaultConnector The vault connector to use.\n\t * @param keyName The name of the key to sign with.\n\t * @param header The header to sign.\n\t * @param payload The payload to sign.\n\t * @returns The token.\n\t */\n\tpublic static async jwtSigner(\n\t\tvaultConnector: IVaultConnector,\n\t\tkeyName: string,\n\t\theader: IJwtHeader,\n\t\tpayload: IJwtPayload\n\t): Promise<string> {\n\t\tGuards.object<IVaultConnector>(\n\t\t\tVaultConnectorHelper.CLASS_NAME,\n\t\t\t\"vaultConnector\",\n\t\t\tvaultConnector\n\t\t);\n\t\tGuards.stringValue(VaultConnectorHelper.CLASS_NAME, \"keyName\", keyName);\n\t\tGuards.object(VaultConnectorHelper.CLASS_NAME, \"header\", header);\n\t\tGuards.object(VaultConnectorHelper.CLASS_NAME, \"payload\", payload);\n\n\t\tconst signingBytes = Jwt.toSigningBytes(header, payload);\n\t\tconst signatureBytes = await vaultConnector.sign(keyName, signingBytes);\n\t\treturn Jwt.tokenFromBytes(signingBytes, signatureBytes);\n\t}\n\n\t/**\n\t * Verify a JWT using a vault connector.\n\t * @param vaultConnector The vault connector to use.\n\t * @param keyName The name of the key to verify with.\n\t * @param token The token to verify.\n\t * @returns The header and payload if verification successful.\n\t */\n\tpublic static async jwtVerifier<T extends IJwtHeader, U extends IJwtPayload>(\n\t\tvaultConnector: IVaultConnector,\n\t\tkeyName: string,\n\t\ttoken: string\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.object<IVaultConnector>(\n\t\t\tVaultConnectorHelper.CLASS_NAME,\n\t\t\t\"vaultConnector\",\n\t\t\tvaultConnector\n\t\t);\n\t\tGuards.stringValue(VaultConnectorHelper.CLASS_NAME, \"keyName\", keyName);\n\t\tGuards.stringValue(VaultConnectorHelper.CLASS_NAME, \"token\", token);\n\n\t\tconst { signingBytes, signature } = Jwt.tokenToBytes(token);\n\n\t\tconst verified = await vaultConnector.verify(keyName, signingBytes, signature);\n\t\tif (!verified) {\n\t\t\tthrow new UnauthorizedError(VaultConnectorHelper.CLASS_NAME, \"invalidSignature\");\n\t\t}\n\n\t\treturn Jwt.fromSigningBytes(signingBytes);\n\t}\n\n\t/**\n\t * Build a key name from parts.\n\t * @param keyParts The parts of the key.\n\t * @returns The constructed key name.\n\t */\n\tpublic static buildKeyName(...keyParts: string[]): string {\n\t\treturn keyParts.join(\"/\");\n\t}\n}\n"]}

package/dist/types/factories/vaultConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IVaultConnector } from "../models/IVaultConnector.js";
+/**
+ * Factory for creating vault connectors.
+ */
+export declare const VaultConnectorFactory: Factory<IVaultConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./factories/vaultConnectorFactory.js";
+export * from "./models/IVaultConnector.js";
+export * from "./models/vaultEncryptionType.js";
+export * from "./models/vaultKeyType.js";
+export * from "./utils/vaultConnectorHelper.js";

package/dist/types/models/IVaultConnector.d.ts

@@ -0,0 +1,129 @@
+import type { IComponent } from "@3sixty/core";
+import type { VaultEncryptionType } from "./vaultEncryptionType.js";
+import type { VaultKeyType } from "./vaultKeyType.js";
+/**
+ * Interface describing a vault securely storing data.
+ */
+export interface IVaultConnector extends IComponent {
+    /**
+     * Generate a new key and store it in the vault.
+     * @param name The name of the key to generate and store in the vault.
+     * @param type The type of key to create.
+     * @returns The public key for the key pair.
+     */
+    createKey(name: string, type: VaultKeyType): Promise<Uint8Array>;
+    /**
+     * Add an existing key to the vault.
+     * @param name The name of the key to add to the vault.
+     * @param type The type of key to add.
+     * @param privateKey The private key.
+     * @param publicKey The public key, can be undefined if the key type is symmetric.
+     * @returns A promise that resolves when the key has been stored.
+     */
+    addKey(name: string, type: VaultKeyType, privateKey: Uint8Array, publicKey?: Uint8Array): Promise<void>;
+    /**
+     * Get a key from the vault.
+     * @param name The name of the key to get from the vault.
+     * @param components Which key components to return, defaults to "both".
+     * @returns The key, publicKey can be undefined if key is symmetric, privateKey can be undefined if only public was requested.
+     * @throws GeneralError if "private" is requested for a symmetric key.
+     */
+    getKey(name: string, components?: "public" | "private" | "both"): Promise<{
+        /**
+         * The type of the key e.g. Ed25519.
+         */
+        type: VaultKeyType;
+        /**
+         * The private key, undefined if only public component was requested.
+         */
+        privateKey?: Uint8Array;
+        /**
+         * The public key, which can be undefined if key type is symmetric or only private was requested.
+         */
+        publicKey?: Uint8Array;
+    }>;
+    /**
+     * Check if a key exists in the vault.
+     * @param name The name of the key to check.
+     * @returns True if the key exists, false otherwise.
+     */
+    keyExists(name: string): Promise<boolean>;
+    /**
+     * Get the type of a key from the vault without retrieving the key material.
+     * @param name The name of the key.
+     * @returns The key type.
+     * @throws NotFoundError if the key does not exist.
+     */
+    getKeyType(name: string): Promise<VaultKeyType>;
+    /**
+     * Rename a key in the vault.
+     * @param name The name of the key to rename.
+     * @param newName The new name of the key.
+     * @returns A promise that resolves when the key has been renamed.
+     */
+    renameKey(name: string, newName: string): Promise<void>;
+    /**
+     * Remove a key from the vault.
+     * @param name The name of the key to remove from the vault.
+     * @returns A promise that resolves when the key has been removed.
+     */
+    removeKey(name: string): Promise<void>;
+    /**
+     * Sign the data using a key in the vault.
+     * @param name The name of the key to use for signing.
+     * @param data The data to sign.
+     * @returns The signature for the data.
+     */
+    sign(name: string, data: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Verify the signature of the data using a key in the vault.
+     * @param name The name of the key to use for verification.
+     * @param data The data that was signed.
+     * @param signature The signature to verify.
+     * @returns True if the verification is successful.
+     */
+    verify(name: string, data: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    /**
+     * Encrypt the data using a key in the vault.
+     * @param name The name of the key to use for encryption.
+     * @param encryptionType The type of encryption to use.
+     * @param data The data to encrypt.
+     * @returns The encrypted data.
+     */
+    encrypt(name: string, encryptionType: VaultEncryptionType, data: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Decrypt the data using a key in the vault.
+     * @param name The name of the key to use for decryption.
+     * @param encryptionType The type of encryption to use.
+     * @param encryptedData The data to decrypt.
+     * @returns The decrypted data.
+     */
+    decrypt(name: string, encryptionType: VaultEncryptionType, encryptedData: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Store a secret in the vault.
+     * @param name The name of the secret in the vault to set.
+     * @param data The secret to add to the vault.
+     * @returns A promise that resolves when the secret has been stored.
+     */
+    setSecret<T>(name: string, data: T): Promise<void>;
+    /**
+     * Check if a secret exists in the vault.
+     * @param name The name of the secret to check.
+     * @returns True if the secret exists, false otherwise.
+     */
+    secretExists(name: string): Promise<boolean>;
+    /**
+     * Get a secret from the vault.
+     * @param name The name of the secret in the vault to get.
+     * @returns The secret from the vault.
+     * @throws Error if the secret is not found.
+     */
+    getSecret<T>(name: string): Promise<T>;
+    /**
+     * Remove a secret from the vault.
+     * @param name The name of the secret in the vault to remove.
+     * @returns A promise that resolves when the secret has been removed.
+     * @throws Error if the secret is not found.
+     */
+    removeSecret(name: string): Promise<void>;
+}

package/dist/types/models/vaultEncryptionType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The names of the vault encryption types.
+ */
+export declare const VaultEncryptionType: {
+    /**
+     * The ChaCha20Poly1305. (symmetric)
+     */
+    readonly ChaCha20Poly1305: 0;
+};
+/**
+ * Vault encryption types.
+ */
+export type VaultEncryptionType = (typeof VaultEncryptionType)[keyof typeof VaultEncryptionType];

package/dist/types/models/vaultKeyType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The names of the vault key types.
+ */
+export declare const VaultKeyType: {
+    /**
+     * Ed25519. (asymmetric)
+     */
+    readonly Ed25519: 0;
+    /**
+     * The ChaCha20Poly1305. (symmetric)
+     */
+    readonly ChaCha20Poly1305: 2;
+};
+/**
+ * Vault key types.
+ */
+export type VaultKeyType = (typeof VaultKeyType)[keyof typeof VaultKeyType];

package/dist/types/utils/vaultConnectorHelper.d.ts

@@ -0,0 +1,37 @@
+import { type IJwtHeader, type IJwtPayload } from "@3sixty/web";
+import type { IVaultConnector } from "../models/IVaultConnector.js";
+/**
+ * Helpers for vault connectors.
+ */
+export declare class VaultConnectorHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Sign a JWT using vault connector.
+     * @param vaultConnector The vault connector to use.
+     * @param keyName The name of the key to sign with.
+     * @param header The header to sign.
+     * @param payload The payload to sign.
+     * @returns The token.
+     */
+    static jwtSigner(vaultConnector: IVaultConnector, keyName: string, header: IJwtHeader, payload: IJwtPayload): Promise<string>;
+    /**
+     * Verify a JWT using a vault connector.
+     * @param vaultConnector The vault connector to use.
+     * @param keyName The name of the key to verify with.
+     * @param token The token to verify.
+     * @returns The header and payload if verification successful.
+     */
+    static jwtVerifier<T extends IJwtHeader, U extends IJwtPayload>(vaultConnector: IVaultConnector, keyName: string, token: string): Promise<{
+        header: T;
+        payload: U;
+    }>;
+    /**
+     * Build a key name from parts.
+     * @param keyParts The parts of the key.
+     * @returns The constructed key name.
+     */
+    static buildKeyName(...keyParts: string[]): string;
+}

package/docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/vault/compare/vault-models-v0.20.0-next.0...vault-models-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([a32b1e0](https://github.com/3sixtyglobal/vault/commit/a32b1e0dfc861076908bb8c9532f37f24cbc6baf))
+* updated ts compile ([77b7687](https://github.com/3sixtyglobal/vault/commit/77b76879092f9be9408b43e3136a29e69f14972c))