Class DefaultKeyChain

Manages the lifecycle of a key. Keys are encrypted at rest using PKCS #8.

A key in the store has two entries

'/info/key-name', contains the KeyInfo for the key
'/pkcs8/key-name', contains the PKCS #8 for the key

Hierarchy

DefaultKeyChain

Implements

KeyChain

Index

Constructors

constructor

new DefaultKeyChain(components: KeyChainComponents, init: KeyChainInit): DefaultKeyChain
Creates a new instance of a key chain
Parameters
- components: KeyChainComponents
- init: KeyChainInit
Returns DefaultKeyChain
- Defined in index.ts:110

Properties

`Private` `Readonly` components

components: KeyChainComponents

`Private` `Readonly` init

init: KeyChainInit

Accessors

`Static` options

get options(): {
    dek: {
        hash: string;
        iterationCount: number;
        keyLength: number;
        salt: string;
    };
}
Gets an object that can encrypt/decrypt protected data. The default options for a keychain.

Returns

Returns {
    dek: {
        hash: string;
        iterationCount: number;
        keyLength: number;
        salt: string;
    };
}
- dek: {
      hash: string;
      iterationCount: number;
      keyLength: number;
      salt: string;
  }
  - hash: string
  - iterationCount: number
  - keyLength: number
  - salt: string
- Defined in index.ts:158

Methods

createKey

createKey(name: string, type: KeyType, size??: number): Promise<KeyInfo>
Create a new key.
Parameters
- name: string
  
  The local key name; cannot already exist.
- type: KeyType
  
  One of the key types; 'rsa'.
- Optional size: number = 2048
Returns Promise<KeyInfo>
Implementation of KeyChain.createKey
- Defined in index.ts:169

exportKey

exportKey(name: string, password: string): Promise<string>
Export an existing key as a PEM encrypted PKCS #8 string
Parameters
- name: string
- password: string
Returns Promise<string>
Implementation of KeyChain.exportKey
- Defined in index.ts:356

exportPeerId

exportPeerId(name: string): Promise<PeerId>
Export an existing key as a PeerId
Parameters
- name: string
Returns Promise<PeerId>
Implementation of KeyChain.exportPeerId
- Defined in index.ts:388

findKeyById

findKeyById(id: string): Promise<KeyInfo>
Find a key by it's id
Parameters
- id: string
Returns Promise<KeyInfo>
Implementation of KeyChain.findKeyById
- Defined in index.ts:248

findKeyByName

findKeyByName(name: string): Promise<KeyInfo>
Find a key by it's name.

Returns
Parameters
- name: string
  
  The local key name.
Returns Promise<KeyInfo>
Implementation of KeyChain.findKeyByName
- Defined in index.ts:270

getPrivateKey

getPrivateKey(name: string): Promise<string>
Gets the private key as PEM encoded PKCS #8 string
Parameters
- name: string
Returns Promise<string>
- Defined in index.ts:506

importKey

importKey(name: string, pem: string, password: string): Promise<KeyInfo>
Import a new key from a PEM encoded PKCS #8 string

Returns
Parameters
- name: string
  
  The local key name; must not already exist.
- pem: string
  
  The PEM encoded PKCS #8 string
- password: string
  
  The password.
Returns Promise<KeyInfo>
Implementation of KeyChain.importKey
- Defined in index.ts:404

importPeer

importPeer(name: string, peer: PeerId): Promise<KeyInfo>
Import a peer key
Parameters
- name: string
- peer: PeerId
Returns Promise<KeyInfo>
Implementation of KeyChain.importPeer
- Defined in index.ts:459

listKeys

listKeys(): Promise<KeyInfo[]>
List all the keys.

Returns

Returns Promise<KeyInfo[]>
Implementation of KeyChain.listKeys
- Defined in index.ts:232

removeKey

removeKey(name: string): Promise<KeyInfo>
Remove an existing key.

Returns
Parameters
- name: string
  
  The local key name; must already exist.
Returns Promise<KeyInfo>
Implementation of KeyChain.removeKey
- Defined in index.ts:293

renameKey

renameKey(oldName: string, newName: string): Promise<KeyInfo>
Rename a key

Returns
Parameters
- oldName: string
  
  The old local key name; must already exist.
- newName: string
  
  The new local key name; must not already exist.
Returns Promise<KeyInfo>
Implementation of KeyChain.renameKey
- Defined in index.ts:314

rotateKeychainPass

rotateKeychainPass(oldPass: string, newPass: string): Promise<void>
Rotate keychain password and re-encrypt all associated keys
Parameters
- oldPass: string
- newPass: string
Returns Promise<void>
Implementation of KeyChain.rotateKeychainPass
- Defined in index.ts:526

`Static` generateOptions

generateOptions(): KeyChainInit
Generates the options for a keychain. A random salt is produced.

Returns

Returns KeyChainInit
- Defined in index.ts:145

Class DefaultKeyChain

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

components: KeyChainComponents

init: KeyChainInit

Returns DefaultKeyChain

Properties

Private Readonly components

Private Readonly init

Accessors

Static options

Returns

Returns { dek: { hash: string; iterationCount: number; keyLength: number; salt: string; }; }

dek: { hash: string; iterationCount: number; keyLength: number; salt: string; }

hash: string

iterationCount: number

keyLength: number

salt: string

Methods

createKey

Parameters

name: string

type: KeyType

Optional size: number = 2048

Returns Promise<KeyInfo>

exportKey

Parameters

name: string

password: string

Returns Promise<string>

exportPeerId

Parameters

name: string

Returns Promise<PeerId>

findKeyById

Parameters

id: string

Returns Promise<KeyInfo>

findKeyByName

Returns

Parameters

name: string

Returns Promise<KeyInfo>

getPrivateKey

Parameters

name: string

Returns Promise<string>

importKey

Returns

Parameters

name: string

pem: string

password: string

Returns Promise<KeyInfo>

importPeer

Parameters

name: string

peer: PeerId

Returns Promise<KeyInfo>

listKeys

Returns

Returns Promise<KeyInfo[]>

removeKey

Returns

Parameters

name: string

Returns Promise<KeyInfo>

renameKey

Returns

Parameters

oldName: string

newName: string

`Private` `Readonly` components

`Private` `Readonly` init

`Static` options

Returns {
dek: {
hash: string;
iterationCount: number;
keyLength: number;
salt: string;
};
}

dek: {
hash: string;
iterationCount: number;
keyLength: number;
salt: string;
}

`Optional` size: number = 2048

`Static` generateOptions