version 1.22.2.5, 2001/06/12 22:47:35 |
version 1.22.2.6, 2001/09/27 00:15:41 |
|
|
* called by a name other than "ssh" or "Secure Shell". |
* called by a name other than "ssh" or "Secure Shell". |
*/ |
*/ |
/* |
/* |
* Copyright (c) 2000 Markus Friedl. All rights reserved. |
* Copyright (c) 1999, 2000, 2001 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 |
|
|
*/ |
*/ |
/* RCSID("$OpenBSD$"); */ |
/* RCSID("$OpenBSD$"); */ |
|
|
#ifndef CHANNELS_H |
#ifndef CHANNEL_H |
#define CHANNELS_H |
#define CHANNEL_H |
|
|
#include "buffer.h" |
#include "buffer.h" |
|
|
/* Definitions for channel types. */ |
/* Definitions for channel types. */ |
#define SSH_CHANNEL_FREE 0 /* This channel is free (unused). */ |
|
#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ |
#define SSH_CHANNEL_X11_LISTENER 1 /* Listening for inet X11 conn. */ |
#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ |
#define SSH_CHANNEL_PORT_LISTENER 2 /* Listening on a port. */ |
#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ |
#define SSH_CHANNEL_OPENING 3 /* waiting for confirmation */ |
|
|
#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_MAX_TYPE 14 |
#define SSH_CHANNEL_ZOMBIE 14 /* Almost dead. */ |
|
#define SSH_CHANNEL_MAX_TYPE 15 |
|
|
/* |
#define SSH_CHANNEL_PATH_LEN 30 |
* Data structure for channel data. This is iniailized in channel_allocate |
|
* and cleared in channel_free. |
|
*/ |
|
struct Channel; |
struct Channel; |
typedef struct Channel Channel; |
typedef struct Channel Channel; |
|
|
typedef void channel_callback_fn(int id, void *arg); |
typedef void channel_callback_fn(int, void *); |
typedef int channel_filter_fn(struct Channel *c, char *buf, int len); |
typedef int channel_filter_fn(struct Channel *, char *, int); |
|
|
struct Channel { |
struct Channel { |
int type; /* channel type/state */ |
int type; /* channel type/state */ |
|
|
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 */ |
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 |
* send on socket */ |
* send on socket */ |
Buffer extended; |
Buffer extended; |
char path[200]; /* path for unix domain sockets, or host name |
char path[SSH_CHANNEL_PATH_LEN]; |
* for forwards */ |
/* path for unix domain sockets, or host name for forwards */ |
int listening_port; /* port being listened for forwards */ |
int listening_port; /* port being listened for forwards */ |
int host_port; /* remote port to connect for forwards */ |
int host_port; /* remote port to connect for forwards */ |
char *remote_name; /* remote hostname */ |
char *remote_name; /* remote hostname */ |
|
|
channel_callback_fn *cb_fn; |
channel_callback_fn *cb_fn; |
void *cb_arg; |
void *cb_arg; |
int cb_event; |
int cb_event; |
channel_callback_fn *dettach_user; |
channel_callback_fn *detach_user; |
|
|
/* filter */ |
/* filter */ |
channel_filter_fn *input_filter; |
channel_filter_fn *input_filter; |
|
|
#define CHAN_X11_WINDOW_DEFAULT (4*1024) |
#define CHAN_X11_WINDOW_DEFAULT (4*1024) |
#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2) |
#define CHAN_X11_PACKET_DEFAULT (CHAN_X11_WINDOW_DEFAULT/2) |
|
|
|
/* possible input states */ |
|
#define CHAN_INPUT_OPEN 0x01 |
|
#define CHAN_INPUT_WAIT_DRAIN 0x02 |
|
#define CHAN_INPUT_WAIT_OCLOSE 0x04 |
|
#define CHAN_INPUT_CLOSED 0x08 |
|
|
void channel_open(int id); |
/* possible output states */ |
void channel_request(int id, char *service, int wantconfirm); |
#define CHAN_OUTPUT_OPEN 0x10 |
void channel_request_start(int id, char *service, int wantconfirm); |
#define CHAN_OUTPUT_WAIT_DRAIN 0x20 |
void channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg); |
#define CHAN_OUTPUT_WAIT_IEOF 0x40 |
void channel_register_cleanup(int id, channel_callback_fn *fn); |
#define CHAN_OUTPUT_CLOSED 0x80 |
void channel_register_filter(int id, channel_filter_fn *fn); |
|
void channel_cancel_cleanup(int id); |
|
Channel *channel_lookup(int id); |
|
|
|
int |
#define CHAN_CLOSE_SENT 0x01 |
channel_new(char *ctype, int type, int rfd, int wfd, int efd, |
#define CHAN_CLOSE_RCVD 0x02 |
int window, int maxpack, int extended_usage, char *remote_name, |
|
int nonblock); |
|
void |
|
channel_set_fds(int id, int rfd, int wfd, int efd, |
|
int extusage, int nonblock); |
|
|
|
void deny_input_open(int type, int plen, void *ctxt); |
/* channel management */ |
|
|
void channel_input_channel_request(int type, int plen, void *ctxt); |
Channel *channel_lookup(int); |
void channel_input_close(int type, int plen, void *ctxt); |
Channel *channel_new(char *, int, int, int, int, int, int, int, char *, int); |
void channel_input_close_confirmation(int type, int plen, void *ctxt); |
void channel_set_fds(int, int, int, int, int, int); |
void channel_input_data(int type, int plen, void *ctxt); |
void channel_free(Channel *); |
void channel_input_extended_data(int type, int plen, void *ctxt); |
void channel_free_all(void); |
void channel_input_ieof(int type, int plen, void *ctxt); |
void channel_detach_all(void); |
void channel_input_oclose(int type, int plen, void *ctxt); |
void channel_stop_listening(void); |
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); |
|
|
|
/* Sets specific protocol options. */ |
void channel_send_open(int); |
void channel_set_options(int hostname_in_open); |
void channel_request(int, char *, int); |
|
void channel_request_start(int, char *, int); |
|
void channel_register_callback(int, int mtype, channel_callback_fn *, void *); |
|
void channel_register_cleanup(int, channel_callback_fn *); |
|
void channel_register_filter(int, channel_filter_fn *); |
|
void channel_cancel_cleanup(int); |
|
int channel_close_fd(int *); |
|
|
/* |
/* protocol handler */ |
* Allocate a new channel object and set its type and socket. Remote_name |
|
* must have been allocated with xmalloc; this will free it when the channel |
|
* is freed. |
|
*/ |
|
int channel_allocate(int type, int sock, char *remote_name); |
|
|
|
/* Free the channel and close its socket. */ |
void channel_input_channel_request(int, int, void *); |
void channel_free(int channel); |
void channel_input_close(int, int, void *); |
|
void channel_input_close_confirmation(int, int, void *); |
|
void channel_input_data(int, int, void *); |
|
void channel_input_extended_data(int, int, void *); |
|
void channel_input_ieof(int, int, void *); |
|
void channel_input_oclose(int, int, void *); |
|
void channel_input_open_confirmation(int, int, void *); |
|
void channel_input_open_failure(int, int, void *); |
|
void channel_input_port_open(int, int, void *); |
|
void channel_input_window_adjust(int, int, void *); |
|
|
/* |
/* file descriptor handling (read/write) */ |
* Allocate/update select bitmasks and add any bits relevant to channels in |
|
* select bitmasks. |
|
*/ |
|
void |
|
channel_prepare_select(fd_set **readsetp, fd_set **writesetp, int *maxfdp, |
|
int rekeying); |
|
|
|
/* |
void channel_prepare_select(fd_set **, fd_set **, int *, int*, int); |
* After select, perform any appropriate operations for channels which have |
void channel_after_select(fd_set *, fd_set *); |
* events pending. |
void channel_output_poll(void); |
*/ |
|
void channel_after_select(fd_set * readset, fd_set * writeset); |
|
|
|
/* If there is data to send to the connection, send some of it now. */ |
int channel_not_very_much_buffered_data(void); |
void channel_output_poll(void); |
void channel_close_all(void); |
|
void channel_free_all(void); |
|
int channel_still_open(void); |
|
char *channel_open_message(void); |
|
int channel_find_open(void); |
|
|
/* Returns true if no channel has too much buffered data. */ |
/* channel_tcpfwd.c */ |
int channel_not_very_much_buffered_data(void); |
void channel_permit_all_opens(void); |
|
void channel_add_permitted_opens(char *, int); |
/* This closes any sockets that are listening for connections; this removes |
void channel_clear_permitted_opens(void); |
any unix domain sockets. */ |
void channel_input_port_forward_request(int, int); |
void channel_stop_listening(void); |
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); |
* Closes the sockets of all channels. This is used to close extra file |
int channel_request_local_forwarding(u_short, const char *, u_short, int); |
* descriptors after a fork. |
|
*/ |
|
void channel_close_all(void); |
|
|
|
/* Returns true if there is still an open channel over the connection. */ |
|
int channel_still_open(void); |
|
|
|
/* |
|
* 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); |
|
|
|
/* |
|
* Initiate forwarding of connections to local port "port" through the secure |
|
* channel to host:port from remote side. |
|
*/ |
|
int |
int |
channel_request_local_forwarding(u_short listen_port, |
channel_request_forwarding(const char *, u_short, const char *, u_short, int, |
const char *host_to_connect, u_short port_to_connect, int gateway_ports); |
int); |
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); |
|
|
|
/* |
/* x11 forwarding */ |
* 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 x11_connect_display(void); |
* Permits opening to any host/port if permitted_opens[] is empty. This is |
char *x11_create_display(int); |
* usually called by the server, because the user could connect to any port |
char *x11_create_display_inet(int, int); |
* anyway, and the server has no way to know but to trust the client anyway. |
void x11_input_open(int, int, void *); |
*/ |
void x11_request_forwarding(void); |
void channel_permit_all_opens(void); |
void x11_request_forwarding_with_spoofing(int, const char *, const char *); |
|
void deny_input_open(int, int, void *); |
|
|
/* Add host/port to list of allowed targets for port forwarding */ |
/* agent forwarding */ |
void channel_add_permitted_opens(char *host, int port); |
|
|
|
/* Flush list */ |
void auth_request_forwarding(void); |
void channel_clear_permitted_opens(void); |
char *auth_get_socket_name(void); |
|
void auth_sock_cleanup_proc(void *); |
|
int auth_input_request_forwarding(struct passwd *); |
|
void auth_input_open_request(int, int, void *); |
|
|
/* |
/* channel close */ |
* This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates |
|
* 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); |
|
|
|
/* |
int chan_is_dead(Channel *); |
* Creates a port for X11 connections, and starts listening for it. Returns |
void chan_mark_dead(Channel *); |
* the display name, or NULL if an error was encountered. |
void chan_init_iostates(Channel *); |
*/ |
void chan_init(void); |
char *x11_create_display(int screen); |
|
|
|
/* |
typedef void chan_event_fn(Channel *); |
* 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); |
|
|
|
/* |
/* for the input state */ |
* This is called when SSH_SMSG_X11_OPEN is received. The packet contains |
extern chan_event_fn *chan_rcvd_oclose; |
* the remote channel number. We should do whatever we want, and respond |
extern chan_event_fn *chan_read_failed; |
* with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE. |
extern chan_event_fn *chan_ibuf_empty; |
*/ |
|
void x11_input_open(int type, int plen, void *ctxt); |
|
|
|
/* |
/* for the output state */ |
* Requests forwarding of X11 connections. This should be called on the |
extern chan_event_fn *chan_rcvd_ieof; |
* client only. |
extern chan_event_fn *chan_write_failed; |
*/ |
extern chan_event_fn *chan_obuf_empty; |
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); |
|
|
|
void auth_sock_cleanup_proc(void *_pw); |
|
|
|
/* |
|
* 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 |