blob: f8426bfbbbfda88c74a81da7a8c4d6f1d265516b [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 Miller95def091999-11-25 00:26:21 +110016/* RCSID("$Id: ssh.h,v 1.15 1999/11/24 13:26:23 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 Miller95def091999-11-25 00:26:21 +110028/* The default cipher used if IDEA is not supported by the remote host.
Damien Millerd4a8b7e1999-10-27 13:42:43 +100029 It is recommended that this be one of the mandatory ciphers (DES, 3DES),
30 though that is not required. */
31#define SSH_FALLBACK_CIPHER SSH_CIPHER_3DES
32
33/* Cipher used for encrypting authentication files. */
34#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
35
36/* Default port number. */
37#define SSH_DEFAULT_PORT 22
38
39/* Maximum number of TCP/IP ports forwarded per direction. */
40#define SSH_MAX_FORWARDS_PER_DIRECTION 100
41
42/* Maximum number of RSA authentication identity files that can be specified
43 in configuration files or on the command line. */
44#define SSH_MAX_IDENTITY_FILES 100
45
46/* Major protocol version. Different version indicates major incompatiblity
47 that prevents communication. */
48#define PROTOCOL_MAJOR 1
49
50/* Minor protocol version. Different version indicates minor incompatibility
51 that does not prevent interoperation. */
52#define PROTOCOL_MINOR 5
53
54/* Name for the service. The port named by this service overrides the default
55 port if present. */
56#define SSH_SERVICE_NAME "ssh"
57
58#ifndef ETCDIR
59#define ETCDIR "/etc"
60#endif /* ETCDIR */
61
Damien Miller95def091999-11-25 00:26:21 +110062#ifndef PIDDIR
Damien Millerd4a8b7e1999-10-27 13:42:43 +100063#define PIDDIR "/var/run"
Damien Miller95def091999-11-25 00:26:21 +110064#endif /* PIDDIR */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065
66/* System-wide file containing host keys of known hosts. This file should be
67 world-readable. */
68#define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
69
70/* HOST_KEY_FILE /etc/ssh_host_key,
71 SERVER_CONFIG_FILE /etc/sshd_config,
72and HOST_CONFIG_FILE /etc/ssh_config
73are all defined in Makefile.in. Of these, ssh_host_key should be readable
74only by root, whereas ssh_config should be world-readable. */
75
76#define HOST_KEY_FILE ETCDIR "/ssh_host_key"
77#define SERVER_CONFIG_FILE ETCDIR "/sshd_config"
78#define HOST_CONFIG_FILE ETCDIR "/ssh_config"
79
Damien Miller356a0b01999-11-08 15:30:59 +110080#ifndef SSH_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110081#define SSH_PROGRAM "/usr/bin/ssh"
Damien Miller356a0b01999-11-08 15:30:59 +110082#endif /* SSH_PROGRAM */
83
84#ifndef LOGIN_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110085#define LOGIN_PROGRAM "/usr/bin/login"
Damien Miller356a0b01999-11-08 15:30:59 +110086#endif /* LOGIN_PROGRAM */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100087
Damien Millerc7b38ce1999-11-09 10:28:04 +110088#ifndef ASKPASS_PROGRAM
Damien Miller95def091999-11-25 00:26:21 +110089#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
Damien Millerc7b38ce1999-11-09 10:28:04 +110090#endif /* ASKPASS_PROGRAM */
91
Damien Millerd4a8b7e1999-10-27 13:42:43 +100092/* The process id of the daemon listening for connections is saved
93 here to make it easier to kill the correct daemon when necessary. */
Damien Millera37010e1999-10-29 09:18:29 +100094#define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100095
96/* The directory in user\'s home directory in which the files reside.
97 The directory should be world-readable (though not all files are). */
98#define SSH_USER_DIR ".ssh"
99
100/* Per-user file containing host keys of known hosts. This file need
101 not be readable by anyone except the user him/herself, though this does
102 not contain anything particularly secret. */
103#define SSH_USER_HOSTFILE "~/.ssh/known_hosts"
104
Damien Miller95def091999-11-25 00:26:21 +1100105/* Name of the default file containing client-side authentication key.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000106 This file should only be readable by the user him/herself. */
107#define SSH_CLIENT_IDENTITY ".ssh/identity"
108
109/* Configuration file in user\'s home directory. This file need not be
110 readable by anyone but the user him/herself, but does not contain
111 anything particularly secret. If the user\'s home directory resides
112 on an NFS volume where root is mapped to nobody, this may need to be
113 world-readable. */
114#define SSH_USER_CONFFILE ".ssh/config"
115
116/* File containing a list of those rsa keys that permit logging in as
117 this user. This file need not be
118 readable by anyone but the user him/herself, but does not contain
119 anything particularly secret. If the user\'s home directory resides
120 on an NFS volume where root is mapped to nobody, this may need to be
Damien Miller95def091999-11-25 00:26:21 +1100121 world-readable. (This file is read by the daemon which is running as
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000122 root.) */
123#define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
124
125/* Per-user and system-wide ssh "rc" files. These files are executed with
126 /bin/sh before starting the shell or command if they exist. They
127 will be passed "proto cookie" as arguments if X11 forwarding with
128 spoofing is in use. xauth will be run if neither of these exists. */
129#define SSH_USER_RC ".ssh/rc"
130#define SSH_SYSTEM_RC ETCDIR "/sshrc"
131
132/* Ssh-only version of /etc/hosts.equiv. */
133#define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
134
Damien Miller95def091999-11-25 00:26:21 +1100135/* Additionally, the daemon may use ~/.rhosts and /etc/hosts.equiv if
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000136 rhosts authentication is enabled. */
137
138/* Name of the environment variable containing the pathname of the
139 authentication socket. */
140#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
141
Damien Miller5eeedae1999-10-29 10:21:15 +1000142/* Name of the environment variable containing the pathname of the
Damien Miller32265091999-11-12 11:33:04 +1100143 authentication socket. */
144#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Miller5eeedae1999-10-29 10:21:15 +1000145
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000146/* Force host key length and server key length to differ by at least this
147 many bits. This is to make double encryption with rsaref work. */
148#define SSH_KEY_BITS_RESERVED 128
149
Damien Miller95def091999-11-25 00:26:21 +1100150/* Length of the session key in bytes. (Specified as 256 bits in the
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000151 protocol.) */
152#define SSH_SESSION_KEY_LENGTH 32
153
154/* Name of Kerberos service for SSH to use. */
155#define KRB4_SERVICE_NAME "rcmd"
156
157/* Authentication methods. New types can be added, but old types should not
158 be removed for compatibility. The maximum allowed value is 31. */
159#define SSH_AUTH_RHOSTS 1
160#define SSH_AUTH_RSA 2
161#define SSH_AUTH_PASSWORD 3
162#define SSH_AUTH_RHOSTS_RSA 4
Damien Miller95def091999-11-25 00:26:21 +1100163#define SSH_AUTH_TIS 5
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000164#define SSH_AUTH_KERBEROS 6
165#define SSH_PASS_KERBEROS_TGT 7
Damien Miller95def091999-11-25 00:26:21 +1100166 /* 8 to 15 are reserved */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000167#define SSH_PASS_AFS_TOKEN 21
168
169/* Protocol flags. These are bit masks. */
Damien Miller95def091999-11-25 00:26:21 +1100170#define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes
171 * screen */
172#define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain
173 * host */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000174
175/* Definition of message types. New values can be added, but old values
176 should not be removed or without careful consideration of the consequences
177 for compatibility. The maximum value is 254; value 255 is reserved
178 for future extension. */
Damien Miller95def091999-11-25 00:26:21 +1100179 /* Message name *//* msg code *//* arguments */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000180#define SSH_MSG_NONE 0 /* no message */
181#define SSH_MSG_DISCONNECT 1 /* cause (string) */
182#define SSH_SMSG_PUBLIC_KEY 2 /* ck,msk,srvk,hostk */
183#define SSH_CMSG_SESSION_KEY 3 /* key (BIGNUM) */
184#define SSH_CMSG_USER 4 /* user (string) */
185#define SSH_CMSG_AUTH_RHOSTS 5 /* user (string) */
186#define SSH_CMSG_AUTH_RSA 6 /* modulus (BIGNUM) */
187#define SSH_SMSG_AUTH_RSA_CHALLENGE 7 /* int (BIGNUM) */
188#define SSH_CMSG_AUTH_RSA_RESPONSE 8 /* int (BIGNUM) */
189#define SSH_CMSG_AUTH_PASSWORD 9 /* pass (string) */
190#define SSH_CMSG_REQUEST_PTY 10 /* TERM, tty modes */
191#define SSH_CMSG_WINDOW_SIZE 11 /* row,col,xpix,ypix */
192#define SSH_CMSG_EXEC_SHELL 12 /* */
193#define SSH_CMSG_EXEC_CMD 13 /* cmd (string) */
194#define SSH_SMSG_SUCCESS 14 /* */
195#define SSH_SMSG_FAILURE 15 /* */
196#define SSH_CMSG_STDIN_DATA 16 /* data (string) */
197#define SSH_SMSG_STDOUT_DATA 17 /* data (string) */
198#define SSH_SMSG_STDERR_DATA 18 /* data (string) */
199#define SSH_CMSG_EOF 19 /* */
200#define SSH_SMSG_EXITSTATUS 20 /* status (int) */
201#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* channel (int) */
202#define SSH_MSG_CHANNEL_OPEN_FAILURE 22 /* channel (int) */
203#define SSH_MSG_CHANNEL_DATA 23 /* ch,data (int,str) */
204#define SSH_MSG_CHANNEL_CLOSE 24 /* channel (int) */
205#define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* channel (int) */
206/* SSH_CMSG_X11_REQUEST_FORWARDING 26 OBSOLETE */
207#define SSH_SMSG_X11_OPEN 27 /* channel (int) */
208#define SSH_CMSG_PORT_FORWARD_REQUEST 28 /* p,host,hp (i,s,i) */
209#define SSH_MSG_PORT_OPEN 29 /* ch,h,p (i,s,i) */
210#define SSH_CMSG_AGENT_REQUEST_FORWARDING 30 /* */
211#define SSH_SMSG_AGENT_OPEN 31 /* port (int) */
212#define SSH_MSG_IGNORE 32 /* string */
213#define SSH_CMSG_EXIT_CONFIRMATION 33 /* */
214#define SSH_CMSG_X11_REQUEST_FORWARDING 34 /* proto,data (s,s) */
215#define SSH_CMSG_AUTH_RHOSTS_RSA 35 /* user,mod (s,mpi) */
216#define SSH_MSG_DEBUG 36 /* string */
217#define SSH_CMSG_REQUEST_COMPRESSION 37 /* level 1-9 (int) */
218#define SSH_CMSG_MAX_PACKET_SIZE 38 /* size 4k-1024k (int) */
Damien Miller95def091999-11-25 00:26:21 +1100219#define SSH_CMSG_AUTH_TIS 39 /* we use this for s/key */
220#define SSH_SMSG_AUTH_TIS_CHALLENGE 40 /* challenge (string) */
221#define SSH_CMSG_AUTH_TIS_RESPONSE 41 /* response (string) */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000222#define SSH_CMSG_AUTH_KERBEROS 42 /* (KTEXT) */
223#define SSH_SMSG_AUTH_KERBEROS_RESPONSE 43 /* (KTEXT) */
224#define SSH_CMSG_HAVE_KERBEROS_TGT 44 /* credentials (s) */
225#define SSH_CMSG_HAVE_AFS_TOKEN 65 /* token (s) */
226
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000227/*------------ definitions for login.c -------------*/
228
Damien Miller95def091999-11-25 00:26:21 +1100229/* Returns the time when the user last logged in. Returns 0 if the
230 information is not available. This must be called before record_login.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000231 The host from which the user logged in is stored in buf. */
Damien Miller95def091999-11-25 00:26:21 +1100232unsigned long
233get_last_login_time(uid_t uid, const char *logname,
234 char *buf, unsigned int bufsize);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000235
236/* Records that the user has logged in. This does many things normally
237 done by login(1). */
Damien Miller95def091999-11-25 00:26:21 +1100238void
239record_login(int pid, const char *ttyname, const char *user, uid_t uid,
240 const char *host, struct sockaddr_in * addr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000241
242/* Records that the user has logged out. This does many thigs normally
243 done by login(1) or init. */
Damien Miller95def091999-11-25 00:26:21 +1100244void record_logout(int pid, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000245
246/*------------ definitions for sshconnect.c ----------*/
247
248/* Opens a TCP/IP connection to the remote server on the given host. If
249 port is 0, the default port will be used. If anonymous is zero,
Damien Miller95def091999-11-25 00:26:21 +1100250 a privileged port will be allocated to make the connection.
251 This requires super-user privileges if anonymous is false.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000252 Connection_attempts specifies the maximum number of tries, one per
253 second. This returns true on success, and zero on failure. If the
254 connection is successful, this calls packet_set_connection for the
255 connection. */
Damien Miller95def091999-11-25 00:26:21 +1100256int
257ssh_connect(const char *host, struct sockaddr_in * hostaddr,
258 int port, int connection_attempts,
259 int anonymous, uid_t original_real_uid,
260 const char *proxy_command);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000261
262/* Starts a dialog with the server, and authenticates the current user on the
263 server. This does not need any extra privileges. The basic connection
Damien Miller95def091999-11-25 00:26:21 +1100264 to the server must already have been established before this is called.
265 If login fails, this function prints an error and never returns.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000266 This initializes the random state, and leaves it initialized (it will also
267 have references from the packet module). */
Damien Miller5ce662a1999-11-11 17:57:39 +1100268
Damien Miller95def091999-11-25 00:26:21 +1100269void
270ssh_login(int host_key_valid, RSA * host_key, const char *host,
271 struct sockaddr_in * hostaddr, uid_t original_real_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000272
273/*------------ Definitions for various authentication methods. -------*/
274
275/* Tries to authenticate the user using the .rhosts file. Returns true if
276 authentication succeeds. If ignore_rhosts is non-zero, this will not
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100277 consider .rhosts and .shosts (/etc/hosts.equiv will still be used). */
Damien Miller95def091999-11-25 00:26:21 +1100278int auth_rhosts(struct passwd * pw, const char *client_user);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000279
280/* Tries to authenticate the user using the .rhosts file and the host using
281 its host key. Returns true if authentication succeeds. */
Damien Miller95def091999-11-25 00:26:21 +1100282int
283auth_rhosts_rsa(struct passwd * pw, const char *client_user,
284 BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000285
286/* Tries to authenticate the user using password. Returns true if
287 authentication succeeds. */
Damien Miller95def091999-11-25 00:26:21 +1100288int auth_password(struct passwd * pw, const char *password);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000289
290/* Performs the RSA authentication dialog with the client. This returns
291 0 if the client could not be authenticated, and 1 if authentication was
292 successful. This may exit if there is a serious protocol violation. */
Damien Miller95def091999-11-25 00:26:21 +1100293int auth_rsa(struct passwd * pw, BIGNUM * client_n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000294
295/* Parses an RSA key (number of bits, e, n) from a string. Moves the pointer
296 over the key. Skips any whitespace at the beginning and at end. */
Damien Miller95def091999-11-25 00:26:21 +1100297int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000298
299/* Returns the name of the machine at the other end of the socket. The
300 returned string should be freed by the caller. */
Damien Miller95def091999-11-25 00:26:21 +1100301char *get_remote_hostname(int socket);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000302
303/* Return the canonical name of the host in the other side of the current
304 connection (as returned by packet_get_connection). The host name is
305 cached, so it is efficient to call this several times. */
306const char *get_canonical_hostname(void);
307
308/* Returns the remote IP address as an ascii string. The value need not be
309 freed by the caller. */
310const char *get_remote_ipaddr(void);
311
312/* Returns the port number of the peer of the socket. */
Damien Miller95def091999-11-25 00:26:21 +1100313int get_peer_port(int sock);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000314
315/* Returns the port number of the remote host. */
Damien Miller95def091999-11-25 00:26:21 +1100316int get_remote_port(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000317
318/* Tries to match the host name (which must be in all lowercase) against the
Damien Miller95def091999-11-25 00:26:21 +1100319 comma-separated sequence of subpatterns (each possibly preceded by ! to
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000320 indicate negation). Returns true if there is a positive match; zero
321 otherwise. */
Damien Miller95def091999-11-25 00:26:21 +1100322int match_hostname(const char *host, const char *pattern, unsigned int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000323
324/* Checks whether the given host is already in the list of our known hosts.
325 Returns HOST_OK if the host is known and has the specified key,
326 HOST_NEW if the host is not known, and HOST_CHANGED if the host is known
327 but used to have a different host key. The host must be in all lowercase. */
Damien Miller95def091999-11-25 00:26:21 +1100328typedef enum {
329 HOST_OK, HOST_NEW, HOST_CHANGED
330} HostStatus;
331HostStatus
332check_host_in_hostfile(const char *filename, const char *host,
333 BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000334
335/* Appends an entry to the host file. Returns false if the entry
336 could not be appended. */
Damien Miller95def091999-11-25 00:26:21 +1100337int
338add_host_to_hostfile(const char *filename, const char *host,
339 BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000340
341/* Performs the RSA authentication challenge-response dialog with the client,
342 and returns true (non-zero) if the client gave the correct answer to
343 our challenge; returns zero if the client gives a wrong answer. */
Damien Miller95def091999-11-25 00:26:21 +1100344int auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000345
Damien Miller95def091999-11-25 00:26:21 +1100346/* Reads a passphrase from /dev/tty with echo turned off. Returns the
347 passphrase (allocated with xmalloc). Exits if EOF is encountered.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000348 If from_stdin is true, the passphrase will be read from stdin instead. */
Damien Miller95def091999-11-25 00:26:21 +1100349char *read_passphrase(const char *prompt, int from_stdin);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000350
351/* Saves the authentication (private) key in a file, encrypting it with
352 passphrase. The identification of the file (lowest 64 bits of n)
353 will precede the key to provide identification of the key without
354 needing a passphrase. */
Damien Miller95def091999-11-25 00:26:21 +1100355int
356save_private_key(const char *filename, const char *passphrase,
357 RSA * private_key, const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000358
Damien Miller95def091999-11-25 00:26:21 +1100359/* Loads the public part of the key file (public key and comment).
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000360 Returns 0 if an error occurred; zero if the public key was successfully
361 read. The comment of the key is returned in comment_return if it is
362 non-NULL; the caller must free the value with xfree. */
Damien Miller95def091999-11-25 00:26:21 +1100363int
364load_public_key(const char *filename, RSA * pub,
365 char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000366
367/* Loads the private key from the file. Returns 0 if an error is encountered
368 (file does not exist or is not readable, or passphrase is bad).
Damien Miller95def091999-11-25 00:26:21 +1100369 This initializes the private key. The comment of the key is returned
370 in comment_return if it is non-NULL; the caller must free the value
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000371 with xfree. */
Damien Miller95def091999-11-25 00:26:21 +1100372int
373load_private_key(const char *filename, const char *passphrase,
374 RSA * private_key, char **comment_return);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000375
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100376/*------------ Definitions for logging. -----------------------*/
377
378/* Supported syslog facilities and levels. */
Damien Miller95def091999-11-25 00:26:21 +1100379typedef enum {
380 SYSLOG_FACILITY_DAEMON,
381 SYSLOG_FACILITY_USER,
382 SYSLOG_FACILITY_AUTH,
383 SYSLOG_FACILITY_LOCAL0,
384 SYSLOG_FACILITY_LOCAL1,
385 SYSLOG_FACILITY_LOCAL2,
386 SYSLOG_FACILITY_LOCAL3,
387 SYSLOG_FACILITY_LOCAL4,
388 SYSLOG_FACILITY_LOCAL5,
389 SYSLOG_FACILITY_LOCAL6,
390 SYSLOG_FACILITY_LOCAL7
391} SyslogFacility;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100392
Damien Miller95def091999-11-25 00:26:21 +1100393typedef enum {
394 SYSLOG_LEVEL_QUIET,
395 SYSLOG_LEVEL_FATAL,
396 SYSLOG_LEVEL_ERROR,
397 SYSLOG_LEVEL_INFO,
398 SYSLOG_LEVEL_VERBOSE,
399 SYSLOG_LEVEL_DEBUG
400} LogLevel;
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100401/* Initializes logging. */
Damien Miller95def091999-11-25 00:26:21 +1100402void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100403
404/* Logging implementation, depending on server or client */
Damien Miller95def091999-11-25 00:26:21 +1100405void do_log(LogLevel level, const char *fmt, va_list args);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100406
Damien Miller6162d121999-11-21 13:23:52 +1100407/* name to facility/level */
408SyslogFacility log_facility_number(char *name);
409LogLevel log_level_number(char *name);
410
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100411/* Output a message to syslog or stderr */
Damien Miller95def091999-11-25 00:26:21 +1100412void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
413void error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
414void log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
415void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
416void debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100417
418/* same as fatal() but w/o logging */
Damien Miller95def091999-11-25 00:26:21 +1100419void fatal_cleanup(void);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100420
Damien Miller95def091999-11-25 00:26:21 +1100421/* Registers a cleanup function to be called by fatal()/fatal_cleanup() before exiting.
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100422 It is permissible to call fatal_remove_cleanup for the function itself
423 from the function. */
Damien Miller95def091999-11-25 00:26:21 +1100424void fatal_add_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100425
426/* Removes a cleanup function to be called at fatal(). */
Damien Miller95def091999-11-25 00:26:21 +1100427void fatal_remove_cleanup(void (*proc) (void *context), void *context);
Damien Miller6d7b2cd1999-11-12 15:19:27 +1100428
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000429/*---------------- definitions for channels ------------------*/
430
431/* Sets specific protocol options. */
Damien Miller95def091999-11-25 00:26:21 +1100432void channel_set_options(int hostname_in_open);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000433
434/* Allocate a new channel object and set its type and socket. Remote_name
435 must have been allocated with xmalloc; this will free it when the channel
436 is freed. */
Damien Miller95def091999-11-25 00:26:21 +1100437int channel_allocate(int type, int sock, char *remote_name);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000438
439/* Free the channel and close its socket. */
Damien Miller95def091999-11-25 00:26:21 +1100440void channel_free(int channel);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000441
442/* Add any bits relevant to channels in select bitmasks. */
Damien Miller95def091999-11-25 00:26:21 +1100443void channel_prepare_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000444
445/* After select, perform any appropriate operations for channels which
446 have events pending. */
Damien Miller95def091999-11-25 00:26:21 +1100447void channel_after_select(fd_set * readset, fd_set * writeset);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000448
449/* If there is data to send to the connection, send some of it now. */
Damien Miller95def091999-11-25 00:26:21 +1100450void channel_output_poll(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000451
452/* This is called when a packet of type CHANNEL_DATA has just been received.
453 The message type has already been consumed, but channel number and data
454 is still there. */
Damien Miller95def091999-11-25 00:26:21 +1100455void channel_input_data(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000456
457/* Returns true if no channel has too much buffered data. */
Damien Miller95def091999-11-25 00:26:21 +1100458int channel_not_very_much_buffered_data(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000459
460/* This is called after receiving CHANNEL_CLOSE. */
Damien Miller95def091999-11-25 00:26:21 +1100461void channel_input_close(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000462
463/* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100464void channel_input_close_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000465
466/* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
Damien Miller95def091999-11-25 00:26:21 +1100467void channel_input_open_confirmation(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000468
469/* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
Damien Miller95def091999-11-25 00:26:21 +1100470void channel_input_open_failure(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000471
472/* This closes any sockets that are listening for connections; this removes
473 any unix domain sockets. */
Damien Miller95def091999-11-25 00:26:21 +1100474void channel_stop_listening(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000475
476/* Closes the sockets of all channels. This is used to close extra file
477 descriptors after a fork. */
Damien Miller95def091999-11-25 00:26:21 +1100478void channel_close_all(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000479
480/* Returns the maximum file descriptor number used by the channels. */
Damien Miller95def091999-11-25 00:26:21 +1100481int channel_max_fd(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000482
483/* Returns true if there is still an open channel over the connection. */
Damien Miller95def091999-11-25 00:26:21 +1100484int channel_still_open(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000485
486/* Returns a string containing a list of all open channels. The list is
487 suitable for displaying to the user. It uses crlf instead of newlines.
488 The caller should free the string with xfree. */
Damien Miller95def091999-11-25 00:26:21 +1100489char *channel_open_message(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000490
491/* Initiate forwarding of connections to local port "port" through the secure
492 channel to host:port from remote side. This never returns if there
493 was an error. */
Damien Miller95def091999-11-25 00:26:21 +1100494void
495channel_request_local_forwarding(int port, const char *host,
496 int remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000497
498/* Initiate forwarding of connections to port "port" on remote host through
499 the secure channel to host:port from local side. This never returns
500 if there was an error. This registers that open requests for that
501 port are permitted. */
Damien Miller95def091999-11-25 00:26:21 +1100502void
503channel_request_remote_forwarding(int port, const char *host,
504 int remote_port);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000505
506/* Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
507 called by the server, because the user could connect to any port anyway,
508 and the server has no way to know but to trust the client anyway. */
Damien Miller95def091999-11-25 00:26:21 +1100509void channel_permit_all_opens(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000510
511/* This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
512 listening for the port, and sends back a success reply (or disconnect
Damien Miller95def091999-11-25 00:26:21 +1100513 message if there was an error). This never returns if there was an
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000514 error. */
Damien Miller95def091999-11-25 00:26:21 +1100515void channel_input_port_forward_request(int is_root);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000516
517/* This is called after receiving PORT_OPEN message. This attempts to connect
518 to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION or
519 CHANNEL_OPEN_FAILURE. */
Damien Miller95def091999-11-25 00:26:21 +1100520void channel_input_port_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000521
522/* Creates a port for X11 connections, and starts listening for it.
523 Returns the display name, or NULL if an error was encountered. */
Damien Miller95def091999-11-25 00:26:21 +1100524char *x11_create_display(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000525
Damien Miller95def091999-11-25 00:26:21 +1100526/* Creates an internet domain socket for listening for X11 connections.
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000527 Returns a suitable value for the DISPLAY variable, or NULL if an error
528 occurs. */
Damien Miller95def091999-11-25 00:26:21 +1100529char *x11_create_display_inet(int screen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000530
531/* This is called when SSH_SMSG_X11_OPEN is received. The packet contains
532 the remote channel number. We should do whatever we want, and respond
533 with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE. */
Damien Miller95def091999-11-25 00:26:21 +1100534void x11_input_open(int payload_len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000535
Damien Miller95def091999-11-25 00:26:21 +1100536/* Requests forwarding of X11 connections. This should be called on the
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000537 client only. */
Damien Miller95def091999-11-25 00:26:21 +1100538void x11_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000539
540/* Requests forwarding for X11 connections, with authentication spoofing.
541 This should be called in the client only. */
Damien Miller95def091999-11-25 00:26:21 +1100542void x11_request_forwarding_with_spoofing(const char *proto, const char *data);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000543
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000544/* Sends a message to the server to request authentication fd forwarding. */
Damien Miller95def091999-11-25 00:26:21 +1100545void auth_request_forwarding(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000546
547/* Returns the name of the forwarded authentication socket. Returns NULL
548 if there is no forwarded authentication socket. The returned value points
549 to a static buffer. */
Damien Miller95def091999-11-25 00:26:21 +1100550char *auth_get_socket_name(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000551
552/* This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
553 This starts forwarding authentication requests. */
Damien Miller95def091999-11-25 00:26:21 +1100554void auth_input_request_forwarding(struct passwd * pw);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000555
556/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
Damien Miller95def091999-11-25 00:26:21 +1100557void auth_input_open_request(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000558
559/* Returns true if the given string matches the pattern (which may contain
560 ? and * as wildcards), and zero if it does not match. */
Damien Miller95def091999-11-25 00:26:21 +1100561int match_pattern(const char *s, const char *pattern);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000562
563/* Expands tildes in the file name. Returns data allocated by xmalloc.
564 Warning: this calls getpw*. */
Damien Miller95def091999-11-25 00:26:21 +1100565char *tilde_expand_filename(const char *filename, uid_t my_uid);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000566
567/* Performs the interactive session. This handles data transmission between
568 the client and the program. Note that the notion of stdin, stdout, and
569 stderr in this function is sort of reversed: this function writes to
570 stdin (of the child program), and reads from stdout and stderr (of the
571 child program). */
Damien Miller95def091999-11-25 00:26:21 +1100572void server_loop(int pid, int fdin, int fdout, int fderr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000573
574/* Client side main loop for the interactive session. */
Damien Miller95def091999-11-25 00:26:21 +1100575int client_loop(int have_pty, int escape_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000576
577/* Linked list of custom environment strings (see auth-rsa.c). */
578struct envstring {
Damien Miller95def091999-11-25 00:26:21 +1100579 struct envstring *next;
580 char *s;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000581};
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000582#ifdef KRB4
583#include <krb.h>
584
585/* Performs Kerberos v4 mutual authentication with the client. This returns
586 0 if the client could not be authenticated, and 1 if authentication was
587 successful. This may exit if there is a serious protocol violation. */
Damien Miller95def091999-11-25 00:26:21 +1100588int auth_krb4(const char *server_user, KTEXT auth, char **client);
589int krb4_init(uid_t uid);
590void krb4_cleanup_proc(void *ignore);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000591
592#ifdef AFS
593#include <kafs.h>
594
595/* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
Damien Miller95def091999-11-25 00:26:21 +1100596int auth_kerberos_tgt(struct passwd * pw, const char *string);
597int auth_afs_token(struct passwd * pw, const char *token_string);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000598
Damien Miller95def091999-11-25 00:26:21 +1100599int creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
600int radix_to_creds(const char *buf, CREDENTIALS * creds);
601#endif /* AFS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000602
Damien Miller95def091999-11-25 00:26:21 +1100603#endif /* KRB4 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000604
605#ifdef SKEY
606#include <skey.h>
Damien Miller95def091999-11-25 00:26:21 +1100607char *skey_fake_keyinfo(char *username);
608#endif /* SKEY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000609
Damien Miller95def091999-11-25 00:26:21 +1100610#endif /* SSH_H */