Interface GetSignerOptions

KeyChain.getSigner options.

interface GetSignerOptions {
    fallback?: Signer | ((name, keyChain, err?) => Promise<Signer>);
    prefixMatch?: boolean;
    useKeyNameKeyLocator?: boolean;
}

Properties

fallback? prefixMatch? useKeyNameKeyLocator?

Properties

Optional fallback

fallback?: Signer | ((name, keyChain, err?) => Promise<Signer>)

Fallback when no matching or certificate is found.

Type declaration

Remarks

If this is a function, it is invoked when no matching key or certificate is found. The function should either return a fallback Signer or reject the promise.

If this is a Signer, it is used when no matching key or certificate is found.

Optional prefixMatch

prefixMatch?: boolean

Whether to allow prefix match between name argument and subject name.

Default Value

false

Remarks

If false, name argument must equal subject name, key name, or certificate name. If true, name argument may be a prefix of subject name.

Optional useKeyNameKeyLocator

useKeyNameKeyLocator?: boolean

Whether to prefer key name in KeyLocator.

Default Value

false

Remarks

If false, KeyLocator is a certificate name when a non-self-signed certificate exists. If true, KeyLocator is the key name.

Settings

Member Visibility

Theme

On This Page

fallbackprefixMatchuseKeyNameKeyLocator