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