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

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.21    ! markus     16: /* RCSID("$Id: ssh.h,v 1.20 1999/11/11 23:36:53 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. */
1.13      markus     48: #define PROTOCOL_MINOR         5
1.1       deraadt    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. */
1.13      markus    121: #define SSH_AUTHSOCKET_ENV_NAME        "SSH_AUTH_SOCK"
1.15      markus    122:
                    123: /* Name of the environment variable containing the pathname of the
                    124:    authentication socket. */
                    125: #define SSH_AGENTPID_ENV_NAME  "SSH_AGENT_PID"
1.1       deraadt   126:
                    127: /* Force host key length and server key length to differ by at least this
                    128:    many bits.  This is to make double encryption with rsaref work. */
                    129: #define SSH_KEY_BITS_RESERVED          128
                    130:
                    131: /* Length of the session key in bytes.  (Specified as 256 bits in the
                    132:    protocol.)  */
                    133: #define SSH_SESSION_KEY_LENGTH         32
                    134:
                    135: /* Name of Kerberos service for SSH to use. */
                    136: #define KRB4_SERVICE_NAME              "rcmd"
                    137:
                    138: /* Authentication methods.  New types can be added, but old types should not
                    139:    be removed for compatibility.  The maximum allowed value is 31. */
                    140: #define SSH_AUTH_RHOSTS                1
                    141: #define SSH_AUTH_RSA           2
                    142: #define SSH_AUTH_PASSWORD      3
                    143: #define SSH_AUTH_RHOSTS_RSA    4
                    144:                                /* 5 is TIS */
                    145: #define SSH_AUTH_KERBEROS      6
                    146: #define SSH_PASS_KERBEROS_TGT  7
1.13      markus    147:                                /* 8 to 15 are reserved */
1.1       deraadt   148: #define SSH_PASS_AFS_TOKEN     21
                    149:
                    150: /* Protocol flags.  These are bit masks. */
                    151: #define SSH_PROTOFLAG_SCREEN_NUMBER    1 /* X11 forwarding includes screen */
                    152: #define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
                    153:
                    154: /* Definition of message types.  New values can be added, but old values
                    155:    should not be removed or without careful consideration of the consequences
                    156:    for compatibility.  The maximum value is 254; value 255 is reserved
                    157:    for future extension. */
                    158: /* Message name */                     /* msg code */  /* arguments */
                    159: #define SSH_MSG_NONE                           0       /* no message */
                    160: #define SSH_MSG_DISCONNECT                     1       /* cause (string) */
                    161: #define SSH_SMSG_PUBLIC_KEY                    2       /* ck,msk,srvk,hostk */
1.3       provos    162: #define SSH_CMSG_SESSION_KEY                   3       /* key (BIGNUM) */
1.1       deraadt   163: #define SSH_CMSG_USER                          4       /* user (string) */
                    164: #define SSH_CMSG_AUTH_RHOSTS                   5       /* user (string) */
1.3       provos    165: #define SSH_CMSG_AUTH_RSA                      6       /* modulus (BIGNUM) */
                    166: #define SSH_SMSG_AUTH_RSA_CHALLENGE            7       /* int (BIGNUM) */
                    167: #define SSH_CMSG_AUTH_RSA_RESPONSE             8       /* int (BIGNUM) */
