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

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