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