]> andersk Git - openssh.git/blob - ssh.h
Add support for GNU rx library for those lacking regexp support
[openssh.git] / ssh.h
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  *
6  * Generic header file for ssh.
7  *
8  * 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".
13  */
14
15 /* RCSID("$OpenBSD: ssh.h,v 1.54 2000/10/11 20:27:24 markus Exp $"); */
16
17 #ifndef SSH_H
18 #define SSH_H
19
20 #include <netinet/in.h> /* For struct sockaddr_in */
21 #include <pwd.h> /* For struct pw */
22 #include <stdarg.h> /* For va_list */
23 #include <sys/socket.h> /* For struct sockaddr_storage */
24 #include "fake-socket.h" /* For struct sockaddr_storage */
25 #ifdef HAVE_SYS_SELECT_H
26 # include <sys/select.h>
27 #endif
28 #include "rsa.h"
29 #include "cipher.h"
30
31 /* Cipher used for encrypting authentication files. */
32 #define SSH_AUTHFILE_CIPHER     SSH_CIPHER_3DES
33
34 /* Default port number. */
35 #define SSH_DEFAULT_PORT        22
36
37 /* Maximum number of TCP/IP ports forwarded per direction. */
38 #define SSH_MAX_FORWARDS_PER_DIRECTION  100
39
40 /*
41  * Maximum number of RSA authentication identity files that can be specified
42  * in configuration files or on the command line.
43  */
44 #define SSH_MAX_IDENTITY_FILES          100
45
46 /*
47  * Major protocol version.  Different version indicates major incompatiblity
48  * that prevents communication.
49  *
50  * Minor protocol version.  Different version indicates minor incompatibility
51  * that does not prevent interoperation.
52  */
53 #define PROTOCOL_MAJOR_1        1
54 #define PROTOCOL_MINOR_1        5
55
56 /* We support both SSH1 and SSH2 */
57 #define PROTOCOL_MAJOR_2        2
58 #define PROTOCOL_MINOR_2        0
59
60 /*
61  * Name for the service.  The port named by this service overrides the
62  * default port if present.
63  */
64 #define SSH_SERVICE_NAME        "ssh"
65
66 #if defined(USE_PAM) && !defined(SSHD_PAM_SERVICE)
67 # define SSHD_PAM_SERVICE       "sshd"
68 #endif
69
70 #ifndef ETCDIR
71 #define ETCDIR                  "/etc"
72 #endif /* ETCDIR */
73
74 #ifndef PIDDIR
75 #define PIDDIR                  "/var/run"
76 #endif /* PIDDIR */
77
78 /*
79  * System-wide file containing host keys of known hosts.  This file should be
80  * world-readable.
81  */
82 #define SSH_SYSTEM_HOSTFILE     ETCDIR "/ssh_known_hosts"
83 #define SSH_SYSTEM_HOSTFILE2    ETCDIR "/ssh_known_hosts2"
84
85 /*
86  * Of these, ssh_host_key must be readable only by root, whereas ssh_config
87  * should be world-readable.
88  */
89 #define HOST_KEY_FILE           ETCDIR "/ssh_host_key"
90 #define SERVER_CONFIG_FILE      ETCDIR "/sshd_config"
91 #define HOST_CONFIG_FILE        ETCDIR "/ssh_config"
92 #define HOST_DSA_KEY_FILE       ETCDIR "/ssh_host_dsa_key"
93 #define DH_PRIMES               ETCDIR "/primes"
94
95 #ifndef SSH_PROGRAM
96 #define SSH_PROGRAM                     "/usr/bin/ssh"
97 #endif /* SSH_PROGRAM */
98
99 #ifndef LOGIN_PROGRAM
100 # ifdef LOGIN_PROGRAM_FALLBACK
101 #  define LOGIN_PROGRAM         LOGIN_PROGRAM_FALLBACK
102 # else
103 #  define LOGIN_PROGRAM         "/usr/bin/login"
104 # endif
105 #endif /* LOGIN_PROGRAM */
106
107 #ifndef ASKPASS_PROGRAM
108 #define ASKPASS_PROGRAM         "/usr/lib/ssh/ssh-askpass"
109 #endif /* ASKPASS_PROGRAM */
110
111 /*
112  * The process id of the daemon listening for connections is saved here to
113  * make it easier to kill the correct daemon when necessary.
114  */
115 #define SSH_DAEMON_PID_FILE     PIDDIR "/sshd.pid"
116
117 /*
118  * The directory in user\'s home directory in which the files reside. The
119  * directory should be world-readable (though not all files are).
120  */
121 #define SSH_USER_DIR            ".ssh"
122
123 /*
124  * Relevant only when using builtin PRNG.
125  */
126 #ifndef SSH_PRNG_SEED_FILE
127 # define SSH_PRNG_SEED_FILE      SSH_USER_DIR"/prng_seed"
128 #endif /* SSH_PRNG_SEED_FILE */
129 #ifndef SSH_PRNG_COMMAND_FILE
130 # define SSH_PRNG_COMMAND_FILE   ETCDIR "/ssh_prng_cmds"
131 #endif /* SSH_PRNG_COMMAND_FILE */
132
133 /*
134  * Per-user file containing host keys of known hosts.  This file need not be
135  * readable by anyone except the user him/herself, though this does not
136  * contain anything particularly secret.
137  */
138 #define SSH_USER_HOSTFILE       "~/.ssh/known_hosts"
139 #define SSH_USER_HOSTFILE2      "~/.ssh/known_hosts2"
140
141 /*
142  * Name of the default file containing client-side authentication key. This
143  * file should only be readable by the user him/herself.
144  */
145 #define SSH_CLIENT_IDENTITY     ".ssh/identity"
146 #define SSH_CLIENT_ID_DSA       ".ssh/id_dsa"
147
148 /*
149  * Configuration file in user\'s home directory.  This file need not be
150  * readable by anyone but the user him/herself, but does not contain anything
151  * particularly secret.  If the user\'s home directory resides on an NFS
152  * volume where root is mapped to nobody, this may need to be world-readable.
153  */
154 #define SSH_USER_CONFFILE       ".ssh/config"
155
156 /*
157  * File containing a list of those rsa keys that permit logging in as this
158  * user.  This file need not be readable by anyone but the user him/herself,
159  * but does not contain anything particularly secret.  If the user\'s home
160  * directory resides on an NFS volume where root is mapped to nobody, this
161  * may need to be world-readable.  (This file is read by the daemon which is
162  * running as root.)
163  */
164 #define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
165 #define SSH_USER_PERMITTED_KEYS2        ".ssh/authorized_keys2"
166
167 /*
168  * Per-user and system-wide ssh "rc" files.  These files are executed with
169  * /bin/sh before starting the shell or command if they exist.  They will be
170  * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
171  * use.  xauth will be run if neither of these exists.
172  */
173 #define SSH_USER_RC             ".ssh/rc"
174 #define SSH_SYSTEM_RC           ETCDIR "/sshrc"
175
176 /*
177  * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
178  * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
179  */
180 #define SSH_HOSTS_EQUIV         ETCDIR "/shosts.equiv"
181
182 /*
183  * Name of the environment variable containing the pathname of the
184  * authentication socket.
185  */
186 #define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
187
188 /*
189  * Name of the environment variable containing the pathname of the
190  * authentication socket.
191  */
192 #define SSH_AGENTPID_ENV_NAME   "SSH_AGENT_PID"
193
194 /*
195  * Default path to ssh-askpass used by ssh-add,
196  * environment variable for overwriting the default location
197  */
198 #ifndef SSH_ASKPASS_DEFAULT
199 # define SSH_ASKPASS_DEFAULT    "/usr/X11R6/bin/ssh-askpass"
200 #endif
201 #define SSH_ASKPASS_ENV         "SSH_ASKPASS"
202
203 /*
204  * Force host key length and server key length to differ by at least this
205  * many bits.  This is to make double encryption with rsaref work.
206  */
207 #define SSH_KEY_BITS_RESERVED           128
208
209 /*
210  * Length of the session key in bytes.  (Specified as 256 bits in the
211  * protocol.)
212  */
213 #define SSH_SESSION_KEY_LENGTH          32
214
215 /* Name of Kerberos service for SSH to use. */
216 #define KRB4_SERVICE_NAME               "rcmd"
217
218 /*
219  * Authentication methods.  New types can be added, but old types should not
220  * be removed for compatibility.  The maximum allowed value is 31.
221  */
222 #define SSH_AUTH_RHOSTS         1
223 #define SSH_AUTH_RSA            2
224 #define SSH_AUTH_PASSWORD       3
225 #define SSH_AUTH_RHOSTS_RSA     4
226 #define SSH_AUTH_TIS            5
227 #define SSH_AUTH_KERBEROS       6
228 #define SSH_PASS_KERBEROS_TGT   7
229                                 /* 8 to 15 are reserved */
230 #define SSH_PASS_AFS_TOKEN      21
231
232 /* Protocol flags.  These are bit masks. */
233 #define SSH_PROTOFLAG_SCREEN_NUMBER     1       /* X11 forwarding includes screen */
234 #define SSH_PROTOFLAG_HOST_IN_FWD_OPEN  2       /* forwarding opens contain host */
235
236 /*
237  * Definition of message types.  New values can be added, but old values
238  * should not be removed or without careful consideration of the consequences
239  * for compatibility.  The maximum value is 254; value 255 is reserved for
240  * future extension.
241  */
242 /* Message name */                      /* msg code */  /* arguments */
243 #define SSH_MSG_NONE                            0       /* no message */
244 #define SSH_MSG_DISCONNECT                      1       /* cause (string) */
245 #define SSH_SMSG_PUBLIC_KEY                     2       /* ck,msk,srvk,hostk */
246 #define SSH_CMSG_SESSION_KEY                    3       /* key (BIGNUM) */
247 #define SSH_CMSG_USER                           4       /* user (string) */
248 #define SSH_CMSG_AUTH_RHOSTS                    5       /* user (string) */
249 #define SSH_CMSG_AUTH_RSA                       6       /* modulus (BIGNUM) */
250 #define SSH_SMSG_AUTH_RSA_CHALLENGE             7       /* int (BIGNUM) */
251 #define SSH_CMSG_AUTH_RSA_RESPONSE              8       /* int (BIGNUM) */
252 #define SSH_CMSG_AUTH_PASSWORD                  9       /* pass (string) */
253 #define SSH_CMSG_REQUEST_PTY                    10      /* TERM, tty modes */
254 #define SSH_CMSG_WINDOW_SIZE                    11      /* row,col,xpix,ypix */
255 #define SSH_CMSG_EXEC_SHELL                     12      /* */
256 #define SSH_CMSG_EXEC_CMD                       13      /* cmd (string) */
257 #define SSH_SMSG_SUCCESS                        14      /* */
258 #define SSH_SMSG_FAILURE                        15      /* */
259 #define SSH_CMSG_STDIN_DATA                     16      /* data (string) */
260 #define SSH_SMSG_STDOUT_DATA                    17      /* data (string) */
261 #define SSH_SMSG_STDERR_DATA                    18      /* data (string) */
262 #define SSH_CMSG_EOF                            19      /* */
263 #define SSH_SMSG_EXITSTATUS                     20      /* status (int) */
264 #define SSH_MSG_CHANNEL_OPEN_CONFIRMATION       21      /* channel (int) */
265 #define SSH_MSG_CHANNEL_OPEN_FAILURE            22      /* channel (int) */
266 #define SSH_MSG_CHANNEL_DATA                    23      /* ch,data (int,str) */
267 #define SSH_MSG_CHANNEL_CLOSE                   24      /* channel (int) */
268 #define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION      25      /* channel (int) */
269 /*      SSH_CMSG_X11_REQUEST_FORWARDING         26         OBSOLETE */
270 #define SSH_SMSG_X11_OPEN                       27      /* channel (int) */
271 #define SSH_CMSG_PORT_FORWARD_REQUEST           28      /* p,host,hp (i,s,i) */
272 #define SSH_MSG_PORT_OPEN                       29      /* ch,h,p (i,s,i) */
273 #define SSH_CMSG_AGENT_REQUEST_FORWARDING       30      /* */
274 #define SSH_SMSG_AGENT_OPEN                     31      /* port (int) */
275 #define SSH_MSG_IGNORE                          32      /* string */
276 #define SSH_CMSG_EXIT_CONFIRMATION              33      /* */
277 #define SSH_CMSG_X11_REQUEST_FORWARDING         34      /* proto,data (s,s) */
278 #define SSH_CMSG_AUTH_RHOSTS_RSA                35      /* user,mod (s,mpi) */
279 #define SSH_MSG_DEBUG                           36      /* string */
280 #define SSH_CMSG_REQUEST_COMPRESSION            37      /* level 1-9 (int) */
281 #define SSH_CMSG_MAX_PACKET_SIZE                38      /* size 4k-1024k (int) */
282 #define SSH_CMSG_AUTH_TIS                       39      /* we use this for s/key */
283 #define SSH_SMSG_AUTH_TIS_CHALLENGE             40      /* challenge (string) */
284 #define SSH_CMSG_AUTH_TIS_RESPONSE              41      /* response (string) */
285 #define SSH_CMSG_AUTH_KERBEROS                  42      /* (KTEXT) */
286 #define SSH_SMSG_AUTH_KERBEROS_RESPONSE         43      /* (KTEXT) */
287 #define SSH_CMSG_HAVE_KERBEROS_TGT              44      /* credentials (s) */
288 #define SSH_CMSG_HAVE_AFS_TOKEN                 65      /* token (s) */
289
290 /*------------ definitions for login.c -------------*/
291
292 /*
293  * Returns the time when the user last logged in.  Returns 0 if the
294  * information is not available.  This must be called before record_login.
295  * The host from which the user logged in is stored in buf.
296  */
297 unsigned long
298 get_last_login_time(uid_t uid, const char *logname,
299     char *buf, unsigned int bufsize);
300
301 /*
302  * Records that the user has logged in.  This does many things normally done
303  * by login(1).
304  */
305 void
306 record_login(pid_t pid, const char *ttyname, const char *user, uid_t uid,
307     const char *host, struct sockaddr *addr);
308
309 /*
310  * Records that the user has logged out.  This does many thigs normally done
311  * by login(1) or init.
312  */
313 void    record_logout(pid_t pid, const char *ttyname);
314
315 /*------------ definitions for sshconnect.c ----------*/
316
317 /*
318  * Opens a TCP/IP connection to the remote server on the given host.  If port
319  * is 0, the default port will be used.  If anonymous is zero, a privileged
320  * port will be allocated to make the connection. This requires super-user
321  * privileges if anonymous is false. Connection_attempts specifies the
322  * maximum number of tries, one per second.  This returns true on success,
323  * and zero on failure.  If the connection is successful, this calls
324  * packet_set_connection for the connection.
325  */
326 int
327 ssh_connect(const char *host, struct sockaddr_storage * hostaddr,
328     u_short port, int connection_attempts,
329     int anonymous, uid_t original_real_uid,
330     const char *proxy_command);
331
332 /*
333  * Starts a dialog with the server, and authenticates the current user on the
334  * server.  This does not need any extra privileges.  The basic connection to
335  * the server must already have been established before this is called. If
336  * login fails, this function prints an error and never returns. This
337  * initializes the random state, and leaves it initialized (it will also have
338  * references from the packet module).
339  */
340
341 void
342 ssh_login(int host_key_valid, RSA * host_key, const char *host,
343     struct sockaddr * hostaddr, uid_t original_real_uid);
344
345 /*------------ Definitions for various authentication methods. -------*/
346
347 /*
348  * Tries to authenticate the user using the .rhosts file.  Returns true if
349  * authentication succeeds.  If ignore_rhosts is non-zero, this will not
350  * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
351  */
352 int     auth_rhosts(struct passwd * pw, const char *client_user);
353
354 /*
355  * Tries to authenticate the user using the .rhosts file and the host using
356  * its host key.  Returns true if authentication succeeds.
357  */
358 int
359 auth_rhosts_rsa(struct passwd * pw, const char *client_user, RSA* client_host_key);
360
361 /*
362  * Tries to authenticate the user using password.  Returns true if
363  * authentication succeeds.
364  */
365 int     auth_password(struct passwd * pw, const char *password);
366
367 /*
368  * Performs the RSA authentication dialog with the client.  This returns 0 if
369  * the client could not be authenticated, and 1 if authentication was
370  * successful.  This may exit if there is a serious protocol violation.
371  */
372 int     auth_rsa(struct passwd * pw, BIGNUM * client_n);
373
374 /*
375  * Parses an RSA key (number of bits, e, n) from a string.  Moves the pointer
376  * over the key.  Skips any whitespace at the beginning and at end.
377  */
378 int     auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
379
380 /*
381  * Returns the name of the machine at the other end of the socket.  The
382  * returned string should be freed by the caller.
383  */
384 char   *get_remote_hostname(int socket);
385
386 /*
387  * Return the canonical name of the host in the other side of the current
388  * connection (as returned by packet_get_connection).  The host name is
389  * cached, so it is efficient to call this several times.
390  */
391 const char *get_canonical_hostname(void);
392
393 /*
394  * Returns the remote IP address as an ascii string.  The value need not be
395  * freed by the caller.
396  */
397 const char *get_remote_ipaddr(void);
398
399 /* Returns the port number of the peer of the socket. */
400 int     get_peer_port(int sock);
401
402 /* Returns the port number of the remote/local host. */
403 int     get_remote_port(void);
404 int     get_local_port(void);
405
406
407 /*
408  * Performs the RSA authentication challenge-response dialog with the client,
409  * and returns true (non-zero) if the client gave the correct answer to our
410  * challenge; returns zero if the client gives a wrong answer.
411  */
412 int     auth_rsa_challenge_dialog(RSA *pk);
413
414 /*
415  * Reads a passphrase from /dev/tty with echo turned off.  Returns the
416  * passphrase (allocated with xmalloc).  Exits if EOF is encountered. If
417  * from_stdin is true, the passphrase will be read from stdin instead.
418  */
419 char   *read_passphrase(char *prompt, int from_stdin);
420
421
422 /*------------ Definitions for logging. -----------------------*/
423
424 /* Supported syslog facilities and levels. */
425 typedef enum {
426         SYSLOG_FACILITY_DAEMON,
427         SYSLOG_FACILITY_USER,
428         SYSLOG_FACILITY_AUTH,
429         SYSLOG_FACILITY_LOCAL0,
430         SYSLOG_FACILITY_LOCAL1,
431         SYSLOG_FACILITY_LOCAL2,
432         SYSLOG_FACILITY_LOCAL3,
433         SYSLOG_FACILITY_LOCAL4,
434         SYSLOG_FACILITY_LOCAL5,
435         SYSLOG_FACILITY_LOCAL6,
436         SYSLOG_FACILITY_LOCAL7
437 }       SyslogFacility;
438
439 typedef enum {
440         SYSLOG_LEVEL_QUIET,
441         SYSLOG_LEVEL_FATAL,
442         SYSLOG_LEVEL_ERROR,
443         SYSLOG_LEVEL_INFO,
444         SYSLOG_LEVEL_VERBOSE,
445         SYSLOG_LEVEL_DEBUG1,
446         SYSLOG_LEVEL_DEBUG2,
447         SYSLOG_LEVEL_DEBUG3
448 }       LogLevel;
449 /* Initializes logging. */
450 void    log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
451
452 /* Logging implementation, depending on server or client */
453 void    do_log(LogLevel level, const char *fmt, va_list args);
454
455 /* name to facility/level */
456 SyslogFacility log_facility_number(char *name);
457 LogLevel log_level_number(char *name);
458
459 /* Output a message to syslog or stderr */
460 void    fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
461 void    error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
462 void    log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
463 void    verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
464 void    debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
465 void    debug2(const char *fmt,...) __attribute__((format(printf, 1, 2)));
466 void    debug3(const char *fmt,...) __attribute__((format(printf, 1, 2)));
467
468 /* same as fatal() but w/o logging */
469 void    fatal_cleanup(void);
470
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  */
476 void    fatal_add_cleanup(void (*proc) (void *context), void *context);
477
478 /* Removes a cleanup function to be called at fatal(). */
479 void    fatal_remove_cleanup(void (*proc) (void *context), void *context);
480
481 /* ---- misc */
482
483 /*
484  * Expands tildes in the file name.  Returns data allocated by xmalloc.
485  * Warning: this calls getpw*.
486  */
487 char   *tilde_expand_filename(const char *filename, uid_t my_uid);
488
489 /* remove newline at end of string */
490 char    *chop(char *s);
491
492 /* return next token in configuration line */
493 char    *strdelim(char **s);
494
495 /* set filedescriptor to non-blocking */
496 void    set_nonblock(int fd);
497
498 /*
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  */
505 void    server_loop(pid_t pid, int fdin, int fdout, int fderr);
506 void    server_loop2(void);
507
508 /* Client side main loop for the interactive session. */
509 int     client_loop(int have_pty, int escape_char, int id);
510
511 /* Linked list of custom environment strings (see auth-rsa.c). */
512 struct envstring {
513         struct envstring *next;
514         char   *s;
515 };
516
517 /*
518  * Ensure all of data on socket comes through. f==read || f==write
519  */
520 ssize_t atomicio(ssize_t (*f)(), int fd, void *s, size_t n);
521
522 #ifdef KRB4
523 #include <krb.h>
524 /*
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  */
529 int     auth_krb4(const char *server_user, KTEXT auth, char **client);
530 int     krb4_init(uid_t uid);
531 void    krb4_cleanup_proc(void *ignore);
532 int     auth_krb4_password(struct passwd * pw, const char *password);
533
534 #ifdef AFS
535 #include <kafs.h>
536
537 /* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
538 int     auth_kerberos_tgt(struct passwd * pw, const char *string);
539 int     auth_afs_token(struct passwd * pw, const char *token_string);
540
541 int     creds_to_radix(CREDENTIALS * creds, unsigned char *buf, size_t buflen);
542 int     radix_to_creds(const char *buf, CREDENTIALS * creds);
543 #endif                          /* AFS */
544
545 #endif                          /* KRB4 */
546
547 #ifdef SKEY
548 #include <skey.h>
549 char   *skey_fake_keyinfo(char *username);
550 int     auth_skey_password(struct passwd * pw, const char *password);
551 #endif                          /* SKEY */
552
553 /* AF_UNSPEC or AF_INET or AF_INET6 */
554 extern int IPv4or6;
555
556 #ifdef USE_PAM
557 #include "auth-pam.h"
558 #endif /* USE_PAM */
559
560 #endif                          /* SSH_H */
This page took 0.077463 seconds and 5 git commands to generate.