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