1.1       deraadt   168: #define SSH_CMSG_AUTH_PASSWORD                 9       /* pass (string) */
                    169: #define SSH_CMSG_REQUEST_PTY                   10      /* TERM, tty modes */
                    170: #define SSH_CMSG_WINDOW_SIZE                   11      /* row,col,xpix,ypix */
                    171: #define SSH_CMSG_EXEC_SHELL                    12      /* */
                    172: #define SSH_CMSG_EXEC_CMD                      13      /* cmd (string) */
                    173: #define SSH_SMSG_SUCCESS                       14      /* */
                    174: #define SSH_SMSG_FAILURE                       15      /* */
                    175: #define SSH_CMSG_STDIN_DATA                    16      /* data (string) */
                    176: #define SSH_SMSG_STDOUT_DATA                   17      /* data (string) */
                    177: #define SSH_SMSG_STDERR_DATA                   18      /* data (string) */
                    178: #define SSH_CMSG_EOF                           19      /* */
                    179: #define SSH_SMSG_EXITSTATUS                    20      /* status (int) */
                    180: #define SSH_MSG_CHANNEL_OPEN_CONFIRMATION      21      /* channel (int) */
                    181: #define SSH_MSG_CHANNEL_OPEN_FAILURE           22      /* channel (int) */
                    182: #define SSH_MSG_CHANNEL_DATA                   23      /* ch,data (int,str) */
                    183: #define SSH_MSG_CHANNEL_CLOSE                  24      /* channel (int) */
                    184: #define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION     25      /* channel (int) */
                    185: /*      SSH_CMSG_X11_REQUEST_FORWARDING         26         OBSOLETE */
                    186: #define SSH_SMSG_X11_OPEN                      27      /* channel (int) */
                    187: #define SSH_CMSG_PORT_FORWARD_REQUEST          28      /* p,host,hp (i,s,i) */
                    188: #define SSH_MSG_PORT_OPEN                      29      /* ch,h,p (i,s,i) */
                    189: #define SSH_CMSG_AGENT_REQUEST_FORWARDING      30      /* */
                    190: #define SSH_SMSG_AGENT_OPEN                    31      /* port (int) */
                    191: #define SSH_MSG_IGNORE                         32      /* string */
                    192: #define SSH_CMSG_EXIT_CONFIRMATION             33      /* */
                    193: #define SSH_CMSG_X11_REQUEST_FORWARDING                34      /* proto,data (s,s) */
                    194: #define SSH_CMSG_AUTH_RHOSTS_RSA               35      /* user,mod (s,mpi) */
                    195: #define SSH_MSG_DEBUG                          36      /* string */
                    196: #define SSH_CMSG_REQUEST_COMPRESSION           37      /* level 1-9 (int) */
1.13      markus    197: #define SSH_CMSG_MAX_PACKET_SIZE               38      /* size 4k-1024k (int) */
                    198: #define SSH_CMSG_AUTH_TIS                      39      /* this is proto-1.5, but we ignore TIS */
                    199: #define SSH_SMSG_AUTH_TIS_CHALLENGE            40
                    200: #define SSH_CMSG_AUTH_TIS_RESPONSE             41
1.1       deraadt   201:
                    202: #define SSH_CMSG_AUTH_KERBEROS                 42      /* (KTEXT) */
                    203: #define SSH_SMSG_AUTH_KERBEROS_RESPONSE                43      /* (KTEXT) */
                    204: #define SSH_CMSG_HAVE_KERBEROS_TGT             44      /* credentials (s) */
                    205: #define SSH_CMSG_HAVE_AFS_TOKEN                        65      /* token (s) */
                    206:
                    207: /*------------ definitions for login.c -------------*/
                    208:
                    209: /* Returns the time when the user last logged in.  Returns 0 if the
                    210:    information is not available.  This must be called before record_login.
                    211:    The host from which the user logged in is stored in buf. */
                    212: unsigned long get_last_login_time(uid_t uid, const char *logname,
                    213:                                  char *buf, unsigned int bufsize);
                    214:
                    215: /* Records that the user has logged in.  This does many things normally
                    216:    done by login(1). */
                    217: void record_login(int pid, const char *ttyname, const char *user, uid_t uid,
                    218:                  const char *host, struct sockaddr_in *addr);
                    219:
                    220: /* Records that the user has logged out.  This does many thigs normally
                    221:    done by login(1) or init. */
                    222: void record_logout(int pid, const char *ttyname);
                    223:
                    224: /*------------ definitions for sshconnect.c ----------*/
                    225:
                    226: /* Opens a TCP/IP connection to the remote server on the given host.  If
                    227:    port is 0, the default port will be used.  If anonymous is zero,
                    228:    a privileged port will be allocated to make the connection.
                    229:    This requires super-user privileges if anonymous is false.
                    230:    Connection_attempts specifies the maximum number of tries, one per
                    231:    second.  This returns true on success, and zero on failure.  If the
                    232:    connection is successful, this calls packet_set_connection for the
                    233:    connection. */
