[BACK]Return to ssh.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/ssh.h, Revision 1.2

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