]>
Commit | Line | Data |
---|---|---|
8efc0c15 | 1 | /* |
6ae2364d | 2 | * |
5260325f | 3 | * ssh.h |
6ae2364d | 4 | * |
5260325f | 5 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
6ae2364d | 6 | * |
5260325f | 7 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
8 | * All rights reserved | |
6ae2364d | 9 | * |
5260325f | 10 | * Created: Fri Mar 17 17:09:37 1995 ylo |
6ae2364d | 11 | * |
5260325f | 12 | * Generic header file for ssh. |
6ae2364d | 13 | * |
5260325f | 14 | */ |
8efc0c15 | 15 | |
74fc9186 | 16 | /* RCSID("$OpenBSD: ssh.h,v 1.47 2000/06/20 01:39:45 markus Exp $"); */ |
8efc0c15 | 17 | |
18 | #ifndef SSH_H | |
19 | #define SSH_H | |
20 | ||
4cca272e | 21 | #include <netinet/in.h> /* For struct sockaddr_in */ |
22 | #include <pwd.h> /* For struct pw */ | |
6a17f9c2 | 23 | #include <stdarg.h> /* For va_list */ |
48e671d5 | 24 | #include <sys/socket.h> /* For struct sockaddr_storage */ |
25 | #include "fake-socket.h" /* For struct sockaddr_storage */ | |
eef6f7e9 | 26 | #ifdef HAVE_SYS_SELECT_H |
27 | # include <sys/select.h> | |
28 | #endif | |
8efc0c15 | 29 | #include "rsa.h" |
30 | #include "cipher.h" | |
31 | ||
aa3378df | 32 | /* |
d0c832f3 | 33 | * XXX |
aa3378df | 34 | * 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 | */ | |
8efc0c15 | 38 | #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 | ||
aa3378df | 49 | /* |
50 | * Maximum number of RSA authentication identity files that can be specified | |
51 | * in configuration files or on the command line. | |
52 | */ | |
8efc0c15 | 53 | #define SSH_MAX_IDENTITY_FILES 100 |
54 | ||
aa3378df | 55 | /* |
56 | * Major protocol version. Different version indicates major incompatiblity | |
57 | * that prevents communication. | |
a8be9f80 | 58 | * |
aa3378df | 59 | * Minor protocol version. Different version indicates minor incompatibility |
60 | * that does not prevent interoperation. | |
61 | */ | |
a8be9f80 | 62 | #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 | |
8efc0c15 | 68 | |
aa3378df | 69 | /* |
70 | * Name for the service. The port named by this service overrides the | |
71 | * default port if present. | |
72 | */ | |
8efc0c15 | 73 | #define SSH_SERVICE_NAME "ssh" |
74 | ||
4e577b89 | 75 | #if defined(USE_PAM) && !defined(SSHD_PAM_SERVICE) |
76 | # define SSHD_PAM_SERVICE "sshd" | |
77 | #endif | |
78 | ||
8efc0c15 | 79 | #ifndef ETCDIR |
80 | #define ETCDIR "/etc" | |
81 | #endif /* ETCDIR */ | |
82 | ||
5260325f | 83 | #ifndef PIDDIR |
8efc0c15 | 84 | #define PIDDIR "/var/run" |
5260325f | 85 | #endif /* PIDDIR */ |
8efc0c15 | 86 | |
aa3378df | 87 | /* |
88 | * System-wide file containing host keys of known hosts. This file should be | |
89 | * world-readable. | |
90 | */ | |
8efc0c15 | 91 | #define SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts" |
a306f2dd | 92 | #define SSH_SYSTEM_HOSTFILE2 ETCDIR "/ssh_known_hosts2" |
8efc0c15 | 93 | |
aa3378df | 94 | /* |
95 | * Of these, ssh_host_key must be readable only by root, whereas ssh_config | |
96 | * should be world-readable. | |
97 | */ | |
8efc0c15 | 98 | #define HOST_KEY_FILE ETCDIR "/ssh_host_key" |
99 | #define SERVER_CONFIG_FILE ETCDIR "/sshd_config" | |
100 | #define HOST_CONFIG_FILE ETCDIR "/ssh_config" | |
1d1ffb87 | 101 | #define HOST_DSA_KEY_FILE ETCDIR "/ssh_host_dsa_key" |
8efc0c15 | 102 | |
e1a9c08d | 103 | #ifndef SSH_PROGRAM |
5260325f | 104 | #define SSH_PROGRAM "/usr/bin/ssh" |
e1a9c08d | 105 | #endif /* SSH_PROGRAM */ |
106 | ||
107 | #ifndef LOGIN_PROGRAM | |
5260325f | 108 | #define LOGIN_PROGRAM "/usr/bin/login" |
e1a9c08d | 109 | #endif /* LOGIN_PROGRAM */ |
8efc0c15 | 110 | |
d4f11b59 | 111 | #ifndef ASKPASS_PROGRAM |
5260325f | 112 | #define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass" |
d4f11b59 | 113 | #endif /* ASKPASS_PROGRAM */ |
114 | ||
aa3378df | 115 | /* |
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 | */ | |
f1bcacf9 | 119 | #define SSH_DAEMON_PID_FILE PIDDIR "/sshd.pid" |
8efc0c15 | 120 | |
aa3378df | 121 | /* |
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 | */ | |
8efc0c15 | 125 | #define SSH_USER_DIR ".ssh" |
126 | ||
b7a87eea | 127 | /* |
128 | * 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 */ | |
d3083fbd | 133 | #ifndef SSH_PRNG_COMMAND_FILE |
134 | # define SSH_PRNG_COMMAND_FILE ETCDIR "/ssh_prng_cmds" | |
135 | #endif /* SSH_PRNG_COMMAND_FILE */ | |
b7a87eea | 136 | |
aa3378df | 137 | /* |
138 | * 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 | */ | |
8efc0c15 | 142 | #define SSH_USER_HOSTFILE "~/.ssh/known_hosts" |
a306f2dd | 143 | #define SSH_USER_HOSTFILE2 "~/.ssh/known_hosts2" |
8efc0c15 | 144 | |
aa3378df | 145 | /* |
146 | * Name of the default file containing client-side authentication key. This | |
147 | * file should only be readable by the user him/herself. | |
148 | */ | |
8efc0c15 | 149 | #define SSH_CLIENT_IDENTITY ".ssh/identity" |
1d1ffb87 | 150 | #define SSH_CLIENT_ID_DSA ".ssh/id_dsa" |
8efc0c15 | 151 | |
aa3378df | 152 | /* |
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 | */ | |
8efc0c15 | 158 | #define SSH_USER_CONFFILE ".ssh/config" |
159 | ||
aa3378df | 160 | /* |
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 | */ | |
8efc0c15 | 168 | #define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys" |
a306f2dd | 169 | #define SSH_USER_PERMITTED_KEYS2 ".ssh/authorized_keys2" |
8efc0c15 | 170 | |
aa3378df | 171 | /* |
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 | */ | |
8efc0c15 | 177 | #define SSH_USER_RC ".ssh/rc" |
178 | #define SSH_SYSTEM_RC ETCDIR "/sshrc" | |
179 | ||
aa3378df | 180 | /* |
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 | */ | |
8efc0c15 | 184 | #define SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv" |
185 | ||
aa3378df | 186 | /* |
187 | * Name of the environment variable containing the pathname of the | |
188 | * authentication socket. | |
189 | */ | |
8efc0c15 | 190 | #define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK" |
191 | ||
aa3378df | 192 | /* |
193 | * Name of the environment variable containing the pathname of the | |
194 | * authentication socket. | |
195 | */ | |
b4748e2f | 196 | #define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID" |
50da1126 | 197 | |
57112b5a | 198 | /* |
199 | * Default path to ssh-askpass used by ssh-add, | |
200 | * environment variable for overwriting the default location | |
201 | */ | |
db28aeb5 | 202 | #ifndef SSH_ASKPASS_DEFAULT |
203 | # define SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass" | |
204 | #endif | |
57112b5a | 205 | #define SSH_ASKPASS_ENV "SSH_ASKPASS" |
206 | ||
aa3378df | 207 | /* |
208 | * 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 | */ | |
8efc0c15 | 211 | #define SSH_KEY_BITS_RESERVED 128 |
212 | ||
aa3378df | 213 | /* |
214 | * Length of the session key in bytes. (Specified as 256 bits in the | |
215 | * protocol.) | |
216 | */ | |
8efc0c15 | 217 | #define SSH_SESSION_KEY_LENGTH 32 |
218 | ||
219 | /* Name of Kerberos service for SSH to use. */ | |
220 | #define KRB4_SERVICE_NAME "rcmd" | |
221 | ||
aa3378df | 222 | /* |
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 | */ | |
8efc0c15 | 226 | #define SSH_AUTH_RHOSTS 1 |
227 | #define SSH_AUTH_RSA 2 | |
228 | #define SSH_AUTH_PASSWORD 3 | |
229 | #define SSH_AUTH_RHOSTS_RSA 4 | |
5260325f | 230 | #define SSH_AUTH_TIS 5 |
8efc0c15 | 231 | #define SSH_AUTH_KERBEROS 6 |
232 | #define SSH_PASS_KERBEROS_TGT 7 | |
aa3378df | 233 | /* 8 to 15 are reserved */ |
8efc0c15 | 234 | #define SSH_PASS_AFS_TOKEN 21 |
235 | ||
236 | /* Protocol flags. These are bit masks. */ | |
aa3378df | 237 | #define SSH_PROTOFLAG_SCREEN_NUMBER 1 /* X11 forwarding includes screen */ |
238 | #define SSH_PROTOFLAG_HOST_IN_FWD_OPEN 2 /* forwarding opens contain host */ | |
239 | ||
240 | /* | |
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 */ | |
8efc0c15 | 247 | #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) */ | |
5260325f | 286 | #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) */ | |
8efc0c15 | 289 | #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 | ||
8efc0c15 | 294 | /*------------ definitions for login.c -------------*/ |
295 | ||
aa3378df | 296 | /* |
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 | */ | |
6ae2364d | 301 | unsigned long |
5260325f | 302 | get_last_login_time(uid_t uid, const char *logname, |
303 | char *buf, unsigned int bufsize); | |
8efc0c15 | 304 | |
aa3378df | 305 | /* |
306 | * Records that the user has logged in. This does many things normally done | |
307 | * by login(1). | |
308 | */ | |
6ae2364d | 309 | void |
9da5c3c9 | 310 | record_login(pid_t pid, const char *ttyname, const char *user, uid_t uid, |
48e671d5 | 311 | const char *host, struct sockaddr *addr); |
8efc0c15 | 312 | |
aa3378df | 313 | /* |
314 | * Records that the user has logged out. This does many thigs normally done | |
315 | * by login(1) or init. | |
316 | */ | |
9da5c3c9 | 317 | void record_logout(pid_t pid, const char *ttyname); |
8efc0c15 | 318 | |
319 | /*------------ definitions for sshconnect.c ----------*/ | |
320 | ||
aa3378df | 321 | /* |
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 | */ | |
6ae2364d | 330 | int |
48e671d5 | 331 | ssh_connect(const char *host, struct sockaddr_storage * hostaddr, |
57112b5a | 332 | u_short port, int connection_attempts, |
5260325f | 333 | int anonymous, uid_t original_real_uid, |
334 | const char *proxy_command); | |
8efc0c15 | 335 | |
aa3378df | 336 | /* |
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 | */ | |
6a17f9c2 | 344 | |
6ae2364d | 345 | void |
5260325f | 346 | ssh_login(int host_key_valid, RSA * host_key, const char *host, |
48e671d5 | 347 | struct sockaddr * hostaddr, uid_t original_real_uid); |
8efc0c15 | 348 | |
349 | /*------------ Definitions for various authentication methods. -------*/ | |
350 | ||
aa3378df | 351 | /* |
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 | */ | |
5260325f | 356 | int auth_rhosts(struct passwd * pw, const char *client_user); |
8efc0c15 | 357 | |
aa3378df | 358 | /* |
359 | * Tries to authenticate the user using the .rhosts file and the host using | |
360 | * its host key. Returns true if authentication succeeds. | |
361 | */ | |
6ae2364d | 362 | int |
4fe2af09 | 363 | auth_rhosts_rsa(struct passwd * pw, const char *client_user, RSA* client_host_key); |
8efc0c15 | 364 | |
aa3378df | 365 | /* |
366 | * Tries to authenticate the user using password. Returns true if | |
367 | * authentication succeeds. | |
368 | */ | |
5260325f | 369 | int auth_password(struct passwd * pw, const char *password); |
8efc0c15 | 370 | |
aa3378df | 371 | /* |
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 | */ | |
5260325f | 376 | int auth_rsa(struct passwd * pw, BIGNUM * client_n); |
8efc0c15 | 377 | |
aa3378df | 378 | /* |
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 | */ | |
5260325f | 382 | int auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n); |
8efc0c15 | 383 | |
aa3378df | 384 | /* |
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 | */ | |
5260325f | 388 | char *get_remote_hostname(int socket); |
8efc0c15 | 389 | |
aa3378df | 390 | /* |
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 | */ | |
8efc0c15 | 395 | const char *get_canonical_hostname(void); |
396 | ||
aa3378df | 397 | /* |
398 | * Returns the remote IP address as an ascii string. The value need not be | |
399 | * freed by the caller. | |
400 | */ | |
8efc0c15 | 401 | const char *get_remote_ipaddr(void); |
402 | ||
403 | /* Returns the port number of the peer of the socket. */ | |
5260325f | 404 | int get_peer_port(int sock); |
8efc0c15 | 405 | |
48e671d5 | 406 | /* Returns the port number of the remote/local host. */ |
5260325f | 407 | int get_remote_port(void); |
48e671d5 | 408 | int get_local_port(void); |
409 | ||
8efc0c15 | 410 | |
aa3378df | 411 | /* |
412 | * Performs the RSA authentication challenge-response dialog with the client, | |
413 | * and returns true (non-zero) if the client gave the correct answer to our | |
414 | * challenge; returns zero if the client gives a wrong answer. | |
415 | */ | |
4fe2af09 | 416 | int auth_rsa_challenge_dialog(RSA *pk); |
8efc0c15 | 417 | |
aa3378df | 418 | /* |
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 | */ | |
5260325f | 423 | char *read_passphrase(const char *prompt, int from_stdin); |
8efc0c15 | 424 | |
8efc0c15 | 425 | |
6fa724bc | 426 | /*------------ Definitions for logging. -----------------------*/ |
427 | ||
428 | /* Supported syslog facilities and levels. */ | |
5260325f | 429 | typedef 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; | |
442 | ||
443 | typedef 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; | |
6fa724bc | 451 | /* Initializes logging. */ |
5260325f | 452 | void log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr); |
6fa724bc | 453 | |
454 | /* Logging implementation, depending on server or client */ | |
5260325f | 455 | void do_log(LogLevel level, const char *fmt, va_list args); |
6fa724bc | 456 | |
9d6b7add | 457 | /* name to facility/level */ |
458 | SyslogFacility log_facility_number(char *name); | |
459 | LogLevel log_level_number(char *name); | |
460 | ||
6fa724bc | 461 | /* Output a message to syslog or stderr */ |
5260325f | 462 | void fatal(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
463 | void error(const char *fmt,...) __attribute__((format(printf, 1, 2))); | |
464 | void log(const char *fmt,...) __attribute__((format(printf, 1, 2))); | |
465 | void verbose(const char *fmt,...) __attribute__((format(printf, 1, 2))); | |
466 | void debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); | |
6fa724bc | 467 | |
468 | /* same as fatal() but w/o logging */ | |
5260325f | 469 | void fatal_cleanup(void); |
6fa724bc | 470 | |
aa3378df | 471 | /* |
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 | */ | |
5260325f | 476 | void fatal_add_cleanup(void (*proc) (void *context), void *context); |
6fa724bc | 477 | |
478 | /* Removes a cleanup function to be called at fatal(). */ | |
5260325f | 479 | void fatal_remove_cleanup(void (*proc) (void *context), void *context); |
6fa724bc | 480 | |
e78a59f5 | 481 | /* ---- misc */ |
482 | ||
aa3378df | 483 | /* |
484 | * Expands tildes in the file name. Returns data allocated by xmalloc. | |
485 | * Warning: this calls getpw*. | |
486 | */ | |
5260325f | 487 | char *tilde_expand_filename(const char *filename, uid_t my_uid); |
8efc0c15 | 488 | |
0e73cc53 | 489 | /* remove newline at end of string */ |
490 | char *chop(char *s); | |
491 | ||
492 | /* set filedescriptor to non-blocking */ | |
493 | void set_nonblock(int fd); | |
494 | ||
aa3378df | 495 | /* |
496 | * Performs the interactive session. This handles data transmission between | |
497 | * the client and the program. Note that the notion of stdin, stdout, and | |
498 | * stderr in this function is sort of reversed: this function writes to stdin | |
499 | * (of the child program), and reads from stdout and stderr (of the child | |
500 | * program). | |
501 | */ | |
9da5c3c9 | 502 | void server_loop(pid_t pid, int fdin, int fdout, int fderr); |
e78a59f5 | 503 | void server_loop2(void); |
8efc0c15 | 504 | |
505 | /* Client side main loop for the interactive session. */ | |
5260325f | 506 | int client_loop(int have_pty, int escape_char); |
8efc0c15 | 507 | |
508 | /* Linked list of custom environment strings (see auth-rsa.c). */ | |
509 | struct envstring { | |
5260325f | 510 | struct envstring *next; |
511 | char *s; | |
8efc0c15 | 512 | }; |
a408af76 | 513 | |
514 | /* | |
515 | * Ensure all of data on socket comes through. f==read || f==write | |
516 | */ | |
c8d54615 | 517 | ssize_t atomicio(ssize_t (*f)(), int fd, void *s, size_t n); |
a408af76 | 518 | |
8efc0c15 | 519 | #ifdef KRB4 |
520 | #include <krb.h> | |
aa3378df | 521 | /* |
522 | * Performs Kerberos v4 mutual authentication with the client. This returns 0 | |
523 | * if the client could not be authenticated, and 1 if authentication was | |
524 | * successful. This may exit if there is a serious protocol violation. | |
525 | */ | |
5260325f | 526 | int auth_krb4(const char *server_user, KTEXT auth, char **client); |
527 | int krb4_init(uid_t uid); | |
528 | void krb4_cleanup_proc(void *ignore); | |
57112b5a | 529 | int auth_krb4_password(struct passwd * pw, const char *password); |
8efc0c15 | 530 | |
531 | #ifdef AFS | |
532 | #include <kafs.h> | |
533 | ||
534 | /* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */ | |
5260325f | 535 | int auth_kerberos_tgt(struct passwd * pw, const char *string); |
536 | int auth_afs_token(struct passwd * pw, const char *token_string); | |
8efc0c15 | 537 | |
1d1ffb87 | 538 | int creds_to_radix(CREDENTIALS * creds, unsigned char *buf, size_t buflen); |
5260325f | 539 | int radix_to_creds(const char *buf, CREDENTIALS * creds); |
540 | #endif /* AFS */ | |
8efc0c15 | 541 | |
5260325f | 542 | #endif /* KRB4 */ |
8efc0c15 | 543 | |
544 | #ifdef SKEY | |
545 | #include <skey.h> | |
5260325f | 546 | char *skey_fake_keyinfo(char *username); |
57112b5a | 547 | int auth_skey_password(struct passwd * pw, const char *password); |
5260325f | 548 | #endif /* SKEY */ |
8efc0c15 | 549 | |
48e671d5 | 550 | /* AF_UNSPEC or AF_INET or AF_INET6 */ |
551 | extern int IPv4or6; | |
552 | ||
a5c9cd31 | 553 | #ifdef USE_PAM |
554 | #include "auth-pam.h" | |
555 | #endif /* USE_PAM */ | |
556 | ||
5260325f | 557 | #endif /* SSH_H */ |