blob: cc612d0d4b69adc68b4654adf7472136fb9241de [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller4af51302000-04-16 11:18:38 +10005 *
Damien Miller95def091999-11-25 00:26:21 +11006 * Generic header file for ssh.
Damien Miller4af51302000-04-16 11:18:38 +10007 *
Damien Millere4340be2000-09-16 13:29:08 +11008 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110013 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100014
Damien Millere4340be2000-09-16 13:29:08 +110015/* RCSID("$OpenBSD: ssh.h,v 1.51 2000/09/12 20:53:10 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016
17#ifndef SSH_H
18#define SSH_H
19
Damien Millerab18c411999-11-11 10:40:23 +110020#include <netinet/in.h> /* For struct sockaddr_in */
21#include <pwd.h> /* For struct pw */
Damien Miller5ce662a1999-11-11 17:57:39 +110022#include <stdarg.h> /* For va_list */
Damien Miller34132e52000-01-14 15:45:46 +110023#include <sys/socket.h> /* For struct sockaddr_storage */
24#include "fake-socket.h" /* For struct sockaddr_storage */
Damien Miller365199d1999-12-22 00:12:38 +110025#ifdef HAVE_SYS_SELECT_H
26# include <sys/select.h>
27#endif
Damien Millerd4a8b7e1999-10-27 13:42:43 +100028#include "rsa.h"
29#include "cipher.h"
30
Damien Miller5428f641999-11-25 11:54:57 +110031/*
Damien Miller30c3d422000-05-09 11:02:59 +100032 * XXX
Damien Miller5428f641999-11-25 11:54:57 +110033 * The default cipher used if IDEA is not supported by the remote host. It is
34 * recommended that this be one of the mandatory ciphers (DES, 3DES), though
35 * that is not required.
36 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100037#define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
38
39/* Cipher used for encrypting authentication files. */
40#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
41
42/* Default port number. */
43#define SSH_DEFAULT_PORT 22
44
45/* Maximum number of TCP/IP ports forwarded per direction. */
46#define SSH_MAX_FORWARDS_PER_DIRECTION 100
47
Damien Miller5428f641999-11-25 11:54:57 +110048/*
49 * Maximum number of RSA authentication identity files that can be specified
50 * in configuration files or on the command line.
51 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100052#define SSH_MAX_IDENTITY_FILES 100
53
Damien Miller5428f641999-11-25 11:54:57 +110054/*
55 * Major protocol version. Different version indicates major incompatiblity
56 * that prevents communication.
Damien Miller78928792000-04-12 20:17:38 +100057 *
Damien Miller5428f641999-11-25 11:54:57 +110058 * Minor protocol version. Different version indicates minor incompatibility
59 * that does not prevent interoperation.
60 */
Damien Miller78928792000-04-12 20:17:38 +100061#define PROTOCOL_MAJOR_1 1
62#define PROTOCOL_MINOR_1 5
63
64/* We support both SSH1 and SSH2 */
65#define PROTOCOL_MAJOR_2 2
66#define PROTOCOL_MINOR_2 0
Damien Millerd4a8b7e1999-10-27 13:42:43 +100067
Damien Miller5428f641999-11-25 11:54:57 +110068/*
69 * Name for the service. The port named by this service overrides the
70 * default port if present.
71 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100072#define SSH_SERVICE_NAME "ssh"
73
Damien Millerd0cff3e2000-04-20 23:12:58 +100074#if defined(USE_PAM) && !defined(SSHD_PAM_SERVICE)
75# define SSHD_PAM_SERVICE "sshd"
76#endif
77
Damien Millerd4a8b7e1999-10-27 13:42:43 +100078#ifndef ETCDIR
79#define ETCDIR "/etc"
80#endif /* ETCDIR */
81
Damien Miller95def091999-11-25 00:26:21 +110082#ifndef PIDDIR
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083#define PIDDIR "/var/run"
Damien Miller95def091999-11-25 00:26:21 +110084#endif /* PIDDIR */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100085
Damien Miller5428f641999-11-25 11:54:57 +110086/*
87 * System-wide file containing host keys of known hosts. This file should be
88 * world-readable.
89 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100090#define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
Damien Millereba71ba2000-04-29 23:57:08 +100091#define SSH_SYSTEM_HOSTFILE2 ETCDIR "/ssh_known_hosts2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100092
Damien Miller5428f641999-11-25 11:54:57 +110093/*
94 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
95 * should be world-readable.
96 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100097#define HOST_KEY_FILE ETCDIR "/ssh_host_key"
98#define SERVER_CONFIG_FILE ETCDIR "/sshd_config"
99#define HOST_CONFIG_FILE ETCDIR "/ssh_config"
Damien Millere247cc42000-05-07 12:03:14 +1000100#define HOST_DSA_KEY_FILE ETCDIR "/ssh_host_dsa_key"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000101
Damien Miller356a0b01999-11-08 15:30:59 +1100102#ifndef SSH_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100103#define SSH_PROGRAM "/usr/bin/ssh"
Damien Miller356a0b01999-11-08 15:30:59 +1100104#endif /* SSH_PROGRAM */
105
106#ifndef LOGIN_PROGRAM
Damien Millerad833b32000-08-23 10:46:23 +1000107# ifdef LOGIN_PROGRAM_FALLBACK
108# define LOGIN_PROGRAM LOGIN_PROGRAM_FALLBACK
109# else
110# define LOGIN_PROGRAM "/usr/bin/login"
111# endif
Damien Miller356a0b01999-11-08 15:30:59 +1100112#endif /* LOGIN_PROGRAM */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000113
Damien Millerc7b38ce1999-11-09 10:28:04 +1100114#ifndef ASKPASS_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +1100115#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
Damien Millerc7b38ce1999-11-09 10:28:04 +1100116#endif /* ASKPASS_PROGRAM */
117
Damien Miller5428f641999-11-25 11:54:57 +1100118/*
119 * The process id of the daemon listening for connections is saved here to
120 * make it easier to kill the correct daemon when necessary.
121 */
Damien Millera37010e1999-10-29 09:18:29 +1000122#define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000123
Damien Miller5428f641999-11-25 11:54:57 +1100124/*
125 * The directory in user\'s home directory in which the files reside. The
126 * directory should be world-readable (though not all files are).
127 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128#define SSH_USER_DIR ".ssh"
129
Damien Miller5428f641999-11-25 11:54:57 +1100130/*
Damien Miller4018c192000-04-30 09:30:44 +1000131 * Relevant only when using builtin PRNG.
132 */
133#ifndef SSH_PRNG_SEED_FILE
134# define SSH_PRNG_SEED_FILE SSH_USER_DIR"/prng_seed"
135#endif /* SSH_PRNG_SEED_FILE */
Damien Miller0437b332000-05-02 09:56:41 +1000136#ifndef SSH_PRNG_COMMAND_FILE
137# define SSH_PRNG_COMMAND_FILE ETCDIR "/ssh_prng_cmds"
138#endif /* SSH_PRNG_COMMAND_FILE */
Damien Miller4018c192000-04-30 09:30:44 +1000139
140/*
Damien Miller5428f641999-11-25 11:54:57 +1100141 * Per-user file containing host keys of known hosts. This file need not be
142 * readable by anyone except the user him/herself, though this does not
143 * contain anything particularly secret.
144 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000145#define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
Damien Millereba71ba2000-04-29 23:57:08 +1000146#define SSH_USER_HOSTFILE2 "~/.ssh/known_hosts2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000147
Damien Miller5428f641999-11-25 11:54:57 +1100148/*
149 * Name of the default file containing client-side authentication key. This
150 * file should only be readable by the user him/herself.
151 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000152#define SSH_CLIENT_IDENTITY ".ssh/identity"
Damien Millere247cc42000-05-07 12:03:14 +1000153#define SSH_CLIENT_ID_DSA ".ssh/id_dsa"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000154
Damien Miller5428f641999-11-25 11:54:57 +1100155/*
156 * Configuration file in user\'s home directory. This file need not be
157 * readable by anyone but the user him/herself, but does not contain anything
158 * particularly secret. If the user\'s home directory resides on an NFS
159 * volume where root is mapped to nobody, this may need to be world-readable.
160 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000161#define SSH_USER_CONFFILE ".ssh/config"
162
Damien Miller5428f641999-11-25 11:54:57 +1100163/*
164 * File containing a list of those rsa keys that permit logging in as this
165 * user. This file need not be readable by anyone but the user him/herself,
166 * but does not contain anything particularly secret. If the user\'s home
167 * directory resides on an NFS volume where root is mapped to nobody, this
168 * may need to be world-readable. (This file is read by the daemon which is
169 * running as root.)
170 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000171#define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
Damien Millereba71ba2000-04-29 23:57:08 +1000172#define SSH_USER_PERMITTED_KEYS2 ".ssh/authorized_keys2"
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000173
Damien Miller5428f641999-11-25 11:54:57 +1100174/*
175 * Per-user and system-wide ssh "rc" files. These files are executed with
176 * /bin/sh before starting the shell or command if they exist. They will be
177 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
178 * use. xauth will be run if neither of these exists.
179 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000180#define SSH_USER_RC ".ssh/rc"
181#define SSH_SYSTEM_RC ETCDIR "/sshrc"
182
Damien Miller5428f641999-11-25 11:54:57 +1100183/*
184 * Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
185 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
186 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000187#define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
188
Damien Miller5428f641999-11-25 11:54:57 +1100189/*
190 * Name of the environment variable containing the pathname of the
191 * authentication socket.
192 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000193#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
194
Damien Miller5428f641999-11-25 11:54:57 +1100195/*
196 * Name of the environment variable containing the pathname of the
197 * authentication socket.
198 */
Damien Miller32265091999-11-12 11:33:04 +1100199#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Miller5eeedae1999-10-29 10:21:15 +1000200
Damien Miller5428f641999-11-25 11:54:57 +1100201/*
Damien Milleraae6c611999-12-06 11:47:28 +1100202 * Default path to ssh-askpass used by ssh-add,
203 * environment variable for overwriting the default location
204 */
Damien Miller3bc14dd1999-12-07 14:54:53 +1100205#ifndef SSH_ASKPASS_DEFAULT
206# define SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
207#endif
Damien Milleraae6c611999-12-06 11:47:28 +1100208#define SSH_ASKPASS_ENV "SSH_ASKPASS"
209
210/*
Damien Miller5428f641999-11-25 11:54:57 +1100211 * Force host key length and server key length to differ by at least this
212 * many bits. This is to make double encryption with rsaref work.
213 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000214#define SSH_KEY_BITS_RESERVED 128
215
Damien Miller5428f641999-11-25 11:54:57 +1100216/*
217 * Length of the session key in bytes. (Specified as 256 bits in the
218 * protocol.)
219 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000220#define SSH_SESSION_KEY_LENGTH 32
221
222/* Name of Kerberos service for SSH to use. */
223#define KRB4_SERVICE_NAME "rcmd"
224
Damien Miller5428f641999-11-25 11:54:57 +1100225/*
226 * Authentication methods. New types can be added, but old types should not
227 * be removed for compatibility. The maximum allowed value is 31.
228 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000229#define SSH_AUTH_RHOSTS 1
230#define SSH_AUTH_RSA 2
231#define SSH_AUTH_PASSWORD 3
232#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100233#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000234#define SSH_AUTH_KERBEROS 6
235#define SSH_PASS_KERBEROS_TGT 7
Damien Miller5428f641999-11-25 11:54:57 +1100236 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000237#define SSH_PASS_AFS_TOKEN 21
238
239/* Protocol flags. These are bit masks. */
Damien Miller5428f641999-11-25 11:54:57 +1100240#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */
241#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000242
Damien Miller5428f641999-11-25 11:54:57 +1100243/*
244 * Definition of message types. New values can be added, but old values
245 * should not be removed or without careful consideration of the consequences
246 * for compatibility. The maximum value is 254; value 255 is reserved for
247 * future extension.
248 */
249/* Message name */ /* msg code */ /* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000250#define SSH_MSG_NONE 0 /* no message */
251#define SSH_MSG_DISCONNECT 1 /* cause (string) */
252#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
253#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
254#define SSH_CMSG_USER 4 /* user (string) */
255#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
256#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
257#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
258#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
259#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
260#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
261#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
262#define SSH_CMSG_EXEC_SHELL 12 /* */
263#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
264#define SSH_SMSG_SUCCESS 14 /* */
265#define SSH_SMSG_FAILURE 15 /* */
266#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
267#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
268#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
269#define SSH_CMSG_EOF 19 /* */
270#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
271#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
272#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
273#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
274#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
275#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
276/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
277#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
278#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
279#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
280#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
281#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
282#define SSH_MSG_IGNORE 32 /* string */
283#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
284#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
285#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
286#define SSH_MSG_DEBUG 36 /* string */
287#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
288#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100289#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
290#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
291#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000292#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
293#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
294#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
295#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
296
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000297/*------------ definitions for login.c -------------*/
298
Damien Miller5428f641999-11-25 11:54:57 +1100299/*
300 * Returns the time when the user last logged in. Returns 0 if the
301 * information is not available. This must be called before record_login.
302 * The host from which the user logged in is stored in buf.
303 */
Damien Miller4af51302000-04-16 11:18:38 +1000304unsigned long
Damien Miller95def091999-11-25 00:26:21 +1100305get_last_login_time(uid_t uid, const char *logname,
306 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000307
Damien Miller5428f641999-11-25 11:54:57 +1100308/*
309 * Records that the user has logged in. This does many things normally done
310 * by login(1).
311 */
Damien Miller4af51302000-04-16 11:18:38 +1000312void
Damien Miller166fca82000-04-20 07:42:21 +1000313record_login(pid_t pid, const char *ttyname, const char *user, uid_t uid,
Damien Miller34132e52000-01-14 15:45:46 +1100314 const char *host, struct sockaddr *addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000315
Damien Miller5428f641999-11-25 11:54:57 +1100316/*
317 * Records that the user has logged out. This does many thigs normally done
318 * by login(1) or init.
319 */
Damien Miller166fca82000-04-20 07:42:21 +1000320void record_logout(pid_t pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000321
322/*------------ definitions for sshconnect.c ----------*/
323
Damien Miller5428f641999-11-25 11:54:57 +1100324/*
325 * Opens a TCP/IP connection to the remote server on the given host. If port
326 * is 0, the default port will be used. If anonymous is zero, a privileged
327 * port will be allocated to make the connection. This requires super-user
328 * privileges if anonymous is false. Connection_attempts specifies the
329 * maximum number of tries, one per second. This returns true on success,
330 * and zero on failure. If the connection is successful, this calls
331 * packet_set_connection for the connection.
332 */
Damien Miller4af51302000-04-16 11:18:38 +1000333int
Damien Miller34132e52000-01-14 15:45:46 +1100334ssh_connect(const char *host, struct sockaddr_storage * hostaddr,
Damien Milleraae6c611999-12-06 11:47:28 +1100335 u_short port, int connection_attempts,
Damien Miller95def091999-11-25 00:26:21 +1100336 int anonymous, uid_t original_real_uid,
337 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000338
Damien Miller5428f641999-11-25 11:54:57 +1100339/*
340 * Starts a dialog with the server, and authenticates the current user on the
341 * server. This does not need any extra privileges. The basic connection to
342 * the server must already have been established before this is called. If
343 * login fails, this function prints an error and never returns. This
344 * initializes the random state, and leaves it initialized (it will also have
345 * references from the packet module).
346 */
Damien Miller5ce662a1999-11-11 17:57:39 +1100347
Damien Miller4af51302000-04-16 11:18:38 +1000348void
Damien Miller95def091999-11-25 00:26:21 +1100349ssh_login(int host_key_valid, RSA * host_key, const char *host,
Damien Miller34132e52000-01-14 15:45:46 +1100350 struct sockaddr * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000351
352/*------------ Definitions for various authentication methods. -------*/
353
Damien Miller5428f641999-11-25 11:54:57 +1100354/*
355 * Tries to authenticate the user using the .rhosts file. Returns true if
356 * authentication succeeds. If ignore_rhosts is non-zero, this will not
357 * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
358 */
Damien Miller95def091999-11-25 00:26:21 +1100359int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000360
Damien Miller5428f641999-11-25 11:54:57 +1100361/*
362 * Tries to authenticate the user using the .rhosts file and the host using
363 * its host key. Returns true if authentication succeeds.
364 */
Damien Miller4af51302000-04-16 11:18:38 +1000365int
Damien Miller450a7a12000-03-26 13:04:51 +1000366auth_rhosts_rsa(struct passwd * pw, const char *client_user, RSA* client_host_key);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000367
Damien Miller5428f641999-11-25 11:54:57 +1100368/*
369 * Tries to authenticate the user using password. Returns true if
370 * authentication succeeds.
371 */
Damien Miller95def091999-11-25 00:26:21 +1100372int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000373
Damien Miller5428f641999-11-25 11:54:57 +1100374/*
375 * Performs the RSA authentication dialog with the client. This returns 0 if
376 * the client could not be authenticated, and 1 if authentication was
377 * successful. This may exit if there is a serious protocol violation.
378 */
Damien Miller95def091999-11-25 00:26:21 +1100379int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000380
Damien Miller5428f641999-11-25 11:54:57 +1100381/*
382 * Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
383 * over the key. Skips any whitespace at the beginning and at end.
384 */
Damien Miller95def091999-11-25 00:26:21 +1100385int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000386
Damien Miller5428f641999-11-25 11:54:57 +1100387/*
388 * Returns the name of the machine at the other end of the socket. The
389 * returned string should be freed by the caller.
390 */
Damien Miller95def091999-11-25 00:26:21 +1100391char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000392
Damien Miller5428f641999-11-25 11:54:57 +1100393/*
394 * Return the canonical name of the host in the other side of the current
395 * connection (as returned by packet_get_connection). The host name is
396 * cached, so it is efficient to call this several times.
397 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000398const char *get_canonical_hostname(void);
399
Damien Miller5428f641999-11-25 11:54:57 +1100400/*
401 * Returns the remote IP address as an ascii string. The value need not be
402 * freed by the caller.
403 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000404const char *get_remote_ipaddr(void);
405
406/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100407int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000408
Damien Miller34132e52000-01-14 15:45:46 +1100409/* Returns the port number of the remote/local host. */
Damien Miller95def091999-11-25 00:26:21 +1100410int get_remote_port(void);
Damien Miller34132e52000-01-14 15:45:46 +1100411int get_local_port(void);
412
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000413
Damien Miller5428f641999-11-25 11:54:57 +1100414/*
Damien Miller5428f641999-11-25 11:54:57 +1100415 * Performs the RSA authentication challenge-response dialog with the client,
416 * and returns true (non-zero) if the client gave the correct answer to our
417 * challenge; returns zero if the client gives a wrong answer.
418 */
Damien Miller450a7a12000-03-26 13:04:51 +1000419int auth_rsa_challenge_dialog(RSA *pk);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000420
Damien Miller5428f641999-11-25 11:54:57 +1100421/*
422 * Reads a passphrase from /dev/tty with echo turned off. Returns the
423 * passphrase (allocated with xmalloc). Exits if EOF is encountered. If
424 * from_stdin is true, the passphrase will be read from stdin instead.
425 */
Damien Miller95def091999-11-25 00:26:21 +1100426char *read_passphrase(const char *prompt, int from_stdin);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000427
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000428
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100429/*------------ Definitions for logging. -----------------------*/
430
431/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100432typedef enum {
433 SYSLOG_FACILITY_DAEMON,
434 SYSLOG_FACILITY_USER,
435 SYSLOG_FACILITY_AUTH,
436 SYSLOG_FACILITY_LOCAL0,
437 SYSLOG_FACILITY_LOCAL1,
438 SYSLOG_FACILITY_LOCAL2,
439 SYSLOG_FACILITY_LOCAL3,
440 SYSLOG_FACILITY_LOCAL4,
441 SYSLOG_FACILITY_LOCAL5,
442 SYSLOG_FACILITY_LOCAL6,
443 SYSLOG_FACILITY_LOCAL7
444} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100445
Damien Miller95def091999-11-25 00:26:21 +1100446typedef enum {
447 SYSLOG_LEVEL_QUIET,
448 SYSLOG_LEVEL_FATAL,
449 SYSLOG_LEVEL_ERROR,
450 SYSLOG_LEVEL_INFO,
451 SYSLOG_LEVEL_VERBOSE,
Damien Millere4340be2000-09-16 13:29:08 +1100452 SYSLOG_LEVEL_DEBUG1,
453 SYSLOG_LEVEL_DEBUG2,
454 SYSLOG_LEVEL_DEBUG3
Damien Miller95def091999-11-25 00:26:21 +1100455} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100456/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100457void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100458
459/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100460void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100461
Damien Miller6162d121999-11-21 13:23:52 +1100462/* name to facility/level */
463SyslogFacility log_facility_number(char *name);
464LogLevel log_level_number(char *name);
465
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100466/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100467void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
468void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
469void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
470void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
471void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Millere4340be2000-09-16 13:29:08 +1100472void debug2(const char *fmt,...) __attribute__((format(printf, 1, 2)));
473void debug3(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100474
475/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100476void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100477
Damien Miller5428f641999-11-25 11:54:57 +1100478/*
479 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
480 * before exiting. It is permissible to call fatal_remove_cleanup for the
481 * function itself from the function.
482 */
Damien Miller95def091999-11-25 00:26:21 +1100483void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100484
485/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100486void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100487
Damien Millerefb4afe2000-04-12 18:45:05 +1000488/* ---- misc */
489
Damien Miller5428f641999-11-25 11:54:57 +1100490/*
491 * Expands tildes in the file name. Returns data allocated by xmalloc.
492 * Warning: this calls getpw*.
493 */
Damien Miller95def091999-11-25 00:26:21 +1100494char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000495
Damien Millerdcb6ecd2000-05-17 22:34:22 +1000496/* remove newline at end of string */
497char *chop(char *s);
498
Damien Millerbe484b52000-07-15 14:14:16 +1000499/* return next token in configuration line */
500char *strdelim(char **s);
501
Damien Millerdcb6ecd2000-05-17 22:34:22 +1000502/* set filedescriptor to non-blocking */
503void set_nonblock(int fd);
504
Damien Miller5428f641999-11-25 11:54:57 +1100505/*
506 * Performs the interactive session. This handles data transmission between
507 * the client and the program. Note that the notion of stdin, stdout, and
508 * stderr in this function is sort of reversed: this function writes to stdin
509 * (of the child program), and reads from stdout and stderr (of the child
510 * program).
511 */
Damien Miller166fca82000-04-20 07:42:21 +1000512void server_loop(pid_t pid, int fdin, int fdout, int fderr);
Damien Millerefb4afe2000-04-12 18:45:05 +1000513void server_loop2(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000514
515/* Client side main loop for the interactive session. */
Damien Millerad833b32000-08-23 10:46:23 +1000516int client_loop(int have_pty, int escape_char, int id);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000517
518/* Linked list of custom environment strings (see auth-rsa.c). */
519struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100520 struct envstring *next;
521 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000522};
Damien Miller037a0dc1999-12-07 15:38:31 +1100523
524/*
525 * Ensure all of data on socket comes through. f==read || f==write
526 */
Damien Miller98c7ad62000-03-09 21:27:49 +1100527ssize_t atomicio(ssize_t (*f)(), int fd, void *s, size_t n);
Damien Miller037a0dc1999-12-07 15:38:31 +1100528
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000529#ifdef KRB4
530#include <krb.h>
Damien Miller5428f641999-11-25 11:54:57 +1100531/*
532 * Performs Kerberos v4 mutual authentication with the client. This returns 0
533 * if the client could not be authenticated, and 1 if authentication was
534 * successful. This may exit if there is a serious protocol violation.
535 */
Damien Miller95def091999-11-25 00:26:21 +1100536int auth_krb4(const char *server_user, KTEXT auth, char **client);
537int krb4_init(uid_t uid);
538void krb4_cleanup_proc(void *ignore);
Damien Milleraae6c611999-12-06 11:47:28 +1100539int auth_krb4_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000540
541#ifdef AFS
542#include <kafs.h>
543
544/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100545int auth_kerberos_tgt(struct passwd * pw, const char *string);
546int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000547
Damien Millere247cc42000-05-07 12:03:14 +1000548int creds_to_radix(CREDENTIALS * creds, unsigned char *buf, size_t buflen);
Damien Miller95def091999-11-25 00:26:21 +1100549int radix_to_creds(const char *buf, CREDENTIALS * creds);
550#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000551
Damien Miller95def091999-11-25 00:26:21 +1100552#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000553
554#ifdef SKEY
555#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100556char *skey_fake_keyinfo(char *username);
Damien Milleraae6c611999-12-06 11:47:28 +1100557int auth_skey_password(struct passwd * pw, const char *password);
Damien Miller95def091999-11-25 00:26:21 +1100558#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000559
Damien Miller34132e52000-01-14 15:45:46 +1100560/* AF_UNSPEC or AF_INET or AF_INET6 */
561extern int IPv4or6;
562
Damien Millere72b7af1999-12-30 15:08:44 +1100563#ifdef USE_PAM
564#include "auth-pam.h"
565#endif /* USE_PAM */
566
Damien Miller95def091999-11-25 00:26:21 +1100567#endif /* SSH_H */