authfd.c

   1 /* $OpenBSD: authfd.c,v 1.75 2006/07/08 21:47:12 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 "ssh.h"
  47 #include "rsa.h"
  48 #include "buffer.h"
  49 #include "bufaux.h"
  50 #include "xmalloc.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 #include "misc.h"
  59
  60 static int agent_present = 0;
  61
  62 /* helper */
  63 int     decode_reply(int type);
  64
  65 /* macro to check for "agent failure" message */
  66 #define agent_failed(x) \
  67     ((x == SSH_AGENT_FAILURE) || (x == SSH_COM_AGENT2_FAILURE) || \
  68     (x == SSH2_AGENT_FAILURE))
  69
  70 int
  71 ssh_agent_present(void)
  72 {
  73         int authfd;
  74
  75         if (agent_present)
  76                 return 1;
  77         if ((authfd = ssh_get_authentication_socket()) == -1)
  78                 return 0;
  79         else {
  80                 ssh_close_authentication_socket(authfd);
  81                 return 1;
  82         }
  83 }
  84
  85 /* Returns the number of the authentication fd, or -1 if there is none. */
  86
  87 int
  88 ssh_get_authentication_socket(void)
  89 {
  90         const char *authsocket;
  91         int sock;
  92         struct sockaddr_un sunaddr;
  93
  94         authsocket = getenv(SSH_AUTHSOCKET_ENV_NAME);
  95         if (!authsocket)
  96                 return -1;
  97
  98         sunaddr.sun_family = AF_UNIX;
  99         strlcpy(sunaddr.sun_path, authsocket, sizeof(sunaddr.sun_path));
 100
 101         sock = socket(AF_UNIX, SOCK_STREAM, 0);
 102         if (sock < 0)
 103                 return -1;
 104
 105         /* close on exec */
 106         if (fcntl(sock, F_SETFD, 1) == -1) {
 107                 close(sock);
 108                 return -1;
 109         }
 110         if (connect(sock, (struct sockaddr *)&sunaddr, sizeof sunaddr) < 0) {
 111                 close(sock);
 112                 return -1;
 113         }
 114         agent_present = 1;
 115         return sock;
 116 }
 117
 118 static int
 119 ssh_request_reply(AuthenticationConnection *auth, Buffer *request, Buffer *reply)
 120 {
 121         u_int l, len;
 122         char buf[1024];
 123
 124         /* Get the length of the message, and format it in the buffer. */
 125         len = buffer_len(request);
 126         put_u32(buf, len);
 127
 128         /* Send the length and then the packet to the agent. */
 129         if (atomicio(vwrite, auth->fd, buf, 4) != 4 ||
 130             atomicio(vwrite, auth->fd, buffer_ptr(request),
 131             buffer_len(request)) != buffer_len(request)) {
 132                 error("Error writing to authentication socket.");
 133                 return 0;
 134         }
 135         /*
 136          * Wait for response from the agent.  First read the length of the
 137          * response packet.
 138          */
 139         if (atomicio(read, auth->fd, buf, 4) != 4) {
 140             error("Error reading response length from authentication socket.");
 141             return 0;
 142         }
 143
 144         /* Extract the length, and check it for sanity. */
 145         len = get_u32(buf);
 146         if (len > 256 * 1024)
 147                 fatal("Authentication response too long: %u", len);
 148
 149         /* Read the rest of the response in to the buffer. */
 150         buffer_clear(reply);
 151         while (len > 0) {
 152                 l = len;
 153                 if (l > sizeof(buf))
 154                         l = sizeof(buf);
 155                 if (atomicio(read, auth->fd, buf, l) != l) {
 156                         error("Error reading response from authentication socket.");
 157                         return 0;
 158                 }
 159                 buffer_append(reply, buf, l);
 160                 len -= l;
 161         }
 162         return 1;
 163 }
 164
 165 /*
 166  * Closes the agent socket if it should be closed (depends on how it was
 167  * obtained).  The argument must have been returned by
 168  * ssh_get_authentication_socket().
 169  */
 170
 171 void
 172 ssh_close_authentication_socket(int sock)
 173 {
 174         if (getenv(SSH_AUTHSOCKET_ENV_NAME))
 175                 close(sock);
 176 }
 177
 178 /*
 179  * Opens and connects a private socket for communication with the
 180  * authentication agent.  Returns the file descriptor (which must be
 181  * shut down and closed by the caller when no longer needed).
 182  * Returns NULL if an error occurred and the connection could not be
 183  * opened.
 184  */
 185
 186 AuthenticationConnection *
 187 ssh_get_authentication_connection(void)
 188 {
 189         AuthenticationConnection *auth;
 190         int sock;
 191
 192         sock = ssh_get_authentication_socket();
 193
 194         /*
 195          * Fail if we couldn't obtain a connection.  This happens if we
 196          * exited due to a timeout.
 197          */
 198         if (sock < 0)
 199                 return NULL;
 200
 201         auth = xmalloc(sizeof(*auth));
 202         auth->fd = sock;
 203         buffer_init(&auth->identities);
 204         auth->howmany = 0;
 205
 206         return auth;
 207 }
 208
 209 /*
 210  * Closes the connection to the authentication agent and frees any associated
 211  * memory.
 212  */
 213
 214 void
 215 ssh_close_authentication_connection(AuthenticationConnection *auth)
 216 {
 217         buffer_free(&auth->identities);
 218         close(auth->fd);
 219         xfree(auth);
 220 }
 221
 222 /* Lock/unlock agent */
 223 int
 224 ssh_lock_agent(AuthenticationConnection *auth, int lock, const char *password)
 225 {
 226         int type;
 227         Buffer msg;
 228
 229         buffer_init(&msg);
 230         buffer_put_char(&msg, lock ? SSH_AGENTC_LOCK : SSH_AGENTC_UNLOCK);
 231         buffer_put_cstring(&msg, password);
 232
 233         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 234                 buffer_free(&msg);
 235                 return 0;
 236         }
 237         type = buffer_get_char(&msg);
 238         buffer_free(&msg);
 239         return decode_reply(type);
 240 }
 241
 242 /*
 243  * Returns the first authentication identity held by the agent.
 244  */
 245
 246 int
 247 ssh_get_num_identities(AuthenticationConnection *auth, int version)
 248 {
 249         int type, code1 = 0, code2 = 0;
 250         Buffer request;
 251
 252         switch (version) {
 253         case 1:
 254                 code1 = SSH_AGENTC_REQUEST_RSA_IDENTITIES;
 255                 code2 = SSH_AGENT_RSA_IDENTITIES_ANSWER;
 256                 break;
 257         case 2:
 258                 code1 = SSH2_AGENTC_REQUEST_IDENTITIES;
 259                 code2 = SSH2_AGENT_IDENTITIES_ANSWER;
 260                 break;
 261         default:
 262                 return 0;
 263         }
 264
 265         /*
 266          * Send a message to the agent requesting for a list of the
 267          * identities it can represent.
 268          */
 269         buffer_init(&request);
 270         buffer_put_char(&request, code1);
 271
 272         buffer_clear(&auth->identities);
 273         if (ssh_request_reply(auth, &request, &auth->identities) == 0) {
 274                 buffer_free(&request);
 275                 return 0;
 276         }
 277         buffer_free(&request);
 278
 279         /* Get message type, and verify that we got a proper answer. */
 280         type = buffer_get_char(&auth->identities);
 281         if (agent_failed(type)) {
 282                 return 0;
 283         } else if (type != code2) {
 284                 fatal("Bad authentication reply message type: %d", type);
 285         }
 286
 287         /* Get the number of entries in the response and check it for sanity. */
 288         auth->howmany = buffer_get_int(&auth->identities);
 289         if ((u_int)auth->howmany > 1024)
 290                 fatal("Too many identities in authentication reply: %d",
 291                     auth->howmany);
 292
 293         return auth->howmany;
 294 }
 295
 296 Key *
 297 ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version)
 298 {
 299         /* get number of identities and return the first entry (if any). */
 300         if (ssh_get_num_identities(auth, version) > 0)
 301                 return ssh_get_next_identity(auth, comment, version);
 302         return NULL;
 303 }
 304
 305 Key *
 306 ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version)
 307 {
 308         int keybits;
 309         u_int bits;
 310         u_char *blob;
 311         u_int blen;
 312         Key *key = NULL;
 313
 314         /* Return failure if no more entries. */
 315         if (auth->howmany <= 0)
 316                 return NULL;
 317
 318         /*
 319          * Get the next entry from the packet.  These will abort with a fatal
 320          * error if the packet is too short or contains corrupt data.
 321          */
 322         switch (version) {
 323         case 1:
 324                 key = key_new(KEY_RSA1);
 325                 bits = buffer_get_int(&auth->identities);
 326                 buffer_get_bignum(&auth->identities, key->rsa->e);
 327                 buffer_get_bignum(&auth->identities, key->rsa->n);
 328                 *comment = buffer_get_string(&auth->identities, NULL);
 329                 keybits = BN_num_bits(key->rsa->n);
 330                 if (keybits < 0 || bits != (u_int)keybits)
 331                         logit("Warning: identity keysize mismatch: actual %d, announced %u",
 332                             BN_num_bits(key->rsa->n), bits);
 333                 break;
 334         case 2:
 335                 blob = buffer_get_string(&auth->identities, &blen);
 336                 *comment = buffer_get_string(&auth->identities, NULL);
 337                 key = key_from_blob(blob, blen);
 338                 xfree(blob);
 339                 break;
 340         default:
 341                 return NULL;
 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] = (u_char)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         }
 524         if (constrained) {
 525                 if (life != 0) {
 526                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
 527                         buffer_put_int(&msg, life);
 528                 }
 529                 if (confirm != 0)
 530                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
 531         }
 532         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 533                 buffer_free(&msg);
 534                 return 0;
 535         }
 536         type = buffer_get_char(&msg);
 537         buffer_free(&msg);
 538         return decode_reply(type);
 539 }
 540
 541 int
 542 ssh_add_identity(AuthenticationConnection *auth, Key *key, const char *comment)
 543 {
 544         return ssh_add_identity_constrained(auth, key, comment, 0, 0);
 545 }
 546
 547 /*
 548  * Removes an identity from the authentication server.  This call is not
 549  * meant to be used by normal applications.
 550  */
 551
 552 int
 553 ssh_remove_identity(AuthenticationConnection *auth, Key *key)
 554 {
 555         Buffer msg;
 556         int type;
 557         u_char *blob;
 558         u_int blen;
 559
 560         buffer_init(&msg);
 561
 562         if (key->type == KEY_RSA1) {
 563                 buffer_put_char(&msg, SSH_AGENTC_REMOVE_RSA_IDENTITY);
 564                 buffer_put_int(&msg, BN_num_bits(key->rsa->n));
 565                 buffer_put_bignum(&msg, key->rsa->e);
 566                 buffer_put_bignum(&msg, key->rsa->n);
 567         } else if (key->type == KEY_DSA || key->type == KEY_RSA) {
 568                 key_to_blob(key, &blob, &blen);
 569                 buffer_put_char(&msg, SSH2_AGENTC_REMOVE_IDENTITY);
 570                 buffer_put_string(&msg, blob, blen);
 571                 xfree(blob);
 572         } else {
 573                 buffer_free(&msg);
 574                 return 0;
 575         }
 576         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 577                 buffer_free(&msg);
 578                 return 0;
 579         }
 580         type = buffer_get_char(&msg);
 581         buffer_free(&msg);
 582         return decode_reply(type);
 583 }
 584
 585 int
 586 ssh_update_card(AuthenticationConnection *auth, int add,
 587     const char *reader_id, const char *pin, u_int life, u_int confirm)
 588 {
 589         Buffer msg;
 590         int type, constrained = (life || confirm);
 591
 592         if (add) {
 593                 type = constrained ?
 594                     SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED :
 595                     SSH_AGENTC_ADD_SMARTCARD_KEY;
 596         } else
 597                 type = SSH_AGENTC_REMOVE_SMARTCARD_KEY;
 598
 599         buffer_init(&msg);
 600         buffer_put_char(&msg, type);
 601         buffer_put_cstring(&msg, reader_id);
 602         buffer_put_cstring(&msg, pin);
 603
 604         if (constrained) {
 605                 if (life != 0) {
 606                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
 607                         buffer_put_int(&msg, life);
 608                 }
 609                 if (confirm != 0)
 610                         buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
 611         }
 612
 613         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 614                 buffer_free(&msg);
 615                 return 0;
 616         }
 617         type = buffer_get_char(&msg);
 618         buffer_free(&msg);
 619         return decode_reply(type);
 620 }
 621
 622 /*
 623  * Removes all identities from the agent.  This call is not meant to be used
 624  * by normal applications.
 625  */
 626
 627 int
 628 ssh_remove_all_identities(AuthenticationConnection *auth, int version)
 629 {
 630         Buffer msg;
 631         int type;
 632         int code = (version==1) ?
 633                 SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES :
 634                 SSH2_AGENTC_REMOVE_ALL_IDENTITIES;
 635
 636         buffer_init(&msg);
 637         buffer_put_char(&msg, code);
 638
 639         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 640                 buffer_free(&msg);
 641                 return 0;
 642         }
 643         type = buffer_get_char(&msg);
 644         buffer_free(&msg);
 645         return decode_reply(type);
 646 }
 647
 648 int
 649 decode_reply(int type)
 650 {
 651         switch (type) {
 652         case SSH_AGENT_FAILURE:
 653         case SSH_COM_AGENT2_FAILURE:
 654         case SSH2_AGENT_FAILURE:
 655                 logit("SSH_AGENT_FAILURE");
 656                 return 0;
 657         case SSH_AGENT_SUCCESS:
 658                 return 1;
 659         default:
 660                 fatal("Bad response from authentication agent: %d", type);
 661         }
 662         /* NOTREACHED */
 663         return 0;
 664 }