[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.4

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