Interface HostKeyPolicy`Experimental`

How a connection decides whether to trust the host key it is offered.

interface HostKeyPolicy {
    confirm?: (info: HostKeyInfo) => Promise<HostKeyDecision>;
    expected?: string;
    pin?: (info: HostKeyInfo) => Promise<void>;
    pinned: PinnedHostKey | undefined;
}

Index

Properties

confirm? expected? pin? pinned

Properties

`Optional` `Readonly` `Experimental`confirm

confirm?: (info: HostKeyInfo) => Promise<HostKeyDecision>

Asks a person about a new key; absent when nobody can be asked.

`Optional` `Readonly` `Experimental`expected

expected?: string

A fingerprint given for unattended runs (--host-key SHA256:...).

`Optional` `Readonly` `Experimental`pin

pin?: (info: HostKeyInfo) => Promise<void>

Stores a key the person chose to pin.

`Readonly` `Experimental`pinned

pinned: PinnedHostKey | undefined

The key pinned for this server, if any.