Class EndpointKey

Index

Constructors

Accessors

Methods

makeCertificate privateKeyPem publicKeyPem generate generateFor

Constructors

constructor

new EndpointKey(privateKeyPem: string): EndpointKey
Load a private key from a PEM-encoded PKCS#8 private key string.

If the key is not ED25519 or ECDSA(256|384), this will error.
Parameters
- privateKeyPem: string
Returns EndpointKey
- Defined in index.d.ts:23

Accessors

validity

get validity(): number
The validity of certificates generated by this key in seconds.

Returns number
- Defined in index.d.ts:37
set validity(seconds: number): void
Set the validity of certificates generated by this key in seconds.

Note that changing the validity of a key once it's used in an Endpoint does nothing.
Parameters
- seconds: number
Returns void
- Defined in index.d.ts:43

Methods

makeCertificate

makeCertificate(): string
Generate a certificate for this key.

This is primarily used internally, but exposed for convenience if you're implementing the transport yourself and don't want to bother making certificates correctly.

Returns the PEM-encoded certificate.

Returns string
- Defined in index.d.ts:52

privateKeyPem

privateKeyPem(): string
Serialize private key to PEM.

Returns string
- Defined in index.d.ts:25

publicKeyPem

publicKeyPem(): string
Serialize public key to PEM.

Returns string
- Defined in index.d.ts:27

`Static`generate

generate(): EndpointKey
Generate a new random key pair in the default scheme.

Returns EndpointKey
- Defined in index.d.ts:29

`Static`generateFor

generateFor(scheme: string): EndpointKey
Generate a new random key pair in the given scheme.

The argument must be one of ed25519, ecdsa256, ecdsa384.
Parameters
- scheme: string
Returns EndpointKey
- Defined in index.d.ts:35