Options
All
  • Public
  • Public/Protected
  • All
Menu

Module keychain

@ndn/keychain

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package provides signing algorithms, encryption algorithms, and certificate management features.

The implementation uses Web Crypto API.

  • Modern browsers natively support WebCrypto.
  • Most browsers restrict WebCrypto to secure contexts only. During development, you may use http://localhost or ngrok.
  • In Node.js, @peculiar/webcrypto wraps Node.js Crypto API and exports them as WebCrypto.

Signing Algorithms

This package implements signature types defined in NDN Packet Format 0.3:

  • DigestSha256 (in @ndn/packet package)
    • signing and verification
  • SignatureSha256WithRsa (RSASSA-PKCS1-v1_5)
    • signing and verification
    • KeyLocator .Name
    • KeyLocator .KeyDigest
  • SignatureSha256WithEcdsa
    • signing and verification
    • KeyLocator .Name
    • KeyLocator .KeyDigest
  • SignatureHmacWithSha256
    • signing and verification
    • KeyLocator matching

Both Interest and Data are signable.

  • sign Interest
    • put certificate name in KeyLocator
    • generate SigNonce, SigTime, SigSeqNum
  • verify Interest
    • check ParametersSha256DigestComponent
    • check SigNonce, SigTime, SigSeqNum
  • sign Data
    • put certificate name in KeyLocator
  • verify Data

Encryption Algorithms

  • AES-CBC
    • low-level encryption and decryption
  • AES-CTR and AES-GCM
    • low-level encryption and decryption
    • generate unique IV
    • check IV uniqueness
  • RSA-OAEP
    • low-level encryption and decryption

Certificate Management and Storage

Certificate class provides basic operations with NDN Certificate Format 2.0.

  • generate self-signed certificate
  • issue certificate to another public key
  • import certificate as PublicKey for RSASSA-PKCS1-v1_5 and ECDSA

KeyChain class provides storage of PrivateKey and Certificate. It could be ephemeral or persistent. KeyChain.createTemp() creates an in-memory ephemeral keychain. KeyChain.open(locator) opens a persistent keychain.

Persistent keychain in Node.js uses JSON files as underlying storage. The locator argument should be a filesystem directory where these files are stored. Private keys are saved as JSON Web Key (JWK) format, so that it's important to protect the storage directory. It is unsafe to simultaneously construct multiple KeyChain instances on the same storage directory or access the same keychain from multiple Node.js processes.

Persistent keychain in browser uses IndexedDB API. The locator argument determines the database name(s). Private keys are saved as non-extractable CryptoKey objects.

Known Issues

  • In Firefox, persistent keychain stores JWK instead of CryptoKey, due to Mozilla Bug 1545813.
  • In Firefox, persistent keychain is unusable in a Private Browsing window, due to Mozilla Bug 781982.
  • In Chrome, AES 192-bit key is not supported.
  • In iOS and macOS Safari, ECDSA P-521 curve is not supported.

Index

Type aliases

EcCurve

EcCurve: keyof typeof PointSizes

KeyKind

KeyKind: "private" | "public" | "secret"

Identify kind of key.

PrivateKey

PrivateKey: Key<"private">

Named private key.

PublicKey

PublicKey: Key<"public">

Named public key.

RsaModulusLength

RsaModulusLength: 2048 | 4096

SecretKey

SecretKey: Key<"secret">

Named secret key.

Variables

Const CryptoAlgorithmList

CryptoAlgorithmList: CryptoAlgorithm[] = ...

Const ECDSA

ECDSA: SigningAlgorithm<Info, true, GenParams> = ...

Sha256WithEcdsa signing algorithm.

Const EncryptionAlgorithmList

EncryptionAlgorithmList: EncryptionAlgorithm[] = ...

Const HMAC

HMAC: SigningAlgorithm<{}, false, GenParams> = ...

HmacWithSha256 signing algorithm.

Const KeyChainImplWebCrypto

KeyChainImplWebCrypto: Crypto = ...

KeyKind

KeyKind: typeof KeyKind

Const RSA

RSA: SigningAlgorithm<{}, true, GenParams> = ...

Sha256WithRsa signing algorithm.

Const RSAOAEP

RSAOAEP: EncryptionAlgorithm<{}, true, GenParams> = ...

RSA-OAEP encryption algorithm.

Const SigningAlgorithmList

SigningAlgorithmList: SigningAlgorithm[] = ...

Functions

createDecrypter

createEncrypter

createSigner

createVerifier

generateEncryptionKey

generateSigningKey

Generated using TypeDoc