blob: 961c82a2556d71244f23b9f00bed3696370262d8 [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 Milleraae6c611999-12-06 11:47:28 +110016/* RCSID("$Id: ssh.h,v 1.17 1999/12/06 00:47:29 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 Miller7f6ea021999-10-28 13:25:17 +100024
Damien Millerd4a8b7e1999-10-27 13:42:43 +100025#include "rsa.h"
26#include "cipher.h"
27
Damien Miller5428f641999-11-25 11:54:57 +110028/*
29 * The default cipher used if IDEA is not supported by the remote host. It is
30 * recommended that this be one of the mandatory ciphers (DES, 3DES), though
31 * that is not required.
32 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100033#define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
34
35/* Cipher used for encrypting authentication files. */
36#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
37
38/* Default port number. */
39#define SSH_DEFAULT_PORT 22
40
41/* Maximum number of TCP/IP ports forwarded per direction. */
42#define SSH_MAX_FORWARDS_PER_DIRECTION 100
43
Damien Miller5428f641999-11-25 11:54:57 +110044/*
45 * Maximum number of RSA authentication identity files that can be specified
46 * in configuration files or on the command line.
47 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100048#define SSH_MAX_IDENTITY_FILES 100
49
Damien Miller5428f641999-11-25 11:54:57 +110050/*
51 * Major protocol version. Different version indicates major incompatiblity
52 * that prevents communication.
53 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100054#define PROTOCOL_MAJOR 1
55
Damien Miller5428f641999-11-25 11:54:57 +110056/*
57 * Minor protocol version. Different version indicates minor incompatibility
58 * that does not prevent interoperation.
59 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100060#define PROTOCOL_MINOR 5
61
Damien Miller5428f641999-11-25 11:54:57 +110062/*
63 * Name for the service. The port named by this service overrides the
64 * default port if present.
65 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100066#define SSH_SERVICE_NAME "ssh"
67
68#ifndef ETCDIR
69#define ETCDIR "/etc"
70#endif /* ETCDIR */
71
Damien Miller95def091999-11-25 00:26:21 +110072#ifndef PIDDIR
Damien Millerd4a8b7e1999-10-27 13:42:43 +100073#define PIDDIR "/var/run"
Damien Miller95def091999-11-25 00:26:21 +110074#endif /* PIDDIR */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100075
Damien Miller5428f641999-11-25 11:54:57 +110076/*
77 * System-wide file containing host keys of known hosts. This file should be
78 * world-readable.
79 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100080#define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
81
Damien Miller5428f641999-11-25 11:54:57 +110082/*
83 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
84 * should be world-readable.
85 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100086#define HOST_KEY_FILE ETCDIR "/ssh_host_key"
87#define SERVER_CONFIG_FILE ETCDIR "/sshd_config"
88#define HOST_CONFIG_FILE ETCDIR "/ssh_config"
89
Damien Miller356a0b01999-11-08 15:30:59 +110090#ifndef SSH_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110091#define SSH_PROGRAM "/usr/bin/ssh"
Damien Miller356a0b01999-11-08 15:30:59 +110092#endif /* SSH_PROGRAM */
93
94#ifndef LOGIN_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110095#define LOGIN_PROGRAM "/usr/bin/login"
Damien Miller356a0b01999-11-08 15:30:59 +110096#endif /* LOGIN_PROGRAM */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100097
Damien Millerc7b38ce1999-11-09 10:28:04 +110098#ifndef ASKPASS_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110099#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
Damien Millerc7b38ce1999-11-09 10:28:04 +1100100#endif /* ASKPASS_PROGRAM */
101
Damien Miller5428f641999-11-25 11:54:57 +1100102/*
103 * The process id of the daemon listening for connections is saved here to
104 * make it easier to kill the correct daemon when necessary.
105 */
Damien Millera37010e1999-10-29 09:18:29 +1000106#define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000107
Damien Miller5428f641999-11-25 11:54:57 +1100108/*
109 * The directory in user\'s home directory in which the files reside. The
110 * directory should be world-readable (though not all files are).
111 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000112#define SSH_USER_DIR ".ssh"
113
Damien Miller5428f641999-11-25 11:54:57 +1100114/*
115 * Per-user file containing host keys of known hosts. This file need not be
116 * readable by anyone except the user him/herself, though this does not
117 * contain anything particularly secret.
118 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000119#define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
120
Damien Miller5428f641999-11-25 11:54:57 +1100121/*
122 * Name of the default file containing client-side authentication key. This
123 * file should only be readable by the user him/herself.
124 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000125#define SSH_CLIENT_IDENTITY ".ssh/identity"
126
Damien Miller5428f641999-11-25 11:54:57 +1100127/*
128 * Configuration file in user\'s home directory. This file need not be
129 * readable by anyone but the user him/herself, but does not contain anything
130 * particularly secret. If the user\'s home directory resides on an NFS
131 * volume where root is mapped to nobody, this may need to be world-readable.
132 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000133#define SSH_USER_CONFFILE ".ssh/config"
134
Damien Miller5428f641999-11-25 11:54:57 +1100135/*
136 * File containing a list of those rsa keys that permit logging in as this
137 * user. This file need not be readable by anyone but the user him/herself,
138 * but does not contain anything particularly secret. If the user\'s home
139 * directory resides on an NFS volume where root is mapped to nobody, this
140 * may need to be world-readable. (This file is read by the daemon which is
141 * running as root.)
142 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000143#define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
144
Damien Miller5428f641999-11-25 11:54:57 +1100145/*
146 * Per-user and system-wide ssh "rc" files. These files are executed with
147 * /bin/sh before starting the shell or command if they exist. They will be
148 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
149 * use. xauth will be run if neither of these exists.
150 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000151#define SSH_USER_RC ".ssh/rc"
152#define SSH_SYSTEM_RC ETCDIR "/sshrc"
153
Damien Miller5428f641999-11-25 11:54:57 +1100154/*
155 * Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
156 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
157 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000158#define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
159
Damien Miller5428f641999-11-25 11:54:57 +1100160/*
161 * Name of the environment variable containing the pathname of the
162 * authentication socket.
163 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000164#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
165
Damien Miller5428f641999-11-25 11:54:57 +1100166/*
167 * Name of the environment variable containing the pathname of the
168 * authentication socket.
169 */
Damien Miller32265091999-11-12 11:33:04 +1100170#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Miller5eeedae1999-10-29 10:21:15 +1000171
Damien Miller5428f641999-11-25 11:54:57 +1100172/*
Damien Milleraae6c611999-12-06 11:47:28 +1100173 * Default path to ssh-askpass used by ssh-add,
174 * environment variable for overwriting the default location
175 */
176#define SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
177#define SSH_ASKPASS_ENV "SSH_ASKPASS"
178
179/*
Damien Miller5428f641999-11-25 11:54:57 +1100180 * Force host key length and server key length to differ by at least this
181 * many bits. This is to make double encryption with rsaref work.
182 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000183#define SSH_KEY_BITS_RESERVED 128
184
Damien Miller5428f641999-11-25 11:54:57 +1100185/*
186 * Length of the session key in bytes. (Specified as 256 bits in the
187 * protocol.)
188 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000189#define SSH_SESSION_KEY_LENGTH 32
190
191/* Name of Kerberos service for SSH to use. */
192#define KRB4_SERVICE_NAME "rcmd"
193
Damien Miller5428f641999-11-25 11:54:57 +1100194/*
195 * Authentication methods. New types can be added, but old types should not
196 * be removed for compatibility. The maximum allowed value is 31.
197 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000198#define SSH_AUTH_RHOSTS 1
199#define SSH_AUTH_RSA 2
200#define SSH_AUTH_PASSWORD 3
201#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100202#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000203#define SSH_AUTH_KERBEROS 6
204#define SSH_PASS_KERBEROS_TGT 7
Damien Miller5428f641999-11-25 11:54:57 +1100205 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000206#define SSH_PASS_AFS_TOKEN 21
207
208/* Protocol flags. These are bit masks. */
Damien Miller5428f641999-11-25 11:54:57 +1100209#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */
210#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000211
Damien Miller5428f641999-11-25 11:54:57 +1100212/*
213 * Definition of message types. New values can be added, but old values
214 * should not be removed or without careful consideration of the consequences
215 * for compatibility. The maximum value is 254; value 255 is reserved for
216 * future extension.
217 */
218/* Message name */ /* msg code */ /* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000219#define SSH_MSG_NONE 0 /* no message */
220#define SSH_MSG_DISCONNECT 1 /* cause (string) */
221#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
222#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
223#define SSH_CMSG_USER 4 /* user (string) */
224#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
225#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
226#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
227#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
228#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
229#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
230#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
231#define SSH_CMSG_EXEC_SHELL 12 /* */
232#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
233#define SSH_SMSG_SUCCESS 14 /* */
234#define SSH_SMSG_FAILURE 15 /* */
235#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
236#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
237#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
238#define SSH_CMSG_EOF 19 /* */
239#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
240#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
241#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
242#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
243#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
244#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
245/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
246#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
247#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
248#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
249#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
250#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
251#define SSH_MSG_IGNORE 32 /* string */
252#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
253#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
254#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
255#define SSH_MSG_DEBUG 36 /* string */
256#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
257#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100258#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
259#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
260#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000261#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
262#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
263#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
264#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
265
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000266/*------------ definitions for login.c -------------*/
267
Damien Miller5428f641999-11-25 11:54:57 +1100268/*
269 * Returns the time when the user last logged in. Returns 0 if the
270 * information is not available. This must be called before record_login.
271 * The host from which the user logged in is stored in buf.
272 */
Damien Miller95def091999-11-25 00:26:21 +1100273unsigned long
274get_last_login_time(uid_t uid, const char *logname,
275 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000276
Damien Miller5428f641999-11-25 11:54:57 +1100277/*
278 * Records that the user has logged in. This does many things normally done
279 * by login(1).
280 */
Damien Miller95def091999-11-25 00:26:21 +1100281void
282record_login(int pid, const char *ttyname, const char *user, uid_t uid,
283 const char *host, struct sockaddr_in * addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000284
Damien Miller5428f641999-11-25 11:54:57 +1100285/*
286 * Records that the user has logged out. This does many thigs normally done
287 * by login(1) or init.
288 */
Damien Miller95def091999-11-25 00:26:21 +1100289void record_logout(int pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000290
291/*------------ definitions for sshconnect.c ----------*/
292
Damien Miller5428f641999-11-25 11:54:57 +1100293/*
294 * Opens a TCP/IP connection to the remote server on the given host. If port
295 * is 0, the default port will be used. If anonymous is zero, a privileged
296 * port will be allocated to make the connection. This requires super-user
297 * privileges if anonymous is false. Connection_attempts specifies the
298 * maximum number of tries, one per second. This returns true on success,
299 * and zero on failure. If the connection is successful, this calls
300 * packet_set_connection for the connection.
301 */
Damien Miller95def091999-11-25 00:26:21 +1100302int
303ssh_connect(const char *host, struct sockaddr_in * hostaddr,
Damien Milleraae6c611999-12-06 11:47:28 +1100304 u_short port, int connection_attempts,
Damien Miller95def091999-11-25 00:26:21 +1100305 int anonymous, uid_t original_real_uid,
306 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000307
Damien Miller5428f641999-11-25 11:54:57 +1100308/*
309 * Starts a dialog with the server, and authenticates the current user on the
310 * server. This does not need any extra privileges. The basic connection to
311 * the server must already have been established before this is called. If
312 * login fails, this function prints an error and never returns. This
313 * initializes the random state, and leaves it initialized (it will also have
314 * references from the packet module).
315 */
Damien Miller5ce662a1999-11-11 17:57:39 +1100316
Damien Miller95def091999-11-25 00:26:21 +1100317void
318ssh_login(int host_key_valid, RSA * host_key, const char *host,
319 struct sockaddr_in * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000320
321/*------------ Definitions for various authentication methods. -------*/
322
Damien Miller5428f641999-11-25 11:54:57 +1100323/*
324 * Tries to authenticate the user using the .rhosts file. Returns true if
325 * authentication succeeds. If ignore_rhosts is non-zero, this will not
326 * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
327 */
Damien Miller95def091999-11-25 00:26:21 +1100328int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000329
Damien Miller5428f641999-11-25 11:54:57 +1100330/*
331 * Tries to authenticate the user using the .rhosts file and the host using
332 * its host key. Returns true if authentication succeeds.
333 */
Damien Miller95def091999-11-25 00:26:21 +1100334int
335auth_rhosts_rsa(struct passwd * pw, const char *client_user,
336 BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000337
Damien Miller5428f641999-11-25 11:54:57 +1100338/*
339 * Tries to authenticate the user using password. Returns true if
340 * authentication succeeds.
341 */
Damien Miller95def091999-11-25 00:26:21 +1100342int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000343
Damien Miller5428f641999-11-25 11:54:57 +1100344/*
345 * Performs the RSA authentication dialog with the client. This returns 0 if
346 * the client could not be authenticated, and 1 if authentication was
347 * successful. This may exit if there is a serious protocol violation.
348 */
Damien Miller95def091999-11-25 00:26:21 +1100349int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000350
Damien Miller5428f641999-11-25 11:54:57 +1100351/*
352 * Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
353 * over the key. Skips any whitespace at the beginning and at end.
354 */
Damien Miller95def091999-11-25 00:26:21 +1100355int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000356
Damien Miller5428f641999-11-25 11:54:57 +1100357/*
358 * Returns the name of the machine at the other end of the socket. The
359 * returned string should be freed by the caller.
360 */
Damien Miller95def091999-11-25 00:26:21 +1100361char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000362
Damien Miller5428f641999-11-25 11:54:57 +1100363/*
364 * Return the canonical name of the host in the other side of the current
365 * connection (as returned by packet_get_connection). The host name is
366 * cached, so it is efficient to call this several times.
367 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000368const char *get_canonical_hostname(void);
369
Damien Miller5428f641999-11-25 11:54:57 +1100370/*
371 * Returns the remote IP address as an ascii string. The value need not be
372 * freed by the caller.
373 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000374const char *get_remote_ipaddr(void);
375
376/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100377int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000378
379/* Returns the port number of the remote host. */
Damien Miller95def091999-11-25 00:26:21 +1100380int get_remote_port(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000381
Damien Miller5428f641999-11-25 11:54:57 +1100382/*
383 * Tries to match the host name (which must be in all lowercase) against the
384 * comma-separated sequence of subpatterns (each possibly preceded by ! to
385 * indicate negation). Returns true if there is a positive match; zero
386 * otherwise.
387 */
Damien Miller95def091999-11-25 00:26:21 +1100388int match_hostname(const char *host, const char *pattern, unsigned int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000389
Damien Miller5428f641999-11-25 11:54:57 +1100390/*
391 * Checks whether the given host is already in the list of our known hosts.
392 * Returns HOST_OK if the host is known and has the specified key, HOST_NEW
393 * if the host is not known, and HOST_CHANGED if the host is known but used
394 * to have a different host key. The host must be in all lowercase.
395 */
Damien Miller95def091999-11-25 00:26:21 +1100396typedef enum {
397 HOST_OK, HOST_NEW, HOST_CHANGED
398} HostStatus;
399HostStatus
400check_host_in_hostfile(const char *filename, const char *host,
401 BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000402
Damien Miller5428f641999-11-25 11:54:57 +1100403/*
404 * Appends an entry to the host file. Returns false if the entry could not
405 * be appended.
406 */
Damien Miller95def091999-11-25 00:26:21 +1100407int
408add_host_to_hostfile(const char *filename, const char *host,
409 BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000410
Damien Miller5428f641999-11-25 11:54:57 +1100411/*
412 * Performs the RSA authentication challenge-response dialog with the client,
413 * and returns true (non-zero) if the client gave the correct answer to our
414 * challenge; returns zero if the client gives a wrong answer.
415 */
Damien Miller95def091999-11-25 00:26:21 +1100416int auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000417
Damien Miller5428f641999-11-25 11:54:57 +1100418/*
419 * Reads a passphrase from /dev/tty with echo turned off. Returns the
420 * passphrase (allocated with xmalloc). Exits if EOF is encountered. If
421 * from_stdin is true, the passphrase will be read from stdin instead.
422 */
Damien Miller95def091999-11-25 00:26:21 +1100423char *read_passphrase(const char *prompt, int from_stdin);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000424
Damien Miller5428f641999-11-25 11:54:57 +1100425/*
426 * Saves the authentication (private) key in a file, encrypting it with
427 * passphrase. The identification of the file (lowest 64 bits of n) will
428 * precede the key to provide identification of the key without needing a
429 * passphrase.
430 */
Damien Miller95def091999-11-25 00:26:21 +1100431int
432save_private_key(const char *filename, const char *passphrase,
433 RSA * private_key, const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000434
Damien Miller5428f641999-11-25 11:54:57 +1100435/*
436 * Loads the public part of the key file (public key and comment). Returns 0
437 * if an error occurred; zero if the public key was successfully read. The
438 * comment of the key is returned in comment_return if it is non-NULL; the
439 * caller must free the value with xfree.
440 */
Damien Miller95def091999-11-25 00:26:21 +1100441int
442load_public_key(const char *filename, RSA * pub,
443 char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000444
Damien Miller5428f641999-11-25 11:54:57 +1100445/*
446 * Loads the private key from the file. Returns 0 if an error is encountered
447 * (file does not exist or is not readable, or passphrase is bad). This
448 * initializes the private key. The comment of the key is returned in
449 * comment_return if it is non-NULL; the caller must free the value with
450 * xfree.
451 */
Damien Miller95def091999-11-25 00:26:21 +1100452int
453load_private_key(const char *filename, const char *passphrase,
454 RSA * private_key, char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000455
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100456/*------------ Definitions for logging. -----------------------*/
457
458/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100459typedef enum {
460 SYSLOG_FACILITY_DAEMON,
461 SYSLOG_FACILITY_USER,
462 SYSLOG_FACILITY_AUTH,
463 SYSLOG_FACILITY_LOCAL0,
464 SYSLOG_FACILITY_LOCAL1,
465 SYSLOG_FACILITY_LOCAL2,
466 SYSLOG_FACILITY_LOCAL3,
467 SYSLOG_FACILITY_LOCAL4,
468 SYSLOG_FACILITY_LOCAL5,
469 SYSLOG_FACILITY_LOCAL6,
470 SYSLOG_FACILITY_LOCAL7
471} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100472
Damien Miller95def091999-11-25 00:26:21 +1100473typedef enum {
474 SYSLOG_LEVEL_QUIET,
475 SYSLOG_LEVEL_FATAL,
476 SYSLOG_LEVEL_ERROR,
477 SYSLOG_LEVEL_INFO,
478 SYSLOG_LEVEL_VERBOSE,
479 SYSLOG_LEVEL_DEBUG
480} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100481/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100482void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100483
484/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100485void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100486
Damien Miller6162d121999-11-21 13:23:52 +1100487/* name to facility/level */
488SyslogFacility log_facility_number(char *name);
489LogLevel log_level_number(char *name);
490
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100491/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100492void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
493void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
494void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
495void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
496void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100497
498/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100499void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100500
Damien Miller5428f641999-11-25 11:54:57 +1100501/*
502 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
503 * before exiting. It is permissible to call fatal_remove_cleanup for the
504 * function itself from the function.
505 */
Damien Miller95def091999-11-25 00:26:21 +1100506void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100507
508/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100509void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100510
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000511/*---------------- definitions for channels ------------------*/
512
513/* Sets specific protocol options. */
Damien Miller95def091999-11-25 00:26:21 +1100514void channel_set_options(int hostname_in_open);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000515
Damien Miller5428f641999-11-25 11:54:57 +1100516/*
517 * Allocate a new channel object and set its type and socket. Remote_name
518 * must have been allocated with xmalloc; this will free it when the channel
519 * is freed.
520 */
Damien Miller95def091999-11-25 00:26:21 +1100521int channel_allocate(int type, int sock, char *remote_name);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000522
523/* Free the channel and close its socket. */
Damien Miller95def091999-11-25 00:26:21 +1100524void channel_free(int channel);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000525
526/* Add any bits relevant to channels in select bitmasks. */
Damien Miller95def091999-11-25 00:26:21 +1100527void channel_prepare_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000528
Damien Miller5428f641999-11-25 11:54:57 +1100529/*
530 * After select, perform any appropriate operations for channels which have
531 * events pending.
532 */
Damien Miller95def091999-11-25 00:26:21 +1100533void channel_after_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000534
535/* If there is data to send to the connection, send some of it now. */
Damien Miller95def091999-11-25 00:26:21 +1100536void channel_output_poll(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000537
Damien Miller5428f641999-11-25 11:54:57 +1100538/*
539 * This is called when a packet of type CHANNEL_DATA has just been received.
540 * The message type has already been consumed, but channel number and data is
541 * still there.
542 */
Damien Miller95def091999-11-25 00:26:21 +1100543void channel_input_data(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000544
545/* Returns true if no channel has too much buffered data. */
Damien Miller95def091999-11-25 00:26:21 +1100546int channel_not_very_much_buffered_data(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000547
548/* This is called after receiving CHANNEL_CLOSE. */
Damien Miller95def091999-11-25 00:26:21 +1100549void channel_input_close(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000550
551/* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100552void channel_input_close_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000553
554/* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100555void channel_input_open_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000556
557/* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
Damien Miller95def091999-11-25 00:26:21 +1100558void channel_input_open_failure(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000559
560/* This closes any sockets that are listening for connections; this removes
561 any unix domain sockets. */
Damien Miller95def091999-11-25 00:26:21 +1100562void channel_stop_listening(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000563
Damien Miller5428f641999-11-25 11:54:57 +1100564/*
565 * Closes the sockets of all channels. This is used to close extra file
566 * descriptors after a fork.
567 */
Damien Miller95def091999-11-25 00:26:21 +1100568void channel_close_all(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000569
570/* Returns the maximum file descriptor number used by the channels. */
Damien Miller95def091999-11-25 00:26:21 +1100571int channel_max_fd(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000572
573/* Returns true if there is still an open channel over the connection. */
Damien Miller95def091999-11-25 00:26:21 +1100574int channel_still_open(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000575
Damien Miller5428f641999-11-25 11:54:57 +1100576/*
577 * Returns a string containing a list of all open channels. The list is
578 * suitable for displaying to the user. It uses crlf instead of newlines.
579 * The caller should free the string with xfree.
580 */
Damien Miller95def091999-11-25 00:26:21 +1100581char *channel_open_message(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000582
Damien Miller5428f641999-11-25 11:54:57 +1100583/*
584 * Initiate forwarding of connections to local port "port" through the secure
585 * channel to host:port from remote side. This never returns if there was an
586 * error.
587 */
Damien Miller95def091999-11-25 00:26:21 +1100588void
Damien Milleraae6c611999-12-06 11:47:28 +1100589channel_request_local_forwarding(u_short port, const char *host,
590 u_short remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000591
Damien Miller5428f641999-11-25 11:54:57 +1100592/*
593 * Initiate forwarding of connections to port "port" on remote host through
594 * the secure channel to host:port from local side. This never returns if
595 * there was an error. This registers that open requests for that port are
596 * permitted.
597 */
Damien Miller95def091999-11-25 00:26:21 +1100598void
Damien Milleraae6c611999-12-06 11:47:28 +1100599channel_request_remote_forwarding(u_short port, const char *host,
600 u_short remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000601
Damien Miller5428f641999-11-25 11:54:57 +1100602/*
603 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
604 * called by the server, because the user could connect to any port anyway,
605 * and the server has no way to know but to trust the client anyway.
606 */
Damien Miller95def091999-11-25 00:26:21 +1100607void channel_permit_all_opens(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000608
Damien Miller5428f641999-11-25 11:54:57 +1100609/*
610 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
611 * listening for the port, and sends back a success reply (or disconnect
612 * message if there was an error). This never returns if there was an error.
613 */
Damien Miller95def091999-11-25 00:26:21 +1100614void channel_input_port_forward_request(int is_root);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000615
Damien Miller5428f641999-11-25 11:54:57 +1100616/*
617 * This is called after receiving PORT_OPEN message. This attempts to
618 * connect to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION
619 * or CHANNEL_OPEN_FAILURE.
620 */
Damien Miller95def091999-11-25 00:26:21 +1100621void channel_input_port_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000622
Damien Miller5428f641999-11-25 11:54:57 +1100623/*
624 * Creates a port for X11 connections, and starts listening for it. Returns
625 * the display name, or NULL if an error was encountered.
626 */
Damien Miller95def091999-11-25 00:26:21 +1100627char *x11_create_display(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000628
Damien Miller5428f641999-11-25 11:54:57 +1100629/*
630 * Creates an internet domain socket for listening for X11 connections.
631 * Returns a suitable value for the DISPLAY variable, or NULL if an error
632 * occurs.
633 */
Damien Miller95def091999-11-25 00:26:21 +1100634char *x11_create_display_inet(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000635
Damien Miller5428f641999-11-25 11:54:57 +1100636/*
637 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
638 * the remote channel number. We should do whatever we want, and respond
639 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
640 */
Damien Miller95def091999-11-25 00:26:21 +1100641void x11_input_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000642
Damien Miller5428f641999-11-25 11:54:57 +1100643/*
644 * Requests forwarding of X11 connections. This should be called on the
645 * client only.
646 */
Damien Miller95def091999-11-25 00:26:21 +1100647void x11_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000648
Damien Miller5428f641999-11-25 11:54:57 +1100649/*
650 * Requests forwarding for X11 connections, with authentication spoofing.
651 * This should be called in the client only.
652 */
Damien Miller95def091999-11-25 00:26:21 +1100653void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000654
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000655/* Sends a message to the server to request authentication fd forwarding. */
Damien Miller95def091999-11-25 00:26:21 +1100656void auth_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000657
Damien Miller5428f641999-11-25 11:54:57 +1100658/*
659 * Returns the name of the forwarded authentication socket. Returns NULL if
660 * there is no forwarded authentication socket. The returned value points to
661 * a static buffer.
662 */
Damien Miller95def091999-11-25 00:26:21 +1100663char *auth_get_socket_name(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000664
Damien Miller5428f641999-11-25 11:54:57 +1100665/*
666 * This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
667 * This starts forwarding authentication requests.
668 */
Damien Miller95def091999-11-25 00:26:21 +1100669void auth_input_request_forwarding(struct passwd * pw);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000670
671/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
Damien Miller95def091999-11-25 00:26:21 +1100672void auth_input_open_request(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000673
Damien Miller5428f641999-11-25 11:54:57 +1100674/*
675 * Returns true if the given string matches the pattern (which may contain ?
676 * and * as wildcards), and zero if it does not match.
677 */
Damien Miller95def091999-11-25 00:26:21 +1100678int match_pattern(const char *s, const char *pattern);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000679
Damien Miller5428f641999-11-25 11:54:57 +1100680/*
681 * Expands tildes in the file name. Returns data allocated by xmalloc.
682 * Warning: this calls getpw*.
683 */
Damien Miller95def091999-11-25 00:26:21 +1100684char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000685
Damien Miller5428f641999-11-25 11:54:57 +1100686/*
687 * Performs the interactive session. This handles data transmission between
688 * the client and the program. Note that the notion of stdin, stdout, and
689 * stderr in this function is sort of reversed: this function writes to stdin
690 * (of the child program), and reads from stdout and stderr (of the child
691 * program).
692 */
Damien Miller95def091999-11-25 00:26:21 +1100693void server_loop(int pid, int fdin, int fdout, int fderr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000694
695/* Client side main loop for the interactive session. */
Damien Miller95def091999-11-25 00:26:21 +1100696int client_loop(int have_pty, int escape_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000697
698/* Linked list of custom environment strings (see auth-rsa.c). */
699struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100700 struct envstring *next;
701 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000702};
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000703#ifdef KRB4
704#include <krb.h>
705
Damien Miller5428f641999-11-25 11:54:57 +1100706/*
707 * Performs Kerberos v4 mutual authentication with the client. This returns 0
708 * if the client could not be authenticated, and 1 if authentication was
709 * successful. This may exit if there is a serious protocol violation.
710 */
Damien Miller95def091999-11-25 00:26:21 +1100711int auth_krb4(const char *server_user, KTEXT auth, char **client);
712int krb4_init(uid_t uid);
713void krb4_cleanup_proc(void *ignore);
Damien Milleraae6c611999-12-06 11:47:28 +1100714int auth_krb4_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000715
716#ifdef AFS
717#include <kafs.h>
718
719/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100720int auth_kerberos_tgt(struct passwd * pw, const char *string);
721int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000722
Damien Miller95def091999-11-25 00:26:21 +1100723int creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
724int radix_to_creds(const char *buf, CREDENTIALS * creds);
725#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000726
Damien Miller95def091999-11-25 00:26:21 +1100727#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000728
729#ifdef SKEY
730#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100731char *skey_fake_keyinfo(char *username);
Damien Milleraae6c611999-12-06 11:47:28 +1100732int auth_skey_password(struct passwd * pw, const char *password);
Damien Miller95def091999-11-25 00:26:21 +1100733#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000734
Damien Miller95def091999-11-25 00:26:21 +1100735#endif /* SSH_H */