assh/helper_portfwd.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 port forwarding features of ssh2.
See also Connection protocol implementation and assh/assh_connection.h.
Members [link]
Types [link]
Functions [link]
- assh_status_t asshh_portfwd_decode_cancel_tcpip_forward(struct asshh_portfwd_cancel_tcpip_forward_s *i, const uint8_t *data, size_t size)
- assh_status_t asshh_portfwd_decode_direct_tcpip(struct asshh_portfwd_direct_tcpip_s *i, const uint8_t *data, size_t size)
- assh_status_t asshh_portfwd_decode_forwarded_tcpip(struct asshh_portfwd_forwarded_tcpip_s *i, const uint8_t *data, size_t size)
- assh_status_t asshh_portfwd_decode_tcpip_forward(struct asshh_portfwd_tcpip_forward_s *i, const uint8_t *data, size_t size)
- assh_status_t asshh_portfwd_decode_tcpip_forward_reply(struct asshh_portfwd_tcpip_forward_reply_s *i, const uint8_t *data, size_t size)
- assh_status_t asshh_portfwd_encode_cancel_tcpip_forward(uint8_t *data, size_t size, const struct asshh_portfwd_cancel_tcpip_forward_s *i)
- assh_status_t asshh_portfwd_encode_direct_tcpip(uint8_t *data, size_t size, const struct asshh_portfwd_direct_tcpip_s *i)
- assh_status_t asshh_portfwd_encode_forwarded_tcpip(uint8_t *data, size_t size, const struct asshh_portfwd_forwarded_tcpip_s *i)
- assh_status_t asshh_portfwd_encode_tcpip_forward(uint8_t *data, size_t size, const struct asshh_portfwd_tcpip_forward_s *i)
- assh_status_t asshh_portfwd_encode_tcpip_forward_reply(uint8_t *data, size_t size, const struct asshh_portfwd_tcpip_forward_reply_s *i)
- void asshh_portfwd_init_cancel_tcpip_forward(struct asshh_portfwd_cancel_tcpip_forward_s *i, const char *addr, uint32_t port)
- void asshh_portfwd_init_direct_tcpip(struct asshh_portfwd_direct_tcpip_s *i, const char *conn_addr, uint32_t conn_port, const char *orig_addr, uint32_t orig_port)
- void asshh_portfwd_init_forwarded_tcpip(struct asshh_portfwd_forwarded_tcpip_s *i, const char *conn_addr, uint32_t conn_port, const char *orig_addr, uint32_t orig_port)
- void asshh_portfwd_init_tcpip_forward(struct asshh_portfwd_tcpip_forward_s *i, const char *addr, uint32_t port)
- void asshh_portfwd_init_tcpip_forward_reply(struct asshh_portfwd_tcpip_forward_reply_s *i, uint32_t port)
- assh_status_t asshh_portfwd_open_direct_tcpip(struct assh_session_s *s, struct assh_channel_s **ch, const struct asshh_portfwd_direct_tcpip_s *i)
- assh_status_t asshh_portfwd_open_forwarded_tcpip(struct assh_session_s *s, struct assh_channel_s **ch, const struct asshh_portfwd_forwarded_tcpip_s *i)
- assh_status_t asshh_portfwd_send_cancel_tcpip_forward(struct assh_session_s *s, struct assh_request_s **rq, const struct asshh_portfwd_cancel_tcpip_forward_s *i)
- assh_status_t asshh_portfwd_send_tcpip_forward(struct assh_session_s *s, struct assh_request_s **rq, const struct asshh_portfwd_tcpip_forward_s *i)
- size_t asshh_portfwd_size_cancel_tcpip_forward(const struct asshh_portfwd_cancel_tcpip_forward_s *i)
- size_t asshh_portfwd_size_direct_tcpip(const struct asshh_portfwd_direct_tcpip_s *i)
- size_t asshh_portfwd_size_forwarded_tcpip(const struct asshh_portfwd_forwarded_tcpip_s *i)
- size_t asshh_portfwd_size_tcpip_forward(const struct asshh_portfwd_tcpip_forward_s *i)
- size_t asshh_portfwd_size_tcpip_forward_reply(const struct asshh_portfwd_tcpip_forward_reply_s *i)
Members detail [link]
struct asshh_portfwd_cancel_tcpip_forward_s [link]
This struct is declared in assh/helper_portfwd.h source file, line 127.
This struct specifies the port forwarding cancel object.
| Field | Description |
|---|---|
| struct assh_cbuffer_s addr; | |
| uint32_t port; |
assh_status_t asshh_portfwd_decode_cancel_tcpip_forward(struct asshh_portfwd_cancel_tcpip_forward_s *i, const uint8_t *data, size_t size) [link]
This function is declared in assh/helper_portfwd.h source file, line 171.
Preprocessor condition: defined( CONFIG_ASSH_SERVER )
This function decodes the port forwarding cancel 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_portfwd_decode_direct_tcpip(struct asshh_portfwd_direct_tcpip_s *i, const uint8_t *data, size_t size) [link]
This function is declared in assh/helper_portfwd.h source file, line 273.
Preprocessor condition: defined( CONFIG_ASSH_SERVER )
This function decodes the direct tcp/ip forwarding 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_portfwd_decode_forwarded_tcpip(struct asshh_portfwd_forwarded_tcpip_s *i, const uint8_t *data, size_t size) [link]
This function is declared in assh/helper_portfwd.h source file, line 220.
This function decodes the incoming forwarded connection 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_portfwd_decode_tcpip_forward(struct asshh_portfwd_tcpip_forward_s *i, const uint8_t *data, size_t size) [link]
This function is declared in assh/helper_portfwd.h source file, line 89.
Preprocessor condition: defined( CONFIG_ASSH_SERVER )
This function decodes the port 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_portfwd_decode_tcpip_forward_reply(struct asshh_portfwd_tcpip_forward_reply_s *i, const uint8_t *data, size_t size) [link]
This function is declared in assh/helper_portfwd.h source file, line 123.
This function decodes the port forwarding request reply 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.
struct asshh_portfwd_direct_tcpip_s [link]
This struct is declared in assh/helper_portfwd.h source file, line 224.
This struct specifies the direct tcp/ip forwarding channel object.
| Field | Description |
|---|---|
| struct assh_cbuffer_s conn_addr; | |
| uint32_t conn_port; | |
| struct assh_cbuffer_s orig_addr; | |
| uint32_t orig_port; |
assh_status_t asshh_portfwd_encode_cancel_tcpip_forward(uint8_t *data, size_t size, const struct asshh_portfwd_cancel_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 152.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function encodes the port forwarding cancel 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_portfwd_encode_direct_tcpip(uint8_t *data, size_t size, const struct asshh_portfwd_direct_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 254.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function encodes the direct tcp/ip forwarding 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_portfwd_encode_forwarded_tcpip(uint8_t *data, size_t size, const struct asshh_portfwd_forwarded_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 204.
This function encodes the incoming forwarded connection 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_portfwd_encode_tcpip_forward(uint8_t *data, size_t size, const struct asshh_portfwd_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 70.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function encodes the port 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_portfwd_encode_tcpip_forward_reply(uint8_t *data, size_t size, const struct asshh_portfwd_tcpip_forward_reply_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 115.
This function encodes the port forwarding request reply object in a buffer suitable for calling the assh_request function. This function fails when the provided buffer is not large enough.
struct asshh_portfwd_forwarded_tcpip_s [link]
This struct is declared in assh/helper_portfwd.h source file, line 176.
This struct specifies the incoming forwarded connection channel object.
| Field | Description |
|---|---|
| struct assh_cbuffer_s conn_addr; | |
| uint32_t conn_port; | |
| struct assh_cbuffer_s orig_addr; | |
| uint32_t orig_port; |
void asshh_portfwd_init_cancel_tcpip_forward(struct asshh_portfwd_cancel_tcpip_forward_s *i, const char *addr, uint32_t port) [link]
This function is declared in assh/helper_portfwd.h source file, line 140.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function initializes a port forwarding cancel object. Any buffer passed to the function is not copied and must remain valid.
void asshh_portfwd_init_direct_tcpip(struct asshh_portfwd_direct_tcpip_s *i, const char *conn_addr, uint32_t conn_port, const char *orig_addr, uint32_t orig_port) [link]
This function is declared in assh/helper_portfwd.h source file, line 241.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function initializes a direct tcp/ip forwarding channel object. Any buffer passed to the function is not copied and must remain valid.
void asshh_portfwd_init_forwarded_tcpip(struct asshh_portfwd_forwarded_tcpip_s *i, const char *conn_addr, uint32_t conn_port, const char *orig_addr, uint32_t orig_port) [link]
This function is declared in assh/helper_portfwd.h source file, line 191.
This function initializes a incoming forwarded connection channel object. Any buffer passed to the function is not copied and must remain valid.
void asshh_portfwd_init_tcpip_forward(struct asshh_portfwd_tcpip_forward_s *i, const char *addr, uint32_t port) [link]
This function is declared in assh/helper_portfwd.h source file, line 58.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function initializes a port forwarding request object. Any buffer passed to the function is not copied and must remain valid.
void asshh_portfwd_init_tcpip_forward_reply(struct asshh_portfwd_tcpip_forward_reply_s *i, uint32_t port) [link]
This function is declared in assh/helper_portfwd.h source file, line 103.
This function initializes a port forwarding request reply object. Any buffer passed to the function is not copied and must remain valid.
assh_status_t asshh_portfwd_open_direct_tcpip(struct assh_session_s *s, struct assh_channel_s **ch, const struct asshh_portfwd_direct_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 262.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function requests a direct tcp/ip forwarding channel open.
See also asshh_portfwd_encode_direct_tcpip and assh_channel_open.
assh_status_t asshh_portfwd_open_forwarded_tcpip(struct assh_session_s *s, struct assh_channel_s **ch, const struct asshh_portfwd_forwarded_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 212.
This function requests a incoming forwarded connection channel open.
See also asshh_portfwd_encode_forwarded_tcpip and assh_channel_open.
assh_status_t asshh_portfwd_send_cancel_tcpip_forward(struct assh_session_s *s, struct assh_request_s **rq, const struct asshh_portfwd_cancel_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 160.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function encodes and sends a port forwarding cancel
See also asshh_portfwd_encode_cancel_tcpip_forward and assh_request.
assh_status_t asshh_portfwd_send_tcpip_forward(struct assh_session_s *s, struct assh_request_s **rq, const struct asshh_portfwd_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 78.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function encodes and sends a port forwarding request
See also asshh_portfwd_encode_tcpip_forward and assh_request.
size_t asshh_portfwd_size_cancel_tcpip_forward(const struct asshh_portfwd_cancel_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 145.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function returns the size of the buffer required to encode a port forwarding cancel object.
size_t asshh_portfwd_size_direct_tcpip(const struct asshh_portfwd_direct_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 246.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function returns the size of the buffer required to encode a direct tcp/ip forwarding channel object.
size_t asshh_portfwd_size_forwarded_tcpip(const struct asshh_portfwd_forwarded_tcpip_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 196.
This function returns the size of the buffer required to encode a incoming forwarded connection channel object.
size_t asshh_portfwd_size_tcpip_forward(const struct asshh_portfwd_tcpip_forward_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 63.
Preprocessor condition: defined( CONFIG_ASSH_CLIENT )
This function returns the size of the buffer required to encode a port forwarding request object.
size_t asshh_portfwd_size_tcpip_forward_reply(const struct asshh_portfwd_tcpip_forward_reply_s *i) [link]
This function is declared in assh/helper_portfwd.h source file, line 108.
This function returns the size of the buffer required to encode a port forwarding request reply object.
struct asshh_portfwd_tcpip_forward_reply_s [link]
This struct is declared in assh/helper_portfwd.h source file, line 94.
This struct specifies the port forwarding request reply object.
| Field | Description |
|---|---|
| uint32_t port; |
struct asshh_portfwd_tcpip_forward_s [link]
This struct is declared in assh/helper_portfwd.h source file, line 45.
This struct specifies the port forwarding request object.
| Field | Description |
|---|---|
| struct assh_cbuffer_s addr; | |
| uint32_t port; |