blob: e3fed053ed7ca4f2a7f324034bfaa00d9174d889 [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 Miller5428f641999-11-25 11:54:57 +110016/* RCSID("$Id: ssh.h,v 1.16 1999/11/25 00:54:59 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/*
173 * Force host key length and server key length to differ by at least this
174 * many bits. This is to make double encryption with rsaref work.
175 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000176#define SSH_KEY_BITS_RESERVED 128
177
Damien Miller5428f641999-11-25 11:54:57 +1100178/*
179 * Length of the session key in bytes. (Specified as 256 bits in the
180 * protocol.)
181 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000182#define SSH_SESSION_KEY_LENGTH 32
183
184/* Name of Kerberos service for SSH to use. */
185#define KRB4_SERVICE_NAME "rcmd"
186
Damien Miller5428f641999-11-25 11:54:57 +1100187/*
188 * Authentication methods. New types can be added, but old types should not
189 * be removed for compatibility. The maximum allowed value is 31.
190 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000191#define SSH_AUTH_RHOSTS 1
192#define SSH_AUTH_RSA 2
193#define SSH_AUTH_PASSWORD 3
194#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100195#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000196#define SSH_AUTH_KERBEROS 6
197#define SSH_PASS_KERBEROS_TGT 7
Damien Miller5428f641999-11-25 11:54:57 +1100198 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000199#define SSH_PASS_AFS_TOKEN 21
200
201/* Protocol flags. These are bit masks. */
Damien Miller5428f641999-11-25 11:54:57 +1100202#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */
203#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000204
Damien Miller5428f641999-11-25 11:54:57 +1100205/*
206 * Definition of message types. New values can be added, but old values
207 * should not be removed or without careful consideration of the consequences
208 * for compatibility. The maximum value is 254; value 255 is reserved for
209 * future extension.
210 */
211/* Message name */ /* msg code */ /* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000212#define SSH_MSG_NONE 0 /* no message */
213#define SSH_MSG_DISCONNECT 1 /* cause (string) */
214#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
215#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
216#define SSH_CMSG_USER 4 /* user (string) */
217#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
218#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
219#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
220#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
221#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
222#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
223#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
224#define SSH_CMSG_EXEC_SHELL 12 /* */
225#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
226#define SSH_SMSG_SUCCESS 14 /* */
227#define SSH_SMSG_FAILURE 15 /* */
228#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
229#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
230#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
231#define SSH_CMSG_EOF 19 /* */
232#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
233#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
234#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
235#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
236#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
237#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
238/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
239#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
240#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
241#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
242#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
243#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
244#define SSH_MSG_IGNORE 32 /* string */
245#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
246#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
247#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
248#define SSH_MSG_DEBUG 36 /* string */
249#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
250#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100251#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
252#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
253#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000254#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
255#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
256#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
257#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
258
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000259/*------------ definitions for login.c -------------*/
260
Damien Miller5428f641999-11-25 11:54:57 +1100261/*
262 * Returns the time when the user last logged in. Returns 0 if the
263 * information is not available. This must be called before record_login.
264 * The host from which the user logged in is stored in buf.
265 */
Damien Miller95def091999-11-25 00:26:21 +1100266unsigned long
267get_last_login_time(uid_t uid, const char *logname,
268 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000269
Damien Miller5428f641999-11-25 11:54:57 +1100270/*
271 * Records that the user has logged in. This does many things normally done
272 * by login(1).
273 */
Damien Miller95def091999-11-25 00:26:21 +1100274void
275record_login(int pid, const char *ttyname, const char *user, uid_t uid,
276 const char *host, struct sockaddr_in * addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000277
Damien Miller5428f641999-11-25 11:54:57 +1100278/*
279 * Records that the user has logged out. This does many thigs normally done
280 * by login(1) or init.
281 */
Damien Miller95def091999-11-25 00:26:21 +1100282void record_logout(int pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000283
284/*------------ definitions for sshconnect.c ----------*/
285
Damien Miller5428f641999-11-25 11:54:57 +1100286/*
287 * Opens a TCP/IP connection to the remote server on the given host. If port
288 * is 0, the default port will be used. If anonymous is zero, a privileged
289 * port will be allocated to make the connection. This requires super-user
290 * privileges if anonymous is false. Connection_attempts specifies the
291 * maximum number of tries, one per second. This returns true on success,
292 * and zero on failure. If the connection is successful, this calls
293 * packet_set_connection for the connection.
294 */
Damien Miller95def091999-11-25 00:26:21 +1100295int
296ssh_connect(const char *host, struct sockaddr_in * hostaddr,
297 int port, int connection_attempts,
298 int anonymous, uid_t original_real_uid,
299 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000300
Damien Miller5428f641999-11-25 11:54:57 +1100301/*
302 * Starts a dialog with the server, and authenticates the current user on the
303 * server. This does not need any extra privileges. The basic connection to
304 * the server must already have been established before this is called. If
305 * login fails, this function prints an error and never returns. This
306 * initializes the random state, and leaves it initialized (it will also have
307 * references from the packet module).
308 */
Damien Miller5ce662a1999-11-11 17:57:39 +1100309
Damien Miller95def091999-11-25 00:26:21 +1100310void
311ssh_login(int host_key_valid, RSA * host_key, const char *host,
312 struct sockaddr_in * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000313
314/*------------ Definitions for various authentication methods. -------*/
315
Damien Miller5428f641999-11-25 11:54:57 +1100316/*
317 * Tries to authenticate the user using the .rhosts file. Returns true if
318 * authentication succeeds. If ignore_rhosts is non-zero, this will not
319 * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
320 */
Damien Miller95def091999-11-25 00:26:21 +1100321int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000322
Damien Miller5428f641999-11-25 11:54:57 +1100323/*
324 * Tries to authenticate the user using the .rhosts file and the host using
325 * its host key. Returns true if authentication succeeds.
326 */
Damien Miller95def091999-11-25 00:26:21 +1100327int
328auth_rhosts_rsa(struct passwd * pw, const char *client_user,
329 BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000330
Damien Miller5428f641999-11-25 11:54:57 +1100331/*
332 * Tries to authenticate the user using password. Returns true if
333 * authentication succeeds.
334 */
Damien Miller95def091999-11-25 00:26:21 +1100335int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000336
Damien Miller5428f641999-11-25 11:54:57 +1100337/*
338 * Performs the RSA authentication dialog with the client. This returns 0 if
339 * the client could not be authenticated, and 1 if authentication was
340 * successful. This may exit if there is a serious protocol violation.
341 */
Damien Miller95def091999-11-25 00:26:21 +1100342int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000343
Damien Miller5428f641999-11-25 11:54:57 +1100344/*
345 * Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
346 * over the key. Skips any whitespace at the beginning and at end.
347 */
Damien Miller95def091999-11-25 00:26:21 +1100348int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000349
Damien Miller5428f641999-11-25 11:54:57 +1100350/*
351 * Returns the name of the machine at the other end of the socket. The
352 * returned string should be freed by the caller.
353 */
Damien Miller95def091999-11-25 00:26:21 +1100354char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000355
Damien Miller5428f641999-11-25 11:54:57 +1100356/*
357 * Return the canonical name of the host in the other side of the current
358 * connection (as returned by packet_get_connection). The host name is
359 * cached, so it is efficient to call this several times.
360 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000361const char *get_canonical_hostname(void);
362
Damien Miller5428f641999-11-25 11:54:57 +1100363/*
364 * Returns the remote IP address as an ascii string. The value need not be
365 * freed by the caller.
366 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000367const char *get_remote_ipaddr(void);
368
369/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100370int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000371
372/* Returns the port number of the remote host. */
Damien Miller95def091999-11-25 00:26:21 +1100373int get_remote_port(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000374
Damien Miller5428f641999-11-25 11:54:57 +1100375/*
376 * Tries to match the host name (which must be in all lowercase) against the
377 * comma-separated sequence of subpatterns (each possibly preceded by ! to
378 * indicate negation). Returns true if there is a positive match; zero
379 * otherwise.
380 */
Damien Miller95def091999-11-25 00:26:21 +1100381int match_hostname(const char *host, const char *pattern, unsigned int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000382
Damien Miller5428f641999-11-25 11:54:57 +1100383/*
384 * Checks whether the given host is already in the list of our known hosts.
385 * Returns HOST_OK if the host is known and has the specified key, HOST_NEW
386 * if the host is not known, and HOST_CHANGED if the host is known but used
387 * to have a different host key. The host must be in all lowercase.
388 */
Damien Miller95def091999-11-25 00:26:21 +1100389typedef enum {
390 HOST_OK, HOST_NEW, HOST_CHANGED
391} HostStatus;
392HostStatus
393check_host_in_hostfile(const char *filename, const char *host,
394 BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000395
Damien Miller5428f641999-11-25 11:54:57 +1100396/*
397 * Appends an entry to the host file. Returns false if the entry could not
398 * be appended.
399 */
Damien Miller95def091999-11-25 00:26:21 +1100400int
401add_host_to_hostfile(const char *filename, const char *host,
402 BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000403
Damien Miller5428f641999-11-25 11:54:57 +1100404/*
405 * Performs the RSA authentication challenge-response dialog with the client,
406 * and returns true (non-zero) if the client gave the correct answer to our
407 * challenge; returns zero if the client gives a wrong answer.
408 */
Damien Miller95def091999-11-25 00:26:21 +1100409int auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000410
Damien Miller5428f641999-11-25 11:54:57 +1100411/*
412 * Reads a passphrase from /dev/tty with echo turned off. Returns the
413 * passphrase (allocated with xmalloc). Exits if EOF is encountered. If
414 * from_stdin is true, the passphrase will be read from stdin instead.
415 */
Damien Miller95def091999-11-25 00:26:21 +1100416char *read_passphrase(const char *prompt, int from_stdin);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000417
Damien Miller5428f641999-11-25 11:54:57 +1100418/*
419 * Saves the authentication (private) key in a file, encrypting it with
420 * passphrase. The identification of the file (lowest 64 bits of n) will
421 * precede the key to provide identification of the key without needing a
422 * passphrase.
423 */
Damien Miller95def091999-11-25 00:26:21 +1100424int
425save_private_key(const char *filename, const char *passphrase,
426 RSA * private_key, const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000427
Damien Miller5428f641999-11-25 11:54:57 +1100428/*
429 * Loads the public part of the key file (public key and comment). Returns 0
430 * if an error occurred; zero if the public key was successfully read. The
431 * comment of the key is returned in comment_return if it is non-NULL; the
432 * caller must free the value with xfree.
433 */
Damien Miller95def091999-11-25 00:26:21 +1100434int
435load_public_key(const char *filename, RSA * pub,
436 char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000437
Damien Miller5428f641999-11-25 11:54:57 +1100438/*
439 * Loads the private key from the file. Returns 0 if an error is encountered
440 * (file does not exist or is not readable, or passphrase is bad). This
441 * initializes the private key. The comment of the key is returned in
442 * comment_return if it is non-NULL; the caller must free the value with
443 * xfree.
444 */
Damien Miller95def091999-11-25 00:26:21 +1100445int
446load_private_key(const char *filename, const char *passphrase,
447 RSA * private_key, char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000448
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100449/*------------ Definitions for logging. -----------------------*/
450
451/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100452typedef enum {
453 SYSLOG_FACILITY_DAEMON,
454 SYSLOG_FACILITY_USER,
455 SYSLOG_FACILITY_AUTH,
456 SYSLOG_FACILITY_LOCAL0,
457 SYSLOG_FACILITY_LOCAL1,
458 SYSLOG_FACILITY_LOCAL2,
459 SYSLOG_FACILITY_LOCAL3,
460 SYSLOG_FACILITY_LOCAL4,
461 SYSLOG_FACILITY_LOCAL5,
462 SYSLOG_FACILITY_LOCAL6,
463 SYSLOG_FACILITY_LOCAL7
464} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100465
Damien Miller95def091999-11-25 00:26:21 +1100466typedef enum {
467 SYSLOG_LEVEL_QUIET,
468 SYSLOG_LEVEL_FATAL,
469 SYSLOG_LEVEL_ERROR,
470 SYSLOG_LEVEL_INFO,
471 SYSLOG_LEVEL_VERBOSE,
472 SYSLOG_LEVEL_DEBUG
473} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100474/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100475void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100476
477/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100478void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100479
Damien Miller6162d121999-11-21 13:23:52 +1100480/* name to facility/level */
481SyslogFacility log_facility_number(char *name);
482LogLevel log_level_number(char *name);
483
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100484/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100485void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
486void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
487void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
488void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
489void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100490
491/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100492void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100493
Damien Miller5428f641999-11-25 11:54:57 +1100494/*
495 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
496 * before exiting. It is permissible to call fatal_remove_cleanup for the
497 * function itself from the function.
498 */
Damien Miller95def091999-11-25 00:26:21 +1100499void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100500
501/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100502void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100503
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000504/*---------------- definitions for channels ------------------*/
505
506/* Sets specific protocol options. */
Damien Miller95def091999-11-25 00:26:21 +1100507void channel_set_options(int hostname_in_open);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000508
Damien Miller5428f641999-11-25 11:54:57 +1100509/*
510 * Allocate a new channel object and set its type and socket. Remote_name
511 * must have been allocated with xmalloc; this will free it when the channel
512 * is freed.
513 */
Damien Miller95def091999-11-25 00:26:21 +1100514int channel_allocate(int type, int sock, char *remote_name);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000515
516/* Free the channel and close its socket. */
Damien Miller95def091999-11-25 00:26:21 +1100517void channel_free(int channel);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000518
519/* Add any bits relevant to channels in select bitmasks. */
Damien Miller95def091999-11-25 00:26:21 +1100520void channel_prepare_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000521
Damien Miller5428f641999-11-25 11:54:57 +1100522/*
523 * After select, perform any appropriate operations for channels which have
524 * events pending.
525 */
Damien Miller95def091999-11-25 00:26:21 +1100526void channel_after_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000527
528/* If there is data to send to the connection, send some of it now. */
Damien Miller95def091999-11-25 00:26:21 +1100529void channel_output_poll(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000530
Damien Miller5428f641999-11-25 11:54:57 +1100531/*
532 * This is called when a packet of type CHANNEL_DATA has just been received.
533 * The message type has already been consumed, but channel number and data is
534 * still there.
535 */
Damien Miller95def091999-11-25 00:26:21 +1100536void channel_input_data(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000537
538/* Returns true if no channel has too much buffered data. */
Damien Miller95def091999-11-25 00:26:21 +1100539int channel_not_very_much_buffered_data(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000540
541/* This is called after receiving CHANNEL_CLOSE. */
Damien Miller95def091999-11-25 00:26:21 +1100542void channel_input_close(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000543
544/* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100545void channel_input_close_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000546
547/* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100548void channel_input_open_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000549
550/* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
Damien Miller95def091999-11-25 00:26:21 +1100551void channel_input_open_failure(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000552
553/* This closes any sockets that are listening for connections; this removes
554 any unix domain sockets. */
Damien Miller95def091999-11-25 00:26:21 +1100555void channel_stop_listening(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000556
Damien Miller5428f641999-11-25 11:54:57 +1100557/*
558 * Closes the sockets of all channels. This is used to close extra file
559 * descriptors after a fork.
560 */
Damien Miller95def091999-11-25 00:26:21 +1100561void channel_close_all(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000562
563/* Returns the maximum file descriptor number used by the channels. */
Damien Miller95def091999-11-25 00:26:21 +1100564int channel_max_fd(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000565
566/* Returns true if there is still an open channel over the connection. */
Damien Miller95def091999-11-25 00:26:21 +1100567int channel_still_open(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000568
Damien Miller5428f641999-11-25 11:54:57 +1100569/*
570 * Returns a string containing a list of all open channels. The list is
571 * suitable for displaying to the user. It uses crlf instead of newlines.
572 * The caller should free the string with xfree.
573 */
Damien Miller95def091999-11-25 00:26:21 +1100574char *channel_open_message(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000575
Damien Miller5428f641999-11-25 11:54:57 +1100576/*
577 * Initiate forwarding of connections to local port "port" through the secure
578 * channel to host:port from remote side. This never returns if there was an
579 * error.
580 */
Damien Miller95def091999-11-25 00:26:21 +1100581void
582channel_request_local_forwarding(int port, const char *host,
583 int remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000584
Damien Miller5428f641999-11-25 11:54:57 +1100585/*
586 * Initiate forwarding of connections to port "port" on remote host through
587 * the secure channel to host:port from local side. This never returns if
588 * there was an error. This registers that open requests for that port are
589 * permitted.
590 */
Damien Miller95def091999-11-25 00:26:21 +1100591void
592channel_request_remote_forwarding(int port, const char *host,
593 int remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000594
Damien Miller5428f641999-11-25 11:54:57 +1100595/*
596 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
597 * called by the server, because the user could connect to any port anyway,
598 * and the server has no way to know but to trust the client anyway.
599 */
Damien Miller95def091999-11-25 00:26:21 +1100600void channel_permit_all_opens(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000601
Damien Miller5428f641999-11-25 11:54:57 +1100602/*
603 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
604 * listening for the port, and sends back a success reply (or disconnect
605 * message if there was an error). This never returns if there was an error.
606 */
Damien Miller95def091999-11-25 00:26:21 +1100607void channel_input_port_forward_request(int is_root);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000608
Damien Miller5428f641999-11-25 11:54:57 +1100609/*
610 * This is called after receiving PORT_OPEN message. This attempts to
611 * connect to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION
612 * or CHANNEL_OPEN_FAILURE.
613 */
Damien Miller95def091999-11-25 00:26:21 +1100614void channel_input_port_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000615
Damien Miller5428f641999-11-25 11:54:57 +1100616/*
617 * Creates a port for X11 connections, and starts listening for it. Returns
618 * the display name, or NULL if an error was encountered.
619 */
Damien Miller95def091999-11-25 00:26:21 +1100620char *x11_create_display(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000621
Damien Miller5428f641999-11-25 11:54:57 +1100622/*
623 * Creates an internet domain socket for listening for X11 connections.
624 * Returns a suitable value for the DISPLAY variable, or NULL if an error
625 * occurs.
626 */
Damien Miller95def091999-11-25 00:26:21 +1100627char *x11_create_display_inet(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000628
Damien Miller5428f641999-11-25 11:54:57 +1100629/*
630 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
631 * the remote channel number. We should do whatever we want, and respond
632 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
633 */
Damien Miller95def091999-11-25 00:26:21 +1100634void x11_input_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000635
Damien Miller5428f641999-11-25 11:54:57 +1100636/*
637 * Requests forwarding of X11 connections. This should be called on the
638 * client only.
639 */
Damien Miller95def091999-11-25 00:26:21 +1100640void x11_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000641
Damien Miller5428f641999-11-25 11:54:57 +1100642/*
643 * Requests forwarding for X11 connections, with authentication spoofing.
644 * This should be called in the client only.
645 */
Damien Miller95def091999-11-25 00:26:21 +1100646void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000647
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000648/* Sends a message to the server to request authentication fd forwarding. */
Damien Miller95def091999-11-25 00:26:21 +1100649void auth_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000650
Damien Miller5428f641999-11-25 11:54:57 +1100651/*
652 * Returns the name of the forwarded authentication socket. Returns NULL if
653 * there is no forwarded authentication socket. The returned value points to
654 * a static buffer.
655 */
Damien Miller95def091999-11-25 00:26:21 +1100656char *auth_get_socket_name(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000657
Damien Miller5428f641999-11-25 11:54:57 +1100658/*
659 * This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
660 * This starts forwarding authentication requests.
661 */
Damien Miller95def091999-11-25 00:26:21 +1100662void auth_input_request_forwarding(struct passwd * pw);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000663
664/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
Damien Miller95def091999-11-25 00:26:21 +1100665void auth_input_open_request(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000666
Damien Miller5428f641999-11-25 11:54:57 +1100667/*
668 * Returns true if the given string matches the pattern (which may contain ?
669 * and * as wildcards), and zero if it does not match.
670 */
Damien Miller95def091999-11-25 00:26:21 +1100671int match_pattern(const char *s, const char *pattern);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000672
Damien Miller5428f641999-11-25 11:54:57 +1100673/*
674 * Expands tildes in the file name. Returns data allocated by xmalloc.
675 * Warning: this calls getpw*.
676 */
Damien Miller95def091999-11-25 00:26:21 +1100677char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000678
Damien Miller5428f641999-11-25 11:54:57 +1100679/*
680 * Performs the interactive session. This handles data transmission between
681 * the client and the program. Note that the notion of stdin, stdout, and
682 * stderr in this function is sort of reversed: this function writes to stdin
683 * (of the child program), and reads from stdout and stderr (of the child
684 * program).
685 */
Damien Miller95def091999-11-25 00:26:21 +1100686void server_loop(int pid, int fdin, int fdout, int fderr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000687
688/* Client side main loop for the interactive session. */
Damien Miller95def091999-11-25 00:26:21 +1100689int client_loop(int have_pty, int escape_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000690
691/* Linked list of custom environment strings (see auth-rsa.c). */
692struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100693 struct envstring *next;
694 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000695};
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000696#ifdef KRB4
697#include <krb.h>
698
Damien Miller5428f641999-11-25 11:54:57 +1100699/*
700 * Performs Kerberos v4 mutual authentication with the client. This returns 0
701 * if the client could not be authenticated, and 1 if authentication was
702 * successful. This may exit if there is a serious protocol violation.
703 */
Damien Miller95def091999-11-25 00:26:21 +1100704int auth_krb4(const char *server_user, KTEXT auth, char **client);
705int krb4_init(uid_t uid);
706void krb4_cleanup_proc(void *ignore);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000707
708#ifdef AFS
709#include <kafs.h>
710
711/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100712int auth_kerberos_tgt(struct passwd * pw, const char *string);
713int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000714
Damien Miller95def091999-11-25 00:26:21 +1100715int creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
716int radix_to_creds(const char *buf, CREDENTIALS * creds);
717#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000718
Damien Miller95def091999-11-25 00:26:21 +1100719#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000720
721#ifdef SKEY
722#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100723char *skey_fake_keyinfo(char *username);
724#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000725
Damien Miller95def091999-11-25 00:26:21 +1100726#endif /* SSH_H */