ssh-add.c

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