1.6       provos    234: int ssh_connect(const char *host, struct sockaddr_in *hostaddr,
                    235:                int port, int connection_attempts,
1.1       deraadt   236:                int anonymous, uid_t original_real_uid,
1.3       provos    237:                const char *proxy_command);
1.1       deraadt   238:
                    239: /* Starts a dialog with the server, and authenticates the current user on the
                    240:    server.  This does not need any extra privileges.  The basic connection
                    241:    to the server must already have been established before this is called.
                    242:    If login fails, this function prints an error and never returns.
                    243:    This initializes the random state, and leaves it initialized (it will also
                    244:    have references from the packet module). */
1.18      markus    245:
1.6       provos    246: void ssh_login(int host_key_valid, RSA *host_key, const char *host,
1.20      markus    247:               struct sockaddr_in *hostaddr, uid_t original_real_uid);
1.1       deraadt   248:
                    249: /*------------ Definitions for various authentication methods. -------*/
                    250:
                    251: /* Tries to authenticate the user using the .rhosts file.  Returns true if
                    252:    authentication succeeds.  If ignore_rhosts is non-zero, this will not
1.20      markus    253:    consider .rhosts and .shosts (/etc/hosts.equiv will still be used).  */
                    254: int auth_rhosts(struct passwd *pw, const char *client_user);
1.1       deraadt   255:
                    256: /* Tries to authenticate the user using the .rhosts file and the host using
                    257:    its host key.  Returns true if authentication succeeds. */
1.3       provos    258: int auth_rhosts_rsa(struct passwd *pw, const char *client_user,
1.21    ! markus    259:                    BIGNUM *client_host_key_e, BIGNUM *client_host_key_n);
1.1       deraadt   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.20      markus    268: int auth_rsa(struct passwd *pw, BIGNUM *client_n);
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.12      provos    303: typedef enum { HOST_OK, HOST_NEW, HOST_CHANGED } HostStatus;
1.21    ! markus    304: HostStatus check_host_in_hostfile(const char *filename, const char *host,
        !           305:                                  BIGNUM *e, BIGNUM *n, BIGNUM *ke, BIGNUM *kn);
1.1       deraadt   306:
                    307: /* Appends an entry to the host file.  Returns false if the entry
                    308:    could not be appended. */
                    309: int add_host_to_hostfile(const char *filename, const char *host,
1.21    ! markus    310:                         BIGNUM *e, BIGNUM *n);
1.1       deraadt   311:
                    312: /* Performs the RSA authentication challenge-response dialog with the client,
                    313:    and returns true (non-zero) if the client gave the correct answer to
                    314:    our challenge; returns zero if the client gives a wrong answer. */
1.21    ! markus    315: int auth_rsa_challenge_dialog(BIGNUM *e, BIGNUM *n);
1.1       deraadt   316:
                    317: /* Reads a passphrase from /dev/tty with echo turned off.  Returns the
                    318:    passphrase (allocated with xmalloc).  Exits if EOF is encountered.
                    319:    If from_stdin is true, the passphrase will be read from stdin instead. */
                    320: char *read_passphrase(const char *prompt, int from_stdin);
                    321:
                    322: /* Saves the authentication (private) key in a file, encrypting it with
                    323:    passphrase.  The identification of the file (lowest 64 bits of n)
                    324:    will precede the key to provide identification of the key without
                    325:    needing a passphrase. */
                    326: int save_private_key(const char *filename, const char *passphrase,
1.3       provos    327:                     RSA *private_key, const char *comment);
1.1       deraadt   328:
                    329: /* Loads the public part of the key file (public key and comment).
                    330:    Returns 0 if an error occurred; zero if the public key was successfully
                    331:    read.  The comment of the key is returned in comment_return if it is
                    332:    non-NULL; the caller must free the value with xfree. */
