blob: 0f3302a69dac2c285aa29d03ea211e275eb2b34c [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 *
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 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Miller34132e52000-01-14 15:45:46 +110016/* RCSID("$Id: ssh.h,v 1.24 2000/01/14 04:45:52 damien Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100017
18#ifndef SSH_H
19#define SSH_H
20
Damien Millerab18c411999-11-11 10:40:23 +110021#include <netinet/in.h> /* For struct sockaddr_in */
22#include <pwd.h> /* For struct pw */
Damien Miller5ce662a1999-11-11 17:57:39 +110023#include <stdarg.h> /* For va_list */
Damien Miller34132e52000-01-14 15:45:46 +110024#include <sys/socket.h> /* For struct sockaddr_storage */
25#include "fake-socket.h" /* For struct sockaddr_storage */
Damien Miller365199d1999-12-22 00:12:38 +110026#ifdef HAVE_SYS_SELECT_H
27# include <sys/select.h>
28#endif
Damien Millerd4a8b7e1999-10-27 13:42:43 +100029#include "rsa.h"
30#include "cipher.h"
31
Damien Miller5428f641999-11-25 11:54:57 +110032/*
33 * The default cipher used if IDEA is not supported by the remote host. It is
34 * recommended that this be one of the mandatory ciphers (DES, 3DES), though
35 * that is not required.
36 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100037#define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
38
39/* Cipher used for encrypting authentication files. */
40#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
41
42/* Default port number. */
43#define SSH_DEFAULT_PORT 22
44
45/* Maximum number of TCP/IP ports forwarded per direction. */
46#define SSH_MAX_FORWARDS_PER_DIRECTION 100
47
Damien Miller5428f641999-11-25 11:54:57 +110048/*
49 * Maximum number of RSA authentication identity files that can be specified
50 * in configuration files or on the command line.
51 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100052#define SSH_MAX_IDENTITY_FILES 100
53
Damien Miller5428f641999-11-25 11:54:57 +110054/*
55 * Major protocol version. Different version indicates major incompatiblity
56 * that prevents communication.
57 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100058#define PROTOCOL_MAJOR 1
59
Damien Miller5428f641999-11-25 11:54:57 +110060/*
61 * Minor protocol version. Different version indicates minor incompatibility
62 * that does not prevent interoperation.
63 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100064#define PROTOCOL_MINOR 5
65
Damien Miller5428f641999-11-25 11:54:57 +110066/*
67 * Name for the service. The port named by this service overrides the
68 * default port if present.
69 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100070#define SSH_SERVICE_NAME "ssh"
71
72#ifndef ETCDIR
73#define ETCDIR "/etc"
74#endif /* ETCDIR */
75
Damien Miller95def091999-11-25 00:26:21 +110076#ifndef PIDDIR
Damien Millerd4a8b7e1999-10-27 13:42:43 +100077#define PIDDIR "/var/run"
Damien Miller95def091999-11-25 00:26:21 +110078#endif /* PIDDIR */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100079
Damien Miller5428f641999-11-25 11:54:57 +110080/*
81 * System-wide file containing host keys of known hosts. This file should be
82 * world-readable.
83 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100084#define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
85
Damien Miller5428f641999-11-25 11:54:57 +110086/*
87 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
88 * should be world-readable.
89 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100090#define HOST_KEY_FILE ETCDIR "/ssh_host_key"
91#define SERVER_CONFIG_FILE ETCDIR "/sshd_config"
92#define HOST_CONFIG_FILE ETCDIR "/ssh_config"
93
Damien Miller356a0b01999-11-08 15:30:59 +110094#ifndef SSH_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110095#define SSH_PROGRAM "/usr/bin/ssh"
Damien Miller356a0b01999-11-08 15:30:59 +110096#endif /* SSH_PROGRAM */
97
98#ifndef LOGIN_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110099#define LOGIN_PROGRAM "/usr/bin/login"
Damien Miller356a0b01999-11-08 15:30:59 +1100100#endif /* LOGIN_PROGRAM */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000101
Damien Millerc7b38ce1999-11-09 10:28:04 +1100102#ifndef ASKPASS_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100103#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
Damien Millerc7b38ce1999-11-09 10:28:04 +1100104#endif /* ASKPASS_PROGRAM */
105
Damien Miller5428f641999-11-25 11:54:57 +1100106/*
107 * The process id of the daemon listening for connections is saved here to
108 * make it easier to kill the correct daemon when necessary.
109 */
Damien Millera37010e1999-10-29 09:18:29 +1000110#define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111
Damien Miller5428f641999-11-25 11:54:57 +1100112/*
113 * The directory in user\'s home directory in which the files reside. The
114 * directory should be world-readable (though not all files are).
115 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000116#define SSH_USER_DIR ".ssh"
117
Damien Miller5428f641999-11-25 11:54:57 +1100118/*
119 * Per-user file containing host keys of known hosts. This file need not be
120 * readable by anyone except the user him/herself, though this does not
121 * contain anything particularly secret.
122 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000123#define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
124
Damien Miller5428f641999-11-25 11:54:57 +1100125/*
126 * Name of the default file containing client-side authentication key. This
127 * file should only be readable by the user him/herself.
128 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000129#define SSH_CLIENT_IDENTITY ".ssh/identity"
130
Damien Miller5428f641999-11-25 11:54:57 +1100131/*
132 * Configuration file in user\'s home directory. This file need not be
133 * readable by anyone but the user him/herself, but does not contain anything
134 * particularly secret. If the user\'s home directory resides on an NFS
135 * volume where root is mapped to nobody, this may need to be world-readable.
136 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000137#define SSH_USER_CONFFILE ".ssh/config"
138
Damien Miller5428f641999-11-25 11:54:57 +1100139/*
140 * File containing a list of those rsa keys that permit logging in as this
141 * user. This file need not be readable by anyone but the user him/herself,
142 * but does not contain anything particularly secret. If the user\'s home
143 * directory resides on an NFS volume where root is mapped to nobody, this
144 * may need to be world-readable. (This file is read by the daemon which is
145 * running as root.)
146 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000147#define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
148
Damien Miller5428f641999-11-25 11:54:57 +1100149/*
150 * Per-user and system-wide ssh "rc" files. These files are executed with
151 * /bin/sh before starting the shell or command if they exist. They will be
152 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
153 * use. xauth will be run if neither of these exists.
154 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000155#define SSH_USER_RC ".ssh/rc"
156#define SSH_SYSTEM_RC ETCDIR "/sshrc"
157
Damien Miller5428f641999-11-25 11:54:57 +1100158/*
159 * Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
160 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
161 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000162#define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
163
Damien Miller5428f641999-11-25 11:54:57 +1100164/*
165 * Name of the environment variable containing the pathname of the
166 * authentication socket.
167 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000168#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
169
Damien Miller5428f641999-11-25 11:54:57 +1100170/*
171 * Name of the environment variable containing the pathname of the
172 * authentication socket.
173 */
Damien Miller32265091999-11-12 11:33:04 +1100174#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Miller5eeedae1999-10-29 10:21:15 +1000175
Damien Miller5428f641999-11-25 11:54:57 +1100176/*
Damien Milleraae6c611999-12-06 11:47:28 +1100177 * Default path to ssh-askpass used by ssh-add,
178 * environment variable for overwriting the default location
179 */
Damien Miller3bc14dd1999-12-07 14:54:53 +1100180#ifndef SSH_ASKPASS_DEFAULT
181# define SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
182#endif
Damien Milleraae6c611999-12-06 11:47:28 +1100183#define SSH_ASKPASS_ENV "SSH_ASKPASS"
184
185/*
Damien Miller5428f641999-11-25 11:54:57 +1100186 * Force host key length and server key length to differ by at least this
187 * many bits. This is to make double encryption with rsaref work.
188 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000189#define SSH_KEY_BITS_RESERVED 128
190
Damien Miller5428f641999-11-25 11:54:57 +1100191/*
192 * Length of the session key in bytes. (Specified as 256 bits in the
193 * protocol.)
194 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000195#define SSH_SESSION_KEY_LENGTH 32
196
197/* Name of Kerberos service for SSH to use. */
198#define KRB4_SERVICE_NAME "rcmd"
199
Damien Miller5428f641999-11-25 11:54:57 +1100200/*
201 * Authentication methods. New types can be added, but old types should not
202 * be removed for compatibility. The maximum allowed value is 31.
203 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000204#define SSH_AUTH_RHOSTS 1
205#define SSH_AUTH_RSA 2
206#define SSH_AUTH_PASSWORD 3
207#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100208#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000209#define SSH_AUTH_KERBEROS 6
210#define SSH_PASS_KERBEROS_TGT 7
Damien Miller5428f641999-11-25 11:54:57 +1100211 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000212#define SSH_PASS_AFS_TOKEN 21
213
214/* Protocol flags. These are bit masks. */
Damien Miller5428f641999-11-25 11:54:57 +1100215#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */
216#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000217
Damien Miller5428f641999-11-25 11:54:57 +1100218/*
219 * Definition of message types. New values can be added, but old values
220 * should not be removed or without careful consideration of the consequences
221 * for compatibility. The maximum value is 254; value 255 is reserved for
222 * future extension.
223 */
224/* Message name */ /* msg code */ /* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000225#define SSH_MSG_NONE 0 /* no message */
226#define SSH_MSG_DISCONNECT 1 /* cause (string) */
227#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
228#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
229#define SSH_CMSG_USER 4 /* user (string) */
230#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
231#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
232#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
233#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
234#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
235#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
236#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
237#define SSH_CMSG_EXEC_SHELL 12 /* */
238#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
239#define SSH_SMSG_SUCCESS 14 /* */
240#define SSH_SMSG_FAILURE 15 /* */
241#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
242#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
243#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
244#define SSH_CMSG_EOF 19 /* */
245#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
246#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
247#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
248#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
249#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
250#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
251/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
252#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
253#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
254#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
255#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
256#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
257#define SSH_MSG_IGNORE 32 /* string */
258#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
259#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
260#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
261#define SSH_MSG_DEBUG 36 /* string */
262#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
263#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100264#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
265#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
266#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000267#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
268#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
269#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
270#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
271
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000272/*------------ definitions for login.c -------------*/
273
Damien Miller5428f641999-11-25 11:54:57 +1100274/*
275 * Returns the time when the user last logged in. Returns 0 if the
276 * information is not available. This must be called before record_login.
277 * The host from which the user logged in is stored in buf.
278 */
Damien Miller95def091999-11-25 00:26:21 +1100279unsigned long
280get_last_login_time(uid_t uid, const char *logname,
281 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000282
Damien Miller5428f641999-11-25 11:54:57 +1100283/*
284 * Records that the user has logged in. This does many things normally done
285 * by login(1).
286 */
Damien Miller95def091999-11-25 00:26:21 +1100287void
288record_login(int pid, const char *ttyname, const char *user, uid_t uid,
Damien Miller34132e52000-01-14 15:45:46 +1100289 const char *host, struct sockaddr *addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000290
Damien Miller5428f641999-11-25 11:54:57 +1100291/*
292 * Records that the user has logged out. This does many thigs normally done
293 * by login(1) or init.
294 */
Damien Miller95def091999-11-25 00:26:21 +1100295void record_logout(int pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000296
297/*------------ definitions for sshconnect.c ----------*/
298
Damien Miller5428f641999-11-25 11:54:57 +1100299/*
300 * Opens a TCP/IP connection to the remote server on the given host. If port
301 * is 0, the default port will be used. If anonymous is zero, a privileged
302 * port will be allocated to make the connection. This requires super-user
303 * privileges if anonymous is false. Connection_attempts specifies the
304 * maximum number of tries, one per second. This returns true on success,
305 * and zero on failure. If the connection is successful, this calls
306 * packet_set_connection for the connection.
307 */
Damien Miller95def091999-11-25 00:26:21 +1100308int
Damien Miller34132e52000-01-14 15:45:46 +1100309ssh_connect(const char *host, struct sockaddr_storage * hostaddr,
Damien Milleraae6c611999-12-06 11:47:28 +1100310 u_short port, int connection_attempts,
Damien Miller95def091999-11-25 00:26:21 +1100311 int anonymous, uid_t original_real_uid,
312 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000313
Damien Miller5428f641999-11-25 11:54:57 +1100314/*
315 * Starts a dialog with the server, and authenticates the current user on the
316 * server. This does not need any extra privileges. The basic connection to
317 * the server must already have been established before this is called. If
318 * login fails, this function prints an error and never returns. This
319 * initializes the random state, and leaves it initialized (it will also have
320 * references from the packet module).
321 */
Damien Miller5ce662a1999-11-11 17:57:39 +1100322
Damien Miller95def091999-11-25 00:26:21 +1100323void
324ssh_login(int host_key_valid, RSA * host_key, const char *host,
Damien Miller34132e52000-01-14 15:45:46 +1100325 struct sockaddr * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000326
327/*------------ Definitions for various authentication methods. -------*/
328
Damien Miller5428f641999-11-25 11:54:57 +1100329/*
330 * Tries to authenticate the user using the .rhosts file. Returns true if
331 * authentication succeeds. If ignore_rhosts is non-zero, this will not
332 * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
333 */
Damien Miller95def091999-11-25 00:26:21 +1100334int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000335
Damien Miller5428f641999-11-25 11:54:57 +1100336/*
337 * Tries to authenticate the user using the .rhosts file and the host using
338 * its host key. Returns true if authentication succeeds.
339 */
Damien Miller95def091999-11-25 00:26:21 +1100340int
341auth_rhosts_rsa(struct passwd * pw, const char *client_user,
342 BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000343
Damien Miller5428f641999-11-25 11:54:57 +1100344/*
345 * Tries to authenticate the user using password. Returns true if
346 * authentication succeeds.
347 */
Damien Miller95def091999-11-25 00:26:21 +1100348int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000349
Damien Miller5428f641999-11-25 11:54:57 +1100350/*
351 * Performs the RSA authentication dialog with the client. This returns 0 if
352 * the client could not be authenticated, and 1 if authentication was
353 * successful. This may exit if there is a serious protocol violation.
354 */
Damien Miller95def091999-11-25 00:26:21 +1100355int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000356
Damien Miller5428f641999-11-25 11:54:57 +1100357/*
358 * Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
359 * over the key. Skips any whitespace at the beginning and at end.
360 */
Damien Miller95def091999-11-25 00:26:21 +1100361int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000362
Damien Miller5428f641999-11-25 11:54:57 +1100363/*
364 * Returns the name of the machine at the other end of the socket. The
365 * returned string should be freed by the caller.
366 */
Damien Miller95def091999-11-25 00:26:21 +1100367char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000368
Damien Miller5428f641999-11-25 11:54:57 +1100369/*
370 * Return the canonical name of the host in the other side of the current
371 * connection (as returned by packet_get_connection). The host name is
372 * cached, so it is efficient to call this several times.
373 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000374const char *get_canonical_hostname(void);
375
Damien Miller5428f641999-11-25 11:54:57 +1100376/*
377 * Returns the remote IP address as an ascii string. The value need not be
378 * freed by the caller.
379 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000380const char *get_remote_ipaddr(void);
381
382/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100383int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000384
Damien Miller34132e52000-01-14 15:45:46 +1100385/* Returns the port number of the remote/local host. */
Damien Miller95def091999-11-25 00:26:21 +1100386int get_remote_port(void);
Damien Miller34132e52000-01-14 15:45:46 +1100387int get_local_port(void);
388
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000389
Damien Miller5428f641999-11-25 11:54:57 +1100390/*
391 * Tries to match the host name (which must be in all lowercase) against the
392 * comma-separated sequence of subpatterns (each possibly preceded by ! to
393 * indicate negation). Returns true if there is a positive match; zero
394 * otherwise.
395 */
Damien Miller95def091999-11-25 00:26:21 +1100396int match_hostname(const char *host, const char *pattern, unsigned int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000397
Damien Miller5428f641999-11-25 11:54:57 +1100398/*
399 * Checks whether the given host is already in the list of our known hosts.
400 * Returns HOST_OK if the host is known and has the specified key, HOST_NEW
401 * if the host is not known, and HOST_CHANGED if the host is known but used
402 * to have a different host key. The host must be in all lowercase.
403 */
Damien Miller95def091999-11-25 00:26:21 +1100404typedef enum {
405 HOST_OK, HOST_NEW, HOST_CHANGED
406} HostStatus;
407HostStatus
408check_host_in_hostfile(const char *filename, const char *host,
409 BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000410
Damien Miller5428f641999-11-25 11:54:57 +1100411/*
412 * Appends an entry to the host file. Returns false if the entry could not
413 * be appended.
414 */
Damien Miller95def091999-11-25 00:26:21 +1100415int
416add_host_to_hostfile(const char *filename, const char *host,
417 BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000418
Damien Miller5428f641999-11-25 11:54:57 +1100419/*
420 * Performs the RSA authentication challenge-response dialog with the client,
421 * and returns true (non-zero) if the client gave the correct answer to our
422 * challenge; returns zero if the client gives a wrong answer.
423 */
Damien Miller95def091999-11-25 00:26:21 +1100424int auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000425
Damien Miller5428f641999-11-25 11:54:57 +1100426/*
427 * Reads a passphrase from /dev/tty with echo turned off. Returns the
428 * passphrase (allocated with xmalloc). Exits if EOF is encountered. If
429 * from_stdin is true, the passphrase will be read from stdin instead.
430 */
Damien Miller95def091999-11-25 00:26:21 +1100431char *read_passphrase(const char *prompt, int from_stdin);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000432
Damien Miller5428f641999-11-25 11:54:57 +1100433/*
434 * Saves the authentication (private) key in a file, encrypting it with
435 * passphrase. The identification of the file (lowest 64 bits of n) will
436 * precede the key to provide identification of the key without needing a
437 * passphrase.
438 */
Damien Miller95def091999-11-25 00:26:21 +1100439int
440save_private_key(const char *filename, const char *passphrase,
441 RSA * private_key, const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000442
Damien Miller5428f641999-11-25 11:54:57 +1100443/*
444 * Loads the public part of the key file (public key and comment). Returns 0
445 * if an error occurred; zero if the public key was successfully read. The
446 * comment of the key is returned in comment_return if it is non-NULL; the
447 * caller must free the value with xfree.
448 */
Damien Miller95def091999-11-25 00:26:21 +1100449int
450load_public_key(const char *filename, RSA * pub,
451 char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000452
Damien Miller5428f641999-11-25 11:54:57 +1100453/*
454 * Loads the private key from the file. Returns 0 if an error is encountered
455 * (file does not exist or is not readable, or passphrase is bad). This
456 * initializes the private key. The comment of the key is returned in
457 * comment_return if it is non-NULL; the caller must free the value with
458 * xfree.
459 */
Damien Miller95def091999-11-25 00:26:21 +1100460int
461load_private_key(const char *filename, const char *passphrase,
462 RSA * private_key, char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000463
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100464/*------------ Definitions for logging. -----------------------*/
465
466/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100467typedef enum {
468 SYSLOG_FACILITY_DAEMON,
469 SYSLOG_FACILITY_USER,
470 SYSLOG_FACILITY_AUTH,
471 SYSLOG_FACILITY_LOCAL0,
472 SYSLOG_FACILITY_LOCAL1,
473 SYSLOG_FACILITY_LOCAL2,
474 SYSLOG_FACILITY_LOCAL3,
475 SYSLOG_FACILITY_LOCAL4,
476 SYSLOG_FACILITY_LOCAL5,
477 SYSLOG_FACILITY_LOCAL6,
478 SYSLOG_FACILITY_LOCAL7
479} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100480
Damien Miller95def091999-11-25 00:26:21 +1100481typedef enum {
482 SYSLOG_LEVEL_QUIET,
483 SYSLOG_LEVEL_FATAL,
484 SYSLOG_LEVEL_ERROR,
485 SYSLOG_LEVEL_INFO,
486 SYSLOG_LEVEL_VERBOSE,
487 SYSLOG_LEVEL_DEBUG
488} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100489/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100490void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100491
492/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100493void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100494
Damien Miller6162d121999-11-21 13:23:52 +1100495/* name to facility/level */
496SyslogFacility log_facility_number(char *name);
497LogLevel log_level_number(char *name);
498
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100499/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100500void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
501void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
502void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
503void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
504void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100505
506/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100507void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100508
Damien Miller5428f641999-11-25 11:54:57 +1100509/*
510 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
511 * before exiting. It is permissible to call fatal_remove_cleanup for the
512 * function itself from the function.
513 */
Damien Miller95def091999-11-25 00:26:21 +1100514void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100515
516/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100517void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100518
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000519/*---------------- definitions for channels ------------------*/
520
521/* Sets specific protocol options. */
Damien Miller95def091999-11-25 00:26:21 +1100522void channel_set_options(int hostname_in_open);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000523
Damien Miller5428f641999-11-25 11:54:57 +1100524/*
525 * Allocate a new channel object and set its type and socket. Remote_name
526 * must have been allocated with xmalloc; this will free it when the channel
527 * is freed.
528 */
Damien Miller95def091999-11-25 00:26:21 +1100529int channel_allocate(int type, int sock, char *remote_name);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000530
531/* Free the channel and close its socket. */
Damien Miller95def091999-11-25 00:26:21 +1100532void channel_free(int channel);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000533
534/* Add any bits relevant to channels in select bitmasks. */
Damien Miller95def091999-11-25 00:26:21 +1100535void channel_prepare_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000536
Damien Miller5428f641999-11-25 11:54:57 +1100537/*
538 * After select, perform any appropriate operations for channels which have
539 * events pending.
540 */
Damien Miller95def091999-11-25 00:26:21 +1100541void channel_after_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000542
543/* If there is data to send to the connection, send some of it now. */
Damien Miller95def091999-11-25 00:26:21 +1100544void channel_output_poll(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000545
Damien Miller5428f641999-11-25 11:54:57 +1100546/*
547 * This is called when a packet of type CHANNEL_DATA has just been received.
548 * The message type has already been consumed, but channel number and data is
549 * still there.
550 */
Damien Miller95def091999-11-25 00:26:21 +1100551void channel_input_data(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000552
553/* Returns true if no channel has too much buffered data. */
Damien Miller95def091999-11-25 00:26:21 +1100554int channel_not_very_much_buffered_data(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000555
556/* This is called after receiving CHANNEL_CLOSE. */
Damien Miller95def091999-11-25 00:26:21 +1100557void channel_input_close(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000558
559/* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100560void channel_input_close_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000561
562/* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100563void channel_input_open_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000564
565/* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
Damien Miller95def091999-11-25 00:26:21 +1100566void channel_input_open_failure(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000567
568/* This closes any sockets that are listening for connections; this removes
569 any unix domain sockets. */
Damien Miller95def091999-11-25 00:26:21 +1100570void channel_stop_listening(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000571
Damien Miller5428f641999-11-25 11:54:57 +1100572/*
573 * Closes the sockets of all channels. This is used to close extra file
574 * descriptors after a fork.
575 */
Damien Miller95def091999-11-25 00:26:21 +1100576void channel_close_all(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000577
578/* Returns the maximum file descriptor number used by the channels. */
Damien Miller95def091999-11-25 00:26:21 +1100579int channel_max_fd(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000580
581/* Returns true if there is still an open channel over the connection. */
Damien Miller95def091999-11-25 00:26:21 +1100582int channel_still_open(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000583
Damien Miller5428f641999-11-25 11:54:57 +1100584/*
585 * Returns a string containing a list of all open channels. The list is
586 * suitable for displaying to the user. It uses crlf instead of newlines.
587 * The caller should free the string with xfree.
588 */
Damien Miller95def091999-11-25 00:26:21 +1100589char *channel_open_message(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000590
Damien Miller5428f641999-11-25 11:54:57 +1100591/*
592 * Initiate forwarding of connections to local port "port" through the secure
593 * channel to host:port from remote side. This never returns if there was an
594 * error.
595 */
Damien Miller95def091999-11-25 00:26:21 +1100596void
Damien Milleraae6c611999-12-06 11:47:28 +1100597channel_request_local_forwarding(u_short port, const char *host,
Damien Millera34a28b1999-12-14 10:47:15 +1100598 u_short remote_port, int gateway_ports);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000599
Damien Miller5428f641999-11-25 11:54:57 +1100600/*
601 * Initiate forwarding of connections to port "port" on remote host through
602 * the secure channel to host:port from local side. This never returns if
603 * there was an error. This registers that open requests for that port are
604 * permitted.
605 */
Damien Miller95def091999-11-25 00:26:21 +1100606void
Damien Milleraae6c611999-12-06 11:47:28 +1100607channel_request_remote_forwarding(u_short port, const char *host,
608 u_short remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000609
Damien Miller5428f641999-11-25 11:54:57 +1100610/*
611 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
612 * called by the server, because the user could connect to any port anyway,
613 * and the server has no way to know but to trust the client anyway.
614 */
Damien Miller95def091999-11-25 00:26:21 +1100615void channel_permit_all_opens(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000616
Damien Miller5428f641999-11-25 11:54:57 +1100617/*
618 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
619 * listening for the port, and sends back a success reply (or disconnect
620 * message if there was an error). This never returns if there was an error.
621 */
Damien Miller95def091999-11-25 00:26:21 +1100622void channel_input_port_forward_request(int is_root);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000623
Damien Miller5428f641999-11-25 11:54:57 +1100624/*
625 * This is called after receiving PORT_OPEN message. This attempts to
626 * connect to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION
627 * or CHANNEL_OPEN_FAILURE.
628 */
Damien Miller95def091999-11-25 00:26:21 +1100629void channel_input_port_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000630
Damien Miller5428f641999-11-25 11:54:57 +1100631/*
632 * Creates a port for X11 connections, and starts listening for it. Returns
633 * the display name, or NULL if an error was encountered.
634 */
Damien Miller95def091999-11-25 00:26:21 +1100635char *x11_create_display(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000636
Damien Miller5428f641999-11-25 11:54:57 +1100637/*
638 * Creates an internet domain socket for listening for X11 connections.
639 * Returns a suitable value for the DISPLAY variable, or NULL if an error
640 * occurs.
641 */
Damien Millera34a28b1999-12-14 10:47:15 +1100642char *x11_create_display_inet(int screen, int x11_display_offset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000643
Damien Miller5428f641999-11-25 11:54:57 +1100644/*
645 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
646 * the remote channel number. We should do whatever we want, and respond
647 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
648 */
Damien Miller95def091999-11-25 00:26:21 +1100649void x11_input_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000650
Damien Miller5428f641999-11-25 11:54:57 +1100651/*
652 * Requests forwarding of X11 connections. This should be called on the
653 * client only.
654 */
Damien Miller95def091999-11-25 00:26:21 +1100655void x11_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000656
Damien Miller5428f641999-11-25 11:54:57 +1100657/*
658 * Requests forwarding for X11 connections, with authentication spoofing.
659 * This should be called in the client only.
660 */
Damien Miller95def091999-11-25 00:26:21 +1100661void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000662
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000663/* Sends a message to the server to request authentication fd forwarding. */
Damien Miller95def091999-11-25 00:26:21 +1100664void auth_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000665
Damien Miller5428f641999-11-25 11:54:57 +1100666/*
667 * Returns the name of the forwarded authentication socket. Returns NULL if
668 * there is no forwarded authentication socket. The returned value points to
669 * a static buffer.
670 */
Damien Miller95def091999-11-25 00:26:21 +1100671char *auth_get_socket_name(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000672
Damien Miller5428f641999-11-25 11:54:57 +1100673/*
674 * This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
675 * This starts forwarding authentication requests.
676 */
Damien Miller95def091999-11-25 00:26:21 +1100677void auth_input_request_forwarding(struct passwd * pw);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000678
679/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
Damien Miller95def091999-11-25 00:26:21 +1100680void auth_input_open_request(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000681
Damien Miller5428f641999-11-25 11:54:57 +1100682/*
683 * Returns true if the given string matches the pattern (which may contain ?
684 * and * as wildcards), and zero if it does not match.
685 */
Damien Miller95def091999-11-25 00:26:21 +1100686int match_pattern(const char *s, const char *pattern);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000687
Damien Miller5428f641999-11-25 11:54:57 +1100688/*
689 * Expands tildes in the file name. Returns data allocated by xmalloc.
690 * Warning: this calls getpw*.
691 */
Damien Miller95def091999-11-25 00:26:21 +1100692char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000693
Damien Miller5428f641999-11-25 11:54:57 +1100694/*
695 * Performs the interactive session. This handles data transmission between
696 * the client and the program. Note that the notion of stdin, stdout, and
697 * stderr in this function is sort of reversed: this function writes to stdin
698 * (of the child program), and reads from stdout and stderr (of the child
699 * program).
700 */
Damien Miller95def091999-11-25 00:26:21 +1100701void server_loop(int pid, int fdin, int fdout, int fderr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000702
703/* Client side main loop for the interactive session. */
Damien Miller95def091999-11-25 00:26:21 +1100704int client_loop(int have_pty, int escape_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000705
706/* Linked list of custom environment strings (see auth-rsa.c). */
707struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100708 struct envstring *next;
709 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000710};
Damien Miller037a0dc1999-12-07 15:38:31 +1100711
712/*
713 * Ensure all of data on socket comes through. f==read || f==write
714 */
715int atomicio(int (*f)(), int fd, void *s, size_t n);
716
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000717#ifdef KRB4
718#include <krb.h>
Damien Miller5428f641999-11-25 11:54:57 +1100719/*
720 * Performs Kerberos v4 mutual authentication with the client. This returns 0
721 * if the client could not be authenticated, and 1 if authentication was
722 * successful. This may exit if there is a serious protocol violation.
723 */
Damien Miller95def091999-11-25 00:26:21 +1100724int auth_krb4(const char *server_user, KTEXT auth, char **client);
725int krb4_init(uid_t uid);
726void krb4_cleanup_proc(void *ignore);
Damien Milleraae6c611999-12-06 11:47:28 +1100727int auth_krb4_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000728
729#ifdef AFS
730#include <kafs.h>
731
732/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100733int auth_kerberos_tgt(struct passwd * pw, const char *string);
734int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000735
Damien Miller95def091999-11-25 00:26:21 +1100736int creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
737int radix_to_creds(const char *buf, CREDENTIALS * creds);
738#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000739
Damien Miller95def091999-11-25 00:26:21 +1100740#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000741
742#ifdef SKEY
743#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100744char *skey_fake_keyinfo(char *username);
Damien Milleraae6c611999-12-06 11:47:28 +1100745int auth_skey_password(struct passwd * pw, const char *password);
Damien Miller95def091999-11-25 00:26:21 +1100746#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000747
Damien Miller34132e52000-01-14 15:45:46 +1100748/* AF_UNSPEC or AF_INET or AF_INET6 */
749extern int IPv4or6;
750
Damien Millere72b7af1999-12-30 15:08:44 +1100751#ifdef USE_PAM
752#include "auth-pam.h"
753#endif /* USE_PAM */
754
Damien Miller8bdeee21999-12-30 15:50:54 +1100755#ifdef HAVE_DANTE
756/*
757 * The following defines map the normal socket operations to SOCKSified
758 * versions coming from the Dante SOCKS package.
759 */
760#define accept Raccept
761#define bind Rbind
762#define bindresvport Rbindresvport
763#define connect Rconnect
764#define gethostbyname Rgethostbyname
765#define gethostbyname2 Rgethostbyname2
766#define getpeername Rgetpeername
767#define getsockname Rgetsockname
768#define read Rread
769#define readv Rreadv
770#define recv Rrecv
771#define recvmsg Rrecvmsg
772#define recvfrom Rrecvfrom
773#define rresvport Rrresvport
774#define send Rsend
775#define sendmsg Rsendmsg
776#define sendto Rsendto
777#define write Rwrite
778#define writev Rwritev
779int Raccept (int, struct sockaddr *, socklen_t *);
780int Rbind (int, const struct sockaddr *, socklen_t);
781int Rbindresvport(int , struct sockaddr_in *);
782int Rconnect (int, const struct sockaddr *, socklen_t);
783struct hostent *Rgethostbyname(const char *);
784struct hostent *Rgethostbyname2(const char *, int);
785int Rgetpeername (int, struct sockaddr *, socklen_t *);
786int Rgetsockname (int, struct sockaddr *, socklen_t *);
787ssize_t Rread(int , void *, size_t );
788ssize_t Rreadv(int d, const struct iovec *iov, int iovcnt);
789ssize_t Rrecv (int, void *, size_t, int);
790ssize_t Rrecvfrom (int, void *, size_t, int, struct sockaddr *,
791 socklen_t *);
792ssize_t Rsend (int, const void *, size_t, int);
793ssize_t Rsendmsg (int, const struct msghdr *, int);
794ssize_t Rsendto (int, const void *,
795 size_t, int, const struct sockaddr *, socklen_t);
796ssize_t Rwrite(int , const void *, size_t );
797ssize_t Rwritev(int , const struct iovec *, int );
798#endif /* HAVE_DANTE */
799
Damien Miller95def091999-11-25 00:26:21 +1100800#endif /* SSH_H */