Document the recent upgrade of the printf and scanf families of functions.
[dragonfly.git] / crypto / openssh-4 / authfd.c
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  * Functions for connecting the local authentication agent.
6  *
7  * As far as I am concerned, the code I have written for this software
8  * can be used freely for any purpose.  Any derived versions of this
9  * software must be clearly marked as such, and if the derived work is
10  * incompatible with the protocol description in the RFC file, it must be
11  * called by a name other than "ssh" or "Secure Shell".
12  *
13  * SSH2 implementation,
14  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  */
36
37 #include "includes.h"
38 RCSID("$OpenBSD: authfd.c,v 1.66 2005/06/17 02:44:32 djm Exp $");
39
40 #include <openssl/evp.h>
41
42 #include "ssh.h"
43 #include "rsa.h"
44 #include "buffer.h"
45 #include "bufaux.h"
46 #include "xmalloc.h"
47 #include "getput.h"
48 #include "key.h"
49 #include "authfd.h"
50 #include "cipher.h"
51 #include "kex.h"
52 #include "compat.h"
53 #include "log.h"
54 #include "atomicio.h"
55
56 static int agent_present = 0;
57
58 /* helper */
59 int     decode_reply(int type);
60
61 /* macro to check for "agent failure" message */
62 #define agent_failed(x) \
63     ((x == SSH_AGENT_FAILURE) || (x == SSH_COM_AGENT2_FAILURE) || \
64     (x == SSH2_AGENT_FAILURE))
65
66 int
67 ssh_agent_present(void)
68 {
69         int authfd;
70
71         if (agent_present)
72                 return 1;
73         if ((authfd = ssh_get_authentication_socket()) == -1)
74                 return 0;
75         else {
76                 ssh_close_authentication_socket(authfd);
77                 return 1;
78         }
79 }
80
81 /* Returns the number of the authentication fd, or -1 if there is none. */
82
83 int
84 ssh_get_authentication_socket(void)
85 {
86         const char *authsocket;
87         int sock;
88         struct sockaddr_un sunaddr;
89
90         authsocket = getenv(SSH_AUTHSOCKET_ENV_NAME);
91         if (!authsocket)
92                 return -1;
93
94         sunaddr.sun_family = AF_UNIX;
95         strlcpy(sunaddr.sun_path, authsocket, sizeof(sunaddr.sun_path));
96
97         sock = socket(AF_UNIX, SOCK_STREAM, 0);
98         if (sock < 0)
99                 return -1;
100
101         /* close on exec */
102         if (fcntl(sock, F_SETFD, 1) == -1) {
103                 close(sock);
104                 return -1;
105         }
106         if (connect(sock, (struct sockaddr *) &sunaddr, sizeof sunaddr) < 0) {
107                 close(sock);
108                 return -1;
109         }
110         agent_present = 1;
111         return sock;
112 }
113
114 static int
115 ssh_request_reply(AuthenticationConnection *auth, Buffer *request, Buffer *reply)
116 {
117         u_int l, len;
118         char buf[1024];
119
120         /* Get the length of the message, and format it in the buffer. */
121         len = buffer_len(request);
122         PUT_32BIT(buf, len);
123
124         /* Send the length and then the packet to the agent. */
125         if (atomicio(vwrite, auth->fd, buf, 4) != 4 ||
126             atomicio(vwrite, auth->fd, buffer_ptr(request),
127             buffer_len(request)) != buffer_len(request)) {
128                 error("Error writing to authentication socket.");
129                 return 0;
130         }
131         /*
132          * Wait for response from the agent.  First read the length of the
133          * response packet.
134          */
135         if (atomicio(read, auth->fd, buf, 4) != 4) {
136             error("Error reading response length from authentication socket.");
137             return 0;
138         }
139
140         /* Extract the length, and check it for sanity. */
141         len = GET_32BIT(buf);
142         if (len > 256 * 1024)
143                 fatal("Authentication response too long: %u", len);
144
145         /* Read the rest of the response in to the buffer. */
146         buffer_clear(reply);
147         while (len > 0) {
148                 l = len;
149                 if (l > sizeof(buf))
150                         l = sizeof(buf);
151                 if (atomicio(read, auth->fd, buf, l) != l) {
152                         error("Error reading response from authentication socket.");
153                         return 0;
154                 }
155                 buffer_append(reply, buf, l);
156                 len -= l;
157         }
158         return 1;
159 }
160
161 /*
162  * Closes the agent socket if it should be closed (depends on how it was
163  * obtained).  The argument must have been returned by
164  * ssh_get_authentication_socket().
165  */
166
167 void
168 ssh_close_authentication_socket(int sock)
169 {
170         if (getenv(SSH_AUTHSOCKET_ENV_NAME))
171                 close(sock);
172 }
173
174 /*
175  * Opens and connects a private socket for communication with the
176  * authentication agent.  Returns the file descriptor (which must be
177  * shut down and closed by the caller when no longer needed).
178  * Returns NULL if an error occurred and the connection could not be
179  * opened.
180  */
181
182 AuthenticationConnection *
183 ssh_get_authentication_connection(void)
184 {
185         AuthenticationConnection *auth;
186         int sock;
187
188         sock = ssh_get_authentication_socket();
189
190         /*
191          * Fail if we couldn't obtain a connection.  This happens if we
192          * exited due to a timeout.
193          */
194         if (sock < 0)
195                 return NULL;
196
197         auth = xmalloc(sizeof(*auth));
198         auth->fd = sock;
199         buffer_init(&auth->identities);
200         auth->howmany = 0;
201
202         return auth;
203 }
204
205 /*
206  * Closes the connection to the authentication agent and frees any associated
207  * memory.
208  */
209
210 void
211 ssh_close_authentication_connection(AuthenticationConnection *auth)
212 {
213         buffer_free(&auth->identities);
214         close(auth->fd);
215         xfree(auth);
216 }
217
218 /* Lock/unlock agent */
219 int
220 ssh_lock_agent(AuthenticationConnection *auth, int lock, const char *password)
221 {
222         int type;
223         Buffer msg;
224
225         buffer_init(&msg);
226         buffer_put_char(&msg, lock ? SSH_AGENTC_LOCK : SSH_AGENTC_UNLOCK);
227         buffer_put_cstring(&msg, password);
228
229         if (ssh_request_reply(auth, &msg, &msg) == 0) {
230                 buffer_free(&msg);
231                 return 0;
232         }
233         type = buffer_get_char(&msg);
234         buffer_free(&msg);
235         return decode_reply(type);
236 }
237
238 /*
239  * Returns the first authentication identity held by the agent.
240  */
241
242 int
243 ssh_get_num_identities(AuthenticationConnection *auth, int version)
244 {
245         int type, code1 = 0, code2 = 0;
246         Buffer request;
247
248         switch (version) {
249         case 1:
250                 code1 = SSH_AGENTC_REQUEST_RSA_IDENTITIES;
251                 code2 = SSH_AGENT_RSA_IDENTITIES_ANSWER;
252                 break;
253         case 2:
254                 code1 = SSH2_AGENTC_REQUEST_IDENTITIES;
255                 code2 = SSH2_AGENT_IDENTITIES_ANSWER;
256                 break;
257         default:
258                 return 0;
259         }
260
261         /*
262          * Send a message to the agent requesting for a list of the
263          * identities it can represent.
264          */
265         buffer_init(&request);
266         buffer_put_char(&request, code1);
267
268         buffer_clear(&auth->identities);
269         if (ssh_request_reply(auth, &request, &auth->identities) == 0) {
270                 buffer_free(&request);
271                 return 0;
272         }
273         buffer_free(&request);
274
275         /* Get message type, and verify that we got a proper answer. */
276         type = buffer_get_char(&auth->identities);
277         if (agent_failed(type)) {
278                 return 0;
279         } else if (type != code2) {
280                 fatal("Bad authentication reply message type: %d", type);
281         }
282
283         /* Get the number of entries in the response and check it for sanity. */
284         auth->howmany = buffer_get_int(&auth->identities);
285         if ((u_int)auth->howmany > 1024)
286                 fatal("Too many identities in authentication reply: %d",
287                     auth->howmany);
288
289         return auth->howmany;
290 }
291
292 Key *
293 ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version)
294 {
295         /* get number of identities and return the first entry (if any). */
296         if (ssh_get_num_identities(auth, version) > 0)
297                 return ssh_get_next_identity(auth, comment, version);
298         return NULL;
299 }
300
301 Key *
302 ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version)
303 {
304         int keybits;
305         u_int bits;
306         u_char *blob;
307         u_int blen;
308         Key *key = NULL;
309
310         /* Return failure if no more entries. */
311         if (auth->howmany <= 0)
312                 return NULL;
313
314         /*
315          * Get the next entry from the packet.  These will abort with a fatal
316          * error if the packet is too short or contains corrupt data.
317          */
318         switch (version) {
319         case 1:
320                 key = key_new(KEY_RSA1);
321                 bits = buffer_get_int(&auth->identities);
322                 buffer_get_bignum(&auth->identities, key->rsa->e);
323                 buffer_get_bignum(&auth->identities, key->rsa->n);
324                 *comment = buffer_get_string(&auth->identities, NULL);
325                 keybits = BN_num_bits(key->rsa->n);
326                 if (keybits < 0 || bits != (u_int)keybits)
327                         logit("Warning: identity keysize mismatch: actual %d, announced %u",
328                             BN_num_bits(key->rsa->n), bits);
329                 break;
330         case 2:
331                 blob = buffer_get_string(&auth->identities, &blen);
332                 *comment = buffer_get_string(&auth->identities, NULL);
333                 key = key_from_blob(blob, blen);
334                 xfree(blob);
335                 break;
336         default:
337                 return NULL;
338                 break;
339         }
340         /* Decrement the number of remaining entries. */
341         auth->howmany--;
342         return key;
343 }
344
345 /*
346  * Generates a random challenge, sends it to the agent, and waits for
347  * response from the agent.  Returns true (non-zero) if the agent gave the
348  * correct answer, zero otherwise.  Response type selects the style of
349  * response desired, with 0 corresponding to protocol version 1.0 (no longer
350  * supported) and 1 corresponding to protocol version 1.1.
351  */
352
353 int
354 ssh_decrypt_challenge(AuthenticationConnection *auth,
355     Key* key, BIGNUM *challenge,
356     u_char session_id[16],
357     u_int response_type,
358     u_char response[16])
359 {
360         Buffer buffer;
361         int success = 0;
362         int i;
363         int type;
364
365         if (key->type != KEY_RSA1)
366                 return 0;
367         if (response_type == 0) {
368                 logit("Compatibility with ssh protocol version 1.0 no longer supported.");
369                 return 0;
370         }
371         buffer_init(&buffer);
372         buffer_put_char(&buffer, SSH_AGENTC_RSA_CHALLENGE);
373         buffer_put_int(&buffer, BN_num_bits(key->rsa->n));
374         buffer_put_bignum(&buffer, key->rsa->e);
375         buffer_put_bignum(&buffer, key->rsa->n);
376         buffer_put_bignum(&buffer, challenge);
377         buffer_append(&buffer, session_id, 16);
378         buffer_put_int(&buffer, response_type);
379
380         if (ssh_request_reply(auth, &buffer, &buffer) == 0) {
381                 buffer_free(&buffer);
382                 return 0;
383         }
384         type = buffer_get_char(&buffer);
385
386         if (agent_failed(type)) {
387                 logit("Agent admitted failure to authenticate using the key.");
388         } else if (type != SSH_AGENT_RSA_RESPONSE) {
389                 fatal("Bad authentication response: %d", type);
390         } else {
391                 success = 1;
392                 /*
393                  * Get the response from the packet.  This will abort with a
394                  * fatal error if the packet is corrupt.
395                  */
396                 for (i = 0; i < 16; i++)
397                         response[i] = buffer_get_char(&buffer);
398         }
399         buffer_free(&buffer);
400         return success;
401 }
402
403 /* ask agent to sign data, returns -1 on error, 0 on success */
404 int
405 ssh_agent_sign(AuthenticationConnection *auth,
406     Key *key,
407     u_char **sigp, u_int *lenp,
408     u_char *data, u_int datalen)
409 {
410         extern int datafellows;
411         Buffer msg;
412         u_char *blob;
413         u_int blen;
414         int type, flags = 0;
415         int ret = -1;
416
417         if (key_to_blob(key, &blob, &blen) == 0)
418                 return -1;
419
420         if (datafellows & SSH_BUG_SIGBLOB)
421                 flags = SSH_AGENT_OLD_SIGNATURE;
422
423         buffer_init(&msg);
424         buffer_put_char(&msg, SSH2_AGENTC_SIGN_REQUEST);
425         buffer_put_string(&msg, blob, blen);
426         buffer_put_string(&msg, data, datalen);
427         buffer_put_int(&msg, flags);
428         xfree(blob);
429
430         if (ssh_request_reply(auth, &msg, &msg) == 0) {
431                 buffer_free(&msg);
432                 return -1;
433         }
434         type = buffer_get_char(&msg);
435         if (agent_failed(type)) {
436                 logit("Agent admitted failure to sign using the key.");
437         } else if (type != SSH2_AGENT_SIGN_RESPONSE) {
438                 fatal("Bad authentication response: %d", type);
439         } else {
440                 ret = 0;
441                 *sigp = buffer_get_string(&msg, lenp);
442         }
443         buffer_free(&msg);
444         return ret;
445 }
446
447 /* Encode key for a message to the agent. */
448
449 static void
450 ssh_encode_identity_rsa1(Buffer *b, RSA *key, const char *comment)
451 {
452         buffer_put_int(b, BN_num_bits(key->n));
453         buffer_put_bignum(b, key->n);
454         buffer_put_bignum(b, key->e);
455         buffer_put_bignum(b, key->d);
456         /* To keep within the protocol: p < q for ssh. in SSL p > q */
457         buffer_put_bignum(b, key->iqmp);        /* ssh key->u */
458         buffer_put_bignum(b, key->q);   /* ssh key->p, SSL key->q */
459         buffer_put_bignum(b, key->p);   /* ssh key->q, SSL key->p */
460         buffer_put_cstring(b, comment);
461 }
462
463 static void
464 ssh_encode_identity_ssh2(Buffer *b, Key *key, const char *comment)
465 {
466         buffer_put_cstring(b, key_ssh_name(key));
467         switch (key->type) {
468         case KEY_RSA:
469                 buffer_put_bignum2(b, key->rsa->n);
470                 buffer_put_bignum2(b, key->rsa->e);
471                 buffer_put_bignum2(b, key->rsa->d);
472                 buffer_put_bignum2(b, key->rsa->iqmp);
473                 buffer_put_bignum2(b, key->rsa->p);
474                 buffer_put_bignum2(b, key->rsa->q);
475                 break;
476         case KEY_DSA:
477                 buffer_put_bignum2(b, key->dsa->p);
478                 buffer_put_bignum2(b, key->dsa->q);
479                 buffer_put_bignum2(b, key->dsa->g);
480                 buffer_put_bignum2(b, key->dsa->pub_key);
481                 buffer_put_bignum2(b, key->dsa->priv_key);
482                 break;
483         }
484         buffer_put_cstring(b, comment);
485 }
486
487 /*
488  * Adds an identity to the authentication server.  This call is not meant to
489  * be used by normal applications.
490  */
491
492 int
493 ssh_add_identity_constrained(AuthenticationConnection *auth, Key *key,
494     const char *comment, u_int life, u_int confirm)
495 {
496         Buffer msg;
497         int type, constrained = (life || confirm);
498
499         buffer_init(&msg);
500
501         switch (key->type) {
502         case KEY_RSA1:
503                 type = constrained ?
504                     SSH_AGENTC_ADD_RSA_ID_CONSTRAINED :
505                     SSH_AGENTC_ADD_RSA_IDENTITY;
506                 buffer_put_char(&msg, type);
507                 ssh_encode_identity_rsa1(&msg, key->rsa, comment);
508                 break;
509         case KEY_RSA:
510         case KEY_DSA:
511                 type = constrained ?
512                     SSH2_AGENTC_ADD_ID_CONSTRAINED :
513                     SSH2_AGENTC_ADD_IDENTITY;
514                 buffer_put_char(&msg, type);
515                 ssh_encode_identity_ssh2(&msg, key, comment);
516                 break;
517         default:
518                 buffer_free(&msg);
519                 return 0;
520                 break;
521         }
522         if (constrained) {
523                 if (life != 0) {
524                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
525                         buffer_put_int(&msg, life);
526                 }
527                 if (confirm != 0)
528                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
529         }
530         if (ssh_request_reply(auth, &msg, &msg) == 0) {
531                 buffer_free(&msg);
532                 return 0;
533         }
534         type = buffer_get_char(&msg);
535         buffer_free(&msg);
536         return decode_reply(type);
537 }
538
539 int
540 ssh_add_identity(AuthenticationConnection *auth, Key *key, const char *comment)
541 {
542         return ssh_add_identity_constrained(auth, key, comment, 0, 0);
543 }
544
545 /*
546  * Removes an identity from the authentication server.  This call is not
547  * meant to be used by normal applications.
548  */
549
550 int
551 ssh_remove_identity(AuthenticationConnection *auth, Key *key)
552 {
553         Buffer msg;
554         int type;
555         u_char *blob;
556         u_int blen;
557
558         buffer_init(&msg);
559
560         if (key->type == KEY_RSA1) {
561                 buffer_put_char(&msg, SSH_AGENTC_REMOVE_RSA_IDENTITY);
562                 buffer_put_int(&msg, BN_num_bits(key->rsa->n));
563                 buffer_put_bignum(&msg, key->rsa->e);
564                 buffer_put_bignum(&msg, key->rsa->n);
565         } else if (key->type == KEY_DSA || key->type == KEY_RSA) {
566                 key_to_blob(key, &blob, &blen);
567                 buffer_put_char(&msg, SSH2_AGENTC_REMOVE_IDENTITY);
568                 buffer_put_string(&msg, blob, blen);
569                 xfree(blob);
570         } else {
571                 buffer_free(&msg);
572                 return 0;
573         }
574         if (ssh_request_reply(auth, &msg, &msg) == 0) {
575                 buffer_free(&msg);
576                 return 0;
577         }
578         type = buffer_get_char(&msg);
579         buffer_free(&msg);
580         return decode_reply(type);
581 }
582
583 int
584 ssh_update_card(AuthenticationConnection *auth, int add,
585     const char *reader_id, const char *pin, u_int life, u_int confirm)
586 {
587         Buffer msg;
588         int type, constrained = (life || confirm);
589
590         if (add) {
591                 type = constrained ?
592                     SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED :
593                     SSH_AGENTC_ADD_SMARTCARD_KEY;
594         } else
595                 type = SSH_AGENTC_REMOVE_SMARTCARD_KEY;
596
597         buffer_init(&msg);
598         buffer_put_char(&msg, type);
599         buffer_put_cstring(&msg, reader_id);
600         buffer_put_cstring(&msg, pin);
601
602         if (constrained) {
603                 if (life != 0) {
604                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
605                         buffer_put_int(&msg, life);
606                 }
607                 if (confirm != 0)
608                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
609         }
610
611         if (ssh_request_reply(auth, &msg, &msg) == 0) {
612                 buffer_free(&msg);
613                 return 0;
614         }
615         type = buffer_get_char(&msg);
616         buffer_free(&msg);
617         return decode_reply(type);
618 }
619
620 /*
621  * Removes all identities from the agent.  This call is not meant to be used
622  * by normal applications.
623  */
624
625 int
626 ssh_remove_all_identities(AuthenticationConnection *auth, int version)
627 {
628         Buffer msg;
629         int type;
630         int code = (version==1) ?
631                 SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES :
632                 SSH2_AGENTC_REMOVE_ALL_IDENTITIES;
633
634         buffer_init(&msg);
635         buffer_put_char(&msg, code);
636
637         if (ssh_request_reply(auth, &msg, &msg) == 0) {
638                 buffer_free(&msg);
639                 return 0;
640         }
641         type = buffer_get_char(&msg);
642         buffer_free(&msg);
643         return decode_reply(type);
644 }
645
646 int
647 decode_reply(int type)
648 {
649         switch (type) {
650         case SSH_AGENT_FAILURE:
651         case SSH_COM_AGENT2_FAILURE:
652         case SSH2_AGENT_FAILURE:
653                 logit("SSH_AGENT_FAILURE");
654                 return 0;
655         case SSH_AGENT_SUCCESS:
656                 return 1;
657         default:
658                 fatal("Bad response from authentication agent: %d", type);
659         }
660         /* NOTREACHED */
661         return 0;
662 }