Skip to content

authentication.md

Latest commit

 

History

History
251 lines (188 loc) · 7.68 KB

authentication.md

File metadata and controls

251 lines (188 loc) · 7.68 KB
Raw
title Authentication
description Exact declarations for 20 package-root exports.

Authentication

Exact declarations for 20 package-root exports. Private and protected class members are omitted.

AgentForwardingProtocol

Type. Declared in src/AgentForwarding.ts.

export type AgentForwardingProtocol = "rfc9987" | "legacy";

buildGSSAPIKeyExchangeUserAuthMIC

Function. Declared in src/GSSAPI.ts.

/** Build the exact RFC 4462 gssapi-keyex user-authentication MIC input. */
export declare function buildGSSAPIKeyExchangeUserAuthMIC(sessionIdentifier: Buffer, username: string, service: string): Buffer;

buildGSSAPIUserAuthMIC

Function. Declared in src/GSSAPI.ts.

/** Build the exact RFC 4462 user-authentication MIC input. */
export declare function buildGSSAPIUserAuthMIC(sessionIdentifier: Buffer, username: string, service: string): Buffer;

GSSAPI_KEYEX

Constant. Declared in src/GSSAPI.ts.

export declare const GSSAPI_KEYEX = "gssapi-keyex";

GSSAPI_WITH_MIC

Constant. Declared in src/GSSAPI.ts.

export declare const GSSAPI_WITH_MIC = "gssapi-with-mic";

GSSAPIClientContext

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIClientContext {
    step(inputToken?: Buffer): GSSAPIContextStep | Promise<GSSAPIContextStep>;
    getMIC(message: Buffer): Buffer | Promise<Buffer>;
    close?(): void | Promise<void>;
}

GSSAPIClientContextOptions

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIClientContextOptions {
    hostname: string;
    username: string;
    service: string;
    delegateCredentials: boolean;
}

GSSAPIClientMechanism

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIClientMechanism {
    /** Complete ASN.1 DER encoding of the GSS-API mechanism object identifier. */
    oid: Buffer;
    createContext?(options: Readonly<GSSAPIClientContextOptions>): GSSAPIClientContext | Promise<GSSAPIClientContext>;
    createKeyExchangeContext?(options: Readonly<GSSAPIKeyExchangeClientContextOptions>): GSSAPIKeyExchangeClientContext | Promise<GSSAPIKeyExchangeClientContext>;
}

GSSAPIContextStep

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIContextStep {
    /** Whether context establishment completed after processing this token. */
    complete: boolean;
    /** Required on completion; whether per-message integrity is available. */
    integrity?: boolean;
    /** Required by key-exchange contexts on completion; whether the peer was mutually authenticated. */
    mutualAuthentication?: boolean;
    /** Non-empty token to send to the peer before the next step or final acknowledgement. */
    token?: Buffer;
    /** Mechanism-defined authenticated peer identity, available to server authorization policy. */
    peerIdentity?: unknown;
    /** Mechanism-defined delegated credentials, when delegation was requested and granted. */
    delegatedCredentials?: unknown;
}

GSSAPIError

Class. Declared in src/GSSAPI.ts.

/** A mechanism error whose RFC 4462 status and optional error token may be sent to the peer. */
export declare class GSSAPIError extends Error {
    readonly majorStatus: number;
    readonly minorStatus: number;
    readonly languageTag: string;
    readonly token?: Buffer;
    constructor(options: GSSAPIErrorOptions);
}

GSSAPIErrorOptions

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIErrorOptions {
    majorStatus: number;
    minorStatus: number;
    message?: string;
    languageTag?: string;
    token?: Buffer;
}

GSSAPIKeyExchangeClientContext

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIKeyExchangeClientContext {
    step(inputToken?: Buffer): GSSAPIContextStep | Promise<GSSAPIContextStep>;
    verifyMIC(message: Buffer, mic: Buffer): boolean | Promise<boolean>;
    getMIC?(message: Buffer): Buffer | Promise<Buffer>;
    close?(): void | Promise<void>;
}

GSSAPIKeyExchangeClientContextOptions

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIKeyExchangeClientContextOptions {
    hostname: string;
    service: "host";
    delegateCredentials: boolean;
    /** Whether this context will not be retained for gssapi-keyex user authentication. */
    anonymous: boolean;
    mutualAuthentication: true;
    integrity: true;
    replayDetection: false;
    sequenceDetection: false;
}

GSSAPIKeyExchangeServerContext

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIKeyExchangeServerContext {
    step(inputToken: Buffer): GSSAPIContextStep | Promise<GSSAPIContextStep>;
    getMIC(message: Buffer): Buffer | Promise<Buffer>;
    verifyMIC?(message: Buffer, mic: Buffer): boolean | Promise<boolean>;
    close?(): void | Promise<void>;
}

GSSAPIKeyExchangeServerContextOptions

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIKeyExchangeServerContextOptions {
    service: "host";
    remoteAddress?: string;
    remotePort?: number;
}

GSSAPIServerContext

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIServerContext {
    step(inputToken: Buffer): GSSAPIContextStep | Promise<GSSAPIContextStep>;
    verifyMIC(message: Buffer, mic: Buffer): boolean | Promise<boolean>;
    close?(): void | Promise<void>;
}

GSSAPIServerContextOptions

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIServerContextOptions {
    username: string;
    service: string;
    remoteAddress?: string;
    remotePort?: number;
}

GSSAPIServerMechanism

Interface. Declared in src/GSSAPI.ts.

export interface GSSAPIServerMechanism {
    /** Complete ASN.1 DER encoding of the GSS-API mechanism object identifier. */
    oid: Buffer;
    createContext?(options: Readonly<GSSAPIServerContextOptions>): GSSAPIServerContext | Promise<GSSAPIServerContext>;
    createKeyExchangeContext?(options: Readonly<GSSAPIKeyExchangeServerContextOptions>): GSSAPIKeyExchangeServerContext | Promise<GSSAPIKeyExchangeServerContext>;
}

KERBEROS_V5_GSSAPI_OID

Constant. Declared in src/GSSAPI.ts.

export declare const KERBEROS_V5_GSSAPI_OID: Buffer<ArrayBuffer>;

normalizeGSSAPIOID

Function. Declared in src/GSSAPI.ts.

/** Validate and copy a complete ASN.1 DER object-identifier encoding. */
export declare function normalizeGSSAPIOID(oid: Buffer): Buffer;