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