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