Annotation of src/usr.bin/ssh/ssh.h, Revision 1.25
1.1 deraadt 1: /*
1.25 ! deraadt 2: *
! 3: * ssh.h
! 4: *
! 5: * Author: Tatu Ylonen <ylo@cs.hut.fi>
! 6: *
! 7: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
! 8: * All rights reserved
! 9: *
! 10: * Created: Fri Mar 17 17:09:37 1995 ylo
! 11: *
! 12: * Generic header file for ssh.
! 13: *
! 14: */
1.1 deraadt 15:
1.25 ! deraadt 16: /* RCSID("$Id: ssh.h,v 1.24 1999/11/22 21:52:42 markus Exp $"); */
1.1 deraadt 17:
18: #ifndef SSH_H
19: #define SSH_H
20:
21: #include "rsa.h"
22: #include "cipher.h"
23:
1.25 ! deraadt 24: /* The default cipher used if IDEA is not supported by the remote host.
1.1 deraadt 25: It is recommended that this be one of the mandatory ciphers (DES, 3DES),
26: though that is not required. */
27: #define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
28:
29: /* Cipher used for encrypting authentication files. */
30: #define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
31:
32: /* Default port number. */
33: #define SSH_DEFAULT_PORT 22
34:
35: /* Maximum number of TCP/IP ports forwarded per direction. */
36: #define SSH_MAX_FORWARDS_PER_DIRECTION 100
37:
38: /* Maximum number of RSA authentication identity files that can be specified
39: in configuration files or on the command line. */
40: #define SSH_MAX_IDENTITY_FILES 100
41:
42: /* Major protocol version. Different version indicates major incompatiblity
43: that prevents communication. */
44: #define PROTOCOL_MAJOR 1
45:
46: /* Minor protocol version. Different version indicates minor incompatibility
47: that does not prevent interoperation. */
1.13 markus 48: #define PROTOCOL_MINOR 5
1.1 deraadt 49:
50: /* Name for the service. The port named by this service overrides the default
51: port if present. */
52: #define SSH_SERVICE_NAME "ssh"
53:
1.2 deraadt 54: #define ETCDIR "/etc"
55: #define PIDDIR "/var/run"
56:
1.1 deraadt 57: /* System-wide file containing host keys of known hosts. This file should be
58: world-readable. */
59: #define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
60:
61: /* HOST_KEY_FILE /etc/ssh_host_key,
62: SERVER_CONFIG_FILE /etc/sshd_config,
63: and HOST_CONFIG_FILE /etc/ssh_config
64: are all defined in Makefile.in. Of these, ssh_host_key should be readable
65: only by root, whereas ssh_config should be world-readable. */
1.2 deraadt 66:
67: #define HOST_KEY_FILE "/etc/ssh_host_key"
68: #define SERVER_CONFIG_FILE "/etc/sshd_config"
69: #define HOST_CONFIG_FILE "/etc/ssh_config"
70:
71: #define SSH_PROGRAM "/usr/bin/ssh"
1.1 deraadt 72:
73: /* The process id of the daemon listening for connections is saved
74: here to make it easier to kill the correct daemon when necessary. */
75: #define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
76:
77: /* The directory in user\'s home directory in which the files reside.
78: The directory should be world-readable (though not all files are). */
79: #define SSH_USER_DIR ".ssh"
80:
81: /* Per-user file containing host keys of known hosts. This file need
82: not be readable by anyone except the user him/herself, though this does
83: not contain anything particularly secret. */
84: #define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
85:
1.25 ! deraadt 86: /* Name of the default file containing client-side authentication key.
1.1 deraadt 87: This file should only be readable by the user him/herself. */
88: #define SSH_CLIENT_IDENTITY ".ssh/identity"
89:
90: /* Configuration file in user\'s home directory. This file need not be
91: readable by anyone but the user him/herself, but does not contain
92: anything particularly secret. If the user\'s home directory resides
93: on an NFS volume where root is mapped to nobody, this may need to be
94: world-readable. */
95: #define SSH_USER_CONFFILE ".ssh/config"
96:
97: /* File containing a list of those rsa keys that permit logging in as
98: this user. This file need not be
99: readable by anyone but the user him/herself, but does not contain
100: anything particularly secret. If the user\'s home directory resides
101: on an NFS volume where root is mapped to nobody, this may need to be
1.25 ! deraadt 102: world-readable. (This file is read by the daemon which is running as
1.1 deraadt 103: root.) */
104: #define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
105:
106: /* Per-user and system-wide ssh "rc" files. These files are executed with
107: /bin/sh before starting the shell or command if they exist. They
108: will be passed "proto cookie" as arguments if X11 forwarding with
109: spoofing is in use. xauth will be run if neither of these exists. */
110: #define SSH_USER_RC ".ssh/rc"
111: #define SSH_SYSTEM_RC ETCDIR "/sshrc"
112:
113: /* Ssh-only version of /etc/hosts.equiv. */
114: #define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
115:
1.25 ! deraadt 116: /* Additionally, the daemon may use ~/.rhosts and /etc/hosts.equiv if
1.1 deraadt 117: rhosts authentication is enabled. */
118:
119: /* Name of the environment variable containing the pathname of the
120: authentication socket. */
1.13 markus 121: #define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
1.15 markus 122:
123: /* Name of the environment variable containing the pathname of the
124: authentication socket. */
125: #define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
1.1 deraadt 126:
127: /* Force host key length and server key length to differ by at least this
128: many bits. This is to make double encryption with rsaref work. */
129: #define SSH_KEY_BITS_RESERVED 128
130:
1.25 ! deraadt 131: /* Length of the session key in bytes. (Specified as 256 bits in the
1.1 deraadt 132: protocol.) */
133: #define SSH_SESSION_KEY_LENGTH 32
134:
135: /* Name of Kerberos service for SSH to use. */
136: #define KRB4_SERVICE_NAME "rcmd"
137:
138: /* Authentication methods. New types can be added, but old types should not
139: be removed for compatibility. The maximum allowed value is 31. */
140: #define SSH_AUTH_RHOSTS 1
141: #define SSH_AUTH_RSA 2
142: #define SSH_AUTH_PASSWORD 3
143: #define SSH_AUTH_RHOSTS_RSA 4
1.24 markus 144: #define SSH_AUTH_TIS 5
1.1 deraadt 145: #define SSH_AUTH_KERBEROS 6
146: #define SSH_PASS_KERBEROS_TGT 7
1.25 ! deraadt 147: /* 8 to 15 are reserved */
1.1 deraadt 148: #define SSH_PASS_AFS_TOKEN 21
149:
150: /* Protocol flags. These are bit masks. */
1.25 ! deraadt 151: #define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes
! 152: * screen */
! 153: #define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain
! 154: * host */
1.1 deraadt 155:
156: /* Definition of message types. New values can be added, but old values
157: should not be removed or without careful consideration of the consequences
158: for compatibility. The maximum value is 254; value 255 is reserved
159: for future extension. */
1.25 ! deraadt 160: /* Message name *//* msg code *//* arguments */
1.1 deraadt 161: #define SSH_MSG_NONE 0 /* no message */
162: #define SSH_MSG_DISCONNECT 1 /* cause (string) */
163: #define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
1.3 provos 164: #define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
1.1 deraadt 165: #define SSH_CMSG_USER 4 /* user (string) */
166: #define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
1.3 provos 167: #define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
168: #define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
169: #define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
1.1 deraadt 170: #define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
171: #define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
172: #define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
173: #define SSH_CMSG_EXEC_SHELL 12 /* */
174: #define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
175: #define SSH_SMSG_SUCCESS 14 /* */
176: #define SSH_SMSG_FAILURE 15 /* */
177: #define SSH_CMSG_STDIN_DATA 16 /* data (string) */
178: #define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
179: #define SSH_SMSG_STDERR_DATA 18 /* data (string) */
180: #define SSH_CMSG_EOF 19 /* */
181: #define SSH_SMSG_EXITSTATUS 20 /* status (int) */
182: #define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
183: #define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
184: #define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
185: #define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
186: #define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
187: /* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
188: #define SSH_SMSG_X11_OPEN 27 /* channel (int) */
189: #define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
190: #define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
191: #define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
192: #define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
193: #define SSH_MSG_IGNORE 32 /* string */
194: #define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
195: #define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
196: #define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
197: #define SSH_MSG_DEBUG 36 /* string */
198: #define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
1.13 markus 199: #define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
1.24 markus 200: #define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
201: #define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
202: #define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
1.1 deraadt 203: #define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
204: #define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
205: #define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
206: #define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
207:
208: /*------------ definitions for login.c -------------*/
209:
1.25 ! deraadt 210: /* Returns the time when the user last logged in. Returns 0 if the
! 211: information is not available. This must be called before record_login.
1.1 deraadt 212: The host from which the user logged in is stored in buf. */
1.25 ! deraadt 213: unsigned long
! 214: get_last_login_time(uid_t uid, const char *logname,
! 215: char *buf, unsigned int bufsize);
1.1 deraadt 216:
217: /* Records that the user has logged in. This does many things normally
218: done by login(1). */
1.25 ! deraadt 219: void
! 220: record_login(int pid, const char *ttyname, const char *user, uid_t uid,
! 221: const char *host, struct sockaddr_in * addr);
1.1 deraadt 222:
223: /* Records that the user has logged out. This does many thigs normally
224: done by login(1) or init. */
1.25 ! deraadt 225: void record_logout(int pid, const char *ttyname);
1.1 deraadt 226:
227: /*------------ definitions for sshconnect.c ----------*/
228:
229: /* Opens a TCP/IP connection to the remote server on the given host. If
230: port is 0, the default port will be used. If anonymous is zero,
1.25 ! deraadt 231: a privileged port will be allocated to make the connection.
! 232: This requires super-user privileges if anonymous is false.
1.1 deraadt 233: Connection_attempts specifies the maximum number of tries, one per
234: second. This returns true on success, and zero on failure. If the
235: connection is successful, this calls packet_set_connection for the
236: connection. */
1.25 ! deraadt 237: int
! 238: ssh_connect(const char *host, struct sockaddr_in * hostaddr,
! 239: int port, int connection_attempts,
! 240: int anonymous, uid_t original_real_uid,
! 241: const char *proxy_command);
1.1 deraadt 242:
243: /* Starts a dialog with the server, and authenticates the current user on the
244: server. This does not need any extra privileges. The basic connection
1.25 ! deraadt 245: to the server must already have been established before this is called.
! 246: If login fails, this function prints an error and never returns.
1.1 deraadt 247: This initializes the random state, and leaves it initialized (it will also
248: have references from the packet module). */
1.18 markus 249:
1.25 ! deraadt 250: void
! 251: ssh_login(int host_key_valid, RSA * host_key, const char *host,
! 252: struct sockaddr_in * hostaddr, uid_t original_real_uid);
1.1 deraadt 253:
254: /*------------ Definitions for various authentication methods. -------*/
255:
256: /* Tries to authenticate the user using the .rhosts file. Returns true if
257: authentication succeeds. If ignore_rhosts is non-zero, this will not
1.20 markus 258: consider .rhosts and .shosts (/etc/hosts.equiv will still be used). */
1.25 ! deraadt 259: int auth_rhosts(struct passwd * pw, const char *client_user);
1.1 deraadt 260:
261: /* Tries to authenticate the user using the .rhosts file and the host using
262: its host key. Returns true if authentication succeeds. */
1.25 ! deraadt 263: int
! 264: auth_rhosts_rsa(struct passwd * pw, const char *client_user,
! 265: BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
1.1 deraadt 266:
267: /* Tries to authenticate the user using password. Returns true if
268: authentication succeeds. */
1.25 ! deraadt 269: int auth_password(struct passwd * pw, const char *password);
1.1 deraadt 270:
271: /* Performs the RSA authentication dialog with the client. This returns
272: 0 if the client could not be authenticated, and 1 if authentication was
273: successful. This may exit if there is a serious protocol violation. */
1.25 ! deraadt 274: int auth_rsa(struct passwd * pw, BIGNUM * client_n);
1.1 deraadt 275:
276: /* Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
277: over the key. Skips any whitespace at the beginning and at end. */
1.25 ! deraadt 278: int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
1.1 deraadt 279:
280: /* Returns the name of the machine at the other end of the socket. The
281: returned string should be freed by the caller. */
1.25 ! deraadt 282: char *get_remote_hostname(int socket);
1.1 deraadt 283:
284: /* Return the canonical name of the host in the other side of the current
285: connection (as returned by packet_get_connection). The host name is
286: cached, so it is efficient to call this several times. */
287: const char *get_canonical_hostname(void);
288:
289: /* Returns the remote IP address as an ascii string. The value need not be
290: freed by the caller. */
291: const char *get_remote_ipaddr(void);
292:
293: /* Returns the port number of the peer of the socket. */
1.25 ! deraadt 294: int get_peer_port(int sock);
1.1 deraadt 295:
296: /* Returns the port number of the remote host. */
1.25 ! deraadt 297: int get_remote_port(void);
1.1 deraadt 298:
299: /* Tries to match the host name (which must be in all lowercase) against the
1.25 ! deraadt 300: comma-separated sequence of subpatterns (each possibly preceded by ! to
1.1 deraadt 301: indicate negation). Returns true if there is a positive match; zero
302: otherwise. */
1.25 ! deraadt 303: int match_hostname(const char *host, const char *pattern, unsigned int len);
1.1 deraadt 304:
305: /* Checks whether the given host is already in the list of our known hosts.
306: Returns HOST_OK if the host is known and has the specified key,
307: HOST_NEW if the host is not known, and HOST_CHANGED if the host is known
308: but used to have a different host key. The host must be in all lowercase. */
1.25 ! deraadt 309: typedef enum {
! 310: HOST_OK, HOST_NEW, HOST_CHANGED
! 311: } HostStatus;
! 312: HostStatus
! 313: check_host_in_hostfile(const char *filename, const char *host,
! 314: BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
1.1 deraadt 315:
316: /* Appends an entry to the host file. Returns false if the entry
317: could not be appended. */
1.25 ! deraadt 318: int
! 319: add_host_to_hostfile(const char *filename, const char *host,
! 320: BIGNUM * e, BIGNUM * n);
1.1 deraadt 321:
322: /* Performs the RSA authentication challenge-response dialog with the client,
323: and returns true (non-zero) if the client gave the correct answer to
324: our challenge; returns zero if the client gives a wrong answer. */
1.25 ! deraadt 325: int auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
1.1 deraadt 326:
1.25 ! deraadt 327: /* Reads a passphrase from /dev/tty with echo turned off. Returns the
! 328: passphrase (allocated with xmalloc). Exits if EOF is encountered.
1.1 deraadt 329: If from_stdin is true, the passphrase will be read from stdin instead. */
1.25 ! deraadt 330: char *read_passphrase(const char *prompt, int from_stdin);
1.1 deraadt 331:
332: /* Saves the authentication (private) key in a file, encrypting it with
333: passphrase. The identification of the file (lowest 64 bits of n)
334: will precede the key to provide identification of the key without
335: needing a passphrase. */
1.25 ! deraadt 336: int
! 337: save_private_key(const char *filename, const char *passphrase,
! 338: RSA * private_key, const char *comment);
1.1 deraadt 339:
1.25 ! deraadt 340: /* Loads the public part of the key file (public key and comment).
1.1 deraadt 341: Returns 0 if an error occurred; zero if the public key was successfully
342: read. The comment of the key is returned in comment_return if it is
343: non-NULL; the caller must free the value with xfree. */
1.25 ! deraadt 344: int
! 345: load_public_key(const char *filename, RSA * pub,
! 346: char **comment_return);
1.1 deraadt 347:
348: /* Loads the private key from the file. Returns 0 if an error is encountered
349: (file does not exist or is not readable, or passphrase is bad).
1.25 ! deraadt 350: This initializes the private key. The comment of the key is returned
! 351: in comment_return if it is non-NULL; the caller must free the value
1.1 deraadt 352: with xfree. */
1.25 ! deraadt 353: int
! 354: load_private_key(const char *filename, const char *passphrase,
! 355: RSA * private_key, char **comment_return);
1.20 markus 356:
357: /*------------ Definitions for logging. -----------------------*/
358:
359: /* Supported syslog facilities and levels. */
1.25 ! deraadt 360: typedef enum {
! 361: SYSLOG_FACILITY_DAEMON,
! 362: SYSLOG_FACILITY_USER,
! 363: SYSLOG_FACILITY_AUTH,
! 364: SYSLOG_FACILITY_LOCAL0,
! 365: SYSLOG_FACILITY_LOCAL1,
! 366: SYSLOG_FACILITY_LOCAL2,
! 367: SYSLOG_FACILITY_LOCAL3,
! 368: SYSLOG_FACILITY_LOCAL4,
! 369: SYSLOG_FACILITY_LOCAL5,
! 370: SYSLOG_FACILITY_LOCAL6,
! 371: SYSLOG_FACILITY_LOCAL7
! 372: } SyslogFacility;
! 373:
! 374: typedef enum {
! 375: SYSLOG_LEVEL_QUIET,
! 376: SYSLOG_LEVEL_FATAL,
! 377: SYSLOG_LEVEL_ERROR,
! 378: SYSLOG_LEVEL_INFO,
! 379: SYSLOG_LEVEL_VERBOSE,
! 380: SYSLOG_LEVEL_DEBUG
! 381: } LogLevel;
1.20 markus 382: /* Initializes logging. */
1.25 ! deraadt 383: void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
1.20 markus 384:
385: /* Logging implementation, depending on server or client */
1.25 ! deraadt 386: void do_log(LogLevel level, const char *fmt, va_list args);
1.22 markus 387:
388: /* name to facility/level */
389: SyslogFacility log_facility_number(char *name);
390: LogLevel log_level_number(char *name);
1.20 markus 391:
392: /* Output a message to syslog or stderr */
1.25 ! deraadt 393: void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
! 394: void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
! 395: void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
! 396: void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
! 397: void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
! 398:
1.20 markus 399: /* same as fatal() but w/o logging */
1.25 ! deraadt 400: void fatal_cleanup(void);
1.20 markus 401:
1.25 ! deraadt 402: /* Registers a cleanup function to be called by fatal()/fatal_cleanup() before exiting.
1.20 markus 403: It is permissible to call fatal_remove_cleanup for the function itself
404: from the function. */
1.25 ! deraadt 405: void fatal_add_cleanup(void (*proc) (void *context), void *context);
1.20 markus 406:
407: /* Removes a cleanup function to be called at fatal(). */
1.25 ! deraadt 408: void fatal_remove_cleanup(void (*proc) (void *context), void *context);
1.1 deraadt 409:
1.14 markus 410: /*---------------- definitions for channels ------------------*/
1.1 deraadt 411:
412: /* Sets specific protocol options. */
1.25 ! deraadt 413: void channel_set_options(int hostname_in_open);
1.1 deraadt 414:
415: /* Allocate a new channel object and set its type and socket. Remote_name
416: must have been allocated with xmalloc; this will free it when the channel
417: is freed. */
1.25 ! deraadt 418: int channel_allocate(int type, int sock, char *remote_name);
1.1 deraadt 419:
420: /* Free the channel and close its socket. */
1.25 ! deraadt 421: void channel_free(int channel);
1.1 deraadt 422:
423: /* Add any bits relevant to channels in select bitmasks. */
1.25 ! deraadt 424: void channel_prepare_select(fd_set * readset, fd_set * writeset);
1.1 deraadt 425:
426: /* After select, perform any appropriate operations for channels which
427: have events pending. */
1.25 ! deraadt 428: void channel_after_select(fd_set * readset, fd_set * writeset);
1.1 deraadt 429:
430: /* If there is data to send to the connection, send some of it now. */
1.25 ! deraadt 431: void channel_output_poll(void);
1.1 deraadt 432:
433: /* This is called when a packet of type CHANNEL_DATA has just been received.
434: The message type has already been consumed, but channel number and data
435: is still there. */
1.25 ! deraadt 436: void channel_input_data(int payload_len);
1.1 deraadt 437:
438: /* Returns true if no channel has too much buffered data. */
1.25 ! deraadt 439: int channel_not_very_much_buffered_data(void);
1.1 deraadt 440:
441: /* This is called after receiving CHANNEL_CLOSE. */
1.25 ! deraadt 442: void channel_input_close(void);
1.1 deraadt 443:
444: /* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
1.25 ! deraadt 445: void channel_input_close_confirmation(void);
1.1 deraadt 446:
447: /* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
1.25 ! deraadt 448: void channel_input_open_confirmation(void);
1.1 deraadt 449:
450: /* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
1.25 ! deraadt 451: void channel_input_open_failure(void);
1.1 deraadt 452:
453: /* This closes any sockets that are listening for connections; this removes
454: any unix domain sockets. */
1.25 ! deraadt 455: void channel_stop_listening(void);
1.1 deraadt 456:
457: /* Closes the sockets of all channels. This is used to close extra file
458: descriptors after a fork. */
1.25 ! deraadt 459: void channel_close_all(void);
1.1 deraadt 460:
461: /* Returns the maximum file descriptor number used by the channels. */
1.25 ! deraadt 462: int channel_max_fd(void);
1.1 deraadt 463:
464: /* Returns true if there is still an open channel over the connection. */
1.25 ! deraadt 465: int channel_still_open(void);
1.1 deraadt 466:
467: /* Returns a string containing a list of all open channels. The list is
468: suitable for displaying to the user. It uses crlf instead of newlines.
469: The caller should free the string with xfree. */
1.25 ! deraadt 470: char *channel_open_message(void);
1.1 deraadt 471:
472: /* Initiate forwarding of connections to local port "port" through the secure
473: channel to host:port from remote side. This never returns if there
474: was an error. */
1.25 ! deraadt 475: void
! 476: channel_request_local_forwarding(int port, const char *host,
! 477: int remote_port);
1.1 deraadt 478:
479: /* Initiate forwarding of connections to port "port" on remote host through
480: the secure channel to host:port from local side. This never returns
481: if there was an error. This registers that open requests for that
482: port are permitted. */
1.25 ! deraadt 483: void
! 484: channel_request_remote_forwarding(int port, const char *host,
! 485: int remote_port);
1.1 deraadt 486:
487: /* Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
488: called by the server, because the user could connect to any port anyway,
489: and the server has no way to know but to trust the client anyway. */
1.25 ! deraadt 490: void channel_permit_all_opens(void);
1.1 deraadt 491:
492: /* This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
493: listening for the port, and sends back a success reply (or disconnect
1.25 ! deraadt 494: message if there was an error). This never returns if there was an
1.1 deraadt 495: error. */
1.25 ! deraadt 496: void channel_input_port_forward_request(int is_root);
1.1 deraadt 497:
498: /* This is called after receiving PORT_OPEN message. This attempts to connect
499: to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION or
500: CHANNEL_OPEN_FAILURE. */
1.25 ! deraadt 501: void channel_input_port_open(int payload_len);
1.1 deraadt 502:
503: /* Creates a port for X11 connections, and starts listening for it.
504: Returns the display name, or NULL if an error was encountered. */
1.25 ! deraadt 505: char *x11_create_display(int screen);
1.1 deraadt 506:
1.25 ! deraadt 507: /* Creates an internet domain socket for listening for X11 connections.
1.1 deraadt 508: Returns a suitable value for the DISPLAY variable, or NULL if an error
509: occurs. */
1.25 ! deraadt 510: char *x11_create_display_inet(int screen);
1.1 deraadt 511:
512: /* This is called when SSH_SMSG_X11_OPEN is received. The packet contains
513: the remote channel number. We should do whatever we want, and respond
514: with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE. */
1.25 ! deraadt 515: void x11_input_open(int payload_len);
1.1 deraadt 516:
1.25 ! deraadt 517: /* Requests forwarding of X11 connections. This should be called on the
1.1 deraadt 518: client only. */
1.25 ! deraadt 519: void x11_request_forwarding(void);
1.1 deraadt 520:
521: /* Requests forwarding for X11 connections, with authentication spoofing.
522: This should be called in the client only. */
1.25 ! deraadt 523: void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
1.1 deraadt 524:
525: /* Sends a message to the server to request authentication fd forwarding. */
1.25 ! deraadt 526: void auth_request_forwarding(void);
1.1 deraadt 527:
528: /* Returns the name of the forwarded authentication socket. Returns NULL
529: if there is no forwarded authentication socket. The returned value points
530: to a static buffer. */
1.25 ! deraadt 531: char *auth_get_socket_name(void);
1.1 deraadt 532:
533: /* This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
534: This starts forwarding authentication requests. */
1.25 ! deraadt 535: void auth_input_request_forwarding(struct passwd * pw);
1.1 deraadt 536:
537: /* This is called to process an SSH_SMSG_AGENT_OPEN message. */
1.25 ! deraadt 538: void auth_input_open_request(void);
1.1 deraadt 539:
540: /* Returns true if the given string matches the pattern (which may contain
541: ? and * as wildcards), and zero if it does not match. */
1.25 ! deraadt 542: int match_pattern(const char *s, const char *pattern);
1.1 deraadt 543:
544: /* Expands tildes in the file name. Returns data allocated by xmalloc.
545: Warning: this calls getpw*. */
1.25 ! deraadt 546: char *tilde_expand_filename(const char *filename, uid_t my_uid);
1.1 deraadt 547:
548: /* Performs the interactive session. This handles data transmission between
549: the client and the program. Note that the notion of stdin, stdout, and
550: stderr in this function is sort of reversed: this function writes to
551: stdin (of the child program), and reads from stdout and stderr (of the
552: child program). */
1.25 ! deraadt 553: void server_loop(int pid, int fdin, int fdout, int fderr);
1.1 deraadt 554:
555: /* Client side main loop for the interactive session. */
1.25 ! deraadt 556: int client_loop(int have_pty, int escape_char);
1.1 deraadt 557:
558: /* Linked list of custom environment strings (see auth-rsa.c). */
559: struct envstring {
1.25 ! deraadt 560: struct envstring *next;
! 561: char *s;
1.1 deraadt 562: };
563: #ifdef KRB4
564: #include <krb.h>
565:
1.4 dugsong 566: /* Performs Kerberos v4 mutual authentication with the client. This returns
567: 0 if the client could not be authenticated, and 1 if authentication was
568: successful. This may exit if there is a serious protocol violation. */
1.25 ! deraadt 569: int auth_krb4(const char *server_user, KTEXT auth, char **client);
! 570: int krb4_init(uid_t uid);
! 571: void krb4_cleanup_proc(void *ignore);
1.4 dugsong 572:
573: #ifdef AFS
574: #include <kafs.h>
575:
576: /* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
1.25 ! deraadt 577: int auth_kerberos_tgt(struct passwd * pw, const char *string);
! 578: int auth_afs_token(struct passwd * pw, const char *token_string);
1.1 deraadt 579:
1.25 ! deraadt 580: int creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
! 581: int radix_to_creds(const char *buf, CREDENTIALS * creds);
! 582: #endif /* AFS */
1.1 deraadt 583:
1.25 ! deraadt 584: #endif /* KRB4 */
1.9 markus 585:
586: #ifdef SKEY
587: #include <skey.h>
1.25 ! deraadt 588: char *skey_fake_keyinfo(char *username);
! 589: #endif /* SKEY */
1.1 deraadt 590:
1.25 ! deraadt 591: #endif /* SSH_H */
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh