Interface Key

Represents a cryptographic key.

Models keys as JWK. Advantages of this format:

  • Standard
  • Widely supported
  • Fully models relevant key types
  • Where not supported, extracting constituent parts for translation is trivial
interface Key {
    constructor: any;
    alg?: string;
    algorithm?: string;
    crv?: CurveType;
    curve?: CurveType;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: boolean;
    extractable?: boolean;
    k?: string;
    key_ops?: string[];
    keyPair: BinaryKeyPair;
    keyPairBits?: BinaryKeyPair;
    kty?: KeyType;
    n?: string;
    operations?: string[];
    oth?: RsaOtherPrimesInfo[];
    p?: string;
    pkcs8?: Uint8Array;
    private?: string;
    privateBits?: Uint8Array;
    privateKey: Uint8Array;
    publicBits?: Uint8Array;
    publicKey: Uint8Array;
    q?: string;
    qi?: string;
    sec1?: Uint8Array;
    spki?: Uint8Array;
    type?: KeyType;
    use?: string;
    x?: string;
    xBits?: Uint8Array;
    y?: string;
    yBits?: Uint8Array;
}

Hierarchy (view full)

Constructors

constructor

Properties

alg? algorithm? crv? curve? d? dp? dq? e? ext? extractable? k? key_ops? keyPair keyPairBits? kty? n? operations? oth? p? pkcs8? private? privateBits? privateKey publicBits? publicKey q? qi? sec1? spki? type? use? x? xBits? y? yBits?

Constructors

constructor

constructor: any

Properties

Optionalalg

alg?: string

Optionalalgorithm

algorithm?: string

The key algorithm, alias for JWK "alg" field.

Optionalcrv

crv?: CurveType

Optionalcurve

curve?: CurveType

The elliptic curve type, alias for JWK "crv" field.

Optionald

d?: string

Optionaldp

dp?: string

Optionaldq

dq?: string

Optionale

e?: string

Optionalext

ext?: boolean

Optionalextractable

extractable?: boolean

Indicates whether the private key is extractable, alias for JSK "ext" field.

Optionalk

k?: string

Optionalkey_ops

key_ops?: string[]

keyPair

keyPair: BinaryKeyPair

Alias for keyPairBits that throws if a complete key pair is not present.

OptionalkeyPairBits

keyPairBits?: BinaryKeyPair

Import/export of BinaryKeyPair structure used as an alternate serialization format for legacy reasons.

Optionalkty

kty?: KeyType

Optionaln

n?: string

Optionaloperations

operations?: string[]

Operations supported by the key, alias for JWK "key_ops" field.

Optionaloth

oth?: RsaOtherPrimesInfo[]

Optionalp

p?: string

Optionalpkcs8

pkcs8?: Uint8Array

Import (write-only) of private keys encoded in PKCS #8 format.

Optionalprivate

private?: string

The private key, alias for JWK "d" field.

OptionalprivateBits

privateBits?: Uint8Array

Binary alias to private key field. Automatically encodes/decodes the base-64 private key.

privateKey

privateKey: Uint8Array

Alias for privateBits that throws if no private key is present.

OptionalpublicBits

publicBits?: Uint8Array

Import/export of EC public key in SEC1/SPKI format. Maps to x & y fields internally.

publicKey

publicKey: Uint8Array

Alias for publicBits that throws if no public key is present.

Optionalq

q?: string

Optionalqi

qi?: string

Optionalsec1

sec1?: Uint8Array

Import (write-only) of private keys encoded in SEC1 format.

Optionalspki

spki?: Uint8Array

Import (write-only) of public keys encoded in SPKI format.

Optionaltype

type?: KeyType

The key type, alias for JWK "kty" field.

Optionaluse

use?: string

Optionalx

x?: string

OptionalxBits

xBits?: Uint8Array

Binary alias to the x field. Automatically encodes/decodes the base-64 x-point on EC public keys.

Optionaly

y?: string

OptionalyBits

yBits?: Uint8Array

Binary alias to the y field. Automatically encodes/decodes the base-64 y-point on EC public keys.

Settings

Member Visibility

On This Page

Constructors
Properties