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