Transport and protocol types

export interface AlgorithmListChanges {
    append?: AlgorithmMatcher | readonly AlgorithmMatcher[];
    prepend?: AlgorithmMatcher | readonly AlgorithmMatcher[];
    remove?: AlgorithmMatcher | readonly AlgorithmMatcher[];
}

export type AlgorithmMatcher = string | RegExp;

export declare class ChannelOpenError extends Error {
    readonly name = "ChannelOpenError";
    readonly reasonCode: number;
    readonly reason_code: number;
    readonly languageTag: string;
    constructor(reasonCode: number, message: string, languageTag?: string);
    getOpenFailurePacket(recipientChannelId: number): ChannelOpenFailure;
}

export declare enum ChannelOpenFailureReasonCodes {
    SSH_OPEN_ADMINISTRATIVELY_PROHIBITED = 1,
    SSH_OPEN_CONNECT_FAILED = 2,
    SSH_OPEN_UNKNOWN_CHANNEL_TYPE = 3,
    SSH_OPEN_RESOURCE_SHORTAGE = 4
}

export type ClientAlgorithmList = readonly string[] | AlgorithmListChanges;

export interface ClientAlgorithmOptions {
    kex?: ClientAlgorithmList;
    serverHostKey?: ClientAlgorithmList;
    cipher?: ClientAlgorithmList;
    hmac?: ClientAlgorithmList;
    compress?: ClientAlgorithmList;
}

export declare const DELAY_COMPRESSION_EXTENSION = "delay-compression";

export type DelayCompressionAlgorithm = "none" | "zlib";

export type DelayCompressionConfiguration = boolean | DelayCompressionOptions;

export declare function delayCompressionExtension(offers: DelayCompressionOptions): SSHExtension;

export interface DelayCompressionOptions {
    readonly clientToServer: readonly DelayCompressionAlgorithm[];
    readonly serverToClient: readonly DelayCompressionAlgorithm[];
}

export declare class DisconnectError extends Error {
    name: string;
    readonly reason_code: number;
    readonly languageTag: string;
    constructor(reason_code: number, message: string, languageTag?: string);
}

export declare enum DisconnectReason {
    SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT = 1,
    SSH_DISCONNECT_PROTOCOL_ERROR = 2,
    SSH_DISCONNECT_KEY_EXCHANGE_FAILED = 3,
    SSH_DISCONNECT_RESERVED = 4,
    SSH_DISCONNECT_MAC_ERROR = 5,
    SSH_DISCONNECT_COMPRESSION_ERROR = 6,
    SSH_DISCONNECT_SERVICE_NOT_AVAILABLE = 7,
    SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED = 8,
    SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE = 9,
    SSH_DISCONNECT_CONNECTION_LOST = 10,
    SSH_DISCONNECT_BY_APPLICATION = 11,
    SSH_DISCONNECT_TOO_MANY_CONNECTIONS = 12,
    SSH_DISCONNECT_AUTH_CANCELLED_BY_USER = 13,
    SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE = 14,
    SSH_DISCONNECT_ILLEGAL_USER_NAME = 15
}

export declare const ELEVATION_EXTENSION = "elevation";

export type ElevationPreference = false | "default" | "elevated" | "unelevated";

export type ElevationRequest = Exclude<ElevationPreference, false>;

export declare const GLOBAL_REQUESTS_OK_EXTENSION = "global-requests-ok";

export interface UserAuthGSSAPIErrorData {
    majorStatus: number;
    minorStatus: number;
    message: string;
    languageTag: string;
}

export interface KexGSSAPIErrorData {
    majorStatus: number;
    minorStatus: number;
    message: string;
    languageTag: string;
}

export declare const MAX_IDENTIFICATION_LENGTH = 255;

export declare const MAXIMUM_CHANNEL_WINDOW_SIZE: number;

export interface NegotiatedAlgorithms {
    kex: string;
    srvHostKey: string;
    cs: NegotiatedDirectionAlgorithms;
    sc: NegotiatedDirectionAlgorithms;
}

export interface NegotiatedDirectionAlgorithms {
    cipher: string;
    mac: string;
    compress: string;
    lang: string;
}

export declare const NO_FLOW_CONTROL_EXTENSION = "no-flow-control";

export type NoFlowControlPreference = false | "preferred" | "supported";

/** OpenSSH extension that requests SIGINFO on BSD-derived systems. */
export declare const OPENSSH_INFO_SIGNAL = "INFO@openssh.com";

export type OpenSSHPrivateKeyCipher = "3des-cbc" | "aes128-cbc" | "aes192-cbc" | "aes256-cbc" | "aes128-ctr" | "aes192-ctr" | "aes256-ctr" | "aes128-gcm@openssh.com" | "aes256-gcm@openssh.com" | "chacha20-poly1305@openssh.com";

export interface OpenSSHPrivateKeyEncryptionOptions {
    passphrase: string | Buffer;
    cipher?: OpenSSHPrivateKeyCipher;
    /** bcrypt_pbkdf rounds; defaults to 16. */
    rounds?: number;
}

export declare class PeerDisconnectError extends Error {
    readonly disconnect: Readonly<PeerDisconnectInfo>;
    readonly name = "PeerDisconnectError";
    readonly reasonCode: number;
    readonly languageTag: string;
    constructor(disconnect: Readonly<PeerDisconnectInfo>);
}

export interface PeerDisconnectInfo {
    readonly reasonCode: number;
    readonly description: string;
    readonly languageTag: string;
}

export interface ProtocolDebugMessage {
    alwaysDisplay: boolean;
    message: string;
    languageTag: string;
}

export interface ProtocolPacketMetadata {
    readonly sequenceNumber: number;
    readonly type: number;
    readonly name?: PacketName;
}

export default class ProtocolVersionExchange {
    readonly protocol_version: string;
    readonly protocol_software: string;
    readonly comments: string | undefined;
    constructor(protocol_version: string, protocol_software: string, comments?: string | undefined);
    static parse(raw: string | Buffer): ProtocolVersionExchange;
    /** Builds an SSH 2.0 identification from a software identifier and optional comment. */
    static fromIdent(ident: string | Buffer): ProtocolVersionExchange;
    static readonly defaultValue: ProtocolVersionExchange;
    toString(): string;
}

export interface ServerAlgorithmOptions {
    kex?: readonly string[];
    serverHostKey?: readonly string[];
    cipher?: readonly string[];
    hmac?: readonly string[];
    compress?: readonly string[];
}

export declare enum SocketState {
    Connecting = 0,
    Connected = 1,
    Closed = 2,
    Disconnected = 3
}

export declare enum SSHAuthenticationMethods {
    None = "none",
    PublicKey = "publickey",
    Hostbased = "hostbased",
    Password = "password",
    KeyboardInteractive = "keyboard-interactive",
    GSSAPIWithMIC = "gssapi-with-mic",
    GSSAPIKeyExchange = "gssapi-keyex",
    HostboundPublicKey = "publickey-hostbound-v00@openssh.com"
}

export declare enum SSHExtendedDataTypes {
    SSH_EXTENDED_DATA_STDERR = 1
}

export interface SSHExtension {
    readonly name: string;
    readonly value: Buffer;
}

export declare enum SSHServiceNames {
    UserAuth = "ssh-userauth",
    Connection = "ssh-connection"
}

export interface UserAuthPrompt {
    prompt: string;
    echo: boolean;
}