version 1.31.2.6, 2002/06/02 22:56:10 |
version 1.32, 2001/05/04 23:47:33 |
|
|
/* $OpenBSD$ */ |
|
|
|
/* |
/* |
* Author: Tatu Ylonen <ylo@cs.hut.fi> |
* Author: Tatu Ylonen <ylo@cs.hut.fi> |
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
|
|
* called by a name other than "ssh" or "Secure Shell". |
* called by a name other than "ssh" or "Secure Shell". |
*/ |
*/ |
/* |
/* |
* Copyright (c) 1999, 2000, 2001, 2002 Markus Friedl. All rights reserved. |
* Copyright (c) 2000 Markus Friedl. All rights reserved. |
* |
* |
* Redistribution and use in source and binary forms, with or without |
* Redistribution and use in source and binary forms, with or without |
* modification, are permitted provided that the following conditions |
* modification, are permitted provided that the following conditions |
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
*/ |
*/ |
|
/* RCSID("$OpenBSD$"); */ |
|
|
#ifndef CHANNEL_H |
#ifndef CHANNELS_H |
#define CHANNEL_H |
#define CHANNELS_H |
|
|
#include "buffer.h" |
#include "buffer.h" |
|
|
|
|
#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ |
#define SSH_CHANNEL_RPORT_LISTENER 11 /* Listening to a R-style port */ |
#define SSH_CHANNEL_CONNECTING 12 |
#define SSH_CHANNEL_CONNECTING 12 |
#define SSH_CHANNEL_DYNAMIC 13 |
#define SSH_CHANNEL_DYNAMIC 13 |
#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ |
#define SSH_CHANNEL_MAX_TYPE 14 |
#define SSH_CHANNEL_MAX_TYPE 15 |
|
|
|
#define SSH_CHANNEL_PATH_LEN 256 |
#define SSH_CHANNEL_PATH_LEN 30 |
|
|
|
/* |
|
* Data structure for channel data. This is initialized in channel_new |
|
* and cleared in channel_free. |
|
*/ |
struct Channel; |
struct Channel; |
typedef struct Channel Channel; |
typedef struct Channel Channel; |
|
|
typedef void channel_callback_fn(int, void *); |
typedef void channel_callback_fn(int id, void *arg); |
typedef int channel_filter_fn(struct Channel *, char *, int); |
typedef int channel_filter_fn(struct Channel *c, char *buf, int len); |
|
|
struct Channel { |
struct Channel { |
int type; /* channel type/state */ |
int type; /* channel type/state */ |
int self; /* my own channel identifier */ |
int self; /* my own channel identifier */ |
int remote_id; /* channel identifier for remote peer */ |
int remote_id; /* channel identifier for remote peer */ |
u_int istate; /* input from channel (state of receive half) */ |
/* peer can be reached over encrypted connection, via packet-sent */ |
u_int ostate; /* output to channel (state of transmit half) */ |
int istate; /* input from channel (state of receive half) */ |
|
int ostate; /* output to channel (state of transmit half) */ |
int flags; /* close sent/rcvd */ |
int flags; /* close sent/rcvd */ |
int rfd; /* read fd */ |
int rfd; /* read fd */ |
int wfd; /* write fd */ |
int wfd; /* write fd */ |
int efd; /* extended fd */ |
int efd; /* extended fd */ |
int sock; /* sock fd */ |
int sock; /* sock fd */ |
int isatty; /* rfd is a tty */ |
int isatty; /* rfd is a tty */ |
int force_drain; /* force close on iEOF */ |
|
int delayed; /* fdset hack */ |
|
Buffer input; /* data read from socket, to be sent over |
Buffer input; /* data read from socket, to be sent over |
* encrypted connection */ |
* encrypted connection */ |
Buffer output; /* data received over encrypted connection for |
Buffer output; /* data received over encrypted connection for |
|
|
int local_consumed; |
int local_consumed; |
int local_maxpacket; |
int local_maxpacket; |
int extended_usage; |
int extended_usage; |
int single_connection; |
|
|
|
char *ctype; /* type */ |
char *ctype; /* type */ |
|
|
/* callback */ |
/* callback */ |
channel_callback_fn *confirm; |
channel_callback_fn *cb_fn; |
channel_callback_fn *detach_user; |
void *cb_arg; |
|
int cb_event; |
|
channel_callback_fn *dettach_user; |
|
|
/* filter */ |
/* filter */ |
channel_filter_fn *input_filter; |
channel_filter_fn *input_filter; |
|
|
#define CHAN_EXTENDED_WRITE 2 |
#define CHAN_EXTENDED_WRITE 2 |
|
|
/* default window/packet sizes for tcp/x11-fwd-channel */ |
/* default window/packet sizes for tcp/x11-fwd-channel */ |
#define CHAN_SES_PACKET_DEFAULT (32*1024) |
#define CHAN_SES_WINDOW_DEFAULT (32*1024) |
#define CHAN_SES_WINDOW_DEFAULT (4*CHAN_SES_PACKET_DEFAULT) |
#define CHAN_SES_PACKET_DEFAULT (CHAN_SES_WINDOW_DEFAULT/2) |
#define CHAN_TCP_PACKET_DEFAULT (32*1024) |
#define CHAN_TCP_WINDOW_DEFAULT (32*1024) |
#define CHAN_TCP_WINDOW_DEFAULT (4*CHAN_TCP_PACKET_DEFAULT) |
#define CHAN_TCP_PACKET_DEFAULT (CHAN_TCP_WINDOW_DEFAULT/2) |
#define CHAN_X11_PACKET_DEFAULT (16*1024) |
#define CHAN_X11_WINDOW_DEFAULT (4*1024) |
#define CHAN_X11_WINDOW_DEFAULT (4*CHAN_X11_PACKET_DEFAULT) |
#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2) |
|
|
/* possible input states */ |
|
#define CHAN_INPUT_OPEN 0 |
|
#define CHAN_INPUT_WAIT_DRAIN 1 |
|
#define CHAN_INPUT_WAIT_OCLOSE 2 |
|
#define CHAN_INPUT_CLOSED 3 |
|
|
|
/* possible output states */ |
void channel_open(int id); |
#define CHAN_OUTPUT_OPEN 0 |
void channel_request(int id, char *service, int wantconfirm); |
#define CHAN_OUTPUT_WAIT_DRAIN 1 |
void channel_request_start(int id, char *service, int wantconfirm); |
#define CHAN_OUTPUT_WAIT_IEOF 2 |
void channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg); |
#define CHAN_OUTPUT_CLOSED 3 |
void channel_register_cleanup(int id, channel_callback_fn *fn); |
|
void channel_register_filter(int id, channel_filter_fn *fn); |
|
void channel_cancel_cleanup(int id); |
|
Channel *channel_lookup(int id); |
|
|
#define CHAN_CLOSE_SENT 0x01 |
void |
#define CHAN_CLOSE_RCVD 0x02 |
channel_set_fds(int id, int rfd, int wfd, int efd, |
#define CHAN_EOF_SENT 0x04 |
int extusage, int nonblock); |
#define CHAN_EOF_RCVD 0x08 |
|
|
|
/* check whether 'efd' is still in use */ |
void deny_input_open(int type, int plen, void *ctxt); |
#define CHANNEL_EFD_INPUT_ACTIVE(c) \ |
|
(compat20 && c->extended_usage == CHAN_EXTENDED_READ && \ |
|
(c->efd != -1 || \ |
|
buffer_len(&c->extended) > 0)) |
|
#define CHANNEL_EFD_OUTPUT_ACTIVE(c) \ |
|
(compat20 && c->extended_usage == CHAN_EXTENDED_WRITE && \ |
|
((c->efd != -1 && !(c->flags & (CHAN_EOF_RCVD|CHAN_CLOSE_RCVD))) || \ |
|
buffer_len(&c->extended) > 0)) |
|
|
|
/* channel management */ |
void channel_input_channel_request(int type, int plen, void *ctxt); |
|
void channel_input_close(int type, int plen, void *ctxt); |
|
void channel_input_close_confirmation(int type, int plen, void *ctxt); |
|
void channel_input_data(int type, int plen, void *ctxt); |
|
void channel_input_extended_data(int type, int plen, void *ctxt); |
|
void channel_input_ieof(int type, int plen, void *ctxt); |
|
void channel_input_oclose(int type, int plen, void *ctxt); |
|
void channel_input_open_confirmation(int type, int plen, void *ctxt); |
|
void channel_input_open_failure(int type, int plen, void *ctxt); |
|
void channel_input_port_open(int type, int plen, void *ctxt); |
|
void channel_input_window_adjust(int type, int plen, void *ctxt); |
|
|
Channel *channel_lookup(int); |
/* Sets specific protocol options. */ |
Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int); |
void channel_set_options(int hostname_in_open); |
void channel_set_fds(int, int, int, int, int, int, u_int); |
|
void channel_free(Channel *); |
|
void channel_free_all(void); |
|
void channel_stop_listening(void); |
|
|
|
void channel_send_open(int); |
/* |
void channel_request_start(int, char *, int); |
* Allocate a new channel object and set its type and socket. Remote_name |
void channel_register_cleanup(int, channel_callback_fn *); |
* must have been allocated with xmalloc; this will free it when the channel |
void channel_register_confirm(int, channel_callback_fn *); |
* is freed. |
void channel_register_filter(int, channel_filter_fn *); |
*/ |
void channel_cancel_cleanup(int); |
Channel * |
int channel_close_fd(int *); |
channel_new(char *ctype, int type, int rfd, int wfd, int efd, |
|
int window, int maxpack, int extended_usage, char *remote_name, |
|
int nonblock); |
|
|
/* protocol handler */ |
/* Free the channel and close its socket. */ |
|
void channel_free(Channel *c); |
|
|
void channel_input_close(int, u_int32_t, void *); |
/* |
void channel_input_close_confirmation(int, u_int32_t, void *); |
* Allocate/update select bitmasks and add any bits relevant to channels in |
void channel_input_data(int, u_int32_t, void *); |
* select bitmasks. |
void channel_input_extended_data(int, u_int32_t, void *); |
*/ |
void channel_input_ieof(int, u_int32_t, void *); |
void |
void channel_input_oclose(int, u_int32_t, void *); |
channel_prepare_select(fd_set **readsetp, fd_set **writesetp, int *maxfdp, |
void channel_input_open_confirmation(int, u_int32_t, void *); |
int rekeying); |
void channel_input_open_failure(int, u_int32_t, void *); |
|
void channel_input_port_open(int, u_int32_t, void *); |
|
void channel_input_window_adjust(int, u_int32_t, void *); |
|
|
|
/* file descriptor handling (read/write) */ |
/* |
|
* After select, perform any appropriate operations for channels which have |
|
* events pending. |
|
*/ |
|
void channel_after_select(fd_set * readset, fd_set * writeset); |
|
|
void channel_prepare_select(fd_set **, fd_set **, int *, int*, int); |
/* If there is data to send to the connection, send some of it now. */ |
void channel_after_select(fd_set *, fd_set *); |
void channel_output_poll(void); |
void channel_output_poll(void); |
|
|
|
int channel_not_very_much_buffered_data(void); |
/* Returns true if no channel has too much buffered data. */ |
void channel_close_all(void); |
int channel_not_very_much_buffered_data(void); |
int channel_still_open(void); |
|
char *channel_open_message(void); |
|
int channel_find_open(void); |
|
|
|
/* tcp forwarding */ |
/* This closes any sockets that are listening for connections; this removes |
void channel_set_af(int af); |
any unix domain sockets. */ |
void channel_permit_all_opens(void); |
void channel_stop_listening(void); |
void channel_add_permitted_opens(char *, int); |
|
void channel_clear_permitted_opens(void); |
|
void channel_input_port_forward_request(int, int); |
|
int channel_connect_to(const char *, u_short); |
|
int channel_connect_by_listen_address(u_short); |
|
void channel_request_remote_forwarding(u_short, const char *, u_short); |
|
int channel_setup_local_fwd_listener(u_short, const char *, u_short, int); |
|
int channel_setup_remote_fwd_listener(const char *, u_short, int); |
|
|
|
/* x11 forwarding */ |
/* |
|
* Closes the sockets of all channels. This is used to close extra file |
|
* descriptors after a fork. |
|
*/ |
|
void channel_close_all(void); |
|
|
int x11_connect_display(void); |
/* Returns true if there is still an open channel over the connection. */ |
int x11_create_display_inet(int, int, int); |
int channel_still_open(void); |
void x11_input_open(int, u_int32_t, void *); |
|
void x11_request_forwarding_with_spoofing(int, const char *, const char *); |
|
void deny_input_open(int, u_int32_t, void *); |
|
|
|
/* agent forwarding */ |
/* |
|
* Returns a string containing a list of all open channels. The list is |
|
* suitable for displaying to the user. It uses crlf instead of newlines. |
|
* The caller should free the string with xfree. |
|
*/ |
|
char *channel_open_message(void); |
|
|
void auth_request_forwarding(void); |
/* |
char *auth_get_socket_name(void); |
* Initiate forwarding of connections to local port "port" through the secure |
void auth_sock_cleanup_proc(void *); |
* channel to host:port from remote side. |
int auth_input_request_forwarding(struct passwd *); |
*/ |
void auth_input_open_request(int, u_int32_t, void *); |
int |
|
channel_request_local_forwarding(u_short listen_port, |
|
const char *host_to_connect, u_short port_to_connect, int gateway_ports); |
|
int |
|
channel_request_forwarding(const char *listen_address, u_short listen_port, |
|
const char *host_to_connect, u_short port_to_connect, int gateway_ports, |
|
int remote_fwd); |
|
|
/* channel close */ |
/* |
|
* Initiate forwarding of connections to port "port" on remote host through |
|
* the secure channel to host:port from local side. This never returns if |
|
* there was an error. This registers that open requests for that port are |
|
* permitted. |
|
*/ |
|
void |
|
channel_request_remote_forwarding(u_short port, const char *host, |
|
u_short remote_port); |
|
|
int chan_is_dead(Channel *, int); |
/* |
void chan_mark_dead(Channel *); |
* Permits opening to any host/port if permitted_opens[] is empty. This is |
|
* usually called by the server, because the user could connect to any port |
|
* anyway, and the server has no way to know but to trust the client anyway. |
|
*/ |
|
void channel_permit_all_opens(void); |
|
|
/* channel events */ |
/* Add host/port to list of allowed targets for port forwarding */ |
|
void channel_add_permitted_opens(char *host, int port); |
|
|
void chan_rcvd_oclose(Channel *); |
/* Flush list */ |
void chan_read_failed(Channel *); |
void channel_clear_permitted_opens(void); |
void chan_ibuf_empty(Channel *); |
|
|
|
void chan_rcvd_ieof(Channel *); |
/* |
void chan_write_failed(Channel *); |
* This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates |
void chan_obuf_empty(Channel *); |
* listening for the port, and sends back a success reply (or disconnect |
|
* message if there was an error). This never returns if there was an error. |
|
*/ |
|
void channel_input_port_forward_request(int is_root, int gateway_ports); |
|
|
|
/* |
|
* Creates a port for X11 connections, and starts listening for it. Returns |
|
* the display name, or NULL if an error was encountered. |
|
*/ |
|
char *x11_create_display(int screen); |
|
|
|
/* |
|
* Creates an internet domain socket for listening for X11 connections. |
|
* Returns a suitable value for the DISPLAY variable, or NULL if an error |
|
* occurs. |
|
*/ |
|
char *x11_create_display_inet(int screen, int x11_display_offset); |
|
|
|
/* |
|
* This is called when SSH_SMSG_X11_OPEN is received. The packet contains |
|
* the remote channel number. We should do whatever we want, and respond |
|
* with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE. |
|
*/ |
|
void x11_input_open(int type, int plen, void *ctxt); |
|
|
|
/* |
|
* Requests forwarding of X11 connections. This should be called on the |
|
* client only. |
|
*/ |
|
void x11_request_forwarding(void); |
|
|
|
/* |
|
* Requests forwarding for X11 connections, with authentication spoofing. |
|
* This should be called in the client only. |
|
*/ |
|
void |
|
x11_request_forwarding_with_spoofing(int client_session_id, |
|
const char *proto, const char *data); |
|
|
|
/* Sends a message to the server to request authentication fd forwarding. */ |
|
void auth_request_forwarding(void); |
|
|
|
/* |
|
* Returns the name of the forwarded authentication socket. Returns NULL if |
|
* there is no forwarded authentication socket. The returned value points to |
|
* a static buffer. |
|
*/ |
|
char *auth_get_socket_name(void); |
|
|
|
/* |
|
* This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server. |
|
* This starts forwarding authentication requests. |
|
*/ |
|
int auth_input_request_forwarding(struct passwd * pw); |
|
|
|
/* This is called to process an SSH_SMSG_AGENT_OPEN message. */ |
|
void auth_input_open_request(int type, int plen, void *ctxt); |
|
|
|
/* XXX */ |
|
int channel_connect_to(const char *host, u_short host_port); |
|
int channel_connect_by_listen_adress(u_short listen_port); |
|
int x11_connect_display(void); |
|
|
|
int channel_find_open(void); |
|
|
#endif |
#endif |