@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias SftpClientConfig

    type SftpClientConfig = {
        agent?: BaseAgent;
        host: string;
        hostKeyFingerprints: readonly string[];
        password?: string;
        port: number;
        readyTimeoutMs?: number;
        username: string;
    }
    Index
    agent? host hostKeyFingerprints password? port readyTimeoutMs? username
    agent?: BaseAgent

    An agent to sign publickey auth with — KmsSshAgent for a key held in KMS, which is the only way this client does publickey at all.

    Supplying a password as well is often necessary: a managed transfer product (MOVEit, Cleo, GoAnywhere) can be configured to demand both, and Dart's MOVEit account is.

    host: string
    hostKeyFingerprints: readonly string[]

    Accepted host-key fingerprints, SHA256:… each. More than one so a counterparty's key rotation can be staged (add the new one, let them cut over, drop the old one) instead of requiring a flag-day deploy.

    password?: string

    Password, for password auth.

    port: number
    readyTimeoutMs?: number

    Milliseconds to wait for the TCP + handshake to complete.

    username: string

    Settings
    Member Visibility

    On This Page
    Properties