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