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