Class CloudPrivateKeystore`Abstract`

Hierarchy (View Summary)

PrivateKeyStore
- CloudPrivateKeystore
  - VaultPrivateKeyStore

Index

Constructors

Methods

close generateIdentityKeyPair retrieveIdentityKey retrieveSessionKey retrieveUnboundSessionPublicKey saveIdentityKey saveSessionKey

Constructors

constructor

new CloudPrivateKeystore(): CloudPrivateKeystore
Returns CloudPrivateKeystore
Inherited from PrivateKeyStore.constructor

Methods

`Abstract`close

close(): Promise<void>
Returns Promise<void>
- Defined in src/lib/CloudPrivateKeystore.ts:4

generateIdentityKeyPair

generateIdentityKeyPair(
keyOptions?: Partial<RSAKeyGenOptions>,
): Promise<IdentityKeyPair>
Parameters
- OptionalkeyOptions: Partial<RSAKeyGenOptions>
Returns Promise<IdentityKeyPair>
Inherited from PrivateKeyStore.generateIdentityKeyPair
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:21

`Abstract`retrieveIdentityKey

retrieveIdentityKey(nodeId: string): Promise<null | CryptoKey>
Return the private component of a node key pair if it exists.
Parameters
- nodeId: string
Returns Promise<null | CryptoKey>
Throws
if the backend failed to retrieve the key due to an error
Inherited from PrivateKeyStore.retrieveIdentityKey
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:28

retrieveSessionKey

retrieveSessionKey(
    keyId: Buffer,
    nodeId: string,
    peerId: string,
): Promise<CryptoKey>
Retrieve private session key, regardless of whether it's an initial key or not.
Parameters
- keyId: Buffer
  The key pair id (typically the serial number)
- nodeId: string
  The id of the node that owns the key
- peerId: string
  The id of the recipient, in case the key is bound to a recipient
Returns Promise<CryptoKey>
Throws
UnknownKeyError when the key does not exist

Throws
PrivateKeyStoreError when the look-up could not be done
Inherited from PrivateKeyStore.retrieveSessionKey
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:54

retrieveUnboundSessionPublicKey

retrieveUnboundSessionPublicKey(nodeId: string): Promise<null | SessionKey>
Return the public key of the latest, unbound session key pair for the specified nodeId.
Parameters
- nodeId: string
  The id of the node that owns the key
Returns Promise<null | SessionKey>
The public key if it exists or null otherwise

Throws
PrivateKeyStoreError when the look-up could not be done
Inherited from PrivateKeyStore.retrieveUnboundSessionPublicKey
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:37

`Abstract`saveIdentityKey

saveIdentityKey(nodeId: string, privateKey: CryptoKey): Promise<void>
Parameters
- nodeId: string
- privateKey: CryptoKey
Returns Promise<void>
Inherited from PrivateKeyStore.saveIdentityKey
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:55

saveSessionKey

saveSessionKey(
    privateKey: CryptoKey,
    keyId: Buffer,
    nodeId: string,
    peerId?: string,
): Promise<void>
Parameters
- privateKey: CryptoKey
- keyId: Buffer
- nodeId: string
- OptionalpeerId: string
Returns Promise<void>
Inherited from PrivateKeyStore.saveSessionKey
- Defined in node_modules/@relaycorp/relaynet-core/build/main/lib/keyStores/PrivateKeyStore.d.ts:29