authfd.c

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