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.29 2000/10/09 21:51:00 markus Exp $");
  39
  40 #include "ssh.h"
  41 #include "rsa.h"
  42 #include "buffer.h"
  43 #include "bufaux.h"
  44 #include "xmalloc.h"
  45 #include "getput.h"
  46
  47 #include <openssl/rsa.h>
  48 #include <openssl/dsa.h>
  49 #include <openssl/evp.h>
  50 #include "key.h"
  51 #include "authfd.h"
  52 #include "kex.h"
  53 #include "dsa.h"
  54 #include "compat.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
  63 /* Returns the number of the authentication fd, or -1 if there is none. */
  64
  65 int
  66 ssh_get_authentication_socket()
  67 {
  68         const char *authsocket;
  69         int sock, len;
  70         struct sockaddr_un sunaddr;
  71
  72         authsocket = getenv(SSH_AUTHSOCKET_ENV_NAME);
  73         if (!authsocket)
  74                 return -1;
  75
  76         sunaddr.sun_family = AF_UNIX;
  77         strlcpy(sunaddr.sun_path, authsocket, sizeof(sunaddr.sun_path));
  78 #ifdef HAVE_SUN_LEN_IN_SOCKADDR_UN
  79         sunaddr.sun_len = len = SUN_LEN(&sunaddr)+1;
  80 #else /* HAVE_SUN_LEN_IN_SOCKADDR_UN */
  81         len = SUN_LEN(&sunaddr)+1;
  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 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 <= 0) {
 125                         error("Error reading response length from authentication socket.");
 126                         return 0;
 127                 }
 128                 len -= l;
 129         }
 130
 131         /* Extract the length, and check it for sanity. */
 132         len = GET_32BIT(buf);
 133         if (len > 256 * 1024)
 134                 fatal("Authentication response too long: %d", len);
 135
 136         /* Read the rest of the response in to the buffer. */
 137         buffer_clear(reply);
 138         while (len > 0) {
 139                 l = len;
 140                 if (l > sizeof(buf))
 141                         l = sizeof(buf);
 142                 l = read(auth->fd, buf, l);
 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()
 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 Key *
 215 ssh_get_first_identity(AuthenticationConnection *auth, char **comment, 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 NULL;
 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 NULL;
 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 NULL;
 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\n",
 259                     auth->howmany);
 260
 261         /* Return the first entry (if any). */
 262         return ssh_get_next_identity(auth, comment, version);
 263 }
 264
 265 Key *
 266 ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version)
 267 {
 268         unsigned int bits;
 269         unsigned char *blob;
 270         unsigned int blen;
 271         Key *key = NULL;
 272
 273         /* Return failure if no more entries. */
 274         if (auth->howmany <= 0)
 275                 return NULL;
 276
 277         /*
 278          * Get the next entry from the packet.  These will abort with a fatal
 279          * error if the packet is too short or contains corrupt data.
 280          */
 281         switch(version){
 282         case 1:
 283                 key = key_new(KEY_RSA);
 284                 bits = buffer_get_int(&auth->identities);
 285                 buffer_get_bignum(&auth->identities, key->rsa->e);
 286                 buffer_get_bignum(&auth->identities, key->rsa->n);
 287                 *comment = buffer_get_string(&auth->identities, NULL);
 288                 if (bits != BN_num_bits(key->rsa->n))
 289                         log("Warning: identity keysize mismatch: actual %d, announced %u",
 290                             BN_num_bits(key->rsa->n), bits);
 291                 break;
 292         case 2:
 293                 blob = buffer_get_string(&auth->identities, &blen);
 294                 *comment = buffer_get_string(&auth->identities, NULL);
 295                 key = dsa_key_from_blob(blob, blen);
 296                 xfree(blob);
 297                 break;
 298         default:
 299                 return NULL;
 300                 break;
 301         }
 302         /* Decrement the number of remaining entries. */
 303         auth->howmany--;
 304         return key;
 305 }
 306
 307 /*
 308  * Generates a random challenge, sends it to the agent, and waits for
 309  * response from the agent.  Returns true (non-zero) if the agent gave the
 310  * correct answer, zero otherwise.  Response type selects the style of
 311  * response desired, with 0 corresponding to protocol version 1.0 (no longer
 312  * supported) and 1 corresponding to protocol version 1.1.
 313  */
 314
 315 int
 316 ssh_decrypt_challenge(AuthenticationConnection *auth,
 317     Key* key, BIGNUM *challenge,
 318     unsigned char session_id[16],
 319     unsigned int response_type,
 320     unsigned char response[16])
 321 {
 322         Buffer buffer;
 323         int success = 0;
 324         int i;
 325         int type;
 326
 327         if (key->type != KEY_RSA)
 328                 return 0;
 329         if (response_type == 0) {
 330                 log("Compatibility with ssh protocol version 1.0 no longer supported.");
 331                 return 0;
 332         }
 333         buffer_init(&buffer);
 334         buffer_put_char(&buffer, SSH_AGENTC_RSA_CHALLENGE);
 335         buffer_put_int(&buffer, BN_num_bits(key->rsa->n));
 336         buffer_put_bignum(&buffer, key->rsa->e);
 337         buffer_put_bignum(&buffer, key->rsa->n);
 338         buffer_put_bignum(&buffer, challenge);
 339         buffer_append(&buffer, (char *) session_id, 16);
 340         buffer_put_int(&buffer, response_type);
 341
 342         if (ssh_request_reply(auth, &buffer, &buffer) == 0) {
 343                 buffer_free(&buffer);
 344                 return 0;
 345         }
 346         type = buffer_get_char(&buffer);
 347
 348         if (agent_failed(type)) {
 349                 log("Agent admitted failure to authenticate using the key.");
 350         } else if (type != SSH_AGENT_RSA_RESPONSE) {
 351                 fatal("Bad authentication response: %d", type);
 352         } else {
 353                 success = 1;
 354                 /*
 355                  * Get the response from the packet.  This will abort with a
 356                  * fatal error if the packet is corrupt.
 357                  */
 358                 for (i = 0; i < 16; i++)
 359                         response[i] = buffer_get_char(&buffer);
 360         }
 361         buffer_free(&buffer);
 362         return success;
 363 }
 364
 365 /* ask agent to sign data, returns -1 on error, 0 on success */
 366 int
 367 ssh_agent_sign(AuthenticationConnection *auth,
 368     Key *key,
 369     unsigned char **sigp, int *lenp,
 370     unsigned char *data, int datalen)
 371 {
 372         extern int datafellows;
 373         Buffer msg;
 374         unsigned char *blob;
 375         unsigned int blen;
 376         int type, flags = 0;
 377         int ret = -1;
 378
 379         if (dsa_make_key_blob(key, &blob, &blen) == 0)
 380                 return -1;
 381
 382         if (datafellows & SSH_BUG_SIGBLOB)
 383                 flags = SSH_AGENT_OLD_SIGNATURE;
 384
 385         buffer_init(&msg);
 386         buffer_put_char(&msg, SSH2_AGENTC_SIGN_REQUEST);
 387         buffer_put_string(&msg, blob, blen);
 388         buffer_put_string(&msg, data, datalen);
 389         buffer_put_int(&msg, flags);
 390         xfree(blob);
 391
 392         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 393                 buffer_free(&msg);
 394                 return -1;
 395         }
 396         type = buffer_get_char(&msg);
 397         if (agent_failed(type)) {
 398                 log("Agent admitted failure to sign using the key.");
 399         } else if (type != SSH2_AGENT_SIGN_RESPONSE) {
 400                 fatal("Bad authentication response: %d", type);
 401         } else {
 402                 ret = 0;
 403                 *sigp = buffer_get_string(&msg, lenp);
 404         }
 405         buffer_free(&msg);
 406         return ret;
 407 }
 408
 409 /* Encode key for a message to the agent. */
 410
 411 void
 412 ssh_encode_identity_rsa(Buffer *b, RSA *key, const char *comment)
 413 {
 414         buffer_clear(b);
 415         buffer_put_char(b, SSH_AGENTC_ADD_RSA_IDENTITY);
 416         buffer_put_int(b, BN_num_bits(key->n));
 417         buffer_put_bignum(b, key->n);
 418         buffer_put_bignum(b, key->e);
 419         buffer_put_bignum(b, key->d);
 420         /* To keep within the protocol: p < q for ssh. in SSL p > q */
 421         buffer_put_bignum(b, key->iqmp);        /* ssh key->u */
 422         buffer_put_bignum(b, key->q);   /* ssh key->p, SSL key->q */
 423         buffer_put_bignum(b, key->p);   /* ssh key->q, SSL key->p */
 424         buffer_put_string(b, comment, strlen(comment));
 425 }
 426
 427 void
 428 ssh_encode_identity_dsa(Buffer *b, DSA *key, const char *comment)
 429 {
 430         buffer_clear(b);
 431         buffer_put_char(b, SSH2_AGENTC_ADD_IDENTITY);
 432         buffer_put_cstring(b, KEX_DSS);
 433         buffer_put_bignum2(b, key->p);
 434         buffer_put_bignum2(b, key->q);
 435         buffer_put_bignum2(b, key->g);
 436         buffer_put_bignum2(b, key->pub_key);
 437         buffer_put_bignum2(b, key->priv_key);
 438         buffer_put_string(b, comment, strlen(comment));
 439 }
 440
 441 /*
 442  * Adds an identity to the authentication server.  This call is not meant to
 443  * be used by normal applications.
 444  */
 445
 446 int
 447 ssh_add_identity(AuthenticationConnection *auth, Key *key, const char *comment)
 448 {
 449         Buffer msg;
 450         int type;
 451
 452         buffer_init(&msg);
 453
 454         switch (key->type) {
 455         case KEY_RSA:
 456                 ssh_encode_identity_rsa(&msg, key->rsa, comment);
 457                 break;
 458         case KEY_DSA:
 459                 ssh_encode_identity_dsa(&msg, key->dsa, comment);
 460                 break;
 461         default:
 462                 buffer_free(&msg);
 463                 return 0;
 464                 break;
 465         }
 466         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 467                 buffer_free(&msg);
 468                 return 0;
 469         }
 470         type = buffer_get_char(&msg);
 471         buffer_free(&msg);
 472         return decode_reply(type);
 473 }
 474
 475 /*
 476  * Removes an identity from the authentication server.  This call is not
 477  * meant to be used by normal applications.
 478  */
 479
 480 int
 481 ssh_remove_identity(AuthenticationConnection *auth, Key *key)
 482 {
 483         Buffer msg;
 484         int type;
 485         unsigned char *blob;
 486         unsigned int blen;
 487
 488         buffer_init(&msg);
 489
 490         if (key->type == KEY_RSA) {
 491                 buffer_put_char(&msg, SSH_AGENTC_REMOVE_RSA_IDENTITY);
 492                 buffer_put_int(&msg, BN_num_bits(key->rsa->n));
 493                 buffer_put_bignum(&msg, key->rsa->e);
 494                 buffer_put_bignum(&msg, key->rsa->n);
 495         } else if (key->type == KEY_DSA) {
 496                 dsa_make_key_blob(key, &blob, &blen);
 497                 buffer_put_char(&msg, SSH2_AGENTC_REMOVE_IDENTITY);
 498                 buffer_put_string(&msg, blob, blen);
 499                 xfree(blob);
 500         } else {
 501                 buffer_free(&msg);
 502                 return 0;
 503         }
 504         if (ssh_request_reply(auth, &msg, &msg) == 0) {
 505                 buffer_free(&msg);
 506                 return 0;
 507         }
 508         type = buffer_get_char(&msg);
 509         buffer_free(&msg);
 510         return decode_reply(type);
 511 }
 512
 513 /*
 514  * Removes all identities from the agent.  This call is not meant to be used
 515  * by normal applications.
 516  */
 517
 518 int
 519 ssh_remove_all_identities(AuthenticationConnection *auth, int version)
 520 {
 521         Buffer msg;
 522         int type;
 523         int code = (version==1) ?
 524                 SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES :
 525                 SSH2_AGENTC_REMOVE_ALL_IDENTITIES;
 526
 527         buffer_init(&msg);
 528         buffer_put_char(&msg, code);
 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 decode_reply(int type)
 541 {
 542         switch (type) {
 543         case SSH_AGENT_FAILURE:
 544         case SSH_COM_AGENT2_FAILURE:
 545                 log("SSH_AGENT_FAILURE");
 546                 return 0;
 547         case SSH_AGENT_SUCCESS:
 548                 return 1;
 549         default:
 550                 fatal("Bad response from authentication agent: %d", type);
 551         }
 552         /* NOTREACHED */
 553         return 0;
 554 }