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