Interface Keychain

interface Keychain {
    exportKey(name: string, options?: AbortOptions): Promise<PrivateKey>;
    generateKey(
        name: string,
        options?: AbortOptions & Record<string, any>,
    ): Promise<PrivateKey>;
    importKey(
        name: string,
        key: PrivateKey,
        options?: AbortOptions,
    ): Promise<PrivateKey>;
    listKeys(options?: AbortOptions): AsyncGenerator<KeyInfo>;
    loadPublicKeyFromProtobuf(
        buf: Uint8Array,
        options?: AbortOptions,
    ): Promise<PublicKey>;
    removeKey(name: string, options?: AbortOptions): Promise<void>;
    renameKey(
        oldName: string,
        newName: string,
        options?: AbortOptions,
    ): Promise<void>;
    rotateKeychainPass(password: string, options?: AbortOptions): Promise<void>;
}

Index

Methods

exportKey generateKey importKey listKeys loadPublicKeyFromProtobuf removeKey renameKey rotateKeychainPass

Methods

exportKey

exportKey(name: string, options?: AbortOptions): Promise<PrivateKey>
Export an existing private key.
Parameters
- name: string
- Optionaloptions: AbortOptions
Returns Promise<PrivateKey>
Example
```
const raw = await helia.exportKey('my-key')
const key = await crypto.subtle.importKey('raw', raw, {
  name: 'Ed25519'
}, true, ['sign', 'verify'])
```
- Defined in src/index.ts:142

generateKey

generateKey(
name: string,
options?: AbortOptions & Record<string, any>,
): Promise<PrivateKey>
Create a key of the passed type and store it under the specified name. A cryptography implementation must be configured for the key type (defaults to Ed25519).
Parameters
- name: string
- Optionaloptions: AbortOptions & Record<string, any>
Returns Promise<PrivateKey>
- Defined in src/index.ts:110

importKey

importKey(
    name: string,
    key: PrivateKey,
    options?: AbortOptions,
): Promise<PrivateKey>
Import a new private key.

The type parameter must match a supported cryptography implementation.

The default supported key types are Ed25519 and RSA, others may be added through configuration.
Parameters
- name: string
- key: PrivateKey
- Optionaloptions: AbortOptions
Returns Promise<PrivateKey>
Example
```
const key = await crypto.subtle.generateKey('Ed25519', true, ['sign', 'verify'])
const raw = await crypto.subtle.exportKey('raw', key)
await helia.keychain.importKey('my-key', 'Ed25519', raw)
```
- Defined in src/index.ts:128

listKeys

listKeys(options?: AbortOptions): AsyncGenerator<KeyInfo>
List all the keys.
Parameters
- Optionaloptions: AbortOptions
Returns AsyncGenerator<KeyInfo>
Example
```
for await (const name of helia.keychain.listKeys()) {
  // ...
}
```
- Defined in src/index.ts:178

loadPublicKeyFromProtobuf

loadPublicKeyFromProtobuf(
buf: Uint8Array,
options?: AbortOptions,
): Promise<PublicKey>
Attempts to load a public key from a serialized protobuf message conforming to the PublicKey message.
Parameters
- buf: Uint8Array
- Optionaloptions: AbortOptions
Returns Promise<PublicKey>
- Defined in src/index.ts:196

removeKey

removeKey(name: string, options?: AbortOptions): Promise<void>
Removes a key from the keychain.
Parameters
- name: string
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await helia.keychain.removeKey('keyTest')
```
- Defined in src/index.ts:153

renameKey

renameKey(
    oldName: string,
    newName: string,
    options?: AbortOptions,
): Promise<void>
Rename a key in the keychain. This is done in a batch commit with rollback so errors thrown during the operation will not cause key loss.
Parameters
- oldName: string
- newName: string
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await helia.keychain.renameKey('oldName', 'newName')
```
- Defined in src/index.ts:165

rotateKeychainPass

rotateKeychainPass(password: string, options?: AbortOptions): Promise<void>
Re-encrypt all keys in the keychain using a crypto graphic key derived from the password
Parameters
- password: string
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await helia.keychain.rotateKeychainPass('newPassword')
```
- Defined in src/index.ts:190