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