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