Class CloudPrivateKeystoreAbstract

Hierarchy (View Summary)

Constructors

constructor

Methods

close generateIdentityKeyPair retrieveIdentityKey retrieveSessionKey retrieveUnboundSessionPublicKey saveIdentityKey saveSessionKey

Constructors

constructor

Methods

Abstractclose

generateIdentityKeyPair

  • generateIdentityKeyPair(
        keyOptions?: Partial<RSAKeyGenOptions>,
    ): Promise<IdentityKeyPair>

  • Parameters

    • OptionalkeyOptions: Partial<RSAKeyGenOptions>

    Returns Promise<IdentityKeyPair>

AbstractretrieveIdentityKey

  • 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

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

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

AbstractsaveIdentityKey

  • saveIdentityKey(nodeId: string, privateKey: CryptoKey): Promise<void>

  • Parameters

    • nodeId: string
    • privateKey: CryptoKey

    Returns Promise<void>

saveSessionKey

  • saveSessionKey(
        privateKey: CryptoKey,
        keyId: Buffer,
        nodeId: string,
        peerId?: string,
    ): Promise<void>

  • Parameters

    • privateKey: CryptoKey
    • keyId: Buffer
    • nodeId: string
    • OptionalpeerId: string

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Methods