ssh-add.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  * Adds an identity to the authentication server, or removes an identity.
   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, 2001 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: ssh-add.c,v 1.75 2006/02/20 17:19:54 stevesk Exp $");
  39
  40 #include <sys/types.h>
  41 #include <sys/stat.h>
  42
  43 #include <openssl/evp.h>
  44
  45 #include "ssh.h"
  46 #include "rsa.h"
  47 #include "log.h"
  48 #include "xmalloc.h"
  49 #include "key.h"
  50 #include "authfd.h"
  51 #include "authfile.h"
  52 #include "pathnames.h"
  53 #include "misc.h"
  54
  55 /* argv0 */
  56 extern char *__progname;
  57
  58 /* Default files to add */
  59 static char *default_files[] = {
  60         _PATH_SSH_CLIENT_ID_RSA,
  61         _PATH_SSH_CLIENT_ID_DSA,
  62         _PATH_SSH_CLIENT_IDENTITY,
  63         NULL
  64 };
  65
  66 /* Default lifetime (0 == forever) */
  67 static int lifetime = 0;
  68
  69 /* User has to confirm key use */
  70 static int confirm = 0;
  71
  72 /* we keep a cache of one passphrases */
  73 static char *pass = NULL;
  74 static void
  75 clear_pass(void)
  76 {
  77         if (pass) {
  78                 memset(pass, 0, strlen(pass));
  79                 xfree(pass);
  80                 pass = NULL;
  81         }
  82 }
  83
  84 static int
  85 delete_file(AuthenticationConnection *ac, const char *filename)
  86 {
  87         Key *public;
  88         char *comment = NULL;
  89         int ret = -1;
  90
  91         public = key_load_public(filename, &comment);
  92         if (public == NULL) {
  93                 printf("Bad key file %s\n", filename);
  94                 return -1;
  95         }
  96         if (ssh_remove_identity(ac, public)) {
  97                 fprintf(stderr, "Identity removed: %s (%s)\n", filename, comment);
  98                 ret = 0;
  99         } else
 100                 fprintf(stderr, "Could not remove identity: %s\n", filename);
 101
 102         key_free(public);
 103         xfree(comment);
 104
 105         return ret;
 106 }
 107
 108 /* Send a request to remove all identities. */
 109 static int
 110 delete_all(AuthenticationConnection *ac)
 111 {
 112         int ret = -1;
 113
 114         if (ssh_remove_all_identities(ac, 1))
 115                 ret = 0;
 116         /* ignore error-code for ssh2 */
 117         ssh_remove_all_identities(ac, 2);
 118
 119         if (ret == 0)
 120                 fprintf(stderr, "All identities removed.\n");
 121         else
 122                 fprintf(stderr, "Failed to remove all identities.\n");
 123
 124         return ret;
 125 }
 126
 127 static int
 128 add_file(AuthenticationConnection *ac, const char *filename)
 129 {
 130         struct stat st;
 131         Key *private;
 132         char *comment = NULL;
 133         char msg[1024];
 134         int ret = -1;
 135
 136         if (stat(filename, &st) < 0) {
 137                 perror(filename);
 138                 return -1;
 139         }
 140         /* At first, try empty passphrase */
 141         private = key_load_private(filename, "", &comment);
 142         if (comment == NULL)
 143                 comment = xstrdup(filename);
 144         /* try last */
 145         if (private == NULL && pass != NULL)
 146                 private = key_load_private(filename, pass, NULL);
 147         if (private == NULL) {
 148                 /* clear passphrase since it did not work */
 149                 clear_pass();
 150                 snprintf(msg, sizeof msg, "Enter passphrase for %.200s: ",
 151                     comment);
 152                 for (;;) {
 153                         pass = read_passphrase(msg, RP_ALLOW_STDIN);
 154                         if (strcmp(pass, "") == 0) {
 155                                 clear_pass();
 156                                 xfree(comment);
 157                                 return -1;
 158                         }
 159                         private = key_load_private(filename, pass, &comment);
 160                         if (private != NULL)
 161                                 break;
 162                         clear_pass();
 163                         snprintf(msg, sizeof msg,
 164                             "Bad passphrase, try again for %.200s: ", comment);
 165                 }
 166         }
 167
 168         if (ssh_add_identity_constrained(ac, private, comment, lifetime,
 169             confirm)) {
 170                 fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
 171                 ret = 0;
 172                 if (lifetime != 0)
 173                         fprintf(stderr,
 174                             "Lifetime set to %d seconds\n", lifetime);
 175                 if (confirm != 0)
 176                         fprintf(stderr,
 177                             "The user has to confirm each use of the key\n");
 178         } else if (ssh_add_identity(ac, private, comment)) {
 179                 fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
 180                 ret = 0;
 181         } else {
 182                 fprintf(stderr, "Could not add identity: %s\n", filename);
 183         }
 184
 185         xfree(comment);
 186         key_free(private);
 187
 188         return ret;
 189 }
 190
 191 static int
 192 update_card(AuthenticationConnection *ac, int add, const char *id)
 193 {
 194         char *pin;
 195         int ret = -1;
 196
 197         pin = read_passphrase("Enter passphrase for smartcard: ", RP_ALLOW_STDIN);
 198         if (pin == NULL)
 199                 return -1;
 200
 201         if (ssh_update_card(ac, add, id, pin, lifetime, confirm)) {
 202                 fprintf(stderr, "Card %s: %s\n",
 203                     add ? "added" : "removed", id);
 204                 ret = 0;
 205         } else {
 206                 fprintf(stderr, "Could not %s card: %s\n",
 207                     add ? "add" : "remove", id);
 208                 ret = -1;
 209         }
 210         xfree(pin);
 211         return ret;
 212 }
 213
 214 static int
 215 list_identities(AuthenticationConnection *ac, int do_fp)
 216 {
 217         Key *key;
 218         char *comment, *fp;
 219         int had_identities = 0;
 220         int version;
 221
 222         for (version = 1; version <= 2; version++) {
 223                 for (key = ssh_get_first_identity(ac, &comment, version);
 224                     key != NULL;
 225                     key = ssh_get_next_identity(ac, &comment, version)) {
 226                         had_identities = 1;
 227                         if (do_fp) {
 228                                 fp = key_fingerprint(key, SSH_FP_MD5,
 229                                     SSH_FP_HEX);
 230                                 printf("%d %s %s (%s)\n",
 231                                     key_size(key), fp, comment, key_type(key));
 232                                 xfree(fp);
 233                         } else {
 234                                 if (!key_write(key, stdout))
 235                                         fprintf(stderr, "key_write failed");
 236                                 fprintf(stdout, " %s\n", comment);
 237                         }
 238                         key_free(key);
 239                         xfree(comment);
 240                 }
 241         }
 242         if (!had_identities) {
 243                 printf("The agent has no identities.\n");
 244                 return -1;
 245         }
 246         return 0;
 247 }
 248
 249 static int
 250 lock_agent(AuthenticationConnection *ac, int lock)
 251 {
 252         char prompt[100], *p1, *p2;
 253         int passok = 1, ret = -1;
 254
 255         strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
 256         p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
 257         if (lock) {
 258                 strlcpy(prompt, "Again: ", sizeof prompt);
 259                 p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
 260                 if (strcmp(p1, p2) != 0) {
 261                         fprintf(stderr, "Passwords do not match.\n");
 262                         passok = 0;
 263                 }
 264                 memset(p2, 0, strlen(p2));
 265                 xfree(p2);
 266         }
 267         if (passok && ssh_lock_agent(ac, lock, p1)) {
 268                 fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
 269                 ret = 0;
 270         } else
 271                 fprintf(stderr, "Failed to %slock agent.\n", lock ? "" : "un");
 272         memset(p1, 0, strlen(p1));
 273         xfree(p1);
 274         return (ret);
 275 }
 276
 277 static int
 278 do_file(AuthenticationConnection *ac, int deleting, char *file)
 279 {
 280         if (deleting) {
 281                 if (delete_file(ac, file) == -1)
 282                         return -1;
 283         } else {
 284                 if (add_file(ac, file) == -1)
 285                         return -1;
 286         }
 287         return 0;
 288 }
 289
 290 static void
 291 usage(void)
 292 {
 293         fprintf(stderr, "Usage: %s [options]\n", __progname);
 294         fprintf(stderr, "Options:\n");
 295         fprintf(stderr, "  -l          List fingerprints of all identities.\n");
 296         fprintf(stderr, "  -L          List public key parameters of all identities.\n");
 297         fprintf(stderr, "  -d          Delete identity.\n");
 298         fprintf(stderr, "  -D          Delete all identities.\n");
 299         fprintf(stderr, "  -x          Lock agent.\n");
 300         fprintf(stderr, "  -X          Unlock agent.\n");
 301         fprintf(stderr, "  -t life     Set lifetime (in seconds) when adding identities.\n");
 302         fprintf(stderr, "  -c          Require confirmation to sign using identities\n");
 303 #ifdef SMARTCARD
 304         fprintf(stderr, "  -s reader   Add key in smartcard reader.\n");
 305         fprintf(stderr, "  -e reader   Remove key in smartcard reader.\n");
 306 #endif
 307 }
 308
 309 int
 310 main(int argc, char **argv)
 311 {
 312         extern char *optarg;
 313         extern int optind;
 314         AuthenticationConnection *ac = NULL;
 315         char *sc_reader_id = NULL;
 316         int i, ch, deleting = 0, ret = 0;
 317
 318         /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
 319         sanitise_stdfd();
 320
 321         __progname = ssh_get_progname(argv[0]);
 322         init_rng();
 323         seed_rng();
 324
 325         SSLeay_add_all_algorithms();
 326
 327         /* At first, get a connection to the authentication agent. */
 328         ac = ssh_get_authentication_connection();
 329         if (ac == NULL) {
 330                 fprintf(stderr,
 331                     "Could not open a connection to your authentication agent.\n");
 332                 exit(2);
 333         }
 334         while ((ch = getopt(argc, argv, "lLcdDxXe:s:t:")) != -1) {
 335                 switch (ch) {
 336                 case 'l':
 337                 case 'L':
 338                         if (list_identities(ac, ch == 'l' ? 1 : 0) == -1)
 339                                 ret = 1;
 340                         goto done;
 341                         break;
 342                 case 'x':
 343                 case 'X':
 344                         if (lock_agent(ac, ch == 'x' ? 1 : 0) == -1)
 345                                 ret = 1;
 346                         goto done;
 347                         break;
 348                 case 'c':
 349                         confirm = 1;
 350                         break;
 351                 case 'd':
 352                         deleting = 1;
 353                         break;
 354                 case 'D':
 355                         if (delete_all(ac) == -1)
 356                                 ret = 1;
 357                         goto done;
 358                         break;
 359                 case 's':
 360                         sc_reader_id = optarg;
 361                         break;
 362                 case 'e':
 363                         deleting = 1;
 364                         sc_reader_id = optarg;
 365                         break;
 366                 case 't':
 367                         if ((lifetime = convtime(optarg)) == -1) {
 368                                 fprintf(stderr, "Invalid lifetime\n");
 369                                 ret = 1;
 370                                 goto done;
 371                         }
 372                         break;
 373                 default:
 374                         usage();
 375                         ret = 1;
 376                         goto done;
 377                 }
 378         }
 379         argc -= optind;
 380         argv += optind;
 381         if (sc_reader_id != NULL) {
 382                 if (update_card(ac, !deleting, sc_reader_id) == -1)
 383                         ret = 1;
 384                 goto done;
 385         }
 386         if (argc == 0) {
 387                 char buf[MAXPATHLEN];
 388                 struct passwd *pw;
 389                 struct stat st;
 390                 int count = 0;
 391
 392                 if ((pw = getpwuid(getuid())) == NULL) {
 393                         fprintf(stderr, "No user found with uid %u\n",
 394                             (u_int)getuid());
 395                         ret = 1;
 396                         goto done;
 397                 }
 398
 399                 for (i = 0; default_files[i]; i++) {
 400                         snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
 401                             default_files[i]);
 402                         if (stat(buf, &st) < 0)
 403                                 continue;
 404                         if (do_file(ac, deleting, buf) == -1)
 405                                 ret = 1;
 406                         else
 407                                 count++;
 408                 }
 409                 if (count == 0)
 410                         ret = 1;
 411         } else {
 412                 for (i = 0; i < argc; i++) {
 413                         if (do_file(ac, deleting, argv[i]) == -1)
 414                                 ret = 1;
 415                 }
 416         }
 417         clear_pass();
 418
 419 done:
 420         ssh_close_authentication_connection(ac);
 421         return ret;
 422 }