1.3       provos    333: int load_public_key(const char *filename, RSA *pub,
1.1       deraadt   334:                    char **comment_return);
                    335:
                    336: /* Loads the private key from the file.  Returns 0 if an error is encountered
                    337:    (file does not exist or is not readable, or passphrase is bad).
                    338:    This initializes the private key.  The comment of the key is returned
                    339:    in comment_return if it is non-NULL; the caller must free the value
                    340:    with xfree. */
                    341: int load_private_key(const char *filename, const char *passphrase,
1.3       provos    342:                     RSA *private_key, char **comment_return);
1.20      markus    343:
                    344: /*------------ Definitions for logging. -----------------------*/
                    345:
                    346: /* Supported syslog facilities and levels. */
                    347: typedef enum
                    348: {
                    349:   SYSLOG_FACILITY_DAEMON,
                    350:   SYSLOG_FACILITY_USER,
                    351:   SYSLOG_FACILITY_AUTH,
                    352:   SYSLOG_FACILITY_LOCAL0,
                    353:   SYSLOG_FACILITY_LOCAL1,
                    354:   SYSLOG_FACILITY_LOCAL2,
                    355:   SYSLOG_FACILITY_LOCAL3,
                    356:   SYSLOG_FACILITY_LOCAL4,
                    357:   SYSLOG_FACILITY_LOCAL5,
                    358:   SYSLOG_FACILITY_LOCAL6,
                    359:   SYSLOG_FACILITY_LOCAL7
                    360: } SyslogFacility;
                    361:
                    362: typedef enum
                    363: {
                    364:   SYSLOG_LEVEL_QUIET,
                    365:   SYSLOG_LEVEL_FATAL,
                    366:   SYSLOG_LEVEL_ERROR,
                    367:   SYSLOG_LEVEL_INFO,
                    368:   SYSLOG_LEVEL_CHAT,
                    369:   SYSLOG_LEVEL_DEBUG
                    370: } LogLevel;
                    371:
                    372: /* Initializes logging. */
                    373: void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
                    374:
                    375: /* Logging implementation, depending on server or client */
                    376: void do_log(LogLevel level, const char *fmt, va_list args);
                    377:
                    378: /* Output a message to syslog or stderr */
                    379: void fatal(const char *fmt, ...);
                    380: void error(const char *fmt, ...);
                    381: void log(const char *fmt, ...);
                    382: void chat(const char *fmt, ...);
                    383: void debug(const char *fmt, ...);
                    384:
                    385: /* same as fatal() but w/o logging */
                    386: void fatal_cleanup(void);
                    387:
                    388: /* Registers a cleanup function to be called by fatal()/fatal_cleanup() before exiting.
                    389:    It is permissible to call fatal_remove_cleanup for the function itself
                    390:    from the function. */
                    391: void fatal_add_cleanup(void (*proc)(void *context), void *context);
                    392:
                    393: /* Removes a cleanup function to be called at fatal(). */
                    394: void fatal_remove_cleanup(void (*proc)(void *context), void *context);
