Xceed .NET Libraries Documentation
Xceed.SSH.Protocols Assembly / Xceed.SSH.Protocols Namespace
Inheritance Hierarchy
In This Topic
    Xceed.SSH.Protocols Namespace
    In This Topic
    Classes
     ClassDescription
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    ClassRFC4254: 5.3. Closing a Channel Packet: SSH_MSG_CHANNEL_CLOSE byte SSH_MSG_CHANNEL_CLOSE uint32 recipient channel
    ClassRFC4254: 5.2. Data Transfer Packet: SSH_MSG_CHANNEL_DATA byte SSH_MSG_CHANNEL_DATA uint32 recipient channel string data
    ClassRFC4254: 5.2. Data Transfer
    ClassRFC4254: 5.3. Closing a Channel Packet: SSH_MSG_CHANNEL_EOF byte SSH_MSG_CHANNEL_EOF uint32 recipient channel
    ClassRFC4254: 5.2. Data Transfer Packet: SSH_MSG_CHANNEL_EXTENDED_DATA byte SSH_MSG_CHANNEL_EXTENDED_DATA uint32 recipient channel uint32 data_type_code string data
    ClassRFC4254: 5.4. Channel-Specific Requests Packet: SSH_MSG_CHANNEL_FAILURE byte SSH_MSG_CHANNEL_FAILURE uint32 recipient channel
    ClassRFC4254: 5.1. Opening a Channel Packet: SSH_MSG_CHANNEL_OPEN_CONFIRMATION byte SSH_MSG_CHANNEL_OPEN_CONFIRMATION uint32 recipient channel uint32 sender channel uint32 initial window size uint32 maximum packet size .... channel type specific data follows
    ClassRFC4254: 6.1. Opening a Session Packet: SSH_MSG_CHANNEL_OPEN_FAILURE byte SSH_MSG_CHANNEL_OPEN_FAILURE uint32 recipient channel uint32 reason code string description in ISO-10646 UTF-8 encoding [RFC3629] string language tag [RFC3066]
    ClassRFC4254: 6.1. Opening a Session Packet: SSH_MSG_CHANNEL_OPEN byte SSH_MSG_CHANNEL_OPEN string "session" uint32 sender channel uint32 initial window size uint32 maximum packet size
    ClassRFC4254: Packet: packet id byte packet id uint32 recipient channel
    ClassRFC4254: 6.4. Environment Variable Passing Packet: SSH_MSG_CHANNEL_REQUEST byte SSH_MSG_CHANNEL_REQUEST uint32 recipient channel string "env" boolean want reply string variable name string variable value
    ClassRFC4254: 6.5. Starting a Shell or a Command Packet: SSH_MSG_CHANNEL_REQUEST byte SSH_MSG_CHANNEL_REQUEST uint32 recipient channel string "exec" boolean want reply string command
    ClassRFC4254: 5.4. Channel-Specific Requests Packet: SSH_MSG_CHANNEL_REQUEST byte SSH_MSG_CHANNEL_REQUEST uint32 recipient channel string request type in US-ASCII characters only boolean want reply .... type-specific data follows
    ClassRFC4254: 6.5. Starting a Shell or a Command Packet: SSH_MSG_CHANNEL_REQUEST byte SSH_MSG_CHANNEL_REQUEST uint32 recipient channel string "subsystem" boolean want reply string subsystem name
    ClassRFC4254: 5.4. Channel-Specific Requests Packet: SSH_MSG_CHANNEL_SUCCESS byte SSH_MSG_CHANNEL_SUCCESS uint32 recipient channel
    ClassRFC4254: 5.2. Data Transfer Packet: SSH_MSG_CHANNEL_WINDOW_ADJUST byte SSH_MSG_CHANNEL_WINDOW_ADJUST uint32 recipient channel uint32 bytes to add
    ClassBase class for all "Ctr" implementation of the encryption algorithm.
    ClassRFC4253: 11.3. Debug Message Packet: SSH_MSG_DEBUG byte SSH_MSG_DEBUG boolean always_display string message in ISO-10646 UTF-8 encoding [RFC3629] string language tag [RFC3066]
    Class 
    Class 
    Class 
    Class 
    Class 
    Class 
    ClassTODODOC
    ClassTODODOC
    ClassTODODOC
    ClassTODODOC
    ClassTODODOC
    ClassRFC4419 Packet: SSH_MSG_KEX_DH_GEX_INIT mpint e
    ClassRFC4419 Packet: SSH_MSG_KEX_DH_GEX_GROUP mpint p, safe prime mpint g, generator for subgroup in GF(p)
    ClassRFC4419 Packet: SSH_MSG_KEX_DH_GEX_REPLY string server public host key and certificates (K_S) mpint f string signature of H
    ClassRFC4419 Packet: SSH_MSG_KEY_DH_GEX_REQUEST_OLD uint32 n, preferred size in bits of the group the server will send
    ClassRFC4419 Packet: SSH_MSG_KEY_DH_GEX_REQUEST uint32 min, minimal size in bits of an acceptable group uint32 n, preferred size in bits of the group the server will send uint32 max, maximal size in bits of an acceptable group
    ClassTODODOC RFC 4419
    Class 
    Class 
    ClassRFC4253: 8. Diffie-Hellman Key Exchange Packet: SSH_MSG_KEXDH_INIT byte SSH_MSG_KEXDH_INIT mpint e
    ClassRFC4253: 8. Diffie-Hellman Key Exchange Packet: SSH_MSG_KEXDH_REPLY byte SSH_MSG_KEXDH_REPLY string server public host key and certificates (K_S) mpint f string signature of H
    ClassRFC4253: 11.1. Disconnection Message Packet: SSH_MSG_DISCONNECT byte SSH_MSG_DISCONNECT uint32 reason code string description in ISO-10646 UTF-8 encoding [RFC3629] string language tag [RFC3066]
    Class 
    Class 
    Class 
    Class 
    Class 
    ClassTODODOC
    ClassRFC5656: 4. ECDH Key Exchange Packet: SSH_MSG_KEX_ECDH_INIT byte SSH_MSG_KEX_ECDH_INIT string Q_C, client's ephemeral public key octet string
    ClassRFC5656: 4. ECDH Key Exchange Packet: SSH_MSG_KEX_ECDH_REPLY byte SSH_MSG_KEX_ECDH_REPLY string K_S, server's public host key string Q_S, server's ephemeral public key octet string string the signature on the exchange hash
    Class 
    Class 
    Class 
    Class 
    ClassRFC8308: 2.3. SSH_MSG_EXT_INFO Message Packet: SSH_MSG_EXT_INFO byte SSH_MSG_EXT_INFO (value 7) uint32 nr-extensions repeat the following 2 fields "nr-extensions" times: string extension-name string extension-value (binary)
    Class 
    ClassRFC4254: 4. Global Requests Packet: SSH_MSG_GLOBAL_REQUEST byte SSH_MSG_GLOBAL_REQUEST string request name in US-ASCII only boolean want reply .... request-specific data follows
    Classfirst 96 bits of HMAC-MD5 (digest length = 12, key length = 16)
    ClassHMAC-MD5 (digest length = key length = 16)
    Classfirst 96 bits of HMAC-SHA1 (digest length = 12, key length = 20)
    ClassHMAC-SHA1 (digest length = key length = 20)
    Class 
    ClassFirst 96 bits of HMAC-SHA2 (digest length = 12 key length = 32)
    ClassDefined by RFC 6698: https://tools.ietf.org/html/rfc6668 256 bits of HMAC-SHA2 (digest length = 32, key length = 32)
    Class 
    ClassDefined by RFC 6698: https://tools.ietf.org/html/rfc6668 512 bits of HMAC-SHA2 (digest length = 64, key length = 64)
    Class 
    ClassRFC4253: 11.2. Ignored Data Message Packet: SSH_MSG_IGNORE byte SSH_MSG_IGNORE string data
    ClassRFC4253: 7.1. Algorithm Negotiation Packet: SSH_MSG_KEXINIT byte SSH_MSG_KEXINIT byte[16] cookie (random bytes) name-list kex_algorithms name-list server_host_key_algorithms name-list encryption_algorithms_client_to_server name-list encryption_algorithms_server_to_client name-list mac_algorithms_client_to_server name-list mac_algorithms_server_to_client name-list compression_algorithms_client_to_server name-list compression_algorithms_server_to_client name-list languages_client_to_server name-list languages_server_to_client boolean first_kex_packet_follows uint32 0 (reserved for future extension)
    Class 
    ClassTODODOC RFC 8731 RFC 7748
    ClassRFC4253: 7.3. Taking Keys Into Use Packet: SSH_MSG_NEWKEYS byte SSH_MSG_NEWKEYS
    Class 
    Class 
    Class 
    ClassBase class for all "One-Time pad" encryption algorithm. Encrypted bytes are simply "xored" with bytes provided by a keystream.
    Class 
    ClassRFC4254: 4. Global Requests Packet: SSH_MSG_REQUEST_FAILURE byte SSH_MSG_REQUEST_FAILURE
    ClassRFC4254: 4. Global Requests Packet: SSH_MSG_REQUEST_SUCCESS byte SSH_MSG_REQUEST_SUCCESS
    Classstring "server-sig-algs" name-list public-key-algorithms-accepted
    ClassRFC4253: 10. Service Request Packet: SSH_MSG_SERVICE_ACCEPT byte SSH_MSG_SERVICE_ACCEPT string service name
    ClassRFC4253: 10. Service Request Packet: SSH_MSG_SERVICE_REQUEST byte SSH_MSG_SERVICE_REQUEST string service name
    Class 
    ClassException that is thrown when an error occurs during authentication with the SSH server.
    Class 
    Class 
    Class 
    Class 
    ClassRFC4254: 5.4. Channel-Specific Requests Packet: SSH_MSG_CHANNEL_REQUEST string signal name (without the "SIG" prefix) boolean core dumped string error message in ISO-10646 UTF-8 encoding string language tag[ RFC3066 ]
    ClassRFC4254: 5.4. Channel-Specific Requests Packet: SSH_MSG_CHANNEL_REQUEST uint32 exit_status
    Class 
    Class 
    Class 
    Class 
    Class"ssh-dss" private key format mpint x (the private key parameter of DSA)
    Class 
    Class 
    ClassRFC4253: 6.6. Public Key Algorithms "ssh-dss" key format string "ssh-dss" mpint p mpint q mpint g mpint y
    ClassRFC4253: 6.6. Public Key Algorithms "ssh-dss" signature format string "ssh-dss" string dss_signature_blob The value for 'dss_signature_blob' is encoded as a string containing r, followed by s (which are 160-bit integers, without lengths or padding, unsigned, and in network byte order).
    ClassFor "ssh-ecdsa-sha2-*", it will be composed of mpint d (the private key parameter)
    Class 
    Class 
    ClassRFC5656: 6.6. Public Key Algorithms string "ecdsa-sha2-[identifier]" byte[n] ecc_key_blob The ecc_key_blob value has the following specific encoding: string [identifier] string Q The string [identifier] is the identifier of the elliptic curve domain parameters.
    ClassRFC5656: 3.1.2. Signature Encoding Signatures are encoded as follows: string "ecdsa-sha2-[identifier]" string ecdsa_signature_blob The string [identifier] is the identifier of the elliptic curve domain parameters. The format of this string is specified in Section 6.1. Information on the REQUIRED and RECOMMENDED sets of elliptic curve domain parameters for use with this algorithm can be found in Section 10. The ecdsa_signature_blob value has the following specific encoding: mpint r mpint s The integers r and s are the output of the ECDSA algorithm. The width of the integer fields is determined by the curve being used. Note that the integers r and s are integers modulo the order of the cryptographic subgroup, which may be larger than the size of the finite field.
    ClassEdDsa private key format. Undocumented MpInt private key
    Class 
    Class 
    ClassRFC8709: 4. Public Key Format string "ssh-ed25519" string key Here, 'key' is the 32-octet public key described in [RFC8032], Section 5.1.5. The ecc_key_blob value has the following specific encoding: string "ssh-ed448" string key Here, 'key' is the 57-octet public key described in [RFC8032], Section 5.2.5.
    ClassRFC8709: 6. Signature Format The "ssh-ed25519" key format has the following encoding: string "ssh-ed25519" string signature Here, 'signature' is the 64-octet signature produced in accordance with [RFC8032], Section 5.1.6. The "ssh-ed448" key format has the following encoding: string "ssh-ed448" string signature Here, 'signature' is the 114-octet signature produced in accordance with [RFC8032], Section 5.2.6.
    Class 
    Class 
    Class 
    Class 
    Class

    The exception that is thrown when an error occurs while sending the SSH Identification string to the server.

    Class 
    Class 
    Class 
    ClassThe exception that is thrown when an error occurs during the SSH key exchange.
    Class 
    ClassThere is no standard format for private keys byte[n] private key data
    ClassTODODOC
    Class 
    Class 
    Class 
    ClassRFC4253: 6.6. Public Key Algorithms string certificate or public key format identifier byte[n] key/certificate data
    Class"ssh-rsa" private key format mpint private_exponent mpint p (the larger of the two primes) mpint q (the smaller prime) mpint iqmp (the inverse of q modulo p) data padding (to reach a multiple of the cipher block size)
    Class 
    ClassRFC4253: 6.6. Public Key Algorithms "ssh-rsa" key format string "ssh-rsa" mpint e mpint n
    Class 
    Class 
    ClassRFC4253: 6.6. Public Key Algorithms "ssh-rsa" signature format string algorithm name ("ssh-rsa", "rsa-sha2-256" or "rsa-sha2-512") string rsa_signature_blob The value for 'rsa_signature_blob' is encoded as a string containing s (which is an integer, without lengths or padding, unsigned, and in network byte order).
    ClassRFC4253: 6.6. Public Key Algorithms string signature format identifier (as specified by the public key/certificate format) byte[n] signature blob in format specific encoding.
    ClassRFC4254: 7.1. Requesting Port Forwarding Packet: SSH_MSG_GLOBAL_REQUEST string address to bind (e.g., "0.0.0.0") uint32 port number to bind
    Class 
    Class 
    Class 
    Class 
    Class 
    ClassRFC4253: 11.4. Reserved Messages Packet: SSH_MSG_UNIMPLEMENTED byte SSH_MSG_UNIMPLEMENTED uint32 packet sequence number of rejected message
    Classstring extension-name string extension-value (binary)
    ClassThe exception that is thrown when the SSH server is running an unsupported version.
    ClassRFC4252: 5.4. Banner Message Packet: SSH_MSG_USERAUTH_BANNER byte SSH_MSG_USERAUTH_BANNER string message in ISO-10646 UTF-8 encoding [RFC3629] string language tag [RFC3066]
    ClassRFC4252: 5.1. Responses to Authentication Requests Packet: SSH_MSG_USERAUTH_FAILURE byte SSH_MSG_USERAUTH_FAILURE name-list authentications that can continue boolean partial success
    ClassRFC4256: 3.2. Information Requests Packet: SSH_MSG_USERAUTH_INFO_REQUEST byte SSH_MSG_USERAUTH_INFO_REQUEST string name (ISO-10646 UTF-8) string instruction (ISO-10646 UTF-8) string language tag (as defined in [RFC-3066]) int num-prompts string prompt[1] (ISO-10646 UTF-8) boolean echo[1] ... string prompt[num-prompts] (ISO-10646 UTF-8) boolean echo[num-prompts]
    ClassRFC4256: 3.4. Information Responses Packet: SSH_MSG_USERAUTH_INFO_RESPONSE byte SSH_MSG_USERAUTH_INFO_RESPONSE int num-responses string response[1] (ISO-10646 UTF-8) ... string response[num-responses] (ISO-10646 UTF-8)
    ClassRFC4256: 3.1. Initial Exchange Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name (ISO-10646 UTF-8, as defined in [RFC-3629]) string service name (US-ASCII) string "keyboard-interactive" (US-ASCII) string language tag (as defined in [RFC-3066]) string submethods (ISO-10646 UTF-8)
    ClassRFC4252: 8. Password Authentication Method: "password" Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name string service name string "password" boolean TRUE string plaintext password in ISO-10646 UTF-8 encoding [RFC3629] string plaintext new password in ISO-10646 UTF-8 encoding [RFC3629]
    ClassRFC4252: 5.2. The "none" Authentication Request Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name (ISO-10646 UTF-8, as defined in [RFC-3629]) string service name (US-ASCII) string "none" (US-ASCII)
    ClassRFC4252: 8. Password Authentication Method: "password" Packet: SSH_MSG_USERAUTH_PASSWD_CHANGEREQ byte SSH_MSG_USERAUTH_PASSWD_CHANGEREQ string prompt in ISO-10646 UTF-8 encoding [RFC3629] string language tag [RFC3066]
    ClassRFC4252: 8. Password Authentication Method: "password" Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name string service name string "password" boolean FALSE string plaintext password in ISO-10646 UTF-8 encoding [RFC3629]
    ClassRFC4252: 7. Public Key Authentication Method: "publickey" Packet: SSH_MSG_USERAUTH_PK_OK byte SSH_MSG_USERAUTH_PK_OK string public key algorithm name from the request string public key blob from the request
    ClassRFC4252: 7. Public Key Authentication Method: "publickey" Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name in ISO-10646 UTF-8 encoding [RFC3629] string service name in US-ASCII string "publickey" boolean FALSE string public key algorithm name string public key blob
    ClassRFC4252: 7. Public Key Authentication Method: "publickey" Packet: SSH_MSG_USERAUTH_REQUEST byte SSH_MSG_USERAUTH_REQUEST string user name in ISO-10646 UTF-8 encoding [RFC3629] string service name in US-ASCII string "publickey" boolean TRUE string public key algorithm name string public key to be used for authentication string signature
    ClassRFC4252: 5.1. Responses to Authentication Requests Packet: SSH_MSG_USERAUTH_SUCCESS byte SSH_MSG_USERAUTH_SUCCESS
    Interfaces
     InterfaceDescription
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    InterfaceRFC4254: 5.2. Data Transfer The window size is decremented by the amount of data sent. Although the RFC does not state it explicitly, window size data is made up of effective data. This does NOT include overhead data like the 'string' type size, the channel id and the packet ID for example.
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    InterfaceTODODOC
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    Interface 
    Delegates
    Enumerations
    See Also