Interface Keychain

Export an existing private key.

Example

import { generateKeyPair } from '@libp2p/crypto/keys'

const key = await generateKeyPair('Ed25519')
const keyInfo = await libp2p.keychain.importKey('my-key', key)
const key = await libp2p.keychain.exportKey(keyInfo.id)
Copy

Find a key by id

Example

import { generateKeyPair } from '@libp2p/crypto/keys'

const key = await generateKeyPair('Ed25519')
const keyInfo = await libp2p.keychain.importKey('my-key', key)
const keyInfo2 = await libp2p.keychain.findKeyById(keyInfo.id)
Copy

Find a key by name

Example

import { generateKeyPair } from '@libp2p/crypto/keys'

const key = await generateKeyPair('Ed25519')
const keyInfo = await libp2p.keychain.importKey('my-key', key)
const keyInfo2 = await libp2p.keychain.findKeyByName(keyInfo.name)
Copy

Import a new private key.

Example

import { generateKeyPair } from '@libp2p/crypto/keys'

const key = await generateKeyPair('Ed25519')
const keyInfo = await libp2p.keychain.importKey('my-key', key)
Copy

List all the keys.

Example

const keyInfos = await libp2p.keychain.listKeys()
Copy

Removes a key from the keychain.

Example

await libp2p.services.keychain.createKey('keyTest', 'RSA', 4096)
const keyInfo = await libp2p.services.keychain.removeKey('keyTest')
Copy

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.

Example

await libp2p.services.keychain.createKey('keyTest', 'RSA', 4096)
const keyInfo = await libp2p.services.keychain.renameKey('keyTest', 'keyNewNtest')
Copy

Rotate keychain password and re-encrypt all associated keys

Example

await libp2p.services.keychain.rotateKeychainPass('oldPassword', 'newPassword')
Copy