1.1       deraadt   395:
1.14      markus    396: /*---------------- definitions for channels ------------------*/
1.1       deraadt   397:
                    398: /* Sets specific protocol options. */
                    399: void channel_set_options(int hostname_in_open);
                    400:
                    401: /* Allocate a new channel object and set its type and socket.  Remote_name
                    402:    must have been allocated with xmalloc; this will free it when the channel
                    403:    is freed. */
                    404: int channel_allocate(int type, int sock, char *remote_name);
                    405:
                    406: /* Free the channel and close its socket. */
                    407: void channel_free(int channel);
                    408:
                    409: /* Add any bits relevant to channels in select bitmasks. */
                    410: void channel_prepare_select(fd_set *readset, fd_set *writeset);
                    411:
                    412: /* After select, perform any appropriate operations for channels which
                    413:    have events pending. */
                    414: void channel_after_select(fd_set *readset, fd_set *writeset);
                    415:
                    416: /* If there is data to send to the connection, send some of it now. */
                    417: void channel_output_poll(void);
                    418:
                    419: /* This is called when a packet of type CHANNEL_DATA has just been received.
                    420:    The message type has already been consumed, but channel number and data
                    421:    is still there. */
                    422: void channel_input_data(int payload_len);
                    423:
                    424: /* Returns true if no channel has too much buffered data. */
                    425: int channel_not_very_much_buffered_data(void);
                    426:
                    427: /* This is called after receiving CHANNEL_CLOSE. */
                    428: void channel_input_close(void);
                    429:
                    430: /* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
                    431: void channel_input_close_confirmation(void);
                    432:
                    433: /* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
                    434: void channel_input_open_confirmation(void);
                    435:
                    436: /* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
                    437: void channel_input_open_failure(void);
                    438:
                    439: /* This closes any sockets that are listening for connections; this removes
                    440:    any unix domain sockets. */
                    441: void channel_stop_listening(void);
                    442:
                    443: /* Closes the sockets of all channels.  This is used to close extra file
                    444:    descriptors after a fork. */
                    445: void channel_close_all(void);
                    446:
                    447: /* Returns the maximum file descriptor number used by the channels. */
                    448: int channel_max_fd(void);
                    449:
                    450: /* Returns true if there is still an open channel over the connection. */
                    451: int channel_still_open(void);
                    452:
                    453: /* Returns a string containing a list of all open channels.  The list is
                    454:    suitable for displaying to the user.  It uses crlf instead of newlines.
                    455:    The caller should free the string with xfree. */
                    456: char *channel_open_message(void);
                    457:
                    458: /* Initiate forwarding of connections to local port "port" through the secure
                    459:    channel to host:port from remote side.  This never returns if there
                    460:    was an error. */
                    461: void channel_request_local_forwarding(int port, const char *host,
                    462:                                      int remote_port);
                    463:
                    464: /* Initiate forwarding of connections to port "port" on remote host through
                    465:    the secure channel to host:port from local side.  This never returns
                    466:    if there was an error.  This registers that open requests for that
                    467:    port are permitted. */
                    468: void channel_request_remote_forwarding(int port, const char *host,
                    469:                                       int remote_port);
                    470:
                    471: /* Permits opening to any host/port in SSH_MSG_PORT_OPEN.  This is usually
                    472:    called by the server, because the user could connect to any port anyway,
                    473:    and the server has no way to know but to trust the client anyway. */
                    474: void channel_permit_all_opens(void);
                    475:
                    476: /* This is called after receiving CHANNEL_FORWARDING_REQUEST.  This initates
                    477:    listening for the port, and sends back a success reply (or disconnect
                    478:    message if there was an error).  This never returns if there was an
                    479:    error. */
                    480: void channel_input_port_forward_request(int is_root);
                    481:
                    482: /* This is called after receiving PORT_OPEN message.  This attempts to connect
                    483:    to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION or
                    484:    CHANNEL_OPEN_FAILURE. */
                    485: void channel_input_port_open(int payload_len);
                    486:
                    487: /* Creates a port for X11 connections, and starts listening for it.
                    488:    Returns the display name, or NULL if an error was encountered. */
                    489: char *x11_create_display(int screen);
                    490:
                    491: /* Creates an internet domain socket for listening for X11 connections.
                    492:    Returns a suitable value for the DISPLAY variable, or NULL if an error
                    493:    occurs. */
                    494: char *x11_create_display_inet(int screen);
                    495:
                    496: /* This is called when SSH_SMSG_X11_OPEN is received.  The packet contains
                    497:    the remote channel number.  We should do whatever we want, and respond
                    498:    with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE. */
                    499: void x11_input_open(int payload_len);
                    500:
                    501: /* Requests forwarding of X11 connections.  This should be called on the
                    502:    client only. */
                    503: void x11_request_forwarding(void);
                    504:
                    505: /* Requests forwarding for X11 connections, with authentication spoofing.
                    506:    This should be called in the client only.  */
