authfd.c

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