DocumentMessages returns a documentation for the message format.

ListTypes returns all defined types.

StreamStderr Is the ID for the standard error containing the error messages for the application in non-TTY mode.

StreamStdin Is the ID of the standard input that accepts data from the user.

StreamStdout Is the ID for the output stream containing normal messages or TTY-encoded data from the application.

TypeAuthKeyboardInteractiveAnswer is a message that indicates a response to a keyboard-interactive challenge.

TypeAuthKeyboardInteractiveBackendError indicates an error in the authentication backend during a keyboard-interactive authentication.

TypeAuthKeyboardInteractiveChallenge is a message that indicates that a keyboard-interactive challenge has been sent to the user.

TypeAuthKeyboardInteractiveFailed indicates that a keyboard-interactive authentication process has failed.

TypeAuthPassword describes a message that is sent when the user submits a username and password.

TypeAuthPasswordBackendError describes a message that is sent when the auth server failed to respond to a request with username and password.

TypeAuthPasswordFailed describes a message that is sent when the submitted username and password were invalid.

TypeAuthPasswordSuccessful describes a message that is sent when the submitted username and password were valid.

TypeAuthPubKey describes a message that is sent when the user submits a username and public key.

TypeAuthPubKeyBackendError describes a message that is sent when the auth server failed to respond with username and password.

TypeAuthPubKeyFailed describes a message that is sent when the submitted username and public key were invalid.

TypeAuthPubKeySuccessful describes a message that is sent when the submitted username and public key were invalid.

TypeChannelRequestDecodeFailed describes an in-channel request from the user that is supported but the payload could not be decoded.

TypeChannelRequestExec describes an in-channel request to run a program.

TypeChannelRequestPty describes an in-channel request to create an interactive terminal.

TypeChannelRequestSetEnv describes an in-channel request to set an environment variable.

TypeChannelRequestShell describes an in-channel request to start a shell.

TypeChannelRequestSignal describes an in-channel request to send a signal to the currently running program.

TypeChannelRequestSubsystem describes an in-channel request to start a well-known subsystem (e.g.

TypeChannelRequestUnknownType describes an in-channel request from the user that is not supported.

TypeChannelRequestWindow describes an in-channel request to resize the current interactive terminal.

TypeClose indicates that the channel was closed.

TypeConnect describes a message that is sent when the user connects on a TCP level.

TypeDisconnect describes a message that is sent when the user disconnects on a TCP level.

TypeExit describes a message that is sent when the program exited.

TypeExitSignal describes the signal that caused a program to terminate abnormally.

TypeGlobalRequestUnknown describes a message when a global (non-channel) request was sent that was not recognized.

TypeHandshakeFailed indicates that the handshake has failed.

TypeHandshakeSuccessful indicates that the handshake and authentication was successful.

TypeIO describes the data transferred to and from the currently running program on the terminal.

TypeNewChannel describes a message that indicates a new channel request.

TypeNewChannelFailed describes a message when the channel request failed for the reason indicated.

TypeNewChannelSuccessful describes a message when the new channel request was successful.

TypeRequestFailed describes that a request has failed.

TypeWriteClose indicates that the channel was closed for writing from the server side.

DocField is a record if documentation inside a struct.

DocStruct documents a structure.

DocType contains an extra description for types.

Documentation is the entire documentation for the messages.

ExtendedMessage is a message that also contains the type in a text format.

KeyboardInteractiveAnswer is the response from the user to a keyboard-interactive authentication.

KeyboardInteractiveQuestion is a description of a question during a keyboard-interactive authentication.

Message is a basic element of audit logging.

PayloadAuthKeyboardInteractiveAnswer is a message that indicates a response to a keyboard-interactive challenge.

PayloadAuthKeyboardInteractiveBackendError indicates an error in the authentication backend during a keyboard-interactive authentication.

PayloadAuthKeyboardInteractiveChallenge is a message that indicates that a keyboard-interactive challenge has been sent to the user.

PayloadAuthKeyboardInteractiveFailed indicates that a keyboard-interactive authentication process has failed.

PayloadAuthPassword is a payload for a message that indicates an authentication attempt, successful, or failed authentication.

PayloadAuthPasswordBackendError is a payload for a message that indicates a backend failure during authentication.

PayloadAuthPubKey is a payload for a public key based authentication.

PayloadAuthPubKeyBackendError is a payload for a message indicating that there was a backend error while authenticating with public key.

PayloadChannelRequestDecodeFailed is a payload that signals a supported request that the server was unable to decode.

PayloadChannelRequestExec is a payload signaling the request to execute a program.

PayloadChannelRequestPty is a payload signaling the request for an interactive terminal.

PayloadChannelRequestSetEnv is a payload signaling the request for an environment variable.

PayloadChannelRequestShell is a payload signaling a request for a shell.

PayloadChannelRequestSignal is a payload signaling a signal request to be sent to the currently running program.

PayloadChannelRequestSubsystem is a payload requesting a well-known subsystem (e.g.

PayloadChannelRequestUnknownType is a payload signaling that a channel request was not supported.

PayloadChannelRequestWindow is a payload requesting the change in the terminal window size.

PayloadConnect is the payload for TypeConnect messages.

PayloadExit is the payload for a message that is sent when a program exits.

PayloadExitSignal indicates the signal that caused a program to abort.

PayloadGlobalRequestUnknown Is a payload for the TypeGlobalRequestUnknown messages.

PayloadHandshakeFailed is a payload for a failed handshake.

PayloadAuthPubKey is a payload for a successful handshake.

PayloadIO The payload for I/O message types containing the data stream from/to the application.

PayloadNewChannel is a payload that signals a request for a new SSH channel.

PayloadNewChannelFailed is a payload that signals that a request for a new channel has failed.

PayloadNewChannelSuccessful is a payload that signals that a channel request was successful.

PayloadRequestFailed is the payload for the TypeRequestFailed messages.

Payload is an interface that makes sure all payloads with Message have a method to compare them.

ConnectionID is an opaque, globally unique identifier for a connection made to the SSH server.

Stream The stream type corresponds to the file descriptor numbers common in UNIX systems for standard input, output, and error.

Type is the ID for the message type describing which payload is in the payload field of the message.