1.3       provos    507: void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
1.1       deraadt   508:
                    509: /* Sends a message to the server to request authentication fd forwarding. */
                    510: void auth_request_forwarding(void);
                    511:
                    512: /* Returns the name of the forwarded authentication socket.  Returns NULL
                    513:    if there is no forwarded authentication socket.  The returned value points
                    514:    to a static buffer. */
                    515: char *auth_get_socket_name(void);
                    516:
                    517: /* This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
                    518:    This starts forwarding authentication requests. */
                    519: void auth_input_request_forwarding(struct passwd *pw);
                    520:
                    521: /* This is called to process an SSH_SMSG_AGENT_OPEN message. */
                    522: void auth_input_open_request(void);
                    523:
                    524: /* Returns true if the given string matches the pattern (which may contain
                    525:    ? and * as wildcards), and zero if it does not match. */
                    526: int match_pattern(const char *s, const char *pattern);
                    527:
                    528: /* Expands tildes in the file name.  Returns data allocated by xmalloc.
                    529:    Warning: this calls getpw*. */
                    530: char *tilde_expand_filename(const char *filename, uid_t my_uid);
                    531:
                    532: /* Performs the interactive session.  This handles data transmission between
                    533:    the client and the program.  Note that the notion of stdin, stdout, and
                    534:    stderr in this function is sort of reversed: this function writes to
                    535:    stdin (of the child program), and reads from stdout and stderr (of the
                    536:    child program). */
                    537: void server_loop(int pid, int fdin, int fdout, int fderr);
                    538:
                    539: /* Client side main loop for the interactive session. */
                    540: int client_loop(int have_pty, int escape_char);
                    541:
                    542: /* Linked list of custom environment strings (see auth-rsa.c). */
                    543: struct envstring {
                    544:   struct envstring *next;
                    545:   char *s;
                    546: };
                    547:
                    548: #ifdef KRB4
                    549: #include <krb.h>
                    550:
1.4       dugsong   551: /* Performs Kerberos v4 mutual authentication with the client. This returns
                    552:    0 if the client could not be authenticated, and 1 if authentication was
                    553:    successful.  This may exit if there is a serious protocol violation. */
                    554: int auth_krb4(const char *server_user, KTEXT auth, char **client);
1.17      markus    555: int krb4_init(uid_t uid);
                    556: void krb4_cleanup_proc(void *ignore);
1.4       dugsong   557:
                    558: #ifdef AFS
                    559: #include <kafs.h>
                    560:
                    561: /* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
1.1       deraadt   562: int auth_kerberos_tgt(struct passwd *pw, const char *string);
1.16      markus    563: int auth_afs_token(struct passwd *pw, const char *token_string);
1.1       deraadt   564:
                    565: int creds_to_radix(CREDENTIALS *creds, unsigned char *buf);
                    566: int radix_to_creds(const char *buf, CREDENTIALS *creds);
1.4       dugsong   567: #endif /* AFS */
1.1       deraadt   568:
                    569: #endif /* KRB4 */
1.9       markus    570:
                    571: #ifdef SKEY
                    572: #include <skey.h>
                    573: char *skey_fake_keyinfo(char *username);
                    574: #endif /* SKEY */
1.1       deraadt   575:
                    576: #endif /* SSH_H */