Class HostKeyVerifier

Verifies host keys against expected fingerprints and captures the last seen value.

Index

Constructors

Methods

getExpectedFingerprint getFailure getLastSeen reset verify

Constructors

constructor

new HostKeyVerifier(
    deviceName: string,
    endpointLabel: string,
    onMismatch?: (details: { expected: string; received: string }) => void,
): HostKeyVerifier
Parameters
- deviceName: string
- endpointLabel: string
- OptionalonMismatch: (details: { expected: string; received: string }) => void
Returns HostKeyVerifier
- Defined in src/logSession/hostKeyVerifier.ts:23

Methods

getExpectedFingerprint

getExpectedFingerprint(endpoint: HostEndpoint): FingerprintDetails | undefined
Normalizes a configured fingerprint string into details for comparison.
Parameters
- endpoint: HostEndpoint
Returns FingerprintDetails | undefined
- Defined in src/logSession/hostKeyVerifier.ts:51

getFailure

getFailure(): { expected: string; received: string } | undefined
Returns the last mismatch if verification failed.

Returns { expected: string; received: string } | undefined
- Defined in src/logSession/hostKeyVerifier.ts:44

getLastSeen

getLastSeen(): FingerprintDetails | undefined
Returns the most recently observed fingerprint.

Returns FingerprintDetails | undefined
- Defined in src/logSession/hostKeyVerifier.ts:37

reset

reset(): void
Returns void
- Defined in src/logSession/hostKeyVerifier.ts:29

verify

verify(
key: string | Buffer<ArrayBufferLike>,
expected?: FingerprintDetails,
): boolean
Validates the provided host key against the expected fingerprint.
Parameters
- key: string | Buffer<ArrayBufferLike>
- Optionalexpected: FingerprintDetails
Returns boolean
- Defined in src/logSession/hostKeyVerifier.ts:62