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