assh/helper_interactive.h header reference

Description [link] 

This headers file provides some helper functions able load and store data embedded in standard requests and channels open messages related to the interactive sessions features of ssh2.

See also Connection protocol implementation and assh/assh_connection.h.

Members [link] 

Types [link] 

Functions [link] 

Members detail [link] 

assh_status_t asshh_inter_decode_env(struct asshh_inter_env_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 254.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the environment variable object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_exec(struct asshh_inter_exec_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 312.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the command execution object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_exit_signal(struct asshh_inter_exit_signal_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 590.

This function decodes the command kill status object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_exit_status(struct asshh_inter_exit_status_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 543.

This function decodes the command exit status object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_pty_req(struct asshh_inter_pty_req_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 107.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the pty request object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_signal(struct asshh_inter_signal_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 501.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the signal delivery object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_subsystem(struct asshh_inter_subsystem_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 360.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the subsystem execution object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_window_change(struct asshh_inter_window_change_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 413.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the window size changed object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_x11(struct asshh_inter_x11_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 205.

This function decodes the x11 channel object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_x11_req(struct asshh_inter_x11_req_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 161.

Preprocessor condition: defined( CONFIG_ASSH_SERVER )

This function decodes the x11 forwarding request object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_decode_xon_xoff(struct asshh_inter_xon_xoff_s *i, const uint8_t *data, size_t size) [link] 

This function is declared in assh/helper_interactive.h source file, line 455.

This function decodes the client xon/xoff allowed object from the passed buffer. The data buffer must remain valid because string buffers are not copied. This function fails when the buffer contains invalid data.

assh_status_t asshh_inter_encode_env(uint8_t *data, size_t size, const struct asshh_inter_env_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 234.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the environment variable object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_exec(uint8_t *data, size_t size, const struct asshh_inter_exec_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 292.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the command execution object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_exit_signal(uint8_t *data, size_t size, const struct asshh_inter_exit_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 574.

This function encodes the command kill status object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_exit_status(uint8_t *data, size_t size, const struct asshh_inter_exit_status_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 527.

This function encodes the command exit status object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_pty_req(uint8_t *data, size_t size, const struct asshh_inter_pty_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 87.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the pty request object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_signal(uint8_t *data, size_t size, const struct asshh_inter_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 482.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the signal delivery object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_subsystem(uint8_t *data, size_t size, const struct asshh_inter_subsystem_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 340.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the subsystem execution object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_window_change(uint8_t *data, size_t size, const struct asshh_inter_window_change_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 394.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the window size changed object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_x11(uint8_t *data, size_t size, const struct asshh_inter_x11_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 189.

This function encodes the x11 channel object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_x11_req(uint8_t *data, size_t size, const struct asshh_inter_x11_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 141.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes the x11 forwarding request object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

assh_status_t asshh_inter_encode_xon_xoff(uint8_t *data, size_t size, const struct asshh_inter_xon_xoff_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 439.

This function encodes the client xon/xoff allowed object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.

struct asshh_inter_env_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 209.

This struct specifies the environment variable object.

FieldDescription
struct assh_cbuffer_s name;
struct assh_cbuffer_s value;

struct asshh_inter_exec_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 269.

This struct specifies the command execution object.

FieldDescription
struct assh_cbuffer_s command;

struct asshh_inter_exit_signal_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 547.

This struct specifies the command kill status object.

struct asshh_inter_exit_status_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 506.

This struct specifies the command exit status object.

FieldDescription
uint32_t status;

void asshh_inter_init_env(struct asshh_inter_env_s *i, const char *name, const char *value) [link] 

This function is declared in assh/helper_interactive.h source file, line 222.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a environment variable object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_exec(struct asshh_inter_exec_s *i, const char *command) [link] 

This function is declared in assh/helper_interactive.h source file, line 280.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a command execution object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_exit_signal(struct asshh_inter_exit_signal_s *i, const char *sig_name, assh_bool_t core, const char *errmsg, const char *lang) [link] 

This function is declared in assh/helper_interactive.h source file, line 562.

This function initializes a command kill status object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_exit_status(struct asshh_inter_exit_status_s *i, uint32_t status) [link] 

This function is declared in assh/helper_interactive.h source file, line 515.

This function initializes a command exit status object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_pty_req(struct asshh_inter_pty_req_s *i, const char *termenv, uint32_t char_width, uint32_t char_height, uint32_t pix_width, uint32_t pix_height, const uint8_t *modes) [link] 

This function is declared in assh/helper_interactive.h source file, line 75.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a pty request object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_signal(struct asshh_inter_signal_s *i, const char *sig_name) [link] 

This function is declared in assh/helper_interactive.h source file, line 470.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a signal delivery object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_subsystem(struct asshh_inter_subsystem_s *i, const char *name) [link] 

This function is declared in assh/helper_interactive.h source file, line 328.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a subsystem execution object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_window_change(struct asshh_inter_window_change_s *i, uint32_t char_width, uint32_t char_height, uint32_t pix_width, uint32_t pix_height) [link] 

This function is declared in assh/helper_interactive.h source file, line 382.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a window size changed object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_x11(struct asshh_inter_x11_s *i, const char *orig_addr, uint32_t orig_port) [link] 

This function is declared in assh/helper_interactive.h source file, line 177.

This function initializes a x11 channel object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_x11_req(struct asshh_inter_x11_req_s *i, assh_bool_t single, const char *auth_protocol, const struct assh_cbuffer_s *auth_cookie, uint32_t screen) [link] 

This function is declared in assh/helper_interactive.h source file, line 129.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function initializes a x11 forwarding request object. Any buffer passed to the function is not copied and must remain valid.

void asshh_inter_init_xon_xoff(struct asshh_inter_xon_xoff_s *i, assh_bool_t client_can_do) [link] 

This function is declared in assh/helper_interactive.h source file, line 427.

This function initializes a client xon/xoff allowed object. Any buffer passed to the function is not copied and must remain valid.

assh_status_t asshh_inter_open_session(struct assh_session_s *s, struct assh_channel_s **ch) [link] 

This function is declared in assh/helper_interactive.h source file, line 49.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function requests a interactive session start open.

See also assh_channel_open.

assh_status_t asshh_inter_open_x11(struct assh_session_s *s, struct assh_channel_s **ch, const struct asshh_inter_x11_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 197.

This function requests a x11 channel open.

See also asshh_inter_encode_x11 and assh_channel_open.

struct asshh_inter_pty_req_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 54.

This struct specifies the pty request object.

FieldDescription
struct assh_cbuffer_s termenv;
uint32_t char_width;
uint32_t char_height;
uint32_t pix_width;
uint32_t pix_height;
struct assh_cbuffer_s modes;

assh_status_t asshh_inter_send_env(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq, const struct asshh_inter_env_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 243.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a environment variable

See also asshh_inter_encode_env and assh_request.

assh_status_t asshh_inter_send_exec(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq, const struct asshh_inter_exec_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 301.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a command execution

See also asshh_inter_encode_exec and assh_request.

assh_status_t asshh_inter_send_exit_signal(struct assh_session_s *s, struct assh_channel_s *ch, const struct asshh_inter_exit_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 582.

This function encodes and sends a command kill status

See also asshh_inter_encode_exit_signal and assh_request.

assh_status_t asshh_inter_send_exit_status(struct assh_session_s *s, struct assh_channel_s *ch, const struct asshh_inter_exit_status_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 535.

This function encodes and sends a command exit status

See also asshh_inter_encode_exit_status and assh_request.

assh_status_t asshh_inter_send_pty_req(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq, const struct asshh_inter_pty_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 96.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a pty request

See also asshh_inter_encode_pty_req and assh_request.

assh_status_t asshh_inter_send_shell(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq) [link] 

This function is declared in assh/helper_interactive.h source file, line 264.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a shell execution

See also assh_request.

assh_status_t asshh_inter_send_signal(struct assh_session_s *s, struct assh_channel_s *ch, const struct asshh_inter_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 490.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a signal delivery

See also asshh_inter_encode_signal and assh_request.

assh_status_t asshh_inter_send_subsystem(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq, const struct asshh_inter_subsystem_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 349.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a subsystem execution

See also asshh_inter_encode_subsystem and assh_request.

assh_status_t asshh_inter_send_window_change(struct assh_session_s *s, struct assh_channel_s *ch, const struct asshh_inter_window_change_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 402.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a window size changed

See also asshh_inter_encode_window_change and assh_request.

assh_status_t asshh_inter_send_x11_req(struct assh_session_s *s, struct assh_channel_s *ch, struct assh_request_s **rq, const struct asshh_inter_x11_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 150.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function encodes and sends a x11 forwarding request

See also asshh_inter_encode_x11_req and assh_request.

assh_status_t asshh_inter_send_xon_xoff(struct assh_session_s *s, struct assh_channel_s *ch, const struct asshh_inter_xon_xoff_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 447.

This function encodes and sends a client xon/xoff allowed

See also asshh_inter_encode_xon_xoff and assh_request.

struct asshh_inter_signal_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 459.

This struct specifies the signal delivery object.

FieldDescription
struct assh_cbuffer_s sig_name;

size_t asshh_inter_size_env(const struct asshh_inter_env_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 227.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a environment variable object.

size_t asshh_inter_size_exec(const struct asshh_inter_exec_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 285.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a command execution object.

size_t asshh_inter_size_exit_signal(const struct asshh_inter_exit_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 567.

This function returns the size of the buffer required to encode a command kill status object.

size_t asshh_inter_size_exit_status(const struct asshh_inter_exit_status_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 520.

This function returns the size of the buffer required to encode a command exit status object.

size_t asshh_inter_size_pty_req(const struct asshh_inter_pty_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 80.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a pty request object.

size_t asshh_inter_size_signal(const struct asshh_inter_signal_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 475.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a signal delivery object.

size_t asshh_inter_size_subsystem(const struct asshh_inter_subsystem_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 333.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a subsystem execution object.

size_t asshh_inter_size_window_change(const struct asshh_inter_window_change_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 387.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a window size changed object.

size_t asshh_inter_size_x11(const struct asshh_inter_x11_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 182.

This function returns the size of the buffer required to encode a x11 channel object.

size_t asshh_inter_size_x11_req(const struct asshh_inter_x11_req_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 134.

Preprocessor condition: defined( CONFIG_ASSH_CLIENT )

This function returns the size of the buffer required to encode a x11 forwarding request object.

size_t asshh_inter_size_xon_xoff(const struct asshh_inter_xon_xoff_s *i) [link] 

This function is declared in assh/helper_interactive.h source file, line 432.

This function returns the size of the buffer required to encode a client xon/xoff allowed object.

struct asshh_inter_subsystem_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 317.

This struct specifies the subsystem execution object.

FieldDescription
struct assh_cbuffer_s name;

struct asshh_inter_window_change_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 365.

This struct specifies the window size changed object.

FieldDescription
uint32_t char_width;
uint32_t char_height;
uint32_t pix_width;
uint32_t pix_height;

struct asshh_inter_x11_req_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 112.

This struct specifies the x11 forwarding request object.

FieldDescription
assh_bool_t single;
struct assh_cbuffer_s auth_protocol;
struct assh_cbuffer_s auth_cookie;
uint32_t screen;

struct asshh_inter_x11_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 166.

This struct specifies the x11 channel object.

FieldDescription
struct assh_cbuffer_s orig_addr;
uint32_t orig_port;

struct asshh_inter_xon_xoff_s [link] 

This struct is declared in assh/helper_interactive.h source file, line 418.

This struct specifies the client xon/xoff allowed object.

FieldDescription
assh_bool_t client_can_do;
Valid XHTML 1.0 StrictGenerated by diaxen on Sun Oct 25 23:30:45 2020 using MkDoc