API reference

This reference is generated from the declarations shipped by the package. It covers all 462 exports available from @bunkerch/modernssh. Class sections contain every public constructor, property, accessor, and method declared by that class; inherited Node.js stream and EventEmitter members remain documented by Node.js.

Regenerate it with pnpm docs:api. CI runs pnpm docs:api:check to prevent the reference from drifting from dist/*.d.ts.

Export	Kind	Area
`Agent`	Class	Agents and public-key management
`AgentError`	Class	Agents and public-key management
`AgentForwardingProtocol`	Type	Authentication
`AgentType`	Enum	Agents and public-key management
`AlgorithmListChanges`	Interface	Transport and protocol types
`AlgorithmMatcher`	Type	Transport and protocol types
`AllowedSignerPrincipalLookupOptions`	Interface	Keys, trust, and signatures
`AllowedSigners`	Class	Keys, trust, and signatures
`AllowedSignerVerificationOptions`	Interface	Keys, trust, and signatures
`AUTOMATIC_TUNNEL_UNIT`	Constant	Channels and forwarding
`buildGSSAPIKeyExchangeUserAuthMIC`	Function	Authentication
`buildGSSAPIUserAuthMIC`	Function	Authentication
`Channel`	Class	Channels and forwarding
`ChannelOpenError`	Class	Transport and protocol types
`ChannelOpenFailureReasonCodes`	Enum	Transport and protocol types
`Client`	Class	Connections and servers
`ClientAgentChannel`	Class	Channels and forwarding
`ClientAlgorithmList`	Type	Transport and protocol types
`ClientAlgorithmOptions`	Interface	Transport and protocol types
`ClientChannel`	Class	Channels and forwarding
`ClientChannelHooker`	Type	Channels and forwarding
`ClientChannelRequestContext`	Type	Channels and forwarding
`ClientChannelRequestController`	Interface	Channels and forwarding
`ClientDirectStreamLocalChannel`	Class	Channels and forwarding
`ClientEnvironment`	Type	Connections and servers
`ClientEvents`	Interface	Connections and servers
`ClientForwardedStreamLocalChannel`	Class	Channels and forwarding
`ClientForwardedTCPIPChannel`	Class	Channels and forwarding
`ClientHooker`	Type	Connections and servers
`ClientHookerAuthenticationMethodContext`	Type	Connections and servers
`ClientHookerAuthenticationMethodController`	Interface	Connections and servers
`ClientHookerGlobalRequestContext`	Type	Connections and servers
`ClientHookerGlobalRequestController`	Interface	Connections and servers
`ClientHookerHostKeyController`	Interface	Connections and servers
`ClientHookerIncomingChannelController`	Interface	Connections and servers
`ClientHookerKeyboardInteractiveContext`	Type	Connections and servers
`ClientHookerKeyboardInteractiveController`	Interface	Connections and servers
`ClientHookerPasswordAuthContext`	Type	Connections and servers
`ClientHookerPasswordAuthController`	Interface	Connections and servers
`ClientHookerPasswordChangeContext`	Type	Connections and servers
`ClientHookerPasswordChangeController`	Interface	Connections and servers
`ClientHostbasedOptions`	Interface	Connections and servers
`ClientOptions`	Interface	Connections and servers
`ClientPtyOptions`	Interface	Channels and forwarding
`ClientSessionChannel`	Class	Channels and forwarding
`ClientSessionOptions`	Interface	Connections and servers
`ClientTCPIPChannel`	Class	Channels and forwarding
`ClientTunnelChannel`	Class	Channels and forwarding
`ClientWindowDimensions`	Interface	Channels and forwarding
`ClientX11Channel`	Class	Channels and forwarding
`ClientX11Options`	Interface	Channels and forwarding
`ClientX11Request`	Interface	Channels and forwarding
`createSocketAgent`	Function	Agents and public-key management
`CygwinAgent`	Class	Agents and public-key management
`CygwinAgentError`	Class	Agents and public-key management
`CygwinAgentOptions`	Interface	Agents and public-key management
`decodePublicKeySubsystemPacket`	Function	Agents and public-key management
`decodeSFTPCopyDataExtension`	Function	SFTP
`decodeSFTPExtensionString`	Function	SFTP
`decodeSFTPHandleExtension`	Function	SFTP
`decodeSFTPLimits`	Function	SFTP
`decodeSFTPLSetStatExtension`	Function	SFTP
`decodeSFTPPacket`	Function	SFTP
`decodeSFTPStatVFS`	Function	SFTP
`decodeSFTPTwoPathExtension`	Function	SFTP
`decodeSFTPUsersGroups`	Function	SFTP
`decodeSFTPUsersGroupsExtension`	Function	SFTP
`DEFAULT_CHANNEL_PACKET_SIZE`	Constant	Channels and forwarding
`DEFAULT_CHANNEL_WINDOW_SIZE`	Constant	Channels and forwarding
`DEFAULT_SERVER_CHANNEL_PACKET_SIZE`	Constant	Channels and forwarding
`DEFAULT_SERVER_CHANNEL_WINDOW_SIZE`	Constant	Channels and forwarding
`DELAY_COMPRESSION_EXTENSION`	Constant	Transport and protocol types
`DelayCompressionAlgorithm`	Type	Transport and protocol types
`DelayCompressionConfiguration`	Type	Transport and protocol types
`delayCompressionExtension`	Function	Transport and protocol types
`DelayCompressionOptions`	Interface	Transport and protocol types
`DirectStreamLocalChannel`	Class	Channels and forwarding
`DirectTCPIPChannel`	Class	Channels and forwarding
`DisconnectError`	Class	Transport and protocol types
`DisconnectReason`	Enum	Transport and protocol types
`discoverPageantAgentSocket`	Function	Agents and public-key management
`DiskAgent`	Class	Agents and public-key management
`DiskAgentError`	Class	Agents and public-key management
`DiskAgentOptions`	Interface	Agents and public-key management
`DiskAgentPassphrase`	Type	Agents and public-key management
`ELEVATION_EXTENSION`	Constant	Transport and protocol types
`ElevationPreference`	Type	Transport and protocol types
`ElevationRequest`	Type	Transport and protocol types
`EncodedSecurityKeySignatureData`	Interface	Keys, trust, and signatures
`EncodedSignature`	Class	Keys, trust, and signatures
`EncodedSignatureData`	Interface	Keys, trust, and signatures
`EncodedWebAuthnSignatureData`	Interface	Keys, trust, and signatures
`encodePublicKeySubsystemPacket`	Function	Agents and public-key management
`encodeSFTPAttributes`	Function	SFTP
`encodeSFTPCopyDataExtension`	Function	SFTP
`encodeSFTPExtensionString`	Function	SFTP
`encodeSFTPLimits`	Function	SFTP
`encodeSFTPLSetStatExtension`	Function	SFTP
`encodeSFTPPacket`	Function	SFTP
`encodeSFTPStatVFS`	Function	SFTP
`encodeSFTPTwoPathExtension`	Function	SFTP
`encodeSFTPUsersGroups`	Function	SFTP
`encodeSFTPUsersGroupsExtension`	Function	SFTP
`flagsToString`	Function	SFTP
`ForwardedAgentChannel`	Class	Channels and forwarding
`ForwardedStreamLocalChannel`	Class	Channels and forwarding
`ForwardedTCPIPChannel`	Class	Channels and forwarding
`ForwardedX11Channel`	Class	Channels and forwarding
`GeneratedKeyPair`	Interface	Keys, trust, and signatures
`generateKeyPair`	Function	Keys, trust, and signatures
`GenerateKeyPairOptions`	Interface	Keys, trust, and signatures
`generateKeyPairSync`	Function	Keys, trust, and signatures
`GLOBAL_REQUESTS_OK_EXTENSION`	Constant	Transport and protocol types
`GlobalRequestError`	Class	Connections and servers
`GSSAPI_KEYEX`	Constant	Authentication
`GSSAPI_WITH_MIC`	Constant	Authentication
`GSSAPIClientContext`	Interface	Authentication
`GSSAPIClientContextOptions`	Interface	Authentication
`GSSAPIClientMechanism`	Interface	Authentication
`GSSAPIContextStep`	Interface	Authentication
`GSSAPIError`	Class	Authentication
`GSSAPIErrorOptions`	Interface	Authentication
`GSSAPIErrorStatus`	Interface	Transport and protocol types
`GSSAPIKeyExchangeClientContext`	Interface	Authentication
`GSSAPIKeyExchangeClientContextOptions`	Interface	Authentication
`GSSAPIKeyExchangeErrorStatus`	Interface	Transport and protocol types
`GSSAPIKeyExchangeServerContext`	Interface	Authentication
`GSSAPIKeyExchangeServerContextOptions`	Interface	Authentication
`GSSAPIServerContext`	Interface	Authentication
`GSSAPIServerContextOptions`	Interface	Authentication
`GSSAPIServerMechanism`	Interface	Authentication
`HostKeyAdvertisementFormat`	Type	Connections and servers
`HTTPAgent`	Class	Connections and servers
`HTTPSAgent`	Class	Connections and servers
`KERBEROS_V5_GSSAPI_OID`	Constant	Authentication
`KeyPairType`	Type	Keys, trust, and signatures
`KeyRevocationList`	Class	Keys, trust, and signatures
`KnownHostCheckResult`	Interface	Keys, trust, and signatures
`KnownHostMarker`	Type	Keys, trust, and signatures
`KnownHosts`	Class	Keys, trust, and signatures
`KnownHostsError`	Class	Keys, trust, and signatures
`KnownHostsReplaceOptions`	Interface	Keys, trust, and signatures
`KnownHostStatus`	Type	Keys, trust, and signatures
`MAX_IDENTIFICATION_LENGTH`	Constant	Transport and protocol types
`MAX_OPENSSH_AGENT_ASSOCIATED_CERTIFICATES`	Constant	Agents and public-key management
`MAX_OPENSSH_AGENT_DESTINATION_CONSTRAINTS`	Constant	Agents and public-key management
`MAX_OPENSSH_AGENT_SESSION_BINDINGS`	Constant	Agents and public-key management
`MAX_OPENSSH_AGENT_SESSION_IDENTIFIER_LENGTH`	Constant	Agents and public-key management
`MAX_PUBLIC_KEY_SUBSYSTEM_NAMESPACE_CHARACTERS`	Constant	Agents and public-key management
`MAX_PUBLIC_KEY_SUBSYSTEM_PACKET_LENGTH`	Constant	Agents and public-key management
`MAX_PUBLIC_KEY_SUBSYSTEM_RESPONSE_BYTES`	Constant	Agents and public-key management
`MAX_PUBLIC_KEY_SUBSYSTEM_RESPONSES`	Constant	Agents and public-key management
`MAX_SFTP_HANDLE_LENGTH`	Constant	SFTP
`MAX_SFTP_PACKET_LENGTH`	Constant	SFTP
`MAX_SSH_AGENT_MESSAGE_LENGTH`	Constant	Agents and public-key management
`MAXIMUM_CHANNEL_WINDOW_SIZE`	Constant	Transport and protocol types
`NegotiatedAlgorithms`	Interface	Transport and protocol types
`NegotiatedDirectionAlgorithms`	Interface	Transport and protocol types
`NO_FLOW_CONTROL_EXTENSION`	Constant	Transport and protocol types
`NoFlowControlPreference`	Type	Transport and protocol types
`normalizeGSSAPIOID`	Function	Authentication
`OnePasswordAgent`	Class	Agents and public-key management
`OnePasswordAgentError`	Class	Agents and public-key management
`OPEN_MODE`	Constant	SFTP
`OPENSSH_AGENT_ASSOCIATED_CERTIFICATES`	Constant	Agents and public-key management
`OPENSSH_AGENT_RESTRICT_DESTINATION`	Constant	Agents and public-key management
`OPENSSH_AGENT_SECURITY_KEY_PROVIDER`	Constant	Agents and public-key management
`OPENSSH_AGENT_SESSION_BIND`	Constant	Agents and public-key management
`OPENSSH_INFO_SIGNAL`	Constant	Transport and protocol types
`OpenSSHAgentAssociatedCertificatesConstraint`	Type	Agents and public-key management
`OpenSSHAgentDestinationConstraint`	Type	Agents and public-key management
`OpenSSHAgentDestinationHop`	Type	Agents and public-key management
`OpenSSHAgentDestinationKey`	Type	Agents and public-key management
`OpenSSHAgentDestinationRule`	Type	Agents and public-key management
`OpenSSHAgentKeyConstraint`	Type	Agents and public-key management
`OpenSSHAgentSecurityKeyProviderConstraint`	Type	Agents and public-key management
`OpenSSHAgentSessionBinding`	Type	Agents and public-key management
`OpenSSHPrivateKeyCipher`	Type	Transport and protocol types
`OpenSSHPrivateKeyEncryptionOptions`	Interface	Transport and protocol types
`PageantAgent`	Class	Agents and public-key management
`PageantAgentError`	Class	Agents and public-key management
`ParsedKey`	Type	Keys, trust, and signatures
`parseKey`	Function	Keys, trust, and signatures
`parseKeys`	Function	Keys, trust, and signatures
`parseRFC4716PublicKey`	Function	Keys, trust, and signatures
`parseRFC4716PublicKeyFile`	Function	Keys, trust, and signatures
`PeerDisconnectError`	Class	Transport and protocol types
`PeerDisconnectInfo`	Interface	Transport and protocol types
`PrivateKey`	Class	Keys, trust, and signatures
`PrivateKeyAgent`	Class	Agents and public-key management
`PrivateKeyAgentError`	Class	Agents and public-key management
`PrivateKeyAlgorithm`	Class	Keys, trust, and signatures
`PrivateKeyData`	Interface	Keys, trust, and signatures
`ProtocolDebugMessage`	Interface	Transport and protocol types
`ProtocolPacketMetadata`	Interface	Transport and protocol types
`ProtocolVersionExchange`	Class	Transport and protocol types
`PUBLIC_KEY_SUBSYSTEM_VERSION`	Constant	Agents and public-key management
`PublicKey`	Class	Keys, trust, and signatures
`PublicKeyAlgorithm`	Class	Keys, trust, and signatures
`PublicKeyData`	Interface	Keys, trust, and signatures
`PublicKeySubsystemAddAttribute`	Interface	Agents and public-key management
`PublicKeySubsystemAddCertificateOptions`	Interface	Agents and public-key management
`PublicKeySubsystemAddCertificatePacket`	Interface	Agents and public-key management
`PublicKeySubsystemAddOptions`	Interface	Agents and public-key management
`PublicKeySubsystemAddPacket`	Interface	Agents and public-key management
`PublicKeySubsystemAttributeInput`	Interface	Agents and public-key management
`PublicKeySubsystemAttributePacket`	Interface	Agents and public-key management
`PublicKeySubsystemCertificate`	Interface	Agents and public-key management
`PublicKeySubsystemCertificatePacket`	Interface	Agents and public-key management
`PublicKeySubsystemClient`	Class	Agents and public-key management
`PublicKeySubsystemClientOptions`	Interface	Agents and public-key management
`PublicKeySubsystemKey`	Interface	Agents and public-key management
`PublicKeySubsystemListAttributesPacket`	Interface	Agents and public-key management
`PublicKeySubsystemListCertificatesPacket`	Interface	Agents and public-key management
`PublicKeySubsystemListedAttribute`	Interface	Agents and public-key management
`PublicKeySubsystemListNamespacesPacket`	Interface	Agents and public-key management
`PublicKeySubsystemListPacket`	Interface	Agents and public-key management
`PublicKeySubsystemNamespacePacket`	Interface	Agents and public-key management
`PublicKeySubsystemPacket`	Type	Agents and public-key management
`PublicKeySubsystemPacketParser`	Class	Agents and public-key management
`PublicKeySubsystemProtocolError`	Class	Agents and public-key management
`PublicKeySubsystemPublicKeyPacket`	Interface	Agents and public-key management
`PublicKeySubsystemRemoveCertificateOptions`	Interface	Agents and public-key management
`PublicKeySubsystemRemoveCertificatePacket`	Interface	Agents and public-key management
`PublicKeySubsystemRemovePacket`	Interface	Agents and public-key management
`PublicKeySubsystemRequestOptions`	Interface	Agents and public-key management
`PublicKeySubsystemServer`	Class	Agents and public-key management
`PublicKeySubsystemServerAddCertificateContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerAddContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerEvents`	Type	Agents and public-key management
`PublicKeySubsystemServerHooker`	Type	Agents and public-key management
`PublicKeySubsystemServerListCertificatesController`	Interface	Agents and public-key management
`PublicKeySubsystemServerListContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerListController`	Interface	Agents and public-key management
`PublicKeySubsystemServerListedAttribute`	Interface	Agents and public-key management
`PublicKeySubsystemServerListedCertificate`	Interface	Agents and public-key management
`PublicKeySubsystemServerListedKey`	Interface	Agents and public-key management
`PublicKeySubsystemServerListNamespacesController`	Interface	Agents and public-key management
`PublicKeySubsystemServerOperationContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerOptions`	Interface	Agents and public-key management
`PublicKeySubsystemServerRemoveCertificateContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerRemoveContext`	Interface	Agents and public-key management
`PublicKeySubsystemServerResponseController`	Interface	Agents and public-key management
`PublicKeySubsystemStatusCode`	Enum	Agents and public-key management
`PublicKeySubsystemStatusError`	Class	Agents and public-key management
`PublicKeySubsystemStatusPacket`	Interface	Agents and public-key management
`PublicKeySubsystemSupportedAttribute`	Interface	Agents and public-key management
`PublicKeySubsystemUnknownPacket`	Interface	Agents and public-key management
`PublicKeySubsystemVersionPacket`	Interface	Agents and public-key management
`RFC4716Header`	Interface	Keys, trust, and signatures
`RFC4716PublicKeyFile`	Interface	Keys, trust, and signatures
`SecurityKeyAttestation`	Class	Keys, trust, and signatures
`SecurityKeyAttestationFormat`	Type	Keys, trust, and signatures
`serializeRFC4716PublicKey`	Function	Keys, trust, and signatures
`Server`	Class	Connections and servers
`ServerAlgorithmOptions`	Interface	Transport and protocol types
`ServerAuthenticationContinuation`	Interface	Connections and servers
`ServerClient`	Class	Connections and servers
`ServerClientEvents`	Interface	Connections and servers
`ServerConnectionInfo`	Interface	Connections and servers
`ServerConnectionListener`	Type	Connections and servers
`ServerEvents`	Interface	Connections and servers
`ServerGlobalRequestError`	Class	Connections and servers
`ServerHooker`	Type	Connections and servers
`ServerHookerChannelOpenRequestController`	Interface	Connections and servers
`ServerHookerChannelRequestController`	Interface	Connections and servers
`ServerHookerElevationContext`	Type	Connections and servers
`ServerHookerElevationController`	Interface	Connections and servers
`ServerHookerGlobalRequestContext`	Type	Connections and servers
`ServerHookerGlobalRequestController`	Interface	Connections and servers
`ServerHookerGSSAPIAuthenticationContext`	Type	Connections and servers
`ServerHookerGSSAPIAuthenticationController`	Interface	Connections and servers
`ServerHookerHostbasedAuthenticationContext`	Type	Connections and servers
`ServerHookerHostbasedAuthenticationController`	Interface	Connections and servers
`ServerHookerKeyboardInteractiveAuthenticationContext`	Type	Connections and servers
`ServerHookerKeyboardInteractiveAuthenticationController`	Interface	Connections and servers
`ServerHookerNoneAuthenticationContext`	Type	Connections and servers
`ServerHookerNoneAuthenticationController`	Interface	Connections and servers
`ServerHookerPasswordAuthenticationContext`	Type	Connections and servers
`ServerHookerPasswordAuthenticationController`	Interface	Connections and servers
`ServerHookerPreconnectController`	Interface	Connections and servers
`ServerHookerPublicKeyAuthenticationContext`	Type	Connections and servers
`ServerHookerPublicKeyAuthenticationController`	Interface	Connections and servers
`ServerHookerStreamLocalForwardContext`	Type	Connections and servers
`ServerHookerStreamLocalForwardController`	Interface	Connections and servers
`ServerHookerTCPIPForwardContext`	Type	Connections and servers
`ServerHookerTCPIPForwardController`	Interface	Connections and servers
`ServerHostKeyInput`	Interface	Connections and servers
`ServerKeyboardInteractivePrompt`	Interface	Connections and servers
`ServerOptions`	Interface	Connections and servers
`ServerTransport`	Interface	Connections and servers
`SessionBreakRequestContext`	Interface	Channels and forwarding
`SessionChannel`	Class	Channels and forwarding
`SessionChannelEvents`	Interface	Channels and forwarding
`SessionChannelHooker`	Type	Channels and forwarding
`SessionChannelHookerAgentForwardRequestController`	Interface	Channels and forwarding
`SessionChannelHookerBreakRequestController`	Interface	Channels and forwarding
`SessionChannelHookerEnvRequestContext`	Interface	Channels and forwarding
`SessionChannelHookerEnvRequestController`	Interface	Channels and forwarding
`SessionChannelHookerExecRequestContext`	Interface	Channels and forwarding
`SessionChannelHookerExecRequestController`	Interface	Channels and forwarding
`SessionChannelHookerPtyRequestController`	Interface	Channels and forwarding
`SessionChannelHookerShellRequestController`	Interface	Channels and forwarding
`SessionChannelHookerSubsystemRequestContext`	Interface	Channels and forwarding
`SessionChannelHookerSubsystemRequestController`	Interface	Channels and forwarding
`SessionChannelHookerX11RequestController`	Interface	Channels and forwarding
`SessionPtyInfo`	Interface	Channels and forwarding
`SessionSignalContext`	Interface	Channels and forwarding
`SessionWindowDimensions`	Interface	Channels and forwarding
`SessionX11Request`	Interface	Channels and forwarding
`SFTP_VERSION`	Constant	SFTP
`SFTPAttributeFlags`	Enum	SFTP
`SFTPAttributes`	Interface	SFTP
`SFTPAttrsPacket`	Interface	SFTP
`SFTPClient`	Class	SFTP
`SFTPClientEvents`	Interface	SFTP
`SFTPClientNameEntry`	Interface	SFTP
`SFTPClientOptions`	Interface	SFTP
`SFTPCopyDataExtension`	Interface	SFTP
`SFTPDataPacket`	Interface	SFTP
`SFTPExtendedAttribute`	Interface	SFTP
`SFTPExtendedPacket`	Interface	SFTP
`SFTPExtendedReplyPacket`	Interface	SFTP
`SFTPExtendedRequestOptions`	Interface	SFTP
`SFTPExtension`	Interface	SFTP
`SFTPExtensionResponsePacket`	Type	SFTP
`SFTPExtensionResponseType`	Type	SFTP
`SFTPFastGetOptions`	Interface	SFTP
`SFTPFastPutOptions`	Interface	SFTP
`SFTPFSetStatPacket`	Interface	SFTP
`SFTPHandlePacket`	Interface	SFTP
`SFTPHandleRequestPacket`	Interface	SFTP
`SFTPInitPacket`	Interface	SFTP
`SFTPLimits`	Interface	SFTP
`SFTPLSetStatExtension`	Interface	SFTP
`SFTPMkDirPacket`	Interface	SFTP
`SFTPNameEncoding`	Type	SFTP
`SFTPNameEntry`	Interface	SFTP
`SFTPNamePacket`	Interface	SFTP
`sftpOpenFlags`	Function	SFTP
`SFTPOpenFlags`	Enum	SFTP
`SFTPOpenPacket`	Interface	SFTP
`SFTPPacket`	Type	SFTP
`SFTPPacketParser`	Class	SFTP
`SFTPPacketType`	Enum	SFTP
`SFTPPath`	Type	SFTP
`SFTPPathPacket`	Interface	SFTP
`SFTPPosition`	Type	SFTP
`SFTPProtocolError`	Class	SFTP
`SFTPReadDirectoryOptions`	Interface	SFTP
`SFTPReadFileOptions`	Interface	SFTP
`SFTPReadPacket`	Interface	SFTP
`SFTPReadResult`	Interface	SFTP
`SFTPReadStream`	Class	SFTP
`SFTPReadStreamOptions`	Interface	SFTP
`SFTPRequestOf`	Type	SFTP
`SFTPRequestPacket`	Type	SFTP
`SFTPRequestPacketBase`	Interface	SFTP
`SFTPServer`	Class	SFTP
`SFTPServerEvents`	Type	SFTP
`SFTPServerHooker`	Type	SFTP
`SFTPServerOperationContext`	Interface	SFTP
`SFTPServerOptions`	Interface	SFTP
`SFTPSetStatPacket`	Interface	SFTP
`SFTPStats`	Class	SFTP
`SFTPStatusCode`	Enum	SFTP
`SFTPStatusError`	Class	SFTP
`SFTPStatusPacket`	Interface	SFTP
`SFTPStatVFS`	Interface	SFTP
`SFTPSymlinkPaths`	Interface	SFTP
`SFTPTransferProgress`	Interface	SFTP
`SFTPTwoPathExtension`	Interface	SFTP
`SFTPTwoPathPacket`	Interface	SFTP
`SFTPUserGroupNames`	Interface	SFTP
`SFTPUsersGroupsExtension`	Interface	SFTP
`SFTPVersionPacket`	Interface	SFTP
`SFTPWriteFileOptions`	Interface	SFTP
`SFTPWritePacket`	Interface	SFTP
`SFTPWriteResult`	Interface	SFTP
`SFTPWriteStream`	Class	SFTP
`SFTPWriteStreamOptions`	Interface	SFTP
`Shell`	Class	Channels and forwarding
`SocketState`	Enum	Transport and protocol types
`SSH_ECDSA_SECURITY_KEY_ALGORITHM`	Constant	Keys, trust, and signatures
`SSH_ED25519_SECURITY_KEY_ALGORITHM`	Constant	Keys, trust, and signatures
`SSH_WEBAUTHN_ECDSA_SECURITY_KEY_ALGORITHM`	Constant	Keys, trust, and signatures
`SSHAgent`	Class	Agents and public-key management
`SSHAgentAddIdentityOptions`	Interface	Agents and public-key management
`SSHAgentAddTokenOptions`	Interface	Agents and public-key management
`SSHAgentConstraint`	Type	Agents and public-key management
`SSHAgentConstraintType`	Enum	Agents and public-key management
`SSHAgentError`	Class	Agents and public-key management
`SSHAgentExtensionFailureError`	Class	Agents and public-key management
`SSHAgentExtensionResult`	Type	Agents and public-key management
`SSHAgentIdentity`	Interface	Agents and public-key management
`SSHAgentMessageType`	Enum	Agents and public-key management
`SSHAgentOptions`	Interface	Connections and servers
`SSHAgentProtocolClient`	Class	Agents and public-key management
`SSHAgentProtocolConnectionContext`	Interface	Agents and public-key management
`SSHAgentProtocolError`	Class	Agents and public-key management
`SSHAgentProtocolOptions`	Interface	Agents and public-key management
`SSHAgentProtocolServer`	Class	Agents and public-key management
`SSHAgentProtocolServerOptions`	Interface	Agents and public-key management
`SSHAgentServerAddIdentityContext`	Type	Agents and public-key management
`SSHAgentServerAddTokenContext`	Type	Agents and public-key management
`SSHAgentServerExtensionContext`	Type	Agents and public-key management
`SSHAgentServerExtensionController`	Interface	Agents and public-key management
`SSHAgentServerExtensionResult`	Type	Agents and public-key management
`SSHAgentServerHooker`	Type	Agents and public-key management
`SSHAgentServerIdentitiesController`	Interface	Agents and public-key management
`SSHAgentServerPassphraseContext`	Type	Agents and public-key management
`SSHAgentServerQueryExtensionsController`	Interface	Agents and public-key management
`SSHAgentServerRemoveIdentityContext`	Type	Agents and public-key management
`SSHAgentServerRemoveTokenContext`	Type	Agents and public-key management
`SSHAgentServerSignContext`	Type	Agents and public-key management
`SSHAgentServerSignController`	Interface	Agents and public-key management
`SSHAgentServerSuccessController`	Interface	Agents and public-key management
`SSHAuthenticationMethods`	Enum	Transport and protocol types
`SSHCertificateData`	Interface	Keys, trust, and signatures
`SSHCertificateOption`	Interface	Keys, trust, and signatures
`SSHCertificatePublicKey`	Class	Keys, trust, and signatures
`SSHCertificateRole`	Type	Keys, trust, and signatures
`SSHECDSASecurityKeyPrivateKey`	Class	Keys, trust, and signatures
`SSHECDSASecurityKeyPrivateKeyData`	Interface	Keys, trust, and signatures
`SSHECDSASecurityKeyPublicKey`	Class	Keys, trust, and signatures
`SSHECDSASecurityKeyPublicKeyData`	Interface	Keys, trust, and signatures
`SSHED25519SecurityKeyPrivateKey`	Class	Keys, trust, and signatures
`SSHED25519SecurityKeyPrivateKeyData`	Interface	Keys, trust, and signatures
`SSHED25519SecurityKeyPublicKey`	Class	Keys, trust, and signatures
`SSHED25519SecurityKeyPublicKeyData`	Interface	Keys, trust, and signatures
`SSHExtendedDataTypes`	Enum	Transport and protocol types
`SSHExtension`	Interface	Transport and protocol types
`SSHFPAlgorithm`	Enum	Keys, trust, and signatures
`SSHFPFingerprintType`	Enum	Keys, trust, and signatures
`SSHFPRecord`	Class	Keys, trust, and signatures
`SSHFPVerificationResult`	Type	Keys, trust, and signatures
`SSHHTTPAgent`	Class	Connections and servers
`SSHHTTPAgentOptions`	Type	Connections and servers
`SSHHTTPSAgent`	Class	Connections and servers
`SSHHTTPSAgentOptions`	Type	Connections and servers
`SSHServiceNames`	Enum	Transport and protocol types
`SSHSignature`	Class	Keys, trust, and signatures
`SSHSignatureHashAlgorithm`	Type	Keys, trust, and signatures
`SSHSignatureOptions`	Interface	Keys, trust, and signatures
`SSHSocketAgentOptions`	Interface	Agents and public-key management
`Stats`	Class	SFTP
`STATUS_CODE`	Constant	SFTP
`StreamLocalConnectionDetails`	Interface	Channels and forwarding
`stringToFlags`	Function	SFTP
`TCPIPConnectionDetails`	Interface	Channels and forwarding
`TerminalMode`	Constant	Channels and forwarding
`TerminalModeOpcode`	Type	Channels and forwarding
`TerminalModes`	Constant	Channels and forwarding
`TerminalModeSettings`	Type	Channels and forwarding
`TunnelAddressFamily`	Enum	Channels and forwarding
`TunnelChannel`	Class	Channels and forwarding
`TunnelEvents`	Interface	Channels and forwarding
`TunnelIPPacket`	Interface	Channels and forwarding
`TunnelMode`	Enum	Channels and forwarding
`UserAuthPrompt`	Interface	Transport and protocol types
`verifySSHFP`	Function	Keys, trust, and signatures
`X11ConnectionDetails`	Interface	Channels and forwarding