]> andersk Git - openssh.git/blob - ssh.h
- Merged OpenBSD CVS changes:
[openssh.git] / ssh.h
1 /*
2  * 
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  */
15
16 /* RCSID("$Id$"); */
17
18 #ifndef SSH_H
19 #define SSH_H
20
21 #include <netinet/in.h> /* For struct sockaddr_in */
22 #include <pwd.h> /* For struct pw */
23 #include <stdarg.h> /* For va_list */
24
25 #include "rsa.h"
26 #include "cipher.h"
27
28 /*
29  * The default cipher used if IDEA is not supported by the remote host. It is
30  * recommended that this be one of the mandatory ciphers (DES, 3DES), though
31  * that is not required.
32  */
33 #define SSH_FALLBACK_CIPHER     SSH_CIPHER_3DES
34
35 /* Cipher used for encrypting authentication files. */
36 #define SSH_AUTHFILE_CIPHER     SSH_CIPHER_3DES
37
38 /* Default port number. */
39 #define SSH_DEFAULT_PORT        22
40
41 /* Maximum number of TCP/IP ports forwarded per direction. */
42 #define SSH_MAX_FORWARDS_PER_DIRECTION  100
43
44 /*
45  * Maximum number of RSA authentication identity files that can be specified
46  * in configuration files or on the command line.
47  */
48 #define SSH_MAX_IDENTITY_FILES          100
49
50 /*
51  * Major protocol version.  Different version indicates major incompatiblity
52  * that prevents communication.
53  */
54 #define PROTOCOL_MAJOR          1
55
56 /*
57  * Minor protocol version.  Different version indicates minor incompatibility
58  * that does not prevent interoperation.
59  */
60 #define PROTOCOL_MINOR          5
61
62 /*
63  * Name for the service.  The port named by this service overrides the
64  * default port if present.
65  */
66 #define SSH_SERVICE_NAME        "ssh"
67
68 #ifndef ETCDIR
69 #define ETCDIR                  "/etc"
70 #endif /* ETCDIR */
71
72 #ifndef PIDDIR
73 #define PIDDIR                  "/var/run"
74 #endif /* PIDDIR */
75
76 /*
77  * System-wide file containing host keys of known hosts.  This file should be
78  * world-readable.
79  */
80 #define SSH_SYSTEM_HOSTFILE     ETCDIR "/ssh_known_hosts"
81
82 /*
83  * Of these, ssh_host_key must be readable only by root, whereas ssh_config
84  * should be world-readable.
85  */
86 #define HOST_KEY_FILE           ETCDIR "/ssh_host_key"
87 #define SERVER_CONFIG_FILE      ETCDIR "/sshd_config"
88 #define HOST_CONFIG_FILE        ETCDIR "/ssh_config"
89
90 #ifndef SSH_PROGRAM
91 #define SSH_PROGRAM                     "/usr/bin/ssh"
92 #endif /* SSH_PROGRAM */
93
94 #ifndef LOGIN_PROGRAM
95 #define LOGIN_PROGRAM           "/usr/bin/login"
96 #endif /* LOGIN_PROGRAM */
97
98 #ifndef ASKPASS_PROGRAM
99 #define ASKPASS_PROGRAM         "/usr/lib/ssh/ssh-askpass"
100 #endif /* ASKPASS_PROGRAM */
101
102 /*
103  * The process id of the daemon listening for connections is saved here to
104  * make it easier to kill the correct daemon when necessary.
105  */
106 #define SSH_DAEMON_PID_FILE     PIDDIR "/sshd.pid"
107
108 /*
109  * The directory in user\'s home directory in which the files reside. The
110  * directory should be world-readable (though not all files are).
111  */
112 #define SSH_USER_DIR            ".ssh"
113
114 /*
115  * Per-user file containing host keys of known hosts.  This file need not be
116  * readable by anyone except the user him/herself, though this does not
117  * contain anything particularly secret.
118  */
119 #define SSH_USER_HOSTFILE       "~/.ssh/known_hosts"
120
121 /*
122  * Name of the default file containing client-side authentication key. This
123  * file should only be readable by the user him/herself.
124  */
125 #define SSH_CLIENT_IDENTITY     ".ssh/identity"
126
127 /*
128  * Configuration file in user\'s home directory.  This file need not be
129  * readable by anyone but the user him/herself, but does not contain anything
130  * particularly secret.  If the user\'s home directory resides on an NFS
131  * volume where root is mapped to nobody, this may need to be world-readable.
132  */
133 #define SSH_USER_CONFFILE       ".ssh/config"
134
135 /*
136  * File containing a list of those rsa keys that permit logging in as this
137  * user.  This file need not be readable by anyone but the user him/herself,
138  * but does not contain anything particularly secret.  If the user\'s home
139  * directory resides on an NFS volume where root is mapped to nobody, this
140  * may need to be world-readable.  (This file is read by the daemon which is
141  * running as root.)
142  */
143 #define SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
144
145 /*
146  * Per-user and system-wide ssh "rc" files.  These files are executed with
147  * /bin/sh before starting the shell or command if they exist.  They will be
148  * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
149  * use.  xauth will be run if neither of these exists.
150  */
151 #define SSH_USER_RC             ".ssh/rc"
152 #define SSH_SYSTEM_RC           ETCDIR "/sshrc"
153
154 /*
155  * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
156  * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
157  */
158 #define SSH_HOSTS_EQUIV         ETCDIR "/shosts.equiv"
159
160 /*
161  * Name of the environment variable containing the pathname of the
162  * authentication socket.
163  */
164 #define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
165
166 /*
167  * Name of the environment variable containing the pathname of the
168  * authentication socket.
169  */
170 #define SSH_AGENTPID_ENV_NAME   "SSH_AGENT_PID"
171
172 /*
173  * Default path to ssh-askpass used by ssh-add,
174  * environment variable for overwriting the default location
175  */
176 #define SSH_ASKPASS_DEFAULT     "/usr/X11R6/bin/ssh-askpass"
177 #define SSH_ASKPASS_ENV         "SSH_ASKPASS"
178
179 /*
180  * Force host key length and server key length to differ by at least this
181  * many bits.  This is to make double encryption with rsaref work.
182  */
183 #define SSH_KEY_BITS_RESERVED           128
184
185 /*
186  * Length of the session key in bytes.  (Specified as 256 bits in the
187  * protocol.)
188  */
189 #define SSH_SESSION_KEY_LENGTH          32
190
191 /* Name of Kerberos service for SSH to use. */
192 #define KRB4_SERVICE_NAME               "rcmd"
193
194 /*
195  * Authentication methods.  New types can be added, but old types should not
196  * be removed for compatibility.  The maximum allowed value is 31.
197  */
198 #define SSH_AUTH_RHOSTS         1
199 #define SSH_AUTH_RSA            2
200 #define SSH_AUTH_PASSWORD       3
201 #define SSH_AUTH_RHOSTS_RSA     4
202 #define SSH_AUTH_TIS            5
203 #define SSH_AUTH_KERBEROS       6
204 #define SSH_PASS_KERBEROS_TGT   7
205                                 /* 8 to 15 are reserved */
206 #define SSH_PASS_AFS_TOKEN      21
207
208 /* Protocol flags.  These are bit masks. */
209 #define SSH_PROTOFLAG_SCREEN_NUMBER     1       /* X11 forwarding includes screen */
210 #define SSH_PROTOFLAG_HOST_IN_FWD_OPEN  2       /* forwarding opens contain host */
211
212 /*
213  * Definition of message types.  New values can be added, but old values
214  * should not be removed or without careful consideration of the consequences
215  * for compatibility.  The maximum value is 254; value 255 is reserved for
216  * future extension.
217  */
218 /* Message name */                      /* msg code */  /* arguments */
219 #define SSH_MSG_NONE                            0       /* no message */
220 #define SSH_MSG_DISCONNECT                      1       /* cause (string) */
221 #define SSH_SMSG_PUBLIC_KEY                     2       /* ck,msk,srvk,hostk */
222 #define SSH_CMSG_SESSION_KEY                    3       /* key (BIGNUM) */
223 #define SSH_CMSG_USER                           4       /* user (string) */
224 #define SSH_CMSG_AUTH_RHOSTS                    5       /* user (string) */
225 #define SSH_CMSG_AUTH_RSA                       6       /* modulus (BIGNUM) */
226 #define SSH_SMSG_AUTH_RSA_CHALLENGE             7       /* int (BIGNUM) */
227 #define SSH_CMSG_AUTH_RSA_RESPONSE              8       /* int (BIGNUM) */
228 #define SSH_CMSG_AUTH_PASSWORD                  9       /* pass (string) */
229 #define SSH_CMSG_REQUEST_PTY                    10      /* TERM, tty modes */
230 #define SSH_CMSG_WINDOW_SIZE                    11      /* row,col,xpix,ypix */
231 #define SSH_CMSG_EXEC_SHELL                     12      /* */
232 #define SSH_CMSG_EXEC_CMD                       13      /* cmd (string) */
233 #define SSH_SMSG_SUCCESS                        14      /* */
234 #define SSH_SMSG_FAILURE                        15      /* */
235 #define SSH_CMSG_STDIN_DATA                     16      /* data (string) */
236 #define SSH_SMSG_STDOUT_DATA                    17      /* data (string) */
237 #define SSH_SMSG_STDERR_DATA                    18      /* data (string) */
238 #define SSH_CMSG_EOF                            19      /* */
239 #define SSH_SMSG_EXITSTATUS                     20      /* status (int) */
240 #define SSH_MSG_CHANNEL_OPEN_CONFIRMATION       21      /* channel (int) */
241 #define SSH_MSG_CHANNEL_OPEN_FAILURE            22      /* channel (int) */
242 #define SSH_MSG_CHANNEL_DATA                    23      /* ch,data (int,str) */
243 #define SSH_MSG_CHANNEL_CLOSE                   24      /* channel (int) */
244 #define SSH_MSG_CHANNEL_CLOSE_CONFIRMATION      25      /* channel (int) */
245 /*      SSH_CMSG_X11_REQUEST_FORWARDING         26         OBSOLETE */
246 #define SSH_SMSG_X11_OPEN                       27      /* channel (int) */
247 #define SSH_CMSG_PORT_FORWARD_REQUEST           28      /* p,host,hp (i,s,i) */
248 #define SSH_MSG_PORT_OPEN                       29      /* ch,h,p (i,s,i) */
249 #define SSH_CMSG_AGENT_REQUEST_FORWARDING       30      /* */
250 #define SSH_SMSG_AGENT_OPEN                     31      /* port (int) */
251 #define SSH_MSG_IGNORE                          32      /* string */
252 #define SSH_CMSG_EXIT_CONFIRMATION              33      /* */
253 #define SSH_CMSG_X11_REQUEST_FORWARDING         34      /* proto,data (s,s) */
254 #define SSH_CMSG_AUTH_RHOSTS_RSA                35      /* user,mod (s,mpi) */
255 #define SSH_MSG_DEBUG                           36      /* string */
256 #define SSH_CMSG_REQUEST_COMPRESSION            37      /* level 1-9 (int) */
257 #define SSH_CMSG_MAX_PACKET_SIZE                38      /* size 4k-1024k (int) */
258 #define SSH_CMSG_AUTH_TIS                       39      /* we use this for s/key */
259 #define SSH_SMSG_AUTH_TIS_CHALLENGE             40      /* challenge (string) */
260 #define SSH_CMSG_AUTH_TIS_RESPONSE              41      /* response (string) */
261 #define SSH_CMSG_AUTH_KERBEROS                  42      /* (KTEXT) */
262 #define SSH_SMSG_AUTH_KERBEROS_RESPONSE         43      /* (KTEXT) */
263 #define SSH_CMSG_HAVE_KERBEROS_TGT              44      /* credentials (s) */
264 #define SSH_CMSG_HAVE_AFS_TOKEN                 65      /* token (s) */
265
266 /*------------ definitions for login.c -------------*/
267
268 /*
269  * Returns the time when the user last logged in.  Returns 0 if the
270  * information is not available.  This must be called before record_login.
271  * The host from which the user logged in is stored in buf.
272  */
273 unsigned long 
274 get_last_login_time(uid_t uid, const char *logname,
275     char *buf, unsigned int bufsize);
276
277 /*
278  * Records that the user has logged in.  This does many things normally done
279  * by login(1).
280  */
281 void 
282 record_login(int pid, const char *ttyname, const char *user, uid_t uid,
283     const char *host, struct sockaddr_in * addr);
284
285 /*
286  * Records that the user has logged out.  This does many thigs normally done
287  * by login(1) or init.
288  */
289 void    record_logout(int pid, const char *ttyname);
290
291 /*------------ definitions for sshconnect.c ----------*/
292
293 /*
294  * Opens a TCP/IP connection to the remote server on the given host.  If port
295  * is 0, the default port will be used.  If anonymous is zero, a privileged
296  * port will be allocated to make the connection. This requires super-user
297  * privileges if anonymous is false. Connection_attempts specifies the
298  * maximum number of tries, one per second.  This returns true on success,
299  * and zero on failure.  If the connection is successful, this calls
300  * packet_set_connection for the connection.
301  */
302 int 
303 ssh_connect(const char *host, struct sockaddr_in * hostaddr,
304     u_short port, int connection_attempts,
305     int anonymous, uid_t original_real_uid,
306     const char *proxy_command);
307
308 /*
309  * Starts a dialog with the server, and authenticates the current user on the
310  * server.  This does not need any extra privileges.  The basic connection to
311  * the server must already have been established before this is called. If
312  * login fails, this function prints an error and never returns. This
313  * initializes the random state, and leaves it initialized (it will also have
314  * references from the packet module).
315  */
316
317 void 
318 ssh_login(int host_key_valid, RSA * host_key, const char *host,
319     struct sockaddr_in * hostaddr, uid_t original_real_uid);
320
321 /*------------ Definitions for various authentication methods. -------*/
322
323 /*
324  * Tries to authenticate the user using the .rhosts file.  Returns true if
325  * authentication succeeds.  If ignore_rhosts is non-zero, this will not
326  * consider .rhosts and .shosts (/etc/hosts.equiv will still be used).
327  */
328 int     auth_rhosts(struct passwd * pw, const char *client_user);
329
330 /*
331  * Tries to authenticate the user using the .rhosts file and the host using
332  * its host key.  Returns true if authentication succeeds.
333  */
334 int 
335 auth_rhosts_rsa(struct passwd * pw, const char *client_user,
336     BIGNUM * client_host_key_e, BIGNUM * client_host_key_n);
337
338 /*
339  * Tries to authenticate the user using password.  Returns true if
340  * authentication succeeds.
341  */
342 int     auth_password(struct passwd * pw, const char *password);
343
344 /*
345  * Performs the RSA authentication dialog with the client.  This returns 0 if
346  * the client could not be authenticated, and 1 if authentication was
347  * successful.  This may exit if there is a serious protocol violation.
348  */
349 int     auth_rsa(struct passwd * pw, BIGNUM * client_n);
350
351 /*
352  * Parses an RSA key (number of bits, e, n) from a string.  Moves the pointer
353  * over the key.  Skips any whitespace at the beginning and at end.
354  */
355 int     auth_rsa_read_key(char **cpp, unsigned int *bitsp, BIGNUM * e, BIGNUM * n);
356
357 /*
358  * Returns the name of the machine at the other end of the socket.  The
359  * returned string should be freed by the caller.
360  */
361 char   *get_remote_hostname(int socket);
362
363 /*
364  * Return the canonical name of the host in the other side of the current
365  * connection (as returned by packet_get_connection).  The host name is
366  * cached, so it is efficient to call this several times.
367  */
368 const char *get_canonical_hostname(void);
369
370 /*
371  * Returns the remote IP address as an ascii string.  The value need not be
372  * freed by the caller.
373  */
374 const char *get_remote_ipaddr(void);
375
376 /* Returns the port number of the peer of the socket. */
377 int     get_peer_port(int sock);
378
379 /* Returns the port number of the remote host. */
380 int     get_remote_port(void);
381
382 /*
383  * Tries to match the host name (which must be in all lowercase) against the
384  * comma-separated sequence of subpatterns (each possibly preceded by ! to
385  * indicate negation).  Returns true if there is a positive match; zero
386  * otherwise.
387  */
388 int     match_hostname(const char *host, const char *pattern, unsigned int len);
389
390 /*
391  * Checks whether the given host is already in the list of our known hosts.
392  * Returns HOST_OK if the host is known and has the specified key, HOST_NEW
393  * if the host is not known, and HOST_CHANGED if the host is known but used
394  * to have a different host key.  The host must be in all lowercase.
395  */
396 typedef enum {
397         HOST_OK, HOST_NEW, HOST_CHANGED
398 }       HostStatus;
399 HostStatus 
400 check_host_in_hostfile(const char *filename, const char *host,
401     BIGNUM * e, BIGNUM * n, BIGNUM * ke, BIGNUM * kn);
402
403 /*
404  * Appends an entry to the host file.  Returns false if the entry could not
405  * be appended.
406  */
407 int 
408 add_host_to_hostfile(const char *filename, const char *host,
409     BIGNUM * e, BIGNUM * n);
410
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  */
416 int     auth_rsa_challenge_dialog(BIGNUM * e, BIGNUM * n);
417
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  */
423 char   *read_passphrase(const char *prompt, int from_stdin);
424
425 /*
426  * Saves the authentication (private) key in a file, encrypting it with
427  * passphrase.  The identification of the file (lowest 64 bits of n) will
428  * precede the key to provide identification of the key without needing a
429  * passphrase.
430  */
431 int 
432 save_private_key(const char *filename, const char *passphrase,
433     RSA * private_key, const char *comment);
434
435 /*
436  * Loads the public part of the key file (public key and comment). Returns 0
437  * if an error occurred; zero if the public key was successfully read.  The
438  * comment of the key is returned in comment_return if it is non-NULL; the
439  * caller must free the value with xfree.
440  */
441 int 
442 load_public_key(const char *filename, RSA * pub,
443     char **comment_return);
444
445 /*
446  * Loads the private key from the file.  Returns 0 if an error is encountered
447  * (file does not exist or is not readable, or passphrase is bad). This
448  * initializes the private key.  The comment of the key is returned in
449  * comment_return if it is non-NULL; the caller must free the value with
450  * xfree.
451  */
452 int 
453 load_private_key(const char *filename, const char *passphrase,
454     RSA * private_key, char **comment_return);
455
456 /*------------ Definitions for logging. -----------------------*/
457
458 /* Supported syslog facilities and levels. */
459 typedef enum {
460         SYSLOG_FACILITY_DAEMON,
461         SYSLOG_FACILITY_USER,
462         SYSLOG_FACILITY_AUTH,
463         SYSLOG_FACILITY_LOCAL0,
464         SYSLOG_FACILITY_LOCAL1,
465         SYSLOG_FACILITY_LOCAL2,
466         SYSLOG_FACILITY_LOCAL3,
467         SYSLOG_FACILITY_LOCAL4,
468         SYSLOG_FACILITY_LOCAL5,
469         SYSLOG_FACILITY_LOCAL6,
470         SYSLOG_FACILITY_LOCAL7
471 }       SyslogFacility;
472
473 typedef enum {
474         SYSLOG_LEVEL_QUIET,
475         SYSLOG_LEVEL_FATAL,
476         SYSLOG_LEVEL_ERROR,
477         SYSLOG_LEVEL_INFO,
478         SYSLOG_LEVEL_VERBOSE,
479         SYSLOG_LEVEL_DEBUG
480 }       LogLevel;
481 /* Initializes logging. */
482 void    log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr);
483
484 /* Logging implementation, depending on server or client */
485 void    do_log(LogLevel level, const char *fmt, va_list args);
486
487 /* name to facility/level */
488 SyslogFacility log_facility_number(char *name);
489 LogLevel log_level_number(char *name);
490
491 /* Output a message to syslog or stderr */
492 void    fatal(const char *fmt,...) __attribute__((format(printf, 1, 2)));
493 void    error(const char *fmt,...) __attribute__((format(printf, 1, 2)));
494 void    log(const char *fmt,...) __attribute__((format(printf, 1, 2)));
495 void    verbose(const char *fmt,...) __attribute__((format(printf, 1, 2)));
496 void    debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
497
498 /* same as fatal() but w/o logging */
499 void    fatal_cleanup(void);
500
501 /*
502  * Registers a cleanup function to be called by fatal()/fatal_cleanup()
503  * before exiting. It is permissible to call fatal_remove_cleanup for the
504  * function itself from the function.
505  */
506 void    fatal_add_cleanup(void (*proc) (void *context), void *context);
507
508 /* Removes a cleanup function to be called at fatal(). */
509 void    fatal_remove_cleanup(void (*proc) (void *context), void *context);
510
511 /*---------------- definitions for channels ------------------*/
512
513 /* Sets specific protocol options. */
514 void    channel_set_options(int hostname_in_open);
515
516 /*
517  * Allocate a new channel object and set its type and socket.  Remote_name
518  * must have been allocated with xmalloc; this will free it when the channel
519  * is freed.
520  */
521 int     channel_allocate(int type, int sock, char *remote_name);
522
523 /* Free the channel and close its socket. */
524 void    channel_free(int channel);
525
526 /* Add any bits relevant to channels in select bitmasks. */
527 void    channel_prepare_select(fd_set * readset, fd_set * writeset);
528
529 /*
530  * After select, perform any appropriate operations for channels which have
531  * events pending.
532  */
533 void    channel_after_select(fd_set * readset, fd_set * writeset);
534
535 /* If there is data to send to the connection, send some of it now. */
536 void    channel_output_poll(void);
537
538 /*
539  * This is called when a packet of type CHANNEL_DATA has just been received.
540  * The message type has already been consumed, but channel number and data is
541  * still there.
542  */
543 void    channel_input_data(int payload_len);
544
545 /* Returns true if no channel has too much buffered data. */
546 int     channel_not_very_much_buffered_data(void);
547
548 /* This is called after receiving CHANNEL_CLOSE. */
549 void    channel_input_close(void);
550
551 /* This is called after receiving CHANNEL_CLOSE_CONFIRMATION. */
552 void    channel_input_close_confirmation(void);
553
554 /* This is called after receiving CHANNEL_OPEN_CONFIRMATION. */
555 void    channel_input_open_confirmation(void);
556
557 /* This is called after receiving CHANNEL_OPEN_FAILURE from the other side. */
558 void    channel_input_open_failure(void);
559
560 /* This closes any sockets that are listening for connections; this removes
561    any unix domain sockets. */
562 void    channel_stop_listening(void);
563
564 /*
565  * Closes the sockets of all channels.  This is used to close extra file
566  * descriptors after a fork.
567  */
568 void    channel_close_all(void);
569
570 /* Returns the maximum file descriptor number used by the channels. */
571 int     channel_max_fd(void);
572
573 /* Returns true if there is still an open channel over the connection. */
574 int     channel_still_open(void);
575
576 /*
577  * Returns a string containing a list of all open channels.  The list is
578  * suitable for displaying to the user.  It uses crlf instead of newlines.
579  * The caller should free the string with xfree.
580  */
581 char   *channel_open_message(void);
582
583 /*
584  * Initiate forwarding of connections to local port "port" through the secure
585  * channel to host:port from remote side.  This never returns if there was an
586  * error.
587  */
588 void 
589 channel_request_local_forwarding(u_short port, const char *host,
590     u_short remote_port);
591
592 /*
593  * Initiate forwarding of connections to port "port" on remote host through
594  * the secure channel to host:port from local side.  This never returns if
595  * there was an error.  This registers that open requests for that port are
596  * permitted.
597  */
598 void 
599 channel_request_remote_forwarding(u_short port, const char *host,
600     u_short remote_port);
601
602 /*
603  * Permits opening to any host/port in SSH_MSG_PORT_OPEN.  This is usually
604  * called by the server, because the user could connect to any port anyway,
605  * and the server has no way to know but to trust the client anyway.
606  */
607 void    channel_permit_all_opens(void);
608
609 /*
610  * This is called after receiving CHANNEL_FORWARDING_REQUEST.  This initates
611  * listening for the port, and sends back a success reply (or disconnect
612  * message if there was an error).  This never returns if there was an error.
613  */
614 void    channel_input_port_forward_request(int is_root);
615
616 /*
617  * This is called after receiving PORT_OPEN message.  This attempts to
618  * connect to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION
619  * or CHANNEL_OPEN_FAILURE.
620  */
621 void    channel_input_port_open(int payload_len);
622
623 /*
624  * Creates a port for X11 connections, and starts listening for it. Returns
625  * the display name, or NULL if an error was encountered.
626  */
627 char   *x11_create_display(int screen);
628
629 /*
630  * Creates an internet domain socket for listening for X11 connections.
631  * Returns a suitable value for the DISPLAY variable, or NULL if an error
632  * occurs.
633  */
634 char   *x11_create_display_inet(int screen);
635
636 /*
637  * This is called when SSH_SMSG_X11_OPEN is received.  The packet contains
638  * the remote channel number.  We should do whatever we want, and respond
639  * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
640  */
641 void    x11_input_open(int payload_len);
642
643 /*
644  * Requests forwarding of X11 connections.  This should be called on the
645  * client only.
646  */
647 void    x11_request_forwarding(void);
648
649 /*
650  * Requests forwarding for X11 connections, with authentication spoofing.
651  * This should be called in the client only.
652  */
653 void    x11_request_forwarding_with_spoofing(const char *proto, const char *data);
654
655 /* Sends a message to the server to request authentication fd forwarding. */
656 void    auth_request_forwarding(void);
657
658 /*
659  * Returns the name of the forwarded authentication socket.  Returns NULL if
660  * there is no forwarded authentication socket.  The returned value points to
661  * a static buffer.
662  */
663 char   *auth_get_socket_name(void);
664
665 /*
666  * This if called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
667  * This starts forwarding authentication requests.
668  */
669 void    auth_input_request_forwarding(struct passwd * pw);
670
671 /* This is called to process an SSH_SMSG_AGENT_OPEN message. */
672 void    auth_input_open_request(void);
673
674 /*
675  * Returns true if the given string matches the pattern (which may contain ?
676  * and * as wildcards), and zero if it does not match.
677  */
678 int     match_pattern(const char *s, const char *pattern);
679
680 /*
681  * Expands tildes in the file name.  Returns data allocated by xmalloc.
682  * Warning: this calls getpw*.
683  */
684 char   *tilde_expand_filename(const char *filename, uid_t my_uid);
685
686 /*
687  * Performs the interactive session.  This handles data transmission between
688  * the client and the program.  Note that the notion of stdin, stdout, and
689  * stderr in this function is sort of reversed: this function writes to stdin
690  * (of the child program), and reads from stdout and stderr (of the child
691  * program).
692  */
693 void    server_loop(int pid, int fdin, int fdout, int fderr);
694
695 /* Client side main loop for the interactive session. */
696 int     client_loop(int have_pty, int escape_char);
697
698 /* Linked list of custom environment strings (see auth-rsa.c). */
699 struct envstring {
700         struct envstring *next;
701         char   *s;
702 };
703 #ifdef KRB4
704 #include <krb.h>
705
706 /*
707  * Performs Kerberos v4 mutual authentication with the client. This returns 0
708  * if the client could not be authenticated, and 1 if authentication was
709  * successful.  This may exit if there is a serious protocol violation.
710  */
711 int     auth_krb4(const char *server_user, KTEXT auth, char **client);
712 int     krb4_init(uid_t uid);
713 void    krb4_cleanup_proc(void *ignore);
714 int     auth_krb4_password(struct passwd * pw, const char *password);
715
716 #ifdef AFS
717 #include <kafs.h>
718
719 /* Accept passed Kerberos v4 ticket-granting ticket and AFS tokens. */
720 int     auth_kerberos_tgt(struct passwd * pw, const char *string);
721 int     auth_afs_token(struct passwd * pw, const char *token_string);
722
723 int     creds_to_radix(CREDENTIALS * creds, unsigned char *buf);
724 int     radix_to_creds(const char *buf, CREDENTIALS * creds);
725 #endif                          /* AFS */
726
727 #endif                          /* KRB4 */
728
729 #ifdef SKEY
730 #include <skey.h>
731 char   *skey_fake_keyinfo(char *username);
732 int     auth_skey_password(struct passwd * pw, const char *password);
733 #endif                          /* SKEY */
734
735 #endif                          /* SSH_H */
This page took 0.091885 seconds and 5 git commands to generate.