Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ndn/keychain

Index

Type aliases

AesKeyLength

AesKeyLength: 128 | 192 | 256

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

AESCBC

AESCBC: AesEncryption<{}, AESCBC.GenParams> = ...

AES-CBC encryption algorithm.

Initialization Vectors must be 16 octets. During encryption, if IV is unspecified, it is randomly generated. During decryption, quality of IV is not checked.

AESCTR

AES-CTR encryption algorithm.

Initialization Vectors must be 16 octets. During encryption, if IV is unspecified, it is constructed with two parts:

li

a 64-bit random number, generated each time a private key instance is constructed;

li

a 64-bit counter starting from zero.

During decryption, quality of IV is not automatically checked. Since the security of AES-CTR depends on having unique IVs, the application is recommended to check IVs using CounterIvChecker type.

AESGCM

AESGCM: AesEncryption<{}, AESGCM.GenParams> = ...

AES-GCM encryption algorithm.

Initialization Vectors must be 12 octets. During encryption, if IV is unspecified, it is constructed with two parts:

li

a 64-bit random number, generated each time a private key instance is constructed;

li

a 32-bit counter starting from zero.

During decryption, quality of IV is not automatically checked. Since the security of AES-CTR depends on having unique IVs, the application is recommended to check IVs using CounterIvChecker type.

AesBlockSize

AesBlockSize: 16 = 16

AES block size in octets.

CryptoAlgorithmListFull

CryptoAlgorithmListFull: readonly CryptoAlgorithm[] = ...

A full list of crypto algorithms.

CryptoAlgorithmListSlim

CryptoAlgorithmListSlim: readonly CryptoAlgorithm[] = ...

A slim list of crypto algorithms.

ECDSA

Sha256WithEcdsa signing algorithm.

EncryptionAlgorithmListFull

EncryptionAlgorithmListFull: readonly EncryptionAlgorithm[] = ...

A full list of encryption algorithms. This list is currently empty.

EncryptionAlgorithmListSlim

EncryptionAlgorithmListSlim: readonly EncryptionAlgorithm[] = []

A slim list of encryption algorithms. This list is currently empty.

HMAC

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

HmacWithSha256 signing algorithm.

KeyChainImplWebCrypto

KeyChainImplWebCrypto: Crypto = ...

KeyKind

KeyKind: typeof KeyKind

RSA

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

Sha256WithRsa signing algorithm.

RSAOAEP

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

RSA-OAEP encryption algorithm.

SigningAlgorithmListFull

SigningAlgorithmListFull: readonly SigningAlgorithm[] = ...

A full list of signing algorithms. This list currently contains ECDSA.

SigningAlgorithmListSlim

SigningAlgorithmListSlim: readonly SigningAlgorithm[] = ...

A slim list of signing algorithms. This list currently contains ECDSA.

Functions

createDecrypter

createEncrypter

createSigner

createVerifier

generateEncryptionKey

generateSigningKey

Generated using TypeDoc