ssh-add.c

   1 /* $OpenBSD: ssh-add.c,v 1.100 2010/08/31 12:33:38 djm Exp $ */
   2 /*
   3  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   4  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5  *                    All rights reserved
   6  * Adds an identity to the authentication server, or removes an identity.
   7  *
   8  * As far as I am concerned, the code I have written for this software
   9  * can be used freely for any purpose.  Any derived versions of this
  10  * software must be clearly marked as such, and if the derived work is
  11  * incompatible with the protocol description in the RFC file, it must be
  12  * called by a name other than "ssh" or "Secure Shell".
  13  *
  14  * SSH2 implementation,
  15  * Copyright (c) 2000, 2001 Markus Friedl.  All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions
  19  * are met:
  20  * 1. Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  * 2. Redistributions in binary form must reproduce the above copyright
  23  *    notice, this list of conditions and the following disclaimer in the
  24  *    documentation and/or other materials provided with the distribution.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #include "includes.h"
  39
  40 #include <sys/types.h>
  41 #include <sys/stat.h>
  42 #include <sys/param.h>
  43
  44 #include <openssl/evp.h>
  45 #include "openbsd-compat/openssl-compat.h"
  46
  47 #include <fcntl.h>
  48 #include <pwd.h>
  49 #include <stdarg.h>
  50 #include <stdio.h>
  51 #include <stdlib.h>
  52 #include <string.h>
  53 #include <unistd.h>
  54
  55 #include "xmalloc.h"
  56 #include "ssh.h"
  57 #include "rsa.h"
  58 #include "log.h"
  59 #include "key.h"
  60 #include "buffer.h"
  61 #include "authfd.h"
  62 #include "authfile.h"
  63 #include "pathnames.h"
  64 #include "misc.h"
  65
  66 /* argv0 */
  67 extern char *__progname;
  68
  69 /* Default files to add */
  70 static char *default_files[] = {
  71         _PATH_SSH_CLIENT_ID_RSA,
  72         _PATH_SSH_CLIENT_ID_DSA,
  73 #ifdef OPENSSL_HAS_ECC
  74         _PATH_SSH_CLIENT_ID_ECDSA,
  75 #endif
  76         _PATH_SSH_CLIENT_IDENTITY,
  77         NULL
  78 };
  79
  80 /* Default lifetime (0 == forever) */
  81 static int lifetime = 0;
  82
  83 /* User has to confirm key use */
  84 static int confirm = 0;
  85
  86 /* we keep a cache of one passphrases */
  87 static char *pass = NULL;
  88 static void
  89 clear_pass(void)
  90 {
  91         if (pass) {
  92                 memset(pass, 0, strlen(pass));
  93                 xfree(pass);
  94                 pass = NULL;
  95         }
  96 }
  97
  98 static int
  99 delete_file(AuthenticationConnection *ac, const char *filename)
 100 {
 101         Key *public;
 102         char *comment = NULL;
 103         int ret = -1;
 104
 105         public = key_load_public(filename, &comment);
 106         if (public == NULL) {
 107                 printf("Bad key file %s\n", filename);
 108                 return -1;
 109         }
 110         if (ssh_remove_identity(ac, public)) {
 111                 fprintf(stderr, "Identity removed: %s (%s)\n", filename, comment);
 112                 ret = 0;
 113         } else
 114                 fprintf(stderr, "Could not remove identity: %s\n", filename);
 115
 116         key_free(public);
 117         xfree(comment);
 118
 119         return ret;
 120 }
 121
 122 /* Send a request to remove all identities. */
 123 static int
 124 delete_all(AuthenticationConnection *ac)
 125 {
 126         int ret = -1;
 127
 128         if (ssh_remove_all_identities(ac, 1))
 129                 ret = 0;
 130         /* ignore error-code for ssh2 */
 131         ssh_remove_all_identities(ac, 2);
 132
 133         if (ret == 0)
 134                 fprintf(stderr, "All identities removed.\n");
 135         else
 136                 fprintf(stderr, "Failed to remove all identities.\n");
 137
 138         return ret;
 139 }
 140
 141 static int
 142 add_file(AuthenticationConnection *ac, const char *filename)
 143 {
 144         Key *private, *cert;
 145         char *comment = NULL, *fp;
 146         char msg[1024], *certpath;
 147         int fd, perms_ok, ret = -1;
 148
 149         if ((fd = open(filename, O_RDONLY)) < 0) {
 150                 perror(filename);
 151                 return -1;
 152         }
 153
 154         /*
 155          * Since we'll try to load a keyfile multiple times, permission errors
 156          * will occur multiple times, so check perms first and bail if wrong.
 157          */
 158         perms_ok = key_perm_ok(fd, filename);
 159         close(fd);
 160         if (!perms_ok)
 161                 return -1;
 162
 163         /* At first, try empty passphrase */
 164         private = key_load_private(filename, "", &comment);
 165         if (comment == NULL)
 166                 comment = xstrdup(filename);
 167         /* try last */
 168         if (private == NULL && pass != NULL)
 169                 private = key_load_private(filename, pass, NULL);
 170         if (private == NULL) {
 171                 /* clear passphrase since it did not work */
 172                 clear_pass();
 173                 snprintf(msg, sizeof msg, "Enter passphrase for %.200s: ",
 174                     comment);
 175                 for (;;) {
 176                         pass = read_passphrase(msg, RP_ALLOW_STDIN);
 177                         if (strcmp(pass, "") == 0) {
 178                                 clear_pass();
 179                                 xfree(comment);
 180                                 return -1;
 181                         }
 182                         private = key_load_private(filename, pass, &comment);
 183                         if (private != NULL)
 184                                 break;
 185                         clear_pass();
 186                         snprintf(msg, sizeof msg,
 187                             "Bad passphrase, try again for %.200s: ", comment);
 188                 }
 189         }
 190         if (blacklisted_key(private, &fp) == 1) {
 191                 fprintf(stderr, "Public key %s blacklisted (see "
 192                     "ssh-vulnkey(1)); refusing to add it\n", fp);
 193                 xfree(fp);
 194                 key_free(private);
 195                 xfree(comment);
 196                 return -1;
 197         }
 198
 199         if (ssh_add_identity_constrained(ac, private, comment, lifetime,
 200             confirm)) {
 201                 fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
 202                 ret = 0;
 203                 if (lifetime != 0)
 204                         fprintf(stderr,
 205                             "Lifetime set to %d seconds\n", lifetime);
 206                 if (confirm != 0)
 207                         fprintf(stderr,
 208                             "The user must confirm each use of the key\n");
 209         } else {
 210                 fprintf(stderr, "Could not add identity: %s\n", filename);
 211         }
 212
 213
 214         /* Now try to add the certificate flavour too */
 215         xasprintf(&certpath, "%s-cert.pub", filename);
 216         if ((cert = key_load_public(certpath, NULL)) == NULL)
 217                 goto out;
 218
 219         if (!key_equal_public(cert, private)) {
 220                 error("Certificate %s does not match private key %s",
 221                     certpath, filename);
 222                 key_free(cert);
 223                 goto out;
 224         }
 225
 226         /* Graft with private bits */
 227         if (key_to_certified(private, key_cert_is_legacy(cert)) != 0) {
 228                 error("%s: key_to_certified failed", __func__);
 229                 key_free(cert);
 230                 goto out;
 231         }
 232         key_cert_copy(cert, private);
 233         key_free(cert);
 234
 235         if (!ssh_add_identity_constrained(ac, private, comment,
 236             lifetime, confirm)) {
 237                 error("Certificate %s (%s) add failed", certpath,
 238                     private->cert->key_id);
 239         }
 240         fprintf(stderr, "Certificate added: %s (%s)\n", certpath,
 241             private->cert->key_id);
 242         if (lifetime != 0)
 243                 fprintf(stderr, "Lifetime set to %d seconds\n", lifetime);
 244         if (confirm != 0)
 245                 fprintf(stderr, "The user must confirm each use of the key\n");
 246  out:
 247         xfree(certpath);
 248         xfree(comment);
 249         key_free(private);
 250
 251         return ret;
 252 }
 253
 254 static int
 255 update_card(AuthenticationConnection *ac, int add, const char *id)
 256 {
 257         char *pin;
 258         int ret = -1;
 259
 260         pin = read_passphrase("Enter passphrase for PKCS#11: ", RP_ALLOW_STDIN);
 261         if (pin == NULL)
 262                 return -1;
 263
 264         if (ssh_update_card(ac, add, id, pin, lifetime, confirm)) {
 265                 fprintf(stderr, "Card %s: %s\n",
 266                     add ? "added" : "removed", id);
 267                 ret = 0;
 268         } else {
 269                 fprintf(stderr, "Could not %s card: %s\n",
 270                     add ? "add" : "remove", id);
 271                 ret = -1;
 272         }
 273         xfree(pin);
 274         return ret;
 275 }
 276
 277 static int
 278 list_identities(AuthenticationConnection *ac, int do_fp)
 279 {
 280         Key *key;
 281         char *comment, *fp;
 282         int had_identities = 0;
 283         int version;
 284
 285         for (version = 1; version <= 2; version++) {
 286                 for (key = ssh_get_first_identity(ac, &comment, version);
 287                     key != NULL;
 288                     key = ssh_get_next_identity(ac, &comment, version)) {
 289                         had_identities = 1;
 290                         if (do_fp) {
 291                                 fp = key_fingerprint(key, SSH_FP_MD5,
 292                                     SSH_FP_HEX);
 293                                 printf("%d %s %s (%s)\n",
 294                                     key_size(key), fp, comment, key_type(key));
 295                                 xfree(fp);
 296                         } else {
 297                                 if (!key_write(key, stdout))
 298                                         fprintf(stderr, "key_write failed");
 299                                 fprintf(stdout, " %s\n", comment);
 300                         }
 301                         key_free(key);
 302                         xfree(comment);
 303                 }
 304         }
 305         if (!had_identities) {
 306                 printf("The agent has no identities.\n");
 307                 return -1;
 308         }
 309         return 0;
 310 }
 311
 312 static int
 313 lock_agent(AuthenticationConnection *ac, int lock)
 314 {
 315         char prompt[100], *p1, *p2;
 316         int passok = 1, ret = -1;
 317
 318         strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
 319         p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
 320         if (lock) {
 321                 strlcpy(prompt, "Again: ", sizeof prompt);
 322                 p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
 323                 if (strcmp(p1, p2) != 0) {
 324                         fprintf(stderr, "Passwords do not match.\n");
 325                         passok = 0;
 326                 }
 327                 memset(p2, 0, strlen(p2));
 328                 xfree(p2);
 329         }
 330         if (passok && ssh_lock_agent(ac, lock, p1)) {
 331                 fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
 332                 ret = 0;
 333         } else
 334                 fprintf(stderr, "Failed to %slock agent.\n", lock ? "" : "un");
 335         memset(p1, 0, strlen(p1));
 336         xfree(p1);
 337         return (ret);
 338 }
 339
 340 static int
 341 do_file(AuthenticationConnection *ac, int deleting, char *file)
 342 {
 343         if (deleting) {
 344                 if (delete_file(ac, file) == -1)
 345                         return -1;
 346         } else {
 347                 if (add_file(ac, file) == -1)
 348                         return -1;
 349         }
 350         return 0;
 351 }
 352
 353 static void
 354 usage(void)
 355 {
 356         fprintf(stderr, "usage: %s [options] [file ...]\n", __progname);
 357         fprintf(stderr, "Options:\n");
 358         fprintf(stderr, "  -l          List fingerprints of all identities.\n");
 359         fprintf(stderr, "  -L          List public key parameters of all identities.\n");
 360         fprintf(stderr, "  -d          Delete identity.\n");
 361         fprintf(stderr, "  -D          Delete all identities.\n");
 362         fprintf(stderr, "  -x          Lock agent.\n");
 363         fprintf(stderr, "  -X          Unlock agent.\n");
 364         fprintf(stderr, "  -t life     Set lifetime (in seconds) when adding identities.\n");
 365         fprintf(stderr, "  -c          Require confirmation to sign using identities\n");
 366         fprintf(stderr, "  -s pkcs11   Add keys from PKCS#11 provider.\n");
 367         fprintf(stderr, "  -e pkcs11   Remove keys provided by PKCS#11 provider.\n");
 368 }
 369
 370 int
 371 main(int argc, char **argv)
 372 {
 373         extern char *optarg;
 374         extern int optind;
 375         AuthenticationConnection *ac = NULL;
 376         char *pkcs11provider = NULL;
 377         int i, ch, deleting = 0, ret = 0;
 378
 379         /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
 380         sanitise_stdfd();
 381
 382         __progname = ssh_get_progname(argv[0]);
 383         init_rng();
 384         seed_rng();
 385
 386         OpenSSL_add_all_algorithms();
 387
 388         /* At first, get a connection to the authentication agent. */
 389         ac = ssh_get_authentication_connection();
 390         if (ac == NULL) {
 391                 fprintf(stderr,
 392                     "Could not open a connection to your authentication agent.\n");
 393                 exit(2);
 394         }
 395         while ((ch = getopt(argc, argv, "lLcdDxXe:s:t:")) != -1) {
 396                 switch (ch) {
 397                 case 'l':
 398                 case 'L':
 399                         if (list_identities(ac, ch == 'l' ? 1 : 0) == -1)
 400                                 ret = 1;
 401                         goto done;
 402                 case 'x':
 403                 case 'X':
 404                         if (lock_agent(ac, ch == 'x' ? 1 : 0) == -1)
 405                                 ret = 1;
 406                         goto done;
 407                 case 'c':
 408                         confirm = 1;
 409                         break;
 410                 case 'd':
 411                         deleting = 1;
 412                         break;
 413                 case 'D':
 414                         if (delete_all(ac) == -1)
 415                                 ret = 1;
 416                         goto done;
 417                 case 's':
 418                         pkcs11provider = optarg;
 419                         break;
 420                 case 'e':
 421                         deleting = 1;
 422                         pkcs11provider = optarg;
 423                         break;
 424                 case 't':
 425                         if ((lifetime = convtime(optarg)) == -1) {
 426                                 fprintf(stderr, "Invalid lifetime\n");
 427                                 ret = 1;
 428                                 goto done;
 429                         }
 430                         break;
 431                 default:
 432                         usage();
 433                         ret = 1;
 434                         goto done;
 435                 }
 436         }
 437         argc -= optind;
 438         argv += optind;
 439         if (pkcs11provider != NULL) {
 440                 if (update_card(ac, !deleting, pkcs11provider) == -1)
 441                         ret = 1;
 442                 goto done;
 443         }
 444         if (argc == 0) {
 445                 char buf[MAXPATHLEN];
 446                 struct passwd *pw;
 447                 struct stat st;
 448                 int count = 0;
 449
 450                 if ((pw = getpwuid(getuid())) == NULL) {
 451                         fprintf(stderr, "No user found with uid %u\n",
 452                             (u_int)getuid());
 453                         ret = 1;
 454                         goto done;
 455                 }
 456
 457                 for (i = 0; default_files[i]; i++) {
 458                         snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
 459                             default_files[i]);
 460                         if (stat(buf, &st) < 0)
 461                                 continue;
 462                         if (do_file(ac, deleting, buf) == -1)
 463                                 ret = 1;
 464                         else
 465                                 count++;
 466                 }
 467                 if (count == 0)
 468                         ret = 1;
 469         } else {
 470                 for (i = 0; i < argc; i++) {
 471                         if (do_file(ac, deleting, argv[i]) == -1)
 472                                 ret = 1;
 473                 }
 474         }
 475         clear_pass();
 476
 477 done:
 478         ssh_close_authentication_connection(ac);
 479         return ret;
 480 }