sm/call-agent.c

   1 /* call-agent.c - Divert GPGSM operations to the agent
   2  * Copyright (C) 2001, 2002, 2003, 2005, 2007,
   3  *               2008, 2009, 2010 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GnuPG.
   6  *
   7  * GnuPG is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * GnuPG is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <errno.h>
  26 #include <unistd.h>
  27 #include <time.h>
  28 #include <assert.h>
  29 #ifdef HAVE_LOCALE_H
  30 #include <locale.h>
  31 #endif
  32
  33 #include "gpgsm.h"
  34 #include <gcrypt.h>
  35 #include <assuan.h>
  36 #include "i18n.h"
  37 #include "asshelp.h"
  38 #include "keydb.h" /* fixme: Move this to import.c */
  39 #include "membuf.h"
  40 #include "shareddefs.h"
  41 #include "passphrase.h"
  42
  43
  44 static assuan_context_t agent_ctx = NULL;
  45
  46
  47 struct cipher_parm_s
  48 {
  49   ctrl_t ctrl;
  50   assuan_context_t ctx;
  51   const unsigned char *ciphertext;
  52   size_t ciphertextlen;
  53 };
  54
  55 struct genkey_parm_s
  56 {
  57   ctrl_t ctrl;
  58   assuan_context_t ctx;
  59   const unsigned char *sexp;
  60   size_t sexplen;
  61 };
  62
  63 struct learn_parm_s
  64 {
  65   int error;
  66   ctrl_t ctrl;
  67   assuan_context_t ctx;
  68   membuf_t *data;
  69 };
  70
  71 struct import_key_parm_s
  72 {
  73   ctrl_t ctrl;
  74   assuan_context_t ctx;
  75   const void *key;
  76   size_t keylen;
  77 };
  78
  79 struct default_inq_parm_s
  80 {
  81   ctrl_t ctrl;
  82   assuan_context_t ctx;
  83 };
  84
  85 \f
  86 /* Print a warning if the server's version number is less than our
  87    version number.  Returns an error code on a connection problem.  */
  88 static gpg_error_t
  89 warn_version_mismatch (ctrl_t ctrl, assuan_context_t ctx,
  90                        const char *servername, int mode)
  91 {
  92   gpg_error_t err;
  93   char *serverversion;
  94   const char *myversion = strusage (13);
  95
  96   err = get_assuan_server_version (ctx, mode, &serverversion);
  97   if (err)
  98     log_error (_("error getting version from '%s': %s\n"),
  99                servername, gpg_strerror (err));
 100   else if (compare_version_strings (serverversion, myversion) < 0)
 101     {
 102       char *warn;
 103
 104       warn = xtryasprintf (_("server '%s' is older than us (%s < %s)"),
 105                            servername, serverversion, myversion);
 106       if (!warn)
 107         err = gpg_error_from_syserror ();
 108       else
 109         {
 110           log_info (_("WARNING: %s\n"), warn);
 111           gpgsm_status2 (ctrl, STATUS_WARNING, "server_version_mismatch 0",
 112                          warn, NULL);
 113           xfree (warn);
 114         }
 115     }
 116   xfree (serverversion);
 117   return err;
 118 }
 119
 120
 121 /* Try to connect to the agent via socket or fork it off and work by
 122    pipes.  Handle the server's initial greeting */
 123 static int
 124 start_agent (ctrl_t ctrl)
 125 {
 126   int rc;
 127
 128   if (agent_ctx)
 129     rc = 0;      /* fixme: We need a context for each thread or
 130                     serialize the access to the agent (which is
 131                     suitable given that the agent is not MT. */
 132   else
 133     {
 134       rc = start_new_gpg_agent (&agent_ctx,
 135                                 GPG_ERR_SOURCE_DEFAULT,
 136                                 opt.agent_program,
 137                                 opt.lc_ctype, opt.lc_messages,
 138                                 opt.session_env,
 139                                 opt.autostart, opt.verbose, DBG_IPC,
 140                                 gpgsm_status2, ctrl);
 141
 142       if (!opt.autostart && gpg_err_code (rc) == GPG_ERR_NO_AGENT)
 143         {
 144           static int shown;
 145
 146           if (!shown)
 147             {
 148               shown = 1;
 149               log_info (_("no gpg-agent running in this session\n"));
 150             }
 151         }
 152       else if (!rc && !(rc = warn_version_mismatch (ctrl, agent_ctx,
 153                                                     GPG_AGENT_NAME, 0)))
 154         {
 155           /* Tell the agent that we support Pinentry notifications.  No
 156              error checking so that it will work also with older
 157              agents.  */
 158           assuan_transact (agent_ctx, "OPTION allow-pinentry-notify",
 159                            NULL, NULL, NULL, NULL, NULL, NULL);
 160
 161           /* Pass on the pinentry mode.  */
 162           if (opt.pinentry_mode)
 163             {
 164               char *tmp = xasprintf ("OPTION pinentry-mode=%s",
 165                                      str_pinentry_mode (opt.pinentry_mode));
 166               rc = assuan_transact (agent_ctx, tmp,
 167                                NULL, NULL, NULL, NULL, NULL, NULL);
 168               xfree (tmp);
 169               if (rc)
 170                 log_error ("setting pinentry mode '%s' failed: %s\n",
 171                            str_pinentry_mode (opt.pinentry_mode),
 172                            gpg_strerror (rc));
 173             }
 174         }
 175     }
 176
 177   if (!ctrl->agent_seen)
 178     {
 179       ctrl->agent_seen = 1;
 180       audit_log_ok (ctrl->audit, AUDIT_AGENT_READY, rc);
 181     }
 182
 183   return rc;
 184 }
 185
 186 /* This is the default inquiry callback.  It mainly handles the
 187    Pinentry notifications.  */
 188 static gpg_error_t
 189 default_inq_cb (void *opaque, const char *line)
 190 {
 191   gpg_error_t err = 0;
 192   struct default_inq_parm_s *parm = opaque;
 193   ctrl_t ctrl = parm->ctrl;
 194
 195   if (has_leading_keyword (line, "PINENTRY_LAUNCHED"))
 196     {
 197       err = gpgsm_proxy_pinentry_notify (ctrl, line);
 198       if (err)
 199         log_error (_("failed to proxy %s inquiry to client\n"),
 200                    "PINENTRY_LAUNCHED");
 201       /* We do not pass errors to avoid breaking other code.  */
 202     }
 203   else if ((has_leading_keyword (line, "PASSPHRASE")
 204             || has_leading_keyword (line, "NEW_PASSPHRASE"))
 205            && opt.pinentry_mode == PINENTRY_MODE_LOOPBACK
 206            && have_static_passphrase ())
 207     {
 208       const char *s = get_static_passphrase ();
 209       err = assuan_send_data (parm->ctx, s, strlen (s));
 210     }
 211   else
 212     log_error ("ignoring gpg-agent inquiry '%s'\n", line);
 213
 214   return err;
 215 }
 216
 217
 218
 219 \f
 220 /* Call the agent to do a sign operation using the key identified by
 221    the hex string KEYGRIP. */
 222 int
 223 gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
 224                     unsigned char *digest, size_t digestlen, int digestalgo,
 225                     unsigned char **r_buf, size_t *r_buflen )
 226 {
 227   int rc, i;
 228   char *p, line[ASSUAN_LINELENGTH];
 229   membuf_t data;
 230   size_t len;
 231   struct default_inq_parm_s inq_parm;
 232
 233   *r_buf = NULL;
 234   rc = start_agent (ctrl);
 235   if (rc)
 236     return rc;
 237   inq_parm.ctx = agent_ctx;
 238
 239   if (digestlen*2 + 50 > DIM(line))
 240     return gpg_error (GPG_ERR_GENERAL);
 241
 242   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 243   if (rc)
 244     return rc;
 245
 246   snprintf (line, DIM(line), "SIGKEY %s", keygrip);
 247   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 248   if (rc)
 249     return rc;
 250
 251   if (desc)
 252     {
 253       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
 254       rc = assuan_transact (agent_ctx, line,
 255                             NULL, NULL, NULL, NULL, NULL, NULL);
 256       if (rc)
 257         return rc;
 258     }
 259
 260   sprintf (line, "SETHASH %d ", digestalgo);
 261   p = line + strlen (line);
 262   for (i=0; i < digestlen ; i++, p += 2 )
 263     sprintf (p, "%02X", digest[i]);
 264   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 265   if (rc)
 266     return rc;
 267
 268   init_membuf (&data, 1024);
 269   rc = assuan_transact (agent_ctx, "PKSIGN",
 270                         put_membuf_cb, &data, default_inq_cb, &inq_parm,
 271                         NULL, NULL);
 272   if (rc)
 273     {
 274       xfree (get_membuf (&data, &len));
 275       return rc;
 276     }
 277   *r_buf = get_membuf (&data, r_buflen);
 278
 279   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
 280     {
 281       xfree (*r_buf); *r_buf = NULL;
 282       return gpg_error (GPG_ERR_INV_VALUE);
 283     }
 284
 285   return *r_buf? 0 : out_of_core ();
 286 }
 287
 288
 289 /* Call the scdaemon to do a sign operation using the key identified by
 290    the hex string KEYID. */
 291 int
 292 gpgsm_scd_pksign (ctrl_t ctrl, const char *keyid, const char *desc,
 293                   unsigned char *digest, size_t digestlen, int digestalgo,
 294                   unsigned char **r_buf, size_t *r_buflen )
 295 {
 296   int rc, i;
 297   char *p, line[ASSUAN_LINELENGTH];
 298   membuf_t data;
 299   size_t len;
 300   const char *hashopt;
 301   unsigned char *sigbuf;
 302   size_t sigbuflen;
 303   struct default_inq_parm_s inq_parm;
 304
 305   (void)desc;
 306
 307   *r_buf = NULL;
 308
 309   switch(digestalgo)
 310     {
 311     case GCRY_MD_SHA1:  hashopt = "--hash=sha1"; break;
 312     case GCRY_MD_RMD160:hashopt = "--hash=rmd160"; break;
 313     case GCRY_MD_MD5:   hashopt = "--hash=md5"; break;
 314     case GCRY_MD_SHA256:hashopt = "--hash=sha256"; break;
 315     default:
 316       return gpg_error (GPG_ERR_DIGEST_ALGO);
 317     }
 318
 319   rc = start_agent (ctrl);
 320   if (rc)
 321     return rc;
 322   inq_parm.ctx = agent_ctx;
 323
 324   if (digestlen*2 + 50 > DIM(line))
 325     return gpg_error (GPG_ERR_GENERAL);
 326
 327   p = stpcpy (line, "SCD SETDATA " );
 328   for (i=0; i < digestlen ; i++, p += 2 )
 329     sprintf (p, "%02X", digest[i]);
 330   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 331   if (rc)
 332     return rc;
 333
 334   init_membuf (&data, 1024);
 335
 336   snprintf (line, DIM(line), "SCD PKSIGN %s %s", hashopt, keyid);
 337   rc = assuan_transact (agent_ctx, line,
 338                         put_membuf_cb, &data, default_inq_cb, &inq_parm,
 339                         NULL, NULL);
 340   if (rc)
 341     {
 342       xfree (get_membuf (&data, &len));
 343       return rc;
 344     }
 345   sigbuf = get_membuf (&data, &sigbuflen);
 346
 347   /* Create an S-expression from it which is formatted like this:
 348      "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" Fixme: If a card ever
 349      creates non-RSA keys we need to change things. */
 350   *r_buflen = 21 + 11 + sigbuflen + 4;
 351   p = xtrymalloc (*r_buflen);
 352   *r_buf = (unsigned char*)p;
 353   if (!p)
 354     {
 355       xfree (sigbuf);
 356       return 0;
 357     }
 358   p = stpcpy (p, "(7:sig-val(3:rsa(1:s" );
 359   sprintf (p, "%u:", (unsigned int)sigbuflen);
 360   p += strlen (p);
 361   memcpy (p, sigbuf, sigbuflen);
 362   p += sigbuflen;
 363   strcpy (p, ")))");
 364   xfree (sigbuf);
 365
 366   assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
 367   return  0;
 368 }
 369
 370
 371
 372 \f
 373 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
 374    assuan_transact takes care of flushing and writing the end */
 375 static gpg_error_t
 376 inq_ciphertext_cb (void *opaque, const char *line)
 377 {
 378   struct cipher_parm_s *parm = opaque;
 379   int rc;
 380
 381   if (has_leading_keyword (line, "CIPHERTEXT"))
 382     {
 383       assuan_begin_confidential (parm->ctx);
 384       rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
 385       assuan_end_confidential (parm->ctx);
 386     }
 387   else
 388     {
 389       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
 390       rc = default_inq_cb (&inq_parm, line);
 391     }
 392
 393   return rc;
 394 }
 395
 396
 397 /* Call the agent to do a decrypt operation using the key identified by
 398    the hex string KEYGRIP. */
 399 int
 400 gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
 401                        ksba_const_sexp_t ciphertext,
 402                        char **r_buf, size_t *r_buflen )
 403 {
 404   int rc;
 405   char line[ASSUAN_LINELENGTH];
 406    membuf_t data;
 407   struct cipher_parm_s cipher_parm;
 408   size_t n, len;
 409   char *p, *buf, *endp;
 410   size_t ciphertextlen;
 411
 412   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
 413     return gpg_error (GPG_ERR_INV_VALUE);
 414   *r_buf = NULL;
 415
 416   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
 417   if (!ciphertextlen)
 418     return gpg_error (GPG_ERR_INV_VALUE);
 419
 420   rc = start_agent (ctrl);
 421   if (rc)
 422     return rc;
 423
 424   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 425   if (rc)
 426     return rc;
 427
 428   assert ( DIM(line) >= 50 );
 429   snprintf (line, DIM(line), "SETKEY %s", keygrip);
 430   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 431   if (rc)
 432     return rc;
 433
 434   if (desc)
 435     {
 436       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
 437       rc = assuan_transact (agent_ctx, line,
 438                             NULL, NULL, NULL, NULL, NULL, NULL);
 439       if (rc)
 440         return rc;
 441     }
 442
 443   init_membuf (&data, 1024);
 444   cipher_parm.ctrl = ctrl;
 445   cipher_parm.ctx = agent_ctx;
 446   cipher_parm.ciphertext = ciphertext;
 447   cipher_parm.ciphertextlen = ciphertextlen;
 448   rc = assuan_transact (agent_ctx, "PKDECRYPT",
 449                         put_membuf_cb, &data,
 450                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
 451   if (rc)
 452     {
 453       xfree (get_membuf (&data, &len));
 454       return rc;
 455     }
 456
 457   put_membuf (&data, "", 1); /* Make sure it is 0 terminated. */
 458   buf = get_membuf (&data, &len);
 459   if (!buf)
 460     return gpg_error (GPG_ERR_ENOMEM);
 461   assert (len); /* (we forced Nul termination.)  */
 462
 463   if (*buf == '(')
 464     {
 465       if (len < 13 || memcmp (buf, "(5:value", 8) ) /* "(5:valueN:D)\0" */
 466         return gpg_error (GPG_ERR_INV_SEXP);
 467       len -= 11;   /* Count only the data of the second part. */
 468       p = buf + 8; /* Skip leading parenthesis and the value tag. */
 469     }
 470   else
 471     {
 472       /* For compatibility with older gpg-agents handle the old style
 473          incomplete S-exps. */
 474       len--;      /* Do not count the Nul. */
 475       p = buf;
 476     }
 477
 478   n = strtoul (p, &endp, 10);
 479   if (!n || *endp != ':')
 480     return gpg_error (GPG_ERR_INV_SEXP);
 481   endp++;
 482   if (endp-p+n > len)
 483     return gpg_error (GPG_ERR_INV_SEXP); /* Oops: Inconsistent S-Exp. */
 484
 485   memmove (buf, endp, n);
 486
 487   *r_buflen = n;
 488   *r_buf = buf;
 489   return 0;
 490 }
 491
 492
 493
 494
 495 \f
 496 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
 497    assuan_transact takes care of flushing and writing the end */
 498 static gpg_error_t
 499 inq_genkey_parms (void *opaque, const char *line)
 500 {
 501   struct genkey_parm_s *parm = opaque;
 502   int rc;
 503
 504   if (has_leading_keyword (line, "KEYPARAM"))
 505     {
 506       rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
 507     }
 508   else
 509     {
 510       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
 511       rc = default_inq_cb (&inq_parm, line);
 512     }
 513
 514   return rc;
 515 }
 516
 517
 518 \f
 519 /* Call the agent to generate a newkey */
 520 int
 521 gpgsm_agent_genkey (ctrl_t ctrl,
 522                     ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey)
 523 {
 524   int rc;
 525   struct genkey_parm_s gk_parm;
 526   membuf_t data;
 527   size_t len;
 528   unsigned char *buf;
 529
 530   *r_pubkey = NULL;
 531   rc = start_agent (ctrl);
 532   if (rc)
 533     return rc;
 534
 535   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 536   if (rc)
 537     return rc;
 538
 539   init_membuf (&data, 1024);
 540   gk_parm.ctrl = ctrl;
 541   gk_parm.ctx = agent_ctx;
 542   gk_parm.sexp = keyparms;
 543   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
 544   if (!gk_parm.sexplen)
 545     return gpg_error (GPG_ERR_INV_VALUE);
 546   rc = assuan_transact (agent_ctx, "GENKEY",
 547                         put_membuf_cb, &data,
 548                         inq_genkey_parms, &gk_parm, NULL, NULL);
 549   if (rc)
 550     {
 551       xfree (get_membuf (&data, &len));
 552       return rc;
 553     }
 554   buf = get_membuf (&data, &len);
 555   if (!buf)
 556     return gpg_error (GPG_ERR_ENOMEM);
 557   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
 558     {
 559       xfree (buf);
 560       return gpg_error (GPG_ERR_INV_SEXP);
 561     }
 562   *r_pubkey = buf;
 563   return 0;
 564 }
 565
 566 \f
 567 /* Call the agent to read the public key part for a given keygrip.  If
 568    FROMCARD is true, the key is directly read from the current
 569    smartcard. In this case HEXKEYGRIP should be the keyID
 570    (e.g. OPENPGP.3). */
 571 int
 572 gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
 573                      ksba_sexp_t *r_pubkey)
 574 {
 575   int rc;
 576   membuf_t data;
 577   size_t len;
 578   unsigned char *buf;
 579   char line[ASSUAN_LINELENGTH];
 580   struct default_inq_parm_s inq_parm;
 581
 582   *r_pubkey = NULL;
 583   rc = start_agent (ctrl);
 584   if (rc)
 585     return rc;
 586   inq_parm.ctx = agent_ctx;
 587
 588   rc = assuan_transact (agent_ctx, "RESET",NULL, NULL, NULL, NULL, NULL, NULL);
 589   if (rc)
 590     return rc;
 591
 592   snprintf (line, DIM(line), "%sREADKEY %s",
 593             fromcard? "SCD ":"", hexkeygrip);
 594
 595   init_membuf (&data, 1024);
 596   rc = assuan_transact (agent_ctx, line,
 597                         put_membuf_cb, &data,
 598                         default_inq_cb, &inq_parm, NULL, NULL);
 599   if (rc)
 600     {
 601       xfree (get_membuf (&data, &len));
 602       return rc;
 603     }
 604   buf = get_membuf (&data, &len);
 605   if (!buf)
 606     return gpg_error (GPG_ERR_ENOMEM);
 607   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
 608     {
 609       xfree (buf);
 610       return gpg_error (GPG_ERR_INV_SEXP);
 611     }
 612   *r_pubkey = buf;
 613   return 0;
 614 }
 615
 616
 617 \f
 618 /* Take the serial number from LINE and return it verbatim in a newly
 619    allocated string.  We make sure that only hex characters are
 620    returned. */
 621 static char *
 622 store_serialno (const char *line)
 623 {
 624   const char *s;
 625   char *p;
 626
 627   for (s=line; hexdigitp (s); s++)
 628     ;
 629   p = xtrymalloc (s + 1 - line);
 630   if (p)
 631     {
 632       memcpy (p, line, s-line);
 633       p[s-line] = 0;
 634     }
 635   return p;
 636 }
 637
 638
 639 /* Callback for the gpgsm_agent_serialno function.  */
 640 static gpg_error_t
 641 scd_serialno_status_cb (void *opaque, const char *line)
 642 {
 643   char **r_serialno = opaque;
 644   const char *keyword = line;
 645   int keywordlen;
 646
 647   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
 648     ;
 649   while (spacep (line))
 650     line++;
 651
 652   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
 653     {
 654       xfree (*r_serialno);
 655       *r_serialno = store_serialno (line);
 656     }
 657
 658   return 0;
 659 }
 660
 661
 662 /* Call the agent to read the serial number of the current card.  */
 663 int
 664 gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno)
 665 {
 666   int rc;
 667   char *serialno = NULL;
 668   struct default_inq_parm_s inq_parm;
 669
 670   *r_serialno = NULL;
 671   rc = start_agent (ctrl);
 672   if (rc)
 673     return rc;
 674   inq_parm.ctrl = ctrl;
 675   inq_parm.ctx = agent_ctx;
 676
 677   rc = assuan_transact (agent_ctx, "SCD SERIALNO",
 678                         NULL, NULL,
 679                         default_inq_cb, &inq_parm,
 680                         scd_serialno_status_cb, &serialno);
 681   if (!rc && !serialno)
 682     rc = gpg_error (GPG_ERR_INTERNAL);
 683   if (rc)
 684     {
 685       xfree (serialno);
 686       return rc;
 687     }
 688   *r_serialno = serialno;
 689   return 0;
 690 }
 691
 692
 693 \f
 694 /* Callback for the gpgsm_agent_serialno function.  */
 695 static gpg_error_t
 696 scd_keypairinfo_status_cb (void *opaque, const char *line)
 697 {
 698   strlist_t *listaddr = opaque;
 699   const char *keyword = line;
 700   int keywordlen;
 701   strlist_t sl;
 702   char *p;
 703
 704   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
 705     ;
 706   while (spacep (line))
 707     line++;
 708
 709   if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
 710     {
 711       sl = append_to_strlist (listaddr, line);
 712       p = sl->d;
 713       /* Make sure that we only have two tokes so that future
 714          extensions of the format won't change the format expected by
 715          the caller.  */
 716       while (*p && !spacep (p))
 717         p++;
 718       if (*p)
 719         {
 720           while (spacep (p))
 721             p++;
 722           while (*p && !spacep (p))
 723             p++;
 724           *p = 0;
 725         }
 726     }
 727
 728   return 0;
 729 }
 730
 731
 732 /* Call the agent to read the keypairinfo lines of the current card.
 733    The list is returned as a string made up of the keygrip, a space
 734    and the keyid.  */
 735 int
 736 gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list)
 737 {
 738   int rc;
 739   strlist_t list = NULL;
 740   struct default_inq_parm_s inq_parm;
 741
 742   *r_list = NULL;
 743   rc = start_agent (ctrl);
 744   if (rc)
 745     return rc;
 746   inq_parm.ctrl = ctrl;
 747   inq_parm.ctx = agent_ctx;
 748
 749   rc = assuan_transact (agent_ctx, "SCD LEARN --force",
 750                         NULL, NULL,
 751                         default_inq_cb, &inq_parm,
 752                         scd_keypairinfo_status_cb, &list);
 753   if (!rc && !list)
 754     rc = gpg_error (GPG_ERR_NO_DATA);
 755   if (rc)
 756     {
 757       free_strlist (list);
 758       return rc;
 759     }
 760   *r_list = list;
 761   return 0;
 762 }
 763
 764
 765 \f
 766 static gpg_error_t
 767 istrusted_status_cb (void *opaque, const char *line)
 768 {
 769   struct rootca_flags_s *flags = opaque;
 770   const char *s;
 771
 772   if ((s = has_leading_keyword (line, "TRUSTLISTFLAG")))
 773     {
 774       line = s;
 775       if (has_leading_keyword (line, "relax"))
 776         flags->relax = 1;
 777       else if (has_leading_keyword (line, "cm"))
 778         flags->chain_model = 1;
 779     }
 780   return 0;
 781 }
 782
 783
 784
 785 /* Ask the agent whether the certificate is in the list of trusted
 786    keys.  The certificate is either specified by the CERT object or by
 787    the fingerprint HEXFPR.  ROOTCA_FLAGS is guaranteed to be cleared
 788    on error. */
 789 int
 790 gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
 791                        struct rootca_flags_s *rootca_flags)
 792 {
 793   int rc;
 794   char line[ASSUAN_LINELENGTH];
 795
 796   memset (rootca_flags, 0, sizeof *rootca_flags);
 797
 798   if (cert && hexfpr)
 799     return gpg_error (GPG_ERR_INV_ARG);
 800
 801   rc = start_agent (ctrl);
 802   if (rc)
 803     return rc;
 804
 805   if (hexfpr)
 806     {
 807       snprintf (line, DIM(line), "ISTRUSTED %s", hexfpr);
 808     }
 809   else
 810     {
 811       char *fpr;
 812
 813       fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
 814       if (!fpr)
 815         {
 816           log_error ("error getting the fingerprint\n");
 817           return gpg_error (GPG_ERR_GENERAL);
 818         }
 819
 820       snprintf (line, DIM(line), "ISTRUSTED %s", fpr);
 821       xfree (fpr);
 822     }
 823
 824   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
 825                         istrusted_status_cb, rootca_flags);
 826   if (!rc)
 827     rootca_flags->valid = 1;
 828   return rc;
 829 }
 830
 831 /* Ask the agent to mark CERT as a trusted Root-CA one */
 832 int
 833 gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert)
 834 {
 835   int rc;
 836   char *fpr, *dn, *dnfmt;
 837   char line[ASSUAN_LINELENGTH];
 838   struct default_inq_parm_s inq_parm;
 839
 840   rc = start_agent (ctrl);
 841   if (rc)
 842     return rc;
 843   inq_parm.ctrl = ctrl;
 844   inq_parm.ctx = agent_ctx;
 845
 846   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
 847   if (!fpr)
 848     {
 849       log_error ("error getting the fingerprint\n");
 850       return gpg_error (GPG_ERR_GENERAL);
 851     }
 852
 853   dn = ksba_cert_get_issuer (cert, 0);
 854   if (!dn)
 855     {
 856       xfree (fpr);
 857       return gpg_error (GPG_ERR_GENERAL);
 858     }
 859   dnfmt = gpgsm_format_name2 (dn, 0);
 860   xfree (dn);
 861   if (!dnfmt)
 862     return gpg_error_from_syserror ();
 863   snprintf (line, DIM(line), "MARKTRUSTED %s S %s", fpr, dnfmt);
 864   ksba_free (dnfmt);
 865   xfree (fpr);
 866
 867   rc = assuan_transact (agent_ctx, line, NULL, NULL,
 868                         default_inq_cb, &inq_parm, NULL, NULL);
 869   return rc;
 870 }
 871
 872
 873 \f
 874 /* Ask the agent whether the a corresponding secret key is available
 875    for the given keygrip */
 876 int
 877 gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip)
 878 {
 879   int rc;
 880   char line[ASSUAN_LINELENGTH];
 881
 882   rc = start_agent (ctrl);
 883   if (rc)
 884     return rc;
 885
 886   if (!hexkeygrip || strlen (hexkeygrip) != 40)
 887     return gpg_error (GPG_ERR_INV_VALUE);
 888
 889   snprintf (line, DIM(line), "HAVEKEY %s", hexkeygrip);
 890
 891   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 892   return rc;
 893 }
 894
 895 \f
 896 static gpg_error_t
 897 learn_status_cb (void *opaque, const char *line)
 898 {
 899   struct learn_parm_s *parm = opaque;
 900   const char *s;
 901
 902   /* Pass progress data to the caller.  */
 903   if ((s = has_leading_keyword (line, "PROGRESS")))
 904     {
 905       line = s;
 906       if (parm->ctrl)
 907         {
 908           if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, line))
 909             return gpg_error (GPG_ERR_ASS_CANCELED);
 910         }
 911     }
 912   return 0;
 913 }
 914
 915 static gpg_error_t
 916 learn_cb (void *opaque, const void *buffer, size_t length)
 917 {
 918   struct learn_parm_s *parm = opaque;
 919   size_t len;
 920   char *buf;
 921   ksba_cert_t cert;
 922   int rc;
 923
 924   if (parm->error)
 925     return 0;
 926
 927   if (buffer)
 928     {
 929       put_membuf (parm->data, buffer, length);
 930       return 0;
 931     }
 932   /* END encountered - process what we have */
 933   buf = get_membuf (parm->data, &len);
 934   if (!buf)
 935     {
 936       parm->error = gpg_error (GPG_ERR_ENOMEM);
 937       return 0;
 938     }
 939
 940   if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, "learncard C 0 0"))
 941     return gpg_error (GPG_ERR_ASS_CANCELED);
 942
 943   /* FIXME: this should go into import.c */
 944   rc = ksba_cert_new (&cert);
 945   if (rc)
 946     {
 947       parm->error = rc;
 948       return 0;
 949     }
 950   rc = ksba_cert_init_from_mem (cert, buf, len);
 951   if (rc)
 952     {
 953       log_error ("failed to parse a certificate: %s\n", gpg_strerror (rc));
 954       ksba_cert_release (cert);
 955       parm->error = rc;
 956       return 0;
 957     }
 958
 959   /* We do not store a certifciate with missing issuers as ephemeral
 960      because we can assume that the --learn-card command has been used
 961      on purpose.  */
 962   rc = gpgsm_basic_cert_check (parm->ctrl, cert);
 963   if (rc && gpg_err_code (rc) != GPG_ERR_MISSING_CERT
 964       && gpg_err_code (rc) != GPG_ERR_MISSING_ISSUER_CERT)
 965     log_error ("invalid certificate: %s\n", gpg_strerror (rc));
 966   else
 967     {
 968       int existed;
 969
 970       if (!keydb_store_cert (parm->ctrl, cert, 0, &existed))
 971         {
 972           if (opt.verbose > 1 && existed)
 973             log_info ("certificate already in DB\n");
 974           else if (opt.verbose && !existed)
 975             log_info ("certificate imported\n");
 976         }
 977     }
 978
 979   ksba_cert_release (cert);
 980   init_membuf (parm->data, 4096);
 981   return 0;
 982 }
 983
 984 /* Call the agent to learn about a smartcard */
 985 int
 986 gpgsm_agent_learn (ctrl_t ctrl)
 987 {
 988   int rc;
 989   struct learn_parm_s learn_parm;
 990   membuf_t data;
 991   size_t len;
 992
 993   rc = start_agent (ctrl);
 994   if (rc)
 995     return rc;
 996
 997   rc = warn_version_mismatch (ctrl, agent_ctx, SCDAEMON_NAME, 2);
 998   if (rc)
 999     return rc;
1000
1001   init_membuf (&data, 4096);
1002   learn_parm.error = 0;
1003   learn_parm.ctrl = ctrl;
1004   learn_parm.ctx = agent_ctx;
1005   learn_parm.data = &data;
1006   rc = assuan_transact (agent_ctx, "LEARN --send",
1007                         learn_cb, &learn_parm,
1008                         NULL, NULL,
1009                         learn_status_cb, &learn_parm);
1010   xfree (get_membuf (&data, &len));
1011   if (rc)
1012     return rc;
1013   return learn_parm.error;
1014 }
1015
1016 \f
1017 /* Ask the agent to change the passphrase of the key identified by
1018    HEXKEYGRIP. If DESC is not NULL, display instead of the default
1019    description message. */
1020 int
1021 gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc)
1022 {
1023   int rc;
1024   char line[ASSUAN_LINELENGTH];
1025   struct default_inq_parm_s inq_parm;
1026
1027   rc = start_agent (ctrl);
1028   if (rc)
1029     return rc;
1030   inq_parm.ctrl = ctrl;
1031   inq_parm.ctx = agent_ctx;
1032
1033   if (!hexkeygrip || strlen (hexkeygrip) != 40)
1034     return gpg_error (GPG_ERR_INV_VALUE);
1035
1036   if (desc)
1037     {
1038       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1039       rc = assuan_transact (agent_ctx, line,
1040                             NULL, NULL, NULL, NULL, NULL, NULL);
1041       if (rc)
1042         return rc;
1043     }
1044
1045   snprintf (line, DIM(line), "PASSWD %s", hexkeygrip);
1046
1047   rc = assuan_transact (agent_ctx, line, NULL, NULL,
1048                         default_inq_cb, &inq_parm, NULL, NULL);
1049   return rc;
1050 }
1051
1052
1053 \f
1054 /* Ask the agent to pop up a confirmation dialog with the text DESC
1055    and an okay and cancel button.  */
1056 gpg_error_t
1057 gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc)
1058 {
1059   int rc;
1060   char line[ASSUAN_LINELENGTH];
1061   struct default_inq_parm_s inq_parm;
1062
1063   rc = start_agent (ctrl);
1064   if (rc)
1065     return rc;
1066   inq_parm.ctrl = ctrl;
1067   inq_parm.ctx = agent_ctx;
1068
1069   snprintf (line, DIM(line), "GET_CONFIRMATION %s", desc);
1070
1071   rc = assuan_transact (agent_ctx, line, NULL, NULL,
1072                         default_inq_cb, &inq_parm, NULL, NULL);
1073   return rc;
1074 }
1075
1076
1077 \f
1078 /* Return 0 if the agent is alive.  This is useful to make sure that
1079    an agent has been started. */
1080 gpg_error_t
1081 gpgsm_agent_send_nop (ctrl_t ctrl)
1082 {
1083   int rc;
1084
1085   rc = start_agent (ctrl);
1086   if (!rc)
1087     rc = assuan_transact (agent_ctx, "NOP",
1088                           NULL, NULL, NULL, NULL, NULL, NULL);
1089   return rc;
1090 }
1091
1092
1093 \f
1094 static gpg_error_t
1095 keyinfo_status_cb (void *opaque, const char *line)
1096 {
1097   char **serialno = opaque;
1098   const char *s, *s2;
1099
1100   if ((s = has_leading_keyword (line, "KEYINFO")) && !*serialno)
1101     {
1102       s = strchr (s, ' ');
1103       if (s && s[1] == 'T' && s[2] == ' ' && s[3])
1104         {
1105           s += 3;
1106           s2 = strchr (s, ' ');
1107           if ( s2 > s )
1108             {
1109               *serialno = xtrymalloc ((s2 - s)+1);
1110               if (*serialno)
1111                 {
1112                   memcpy (*serialno, s, s2 - s);
1113                   (*serialno)[s2 - s] = 0;
1114                 }
1115             }
1116         }
1117     }
1118   return 0;
1119 }
1120
1121 /* Return the serial number for a secret key.  If the returned serial
1122    number is NULL, the key is not stored on a smartcard.  Caller needs
1123    to free R_SERIALNO.  */
1124 gpg_error_t
1125 gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip, char **r_serialno)
1126 {
1127   gpg_error_t err;
1128   char line[ASSUAN_LINELENGTH];
1129   char *serialno = NULL;
1130
1131   *r_serialno = NULL;
1132
1133   err = start_agent (ctrl);
1134   if (err)
1135     return err;
1136
1137   if (!hexkeygrip || strlen (hexkeygrip) != 40)
1138     return gpg_error (GPG_ERR_INV_VALUE);
1139
1140   snprintf (line, DIM(line), "KEYINFO %s", hexkeygrip);
1141
1142   err = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
1143                          keyinfo_status_cb, &serialno);
1144   if (!err && serialno)
1145     {
1146       /* Sanity check for bad characters.  */
1147       if (strpbrk (serialno, ":\n\r"))
1148         err = GPG_ERR_INV_VALUE;
1149     }
1150   if (err)
1151     xfree (serialno);
1152   else
1153     *r_serialno = serialno;
1154   return err;
1155 }
1156
1157
1158 \f
1159 /* Ask for the passphrase (this is used for pkcs#12 import/export.  On
1160    success the caller needs to free the string stored at R_PASSPHRASE.
1161    On error NULL will be stored at R_PASSPHRASE and an appropriate
1162    error code returned.  If REPEAT is true the agent tries to get a
1163    new passphrase (i.e. asks the user to confirm it).  */
1164 gpg_error_t
1165 gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg, int repeat,
1166                             char **r_passphrase)
1167 {
1168   gpg_error_t err;
1169   char line[ASSUAN_LINELENGTH];
1170   char *arg4 = NULL;
1171   membuf_t data;
1172   struct default_inq_parm_s inq_parm;
1173
1174   *r_passphrase = NULL;
1175
1176   err = start_agent (ctrl);
1177   if (err)
1178     return err;
1179   inq_parm.ctrl = ctrl;
1180   inq_parm.ctx = agent_ctx;
1181
1182   if (desc_msg && *desc_msg && !(arg4 = percent_plus_escape (desc_msg)))
1183     return gpg_error_from_syserror ();
1184
1185   snprintf (line, DIM(line), "GET_PASSPHRASE --data%s -- X X X %s",
1186             repeat? " --repeat=1 --check --qualitybar":"",
1187             arg4);
1188   xfree (arg4);
1189
1190   init_membuf_secure (&data, 64);
1191   err = assuan_transact (agent_ctx, line,
1192                          put_membuf_cb, &data,
1193                          default_inq_cb, &inq_parm, NULL, NULL);
1194
1195   if (err)
1196     xfree (get_membuf (&data, NULL));
1197   else
1198     {
1199       put_membuf (&data, "", 1);
1200       *r_passphrase = get_membuf (&data, NULL);
1201       if (!*r_passphrase)
1202         err = gpg_error_from_syserror ();
1203     }
1204   return err;
1205 }
1206
1207
1208 \f
1209 /* Retrieve a key encryption key from the agent.  With FOREXPORT true
1210    the key shall be use for export, with false for import.  On success
1211    the new key is stored at R_KEY and its length at R_KEKLEN.  */
1212 gpg_error_t
1213 gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
1214                          void **r_kek, size_t *r_keklen)
1215 {
1216   gpg_error_t err;
1217   membuf_t data;
1218   size_t len;
1219   unsigned char *buf;
1220   char line[ASSUAN_LINELENGTH];
1221   struct default_inq_parm_s inq_parm;
1222
1223   *r_kek = NULL;
1224   err = start_agent (ctrl);
1225   if (err)
1226     return err;
1227   inq_parm.ctrl = ctrl;
1228   inq_parm.ctx = agent_ctx;
1229
1230   snprintf (line, DIM(line), "KEYWRAP_KEY %s",
1231             forexport? "--export":"--import");
1232
1233   init_membuf_secure (&data, 64);
1234   err = assuan_transact (agent_ctx, line,
1235                          put_membuf_cb, &data,
1236                          default_inq_cb, &inq_parm, NULL, NULL);
1237   if (err)
1238     {
1239       xfree (get_membuf (&data, &len));
1240       return err;
1241     }
1242   buf = get_membuf (&data, &len);
1243   if (!buf)
1244     return gpg_error_from_syserror ();
1245   *r_kek = buf;
1246   *r_keklen = len;
1247   return 0;
1248 }
1249
1250
1251
1252 \f
1253 /* Handle the inquiry for an IMPORT_KEY command.  */
1254 static gpg_error_t
1255 inq_import_key_parms (void *opaque, const char *line)
1256 {
1257   struct import_key_parm_s *parm = opaque;
1258   gpg_error_t err;
1259
1260   if (has_leading_keyword (line, "KEYDATA"))
1261     {
1262       assuan_begin_confidential (parm->ctx);
1263       err = assuan_send_data (parm->ctx, parm->key, parm->keylen);
1264       assuan_end_confidential (parm->ctx);
1265     }
1266   else
1267     {
1268       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
1269       err = default_inq_cb (&inq_parm, line);
1270     }
1271
1272   return err;
1273 }
1274
1275
1276 /* Call the agent to import a key into the agent.  */
1277 gpg_error_t
1278 gpgsm_agent_import_key (ctrl_t ctrl, const void *key, size_t keylen)
1279 {
1280   gpg_error_t err;
1281   struct import_key_parm_s parm;
1282
1283   err = start_agent (ctrl);
1284   if (err)
1285     return err;
1286
1287   parm.ctrl   = ctrl;
1288   parm.ctx    = agent_ctx;
1289   parm.key    = key;
1290   parm.keylen = keylen;
1291
1292   err = assuan_transact (agent_ctx, "IMPORT_KEY",
1293                          NULL, NULL, inq_import_key_parms, &parm, NULL, NULL);
1294   return err;
1295 }
1296
1297
1298 \f
1299 /* Receive a secret key from the agent.  KEYGRIP is the hexified
1300    keygrip, DESC a prompt to be displayed with the agent's passphrase
1301    question (needs to be plus+percent escaped).  On success the key is
1302    stored as a canonical S-expression at R_RESULT and R_RESULTLEN. */
1303 gpg_error_t
1304 gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip, const char *desc,
1305                         unsigned char **r_result, size_t *r_resultlen)
1306 {
1307   gpg_error_t err;
1308   membuf_t data;
1309   size_t len;
1310   unsigned char *buf;
1311   char line[ASSUAN_LINELENGTH];
1312   struct default_inq_parm_s inq_parm;
1313
1314   *r_result = NULL;
1315
1316   err = start_agent (ctrl);
1317   if (err)
1318     return err;
1319   inq_parm.ctrl = ctrl;
1320   inq_parm.ctx = agent_ctx;
1321
1322   if (desc)
1323     {
1324       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1325       err = assuan_transact (agent_ctx, line,
1326                              NULL, NULL, NULL, NULL, NULL, NULL);
1327       if (err)
1328         return err;
1329     }
1330
1331   snprintf (line, DIM(line), "EXPORT_KEY %s", keygrip);
1332
1333   init_membuf_secure (&data, 1024);
1334   err = assuan_transact (agent_ctx, line,
1335                          put_membuf_cb, &data,
1336                          default_inq_cb, &inq_parm, NULL, NULL);
1337   if (err)
1338     {
1339       xfree (get_membuf (&data, &len));
1340       return err;
1341     }
1342   buf = get_membuf (&data, &len);
1343   if (!buf)
1344     return gpg_error_from_syserror ();
1345   *r_result = buf;
1346   *r_resultlen = len;
1347   return 0;
1348 }