blob: f3f049fccfaeaf2606a1e8a8cd1410ac52e5b109 [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller4af51302000-04-16 11:18:38 +10002 *
Damien Miller95def091999-11-25 00:26:21 +11003 * ssh.h
Damien Miller4af51302000-04-16 11:18:38 +10004 *
Damien Miller95def091999-11-25 00:26:21 +11005 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Miller95def091999-11-25 00:26:21 +11007 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 * All rights reserved
Damien Miller4af51302000-04-16 11:18:38 +10009 *
Damien Miller95def091999-11-25 00:26:21 +110010 * Created: Fri Mar 17 17:09:37 1995 ylo
Damien Miller4af51302000-04-16 11:18:38 +100011 *
Damien Miller95def091999-11-25 00:26:21 +110012 * Generic header file for ssh.
Damien Miller4af51302000-04-16 11:18:38 +100013 *
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerbe484b52000-07-15 14:14:16 +100016/* RCSID("$OpenBSD: ssh.h,v 1.48 2000/07/13 22:53:21 provos 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/*
Damien Miller30c3d422000-05-09 11:02:59 +100033 * XXX
Damien Miller5428f641999-11-25 11:54:57 +110034 * The default cipher used if IDEA is not supported by the remote host. It is
35 * recommended that this be one of the mandatory ciphers (DES, 3DES), though
36 * that is not required.
37 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100038#define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
39
40/* Cipher used for encrypting authentication files. */
41#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
42
43/* Default port number. */
44#define SSH_DEFAULT_PORT 22
45
46/* Maximum number of TCP/IP ports forwarded per direction. */
47#define SSH_MAX_FORWARDS_PER_DIRECTION 100
48
Damien Miller5428f641999-11-25 11:54:57 +110049/*
50 * Maximum number of RSA authentication identity files that can be specified
51 * in configuration files or on the command line.
52 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100053#define SSH_MAX_IDENTITY_FILES 100
54
Damien Miller5428f641999-11-25 11:54:57 +110055/*
56 * Major protocol version. Different version indicates major incompatiblity
57 * that prevents communication.
Damien Miller78928792000-04-12 20:17:38 +100058 *
Damien Miller5428f641999-11-25 11:54:57 +110059 * Minor protocol version. Different version indicates minor incompatibility
60 * that does not prevent interoperation.
61 */
Damien Miller78928792000-04-12 20:17:38 +100062#define PROTOCOL_MAJOR_1 1
63#define PROTOCOL_MINOR_1 5
64
65/* We support both SSH1 and SSH2 */
66#define PROTOCOL_MAJOR_2 2
67#define PROTOCOL_MINOR_2 0
Damien Millerd4a8b7e1999-10-27 13:42:43 +100068
Damien Miller5428f641999-11-25 11:54:57 +110069/*
70 * Name for the service. The port named by this service overrides the
71 * default port if present.
72 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100073#define SSH_SERVICE_NAME "ssh"
74
Damien Millerd0cff3e2000-04-20 23:12:58 +100075#if defined(USE_PAM) && !defined(SSHD_PAM_SERVICE)
76# define SSHD_PAM_SERVICE "sshd"
77#endif
78
Damien Millerd4a8b7e1999-10-27 13:42:43 +100079#ifndef ETCDIR
80#define ETCDIR "/etc"
81#endif /* ETCDIR */
82
Damien Miller95def091999-11-25 00:26:21 +110083#ifndef PIDDIR
Damien Millerd4a8b7e1999-10-27 13:42:43 +100084#define PIDDIR "/var/run"
Damien Miller95def091999-11-25 00:26:21 +110085#endif /* PIDDIR */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100086
Damien Miller5428f641999-11-25 11:54:57 +110087/*
88 * System-wide file containing host keys of known hosts. This file should be
89 * world-readable.
90 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100091#define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
Damien Millereba71ba2000-04-29 23:57:08 +100092#define SSH_SYSTEM_HOSTFILE2 ETCDIR "/ssh_known_hosts2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100093
Damien Miller5428f641999-11-25 11:54:57 +110094/*
95 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
96 * should be world-readable.
97 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100098#define HOST_KEY_FILE ETCDIR "/ssh_host_key"
99#define SERVER_CONFIG_FILE ETCDIR "/sshd_config"
100#define HOST_CONFIG_FILE ETCDIR "/ssh_config"
Damien Millere247cc42000-05-07 12:03:14 +1000101#define HOST_DSA_KEY_FILE ETCDIR "/ssh_host_dsa_key"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000102
Damien Miller356a0b01999-11-08 15:30:59 +1100103#ifndef SSH_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100104#define SSH_PROGRAM "/usr/bin/ssh"
Damien Miller356a0b01999-11-08 15:30:59 +1100105#endif /* SSH_PROGRAM */
106
107#ifndef LOGIN_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100108#define LOGIN_PROGRAM "/usr/bin/login"
Damien Miller356a0b01999-11-08 15:30:59 +1100109#endif /* LOGIN_PROGRAM */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000110
Damien Millerc7b38ce1999-11-09 10:28:04 +1100111#ifndef ASKPASS_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100112#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
Damien Millerc7b38ce1999-11-09 10:28:04 +1100113#endif /* ASKPASS_PROGRAM */
114
Damien Miller5428f641999-11-25 11:54:57 +1100115/*
116 * The process id of the daemon listening for connections is saved here to
117 * make it easier to kill the correct daemon when necessary.
118 */
Damien Millera37010e1999-10-29 09:18:29 +1000119#define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000120
Damien Miller5428f641999-11-25 11:54:57 +1100121/*
122 * The directory in user\'s home directory in which the files reside. The
123 * directory should be world-readable (though not all files are).
124 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000125#define SSH_USER_DIR ".ssh"
126
Damien Miller5428f641999-11-25 11:54:57 +1100127/*
Damien Miller4018c192000-04-30 09:30:44 +1000128 * Relevant only when using builtin PRNG.
129 */
130#ifndef SSH_PRNG_SEED_FILE
131# define SSH_PRNG_SEED_FILE SSH_USER_DIR"/prng_seed"
132#endif /* SSH_PRNG_SEED_FILE */
Damien Miller0437b332000-05-02 09:56:41 +1000133#ifndef SSH_PRNG_COMMAND_FILE
134# define SSH_PRNG_COMMAND_FILE ETCDIR "/ssh_prng_cmds"
135#endif /* SSH_PRNG_COMMAND_FILE */
Damien Miller4018c192000-04-30 09:30:44 +1000136
137/*
Damien Miller5428f641999-11-25 11:54:57 +1100138 * Per-user file containing host keys of known hosts. This file need not be
139 * readable by anyone except the user him/herself, though this does not
140 * contain anything particularly secret.
141 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000142#define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
Damien Millereba71ba2000-04-29 23:57:08 +1000143#define SSH_USER_HOSTFILE2 "~/.ssh/known_hosts2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000144
Damien Miller5428f641999-11-25 11:54:57 +1100145/*
146 * Name of the default file containing client-side authentication key. This
147 * file should only be readable by the user him/herself.
148 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000149#define SSH_CLIENT_IDENTITY ".ssh/identity"
Damien Millere247cc42000-05-07 12:03:14 +1000150#define SSH_CLIENT_ID_DSA ".ssh/id_dsa"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000151
Damien Miller5428f641999-11-25 11:54:57 +1100152/*
153 * Configuration file in user\'s home directory. This file need not be
154 * readable by anyone but the user him/herself, but does not contain anything
155 * particularly secret. If the user\'s home directory resides on an NFS
156 * volume where root is mapped to nobody, this may need to be world-readable.
157 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000158#define SSH_USER_CONFFILE ".ssh/config"
159
Damien Miller5428f641999-11-25 11:54:57 +1100160/*
161 * File containing a list of those rsa keys that permit logging in as this
162 * user. This file need not be readable by anyone but the user him/herself,
163 * but does not contain anything particularly secret. If the user\'s home
164 * directory resides on an NFS volume where root is mapped to nobody, this
165 * may need to be world-readable. (This file is read by the daemon which is
166 * running as root.)
167 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000168#define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
Damien Millereba71ba2000-04-29 23:57:08 +1000169#define SSH_USER_PERMITTED_KEYS2 ".ssh/authorized_keys2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000170
Damien Miller5428f641999-11-25 11:54:57 +1100171/*
172 * Per-user and system-wide ssh "rc" files. These files are executed with
173 * /bin/sh before starting the shell or command if they exist. They will be
174 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
175 * use. xauth will be run if neither of these exists.
176 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000177#define SSH_USER_RC ".ssh/rc"
178#define SSH_SYSTEM_RC ETCDIR "/sshrc"
179
Damien Miller5428f641999-11-25 11:54:57 +1100180/*
181 * Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
182 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
183 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000184#define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
185
Damien Miller5428f641999-11-25 11:54:57 +1100186/*
187 * Name of the environment variable containing the pathname of the
188 * authentication socket.
189 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000190#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
191
Damien Miller5428f641999-11-25 11:54:57 +1100192/*
193 * Name of the environment variable containing the pathname of the
194 * authentication socket.
195 */
Damien Miller32265091999-11-12 11:33:04 +1100196#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Miller5eeedae1999-10-29 10:21:15 +1000197
Damien Miller5428f641999-11-25 11:54:57 +1100198/*
Damien Milleraae6c611999-12-06 11:47:28 +1100199 * Default path to ssh-askpass used by ssh-add,
200 * environment variable for overwriting the default location
201 */
Damien Miller3bc14dd1999-12-07 14:54:53 +1100202#ifndef SSH_ASKPASS_DEFAULT
203# define SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
204#endif
Damien Milleraae6c611999-12-06 11:47:28 +1100205#define SSH_ASKPASS_ENV "SSH_ASKPASS"
206
207/*
Damien Miller5428f641999-11-25 11:54:57 +1100208 * Force host key length and server key length to differ by at least this
209 * many bits. This is to make double encryption with rsaref work.
210 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000211#define SSH_KEY_BITS_RESERVED 128
212
Damien Miller5428f641999-11-25 11:54:57 +1100213/*
214 * Length of the session key in bytes. (Specified as 256 bits in the
215 * protocol.)
216 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000217#define SSH_SESSION_KEY_LENGTH 32
218
219/* Name of Kerberos service for SSH to use. */
220#define KRB4_SERVICE_NAME "rcmd"
221
Damien Miller5428f641999-11-25 11:54:57 +1100222/*
223 * Authentication methods. New types can be added, but old types should not
224 * be removed for compatibility. The maximum allowed value is 31.
225 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000226#define SSH_AUTH_RHOSTS 1
227#define SSH_AUTH_RSA 2
228#define SSH_AUTH_PASSWORD 3
229#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100230#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000231#define SSH_AUTH_KERBEROS 6
232#define SSH_PASS_KERBEROS_TGT 7
Damien Miller5428f641999-11-25 11:54:57 +1100233 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000234#define SSH_PASS_AFS_TOKEN 21
235
236/* Protocol flags. These are bit masks. */
Damien Miller5428f641999-11-25 11:54:57 +1100237#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */
238#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000239
Damien Miller5428f641999-11-25 11:54:57 +1100240/*
241 * Definition of message types. New values can be added, but old values
242 * should not be removed or without careful consideration of the consequences
243 * for compatibility. The maximum value is 254; value 255 is reserved for
244 * future extension.
245 */
246/* Message name */ /* msg code */ /* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000247#define SSH_MSG_NONE 0 /* no message */
248#define SSH_MSG_DISCONNECT 1 /* cause (string) */
249#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
250#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
251#define SSH_CMSG_USER 4 /* user (string) */
252#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
253#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
254#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
255#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
256#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
257#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
258#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
259#define SSH_CMSG_EXEC_SHELL 12 /* */
260#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
261#define SSH_SMSG_SUCCESS 14 /* */
262#define SSH_SMSG_FAILURE 15 /* */
263#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
264#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
265#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
266#define SSH_CMSG_EOF 19 /* */
267#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
268#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
269#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
270#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
271#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
272#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
273/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
274#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
275#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
276#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
277#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
278#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
279#define SSH_MSG_IGNORE 32 /* string */
280#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
281#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
282#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
283#define SSH_MSG_DEBUG 36 /* string */
284#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
285#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100286#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
287#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
288#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000289#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
290#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
291#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
292#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
293
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000294/*------------ definitions for login.c -------------*/
295
Damien Miller5428f641999-11-25 11:54:57 +1100296/*
297 * Returns the time when the user last logged in. Returns 0 if the
298 * information is not available. This must be called before record_login.
299 * The host from which the user logged in is stored in buf.
300 */
Damien Miller4af51302000-04-16 11:18:38 +1000301unsigned long
Damien Miller95def091999-11-25 00:26:21 +1100302get_last_login_time(uid_t uid, const char *logname,
303 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000304
Damien Miller5428f641999-11-25 11:54:57 +1100305/*
306 * Records that the user has logged in. This does many things normally done
307 * by login(1).
308 */
Damien Miller4af51302000-04-16 11:18:38 +1000309void
Damien Miller166fca82000-04-20 07:42:21 +1000310record_login(pid_t pid, const char *ttyname, const char *user, uid_t uid,
Damien Miller34132e52000-01-14 15:45:46 +1100311 const char *host, struct sockaddr *addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000312
Damien Miller5428f641999-11-25 11:54:57 +1100313/*
314 * Records that the user has logged out. This does many thigs normally done
315 * by login(1) or init.
316 */
Damien Miller166fca82000-04-20 07:42:21 +1000317void record_logout(pid_t pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000318
319/*------------ definitions for sshconnect.c ----------*/
320
Damien Miller5428f641999-11-25 11:54:57 +1100321/*
322 * Opens a TCP/IP connection to the remote server on the given host. If port
323 * is 0, the default port will be used. If anonymous is zero, a privileged
324 * port will be allocated to make the connection. This requires super-user
325 * privileges if anonymous is false. Connection_attempts specifies the
326 * maximum number of tries, one per second. This returns true on success,
327 * and zero on failure. If the connection is successful, this calls
328 * packet_set_connection for the connection.
329 */
Damien Miller4af51302000-04-16 11:18:38 +1000330int
Damien Miller34132e52000-01-14 15:45:46 +1100331ssh_connect(const char *host, struct sockaddr_storage * hostaddr,
Damien Milleraae6c611999-12-06 11:47:28 +1100332 u_short port, int connection_attempts,
Damien Miller95def091999-11-25 00:26:21 +1100333 int anonymous, uid_t original_real_uid,
334 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000335
Damien Miller5428f641999-11-25 11:54:57 +1100336/*
337 * Starts a dialog with the server, and authenticates the current user on the
338 * server. This does not need any extra privileges. The basic connection to
339 * the server must already have been established before this is called. If
340 * login fails, this function prints an error and never returns. This
341 * initializes the random state, and leaves it initialized (it will also have
342 * references from the packet module).
343 */
Damien Miller5ce662a1999-11-11 17:57:39 +1100344
Damien Miller4af51302000-04-16 11:18:38 +1000345void
Damien Miller95def091999-11-25 00:26:21 +1100346ssh_login(int host_key_valid, RSA * host_key, const char *host,
Damien Miller34132e52000-01-14 15:45:46 +1100347 struct sockaddr * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000348
349/*------------ Definitions for various authentication methods. -------*/
350
Damien Miller5428f641999-11-25 11:54:57 +1100351/*
352 * Tries to authenticate the user using the .rhosts file. Returns true if
353 * authentication succeeds. If ignore_rhosts is non-zero, this will not
354 * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
355 */
Damien Miller95def091999-11-25 00:26:21 +1100356int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000357
Damien Miller5428f641999-11-25 11:54:57 +1100358/*
359 * Tries to authenticate the user using the .rhosts file and the host using
360 * its host key. Returns true if authentication succeeds.
361 */
Damien Miller4af51302000-04-16 11:18:38 +1000362int
Damien Miller450a7a12000-03-26 13:04:51 +1000363auth_rhosts_rsa(struct passwd * pw, const char *client_user, RSA* client_host_key);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000364
Damien Miller5428f641999-11-25 11:54:57 +1100365/*
366 * Tries to authenticate the user using password. Returns true if
367 * authentication succeeds.
368 */
Damien Miller95def091999-11-25 00:26:21 +1100369int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000370
Damien Miller5428f641999-11-25 11:54:57 +1100371/*
372 * Performs the RSA authentication dialog with the client. This returns 0 if
373 * the client could not be authenticated, and 1 if authentication was
374 * successful. This may exit if there is a serious protocol violation.
375 */
Damien Miller95def091999-11-25 00:26:21 +1100376int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000377
Damien Miller5428f641999-11-25 11:54:57 +1100378/*
379 * Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
380 * over the key. Skips any whitespace at the beginning and at end.
381 */
Damien Miller95def091999-11-25 00:26:21 +1100382int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000383
Damien Miller5428f641999-11-25 11:54:57 +1100384/*
385 * Returns the name of the machine at the other end of the socket. The
386 * returned string should be freed by the caller.
387 */
Damien Miller95def091999-11-25 00:26:21 +1100388char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000389
Damien Miller5428f641999-11-25 11:54:57 +1100390/*
391 * Return the canonical name of the host in the other side of the current
392 * connection (as returned by packet_get_connection). The host name is
393 * cached, so it is efficient to call this several times.
394 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000395const char *get_canonical_hostname(void);
396
Damien Miller5428f641999-11-25 11:54:57 +1100397/*
398 * Returns the remote IP address as an ascii string. The value need not be
399 * freed by the caller.
400 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000401const char *get_remote_ipaddr(void);
402
403/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100404int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000405
Damien Miller34132e52000-01-14 15:45:46 +1100406/* Returns the port number of the remote/local host. */
Damien Miller95def091999-11-25 00:26:21 +1100407int get_remote_port(void);
Damien Miller34132e52000-01-14 15:45:46 +1100408int get_local_port(void);
409
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000410
Damien Miller5428f641999-11-25 11:54:57 +1100411/*
Damien Miller5428f641999-11-25 11:54:57 +1100412 * 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 Miller450a7a12000-03-26 13:04:51 +1000416int auth_rsa_challenge_dialog(RSA *pk);
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 Millerd4a8b7e1999-10-27 13:42:43 +1000425
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100426/*------------ Definitions for logging. -----------------------*/
427
428/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100429typedef enum {
430 SYSLOG_FACILITY_DAEMON,
431 SYSLOG_FACILITY_USER,
432 SYSLOG_FACILITY_AUTH,
433 SYSLOG_FACILITY_LOCAL0,
434 SYSLOG_FACILITY_LOCAL1,
435 SYSLOG_FACILITY_LOCAL2,
436 SYSLOG_FACILITY_LOCAL3,
437 SYSLOG_FACILITY_LOCAL4,
438 SYSLOG_FACILITY_LOCAL5,
439 SYSLOG_FACILITY_LOCAL6,
440 SYSLOG_FACILITY_LOCAL7
441} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100442
Damien Miller95def091999-11-25 00:26:21 +1100443typedef enum {
444 SYSLOG_LEVEL_QUIET,
445 SYSLOG_LEVEL_FATAL,
446 SYSLOG_LEVEL_ERROR,
447 SYSLOG_LEVEL_INFO,
448 SYSLOG_LEVEL_VERBOSE,
449 SYSLOG_LEVEL_DEBUG
450} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100451/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100452void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100453
454/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100455void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100456
Damien Miller6162d121999-11-21 13:23:52 +1100457/* name to facility/level */
458SyslogFacility log_facility_number(char *name);
459LogLevel log_level_number(char *name);
460
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100461/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100462void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
463void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
464void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
465void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
466void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100467
468/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100469void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100470
Damien Miller5428f641999-11-25 11:54:57 +1100471/*
472 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
473 * before exiting. It is permissible to call fatal_remove_cleanup for the
474 * function itself from the function.
475 */
Damien Miller95def091999-11-25 00:26:21 +1100476void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100477
478/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100479void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100480
Damien Millerefb4afe2000-04-12 18:45:05 +1000481/* ---- misc */
482
Damien Miller5428f641999-11-25 11:54:57 +1100483/*
484 * Expands tildes in the file name. Returns data allocated by xmalloc.
485 * Warning: this calls getpw*.
486 */
Damien Miller95def091999-11-25 00:26:21 +1100487char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000488
Damien Millerdcb6ecd2000-05-17 22:34:22 +1000489/* remove newline at end of string */
490char *chop(char *s);
491
Damien Millerbe484b52000-07-15 14:14:16 +1000492/* return next token in configuration line */
493char *strdelim(char **s);
494
Damien Millerdcb6ecd2000-05-17 22:34:22 +1000495/* set filedescriptor to non-blocking */
496void set_nonblock(int fd);
497
Damien Miller5428f641999-11-25 11:54:57 +1100498/*
499 * Performs the interactive session. This handles data transmission between
500 * the client and the program. Note that the notion of stdin, stdout, and
501 * stderr in this function is sort of reversed: this function writes to stdin
502 * (of the child program), and reads from stdout and stderr (of the child
503 * program).
504 */
Damien Miller166fca82000-04-20 07:42:21 +1000505void server_loop(pid_t pid, int fdin, int fdout, int fderr);
Damien Millerefb4afe2000-04-12 18:45:05 +1000506void server_loop2(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000507
508/* Client side main loop for the interactive session. */
Damien Miller95def091999-11-25 00:26:21 +1100509int client_loop(int have_pty, int escape_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000510
511/* Linked list of custom environment strings (see auth-rsa.c). */
512struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100513 struct envstring *next;
514 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000515};
Damien Miller037a0dc1999-12-07 15:38:31 +1100516
517/*
518 * Ensure all of data on socket comes through. f==read || f==write
519 */
Damien Miller98c7ad62000-03-09 21:27:49 +1100520ssize_t atomicio(ssize_t (*f)(), int fd, void *s, size_t n);
Damien Miller037a0dc1999-12-07 15:38:31 +1100521
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000522#ifdef KRB4
523#include <krb.h>
Damien Miller5428f641999-11-25 11:54:57 +1100524/*
525 * Performs Kerberos v4 mutual authentication with the client. This returns 0
526 * if the client could not be authenticated, and 1 if authentication was
527 * successful. This may exit if there is a serious protocol violation.
528 */
Damien Miller95def091999-11-25 00:26:21 +1100529int auth_krb4(const char *server_user, KTEXT auth, char **client);
530int krb4_init(uid_t uid);
531void krb4_cleanup_proc(void *ignore);
Damien Milleraae6c611999-12-06 11:47:28 +1100532int auth_krb4_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000533
534#ifdef AFS
535#include <kafs.h>
536
537/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100538int auth_kerberos_tgt(struct passwd * pw, const char *string);
539int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000540
Damien Millere247cc42000-05-07 12:03:14 +1000541int creds_to_radix(CREDENTIALS * creds, unsigned char *buf, size_t buflen);
Damien Miller95def091999-11-25 00:26:21 +1100542int radix_to_creds(const char *buf, CREDENTIALS * creds);
543#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000544
Damien Miller95def091999-11-25 00:26:21 +1100545#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000546
547#ifdef SKEY
548#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100549char *skey_fake_keyinfo(char *username);
Damien Milleraae6c611999-12-06 11:47:28 +1100550int auth_skey_password(struct passwd * pw, const char *password);
Damien Miller95def091999-11-25 00:26:21 +1100551#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000552
Damien Miller34132e52000-01-14 15:45:46 +1100553/* AF_UNSPEC or AF_INET or AF_INET6 */
554extern int IPv4or6;
555
Damien Millere72b7af1999-12-30 15:08:44 +1100556#ifdef USE_PAM
557#include "auth-pam.h"
558#endif /* USE_PAM */
559
Damien Miller95def091999-11-25 00:26:21 +1100560#endif /* SSH_H */