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 <http://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))
 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 = { ctrl, agent_ctx };
 232
 233   *r_buf = NULL;
 234   rc = start_agent (ctrl);
 235   if (rc)
 236     return rc;
 237
 238   if (digestlen*2 + 50 > DIM(line))
 239     return gpg_error (GPG_ERR_GENERAL);
 240
 241   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 242   if (rc)
 243     return rc;
 244
 245   snprintf (line, DIM(line)-1, "SIGKEY %s", keygrip);
 246   line[DIM(line)-1] = 0;
 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)-1, "SETKEYDESC %s", desc);
 254       line[DIM(line)-1] = 0;
 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 = { ctrl, agent_ctx };
 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
 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)-1, "SCD PKSIGN %s %s", hashopt, keyid);
 337   line[DIM(line)-1] = 0;
 338   rc = assuan_transact (agent_ctx, line,
 339                         put_membuf_cb, &data, default_inq_cb, &inq_parm,
 340                         NULL, NULL);
 341   if (rc)
 342     {
 343       xfree (get_membuf (&data, &len));
 344       return rc;
 345     }
 346   sigbuf = get_membuf (&data, &sigbuflen);
 347
 348   /* Create an S-expression from it which is formatted like this:
 349      "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" Fixme: If a card ever
 350      creates non-RSA keys we need to change things. */
 351   *r_buflen = 21 + 11 + sigbuflen + 4;
 352   p = xtrymalloc (*r_buflen);
 353   *r_buf = (unsigned char*)p;
 354   if (!p)
 355     {
 356       xfree (sigbuf);
 357       return 0;
 358     }
 359   p = stpcpy (p, "(7:sig-val(3:rsa(1:s" );
 360   sprintf (p, "%u:", (unsigned int)sigbuflen);
 361   p += strlen (p);
 362   memcpy (p, sigbuf, sigbuflen);
 363   p += sigbuflen;
 364   strcpy (p, ")))");
 365   xfree (sigbuf);
 366
 367   assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
 368   return  0;
 369 }
 370
 371
 372
 373 \f
 374 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
 375    assuan_transact takes care of flushing and writing the end */
 376 static gpg_error_t
 377 inq_ciphertext_cb (void *opaque, const char *line)
 378 {
 379   struct cipher_parm_s *parm = opaque;
 380   int rc;
 381
 382   if (has_leading_keyword (line, "CIPHERTEXT"))
 383     {
 384       assuan_begin_confidential (parm->ctx);
 385       rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
 386       assuan_end_confidential (parm->ctx);
 387     }
 388   else
 389     {
 390       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
 391       rc = default_inq_cb (&inq_parm, line);
 392     }
 393
 394   return rc;
 395 }
 396
 397
 398 /* Call the agent to do a decrypt operation using the key identified by
 399    the hex string KEYGRIP. */
 400 int
 401 gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
 402                        ksba_const_sexp_t ciphertext,
 403                        char **r_buf, size_t *r_buflen )
 404 {
 405   int rc;
 406   char line[ASSUAN_LINELENGTH];
 407    membuf_t data;
 408   struct cipher_parm_s cipher_parm;
 409   size_t n, len;
 410   char *p, *buf, *endp;
 411   size_t ciphertextlen;
 412
 413   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
 414     return gpg_error (GPG_ERR_INV_VALUE);
 415   *r_buf = NULL;
 416
 417   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
 418   if (!ciphertextlen)
 419     return gpg_error (GPG_ERR_INV_VALUE);
 420
 421   rc = start_agent (ctrl);
 422   if (rc)
 423     return rc;
 424
 425   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 426   if (rc)
 427     return rc;
 428
 429   assert ( DIM(line) >= 50 );
 430   snprintf (line, DIM(line)-1, "SETKEY %s", keygrip);
 431   line[DIM(line)-1] = 0;
 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)-1, "SETKEYDESC %s", desc);
 439       line[DIM(line)-1] = 0;
 440       rc = assuan_transact (agent_ctx, line,
 441                             NULL, NULL, NULL, NULL, NULL, NULL);
 442       if (rc)
 443         return rc;
 444     }
 445
 446   init_membuf (&data, 1024);
 447   cipher_parm.ctrl = ctrl;
 448   cipher_parm.ctx = agent_ctx;
 449   cipher_parm.ciphertext = ciphertext;
 450   cipher_parm.ciphertextlen = ciphertextlen;
 451   rc = assuan_transact (agent_ctx, "PKDECRYPT",
 452                         put_membuf_cb, &data,
 453                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
 454   if (rc)
 455     {
 456       xfree (get_membuf (&data, &len));
 457       return rc;
 458     }
 459
 460   put_membuf (&data, "", 1); /* Make sure it is 0 terminated. */
 461   buf = get_membuf (&data, &len);
 462   if (!buf)
 463     return gpg_error (GPG_ERR_ENOMEM);
 464   assert (len); /* (we forced Nul termination.)  */
 465
 466   if (*buf == '(')
 467     {
 468       if (len < 13 || memcmp (buf, "(5:value", 8) ) /* "(5:valueN:D)\0" */
 469         return gpg_error (GPG_ERR_INV_SEXP);
 470       len -= 11;   /* Count only the data of the second part. */
 471       p = buf + 8; /* Skip leading parenthesis and the value tag. */
 472     }
 473   else
 474     {
 475       /* For compatibility with older gpg-agents handle the old style
 476          incomplete S-exps. */
 477       len--;      /* Do not count the Nul. */
 478       p = buf;
 479     }
 480
 481   n = strtoul (p, &endp, 10);
 482   if (!n || *endp != ':')
 483     return gpg_error (GPG_ERR_INV_SEXP);
 484   endp++;
 485   if (endp-p+n > len)
 486     return gpg_error (GPG_ERR_INV_SEXP); /* Oops: Inconsistent S-Exp. */
 487
 488   memmove (buf, endp, n);
 489
 490   *r_buflen = n;
 491   *r_buf = buf;
 492   return 0;
 493 }
 494
 495
 496
 497
 498 \f
 499 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
 500    assuan_transact takes care of flushing and writing the end */
 501 static gpg_error_t
 502 inq_genkey_parms (void *opaque, const char *line)
 503 {
 504   struct genkey_parm_s *parm = opaque;
 505   int rc;
 506
 507   if (has_leading_keyword (line, "KEYPARAM"))
 508     {
 509       rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
 510     }
 511   else
 512     {
 513       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
 514       rc = default_inq_cb (&inq_parm, line);
 515     }
 516
 517   return rc;
 518 }
 519
 520
 521 \f
 522 /* Call the agent to generate a newkey */
 523 int
 524 gpgsm_agent_genkey (ctrl_t ctrl,
 525                     ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey)
 526 {
 527   int rc;
 528   struct genkey_parm_s gk_parm;
 529   membuf_t data;
 530   size_t len;
 531   unsigned char *buf;
 532
 533   *r_pubkey = NULL;
 534   rc = start_agent (ctrl);
 535   if (rc)
 536     return rc;
 537
 538   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
 539   if (rc)
 540     return rc;
 541
 542   init_membuf (&data, 1024);
 543   gk_parm.ctrl = ctrl;
 544   gk_parm.ctx = agent_ctx;
 545   gk_parm.sexp = keyparms;
 546   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
 547   if (!gk_parm.sexplen)
 548     return gpg_error (GPG_ERR_INV_VALUE);
 549   rc = assuan_transact (agent_ctx, "GENKEY",
 550                         put_membuf_cb, &data,
 551                         inq_genkey_parms, &gk_parm, NULL, NULL);
 552   if (rc)
 553     {
 554       xfree (get_membuf (&data, &len));
 555       return rc;
 556     }
 557   buf = get_membuf (&data, &len);
 558   if (!buf)
 559     return gpg_error (GPG_ERR_ENOMEM);
 560   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
 561     {
 562       xfree (buf);
 563       return gpg_error (GPG_ERR_INV_SEXP);
 564     }
 565   *r_pubkey = buf;
 566   return 0;
 567 }
 568
 569 \f
 570 /* Call the agent to read the public key part for a given keygrip.  If
 571    FROMCARD is true, the key is directly read from the current
 572    smartcard. In this case HEXKEYGRIP should be the keyID
 573    (e.g. OPENPGP.3). */
 574 int
 575 gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
 576                      ksba_sexp_t *r_pubkey)
 577 {
 578   int rc;
 579   membuf_t data;
 580   size_t len;
 581   unsigned char *buf;
 582   char line[ASSUAN_LINELENGTH];
 583   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
 584
 585   *r_pubkey = NULL;
 586   rc = start_agent (ctrl);
 587   if (rc)
 588     return rc;
 589
 590   rc = assuan_transact (agent_ctx, "RESET",NULL, NULL, NULL, NULL, NULL, NULL);
 591   if (rc)
 592     return rc;
 593
 594   snprintf (line, DIM(line)-1, "%sREADKEY %s",
 595             fromcard? "SCD ":"", hexkeygrip);
 596   line[DIM(line)-1] = 0;
 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 = { ctrl, agent_ctx };
 672
 673   *r_serialno = NULL;
 674   rc = start_agent (ctrl);
 675   if (rc)
 676     return rc;
 677
 678   rc = assuan_transact (agent_ctx, "SCD SERIALNO",
 679                         NULL, NULL,
 680                         default_inq_cb, &inq_parm,
 681                         scd_serialno_status_cb, &serialno);
 682   if (!rc && !serialno)
 683     rc = gpg_error (GPG_ERR_INTERNAL);
 684   if (rc)
 685     {
 686       xfree (serialno);
 687       return rc;
 688     }
 689   *r_serialno = serialno;
 690   return 0;
 691 }
 692
 693
 694 \f
 695 /* Callback for the gpgsm_agent_serialno function.  */
 696 static gpg_error_t
 697 scd_keypairinfo_status_cb (void *opaque, const char *line)
 698 {
 699   strlist_t *listaddr = opaque;
 700   const char *keyword = line;
 701   int keywordlen;
 702   strlist_t sl;
 703   char *p;
 704
 705   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
 706     ;
 707   while (spacep (line))
 708     line++;
 709
 710   if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
 711     {
 712       sl = append_to_strlist (listaddr, line);
 713       p = sl->d;
 714       /* Make sure that we only have two tokes so that future
 715          extensions of the format won't change the format expected by
 716          the caller.  */
 717       while (*p && !spacep (p))
 718         p++;
 719       if (*p)
 720         {
 721           while (spacep (p))
 722             p++;
 723           while (*p && !spacep (p))
 724             p++;
 725           *p = 0;
 726         }
 727     }
 728
 729   return 0;
 730 }
 731
 732
 733 /* Call the agent to read the keypairinfo lines of the current card.
 734    The list is returned as a string made up of the keygrip, a space
 735    and the keyid.  */
 736 int
 737 gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list)
 738 {
 739   int rc;
 740   strlist_t list = NULL;
 741   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
 742
 743   *r_list = NULL;
 744   rc = start_agent (ctrl);
 745   if (rc)
 746     return rc;
 747
 748   rc = assuan_transact (agent_ctx, "SCD LEARN --force",
 749                         NULL, NULL,
 750                         default_inq_cb, &inq_parm,
 751                         scd_keypairinfo_status_cb, &list);
 752   if (!rc && !list)
 753     rc = gpg_error (GPG_ERR_NO_DATA);
 754   if (rc)
 755     {
 756       free_strlist (list);
 757       return rc;
 758     }
 759   *r_list = list;
 760   return 0;
 761 }
 762
 763
 764 \f
 765 static gpg_error_t
 766 istrusted_status_cb (void *opaque, const char *line)
 767 {
 768   struct rootca_flags_s *flags = opaque;
 769   const char *s;
 770
 771   if ((s = has_leading_keyword (line, "TRUSTLISTFLAG")))
 772     {
 773       line = s;
 774       if (has_leading_keyword (line, "relax"))
 775         flags->relax = 1;
 776       else if (has_leading_keyword (line, "cm"))
 777         flags->chain_model = 1;
 778     }
 779   return 0;
 780 }
 781
 782
 783
 784 /* Ask the agent whether the certificate is in the list of trusted
 785    keys.  The certificate is either specified by the CERT object or by
 786    the fingerprint HEXFPR.  ROOTCA_FLAGS is guaranteed to be cleared
 787    on error. */
 788 int
 789 gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
 790                        struct rootca_flags_s *rootca_flags)
 791 {
 792   int rc;
 793   char line[ASSUAN_LINELENGTH];
 794
 795   memset (rootca_flags, 0, sizeof *rootca_flags);
 796
 797   if (cert && hexfpr)
 798     return gpg_error (GPG_ERR_INV_ARG);
 799
 800   rc = start_agent (ctrl);
 801   if (rc)
 802     return rc;
 803
 804   if (hexfpr)
 805     {
 806       snprintf (line, DIM(line)-1, "ISTRUSTED %s", hexfpr);
 807       line[DIM(line)-1] = 0;
 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)-1, "ISTRUSTED %s", fpr);
 821       line[DIM(line)-1] = 0;
 822       xfree (fpr);
 823     }
 824
 825   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
 826                         istrusted_status_cb, rootca_flags);
 827   if (!rc)
 828     rootca_flags->valid = 1;
 829   return rc;
 830 }
 831
 832 /* Ask the agent to mark CERT as a trusted Root-CA one */
 833 int
 834 gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert)
 835 {
 836   int rc;
 837   char *fpr, *dn, *dnfmt;
 838   char line[ASSUAN_LINELENGTH];
 839   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
 840
 841   rc = start_agent (ctrl);
 842   if (rc)
 843     return rc;
 844
 845   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
 846   if (!fpr)
 847     {
 848       log_error ("error getting the fingerprint\n");
 849       return gpg_error (GPG_ERR_GENERAL);
 850     }
 851
 852   dn = ksba_cert_get_issuer (cert, 0);
 853   if (!dn)
 854     {
 855       xfree (fpr);
 856       return gpg_error (GPG_ERR_GENERAL);
 857     }
 858   dnfmt = gpgsm_format_name2 (dn, 0);
 859   xfree (dn);
 860   if (!dnfmt)
 861     return gpg_error_from_syserror ();
 862   snprintf (line, DIM(line)-1, "MARKTRUSTED %s S %s", fpr, dnfmt);
 863   line[DIM(line)-1] = 0;
 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)-1, "HAVEKEY %s", hexkeygrip);
 890   line[DIM(line)-1] = 0;
 891
 892   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
 893   return rc;
 894 }
 895
 896 \f
 897 static gpg_error_t
 898 learn_status_cb (void *opaque, const char *line)
 899 {
 900   struct learn_parm_s *parm = opaque;
 901   const char *s;
 902
 903   /* Pass progress data to the caller.  */
 904   if ((s = has_leading_keyword (line, "PROGRESS")))
 905     {
 906       line = s;
 907       if (parm->ctrl)
 908         {
 909           if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, line))
 910             return gpg_error (GPG_ERR_ASS_CANCELED);
 911         }
 912     }
 913   return 0;
 914 }
 915
 916 static gpg_error_t
 917 learn_cb (void *opaque, const void *buffer, size_t length)
 918 {
 919   struct learn_parm_s *parm = opaque;
 920   size_t len;
 921   char *buf;
 922   ksba_cert_t cert;
 923   int rc;
 924
 925   if (parm->error)
 926     return 0;
 927
 928   if (buffer)
 929     {
 930       put_membuf (parm->data, buffer, length);
 931       return 0;
 932     }
 933   /* END encountered - process what we have */
 934   buf = get_membuf (parm->data, &len);
 935   if (!buf)
 936     {
 937       parm->error = gpg_error (GPG_ERR_ENOMEM);
 938       return 0;
 939     }
 940
 941   if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, "learncard C 0 0"))
 942     return gpg_error (GPG_ERR_ASS_CANCELED);
 943
 944   /* FIXME: this should go into import.c */
 945   rc = ksba_cert_new (&cert);
 946   if (rc)
 947     {
 948       parm->error = rc;
 949       return 0;
 950     }
 951   rc = ksba_cert_init_from_mem (cert, buf, len);
 952   if (rc)
 953     {
 954       log_error ("failed to parse a certificate: %s\n", gpg_strerror (rc));
 955       ksba_cert_release (cert);
 956       parm->error = rc;
 957       return 0;
 958     }
 959
 960   /* We do not store a certifciate with missing issuers as ephemeral
 961      because we can assume that the --learn-card command has been used
 962      on purpose.  */
 963   rc = gpgsm_basic_cert_check (parm->ctrl, cert);
 964   if (rc && gpg_err_code (rc) != GPG_ERR_MISSING_CERT
 965       && gpg_err_code (rc) != GPG_ERR_MISSING_ISSUER_CERT)
 966     log_error ("invalid certificate: %s\n", gpg_strerror (rc));
 967   else
 968     {
 969       int existed;
 970
 971       if (!keydb_store_cert (cert, 0, &existed))
 972         {
 973           if (opt.verbose > 1 && existed)
 974             log_info ("certificate already in DB\n");
 975           else if (opt.verbose && !existed)
 976             log_info ("certificate imported\n");
 977         }
 978     }
 979
 980   ksba_cert_release (cert);
 981   init_membuf (parm->data, 4096);
 982   return 0;
 983 }
 984
 985 /* Call the agent to learn about a smartcard */
 986 int
 987 gpgsm_agent_learn (ctrl_t ctrl)
 988 {
 989   int rc;
 990   struct learn_parm_s learn_parm;
 991   membuf_t data;
 992   size_t len;
 993
 994   rc = start_agent (ctrl);
 995   if (rc)
 996     return rc;
 997
 998   rc = warn_version_mismatch (ctrl, agent_ctx, SCDAEMON_NAME, 2);
 999   if (rc)
1000     return rc;
1001
1002   init_membuf (&data, 4096);
1003   learn_parm.error = 0;
1004   learn_parm.ctrl = ctrl;
1005   learn_parm.ctx = agent_ctx;
1006   learn_parm.data = &data;
1007   rc = assuan_transact (agent_ctx, "LEARN --send",
1008                         learn_cb, &learn_parm,
1009                         NULL, NULL,
1010                         learn_status_cb, &learn_parm);
1011   xfree (get_membuf (&data, &len));
1012   if (rc)
1013     return rc;
1014   return learn_parm.error;
1015 }
1016
1017 \f
1018 /* Ask the agent to change the passphrase of the key identified by
1019    HEXKEYGRIP. If DESC is not NULL, display instead of the default
1020    description message. */
1021 int
1022 gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc)
1023 {
1024   int rc;
1025   char line[ASSUAN_LINELENGTH];
1026   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
1027
1028   rc = start_agent (ctrl);
1029   if (rc)
1030     return rc;
1031
1032   if (!hexkeygrip || strlen (hexkeygrip) != 40)
1033     return gpg_error (GPG_ERR_INV_VALUE);
1034
1035   if (desc)
1036     {
1037       snprintf (line, DIM(line)-1, "SETKEYDESC %s", desc);
1038       line[DIM(line)-1] = 0;
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)-1, "PASSWD %s", hexkeygrip);
1046   line[DIM(line)-1] = 0;
1047
1048   rc = assuan_transact (agent_ctx, line, NULL, NULL,
1049                         default_inq_cb, &inq_parm, NULL, NULL);
1050   return rc;
1051 }
1052
1053
1054 \f
1055 /* Ask the agent to pop up a confirmation dialog with the text DESC
1056    and an okay and cancel button.  */
1057 gpg_error_t
1058 gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc)
1059 {
1060   int rc;
1061   char line[ASSUAN_LINELENGTH];
1062   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
1063
1064   rc = start_agent (ctrl);
1065   if (rc)
1066     return rc;
1067
1068   snprintf (line, DIM(line)-1, "GET_CONFIRMATION %s", desc);
1069   line[DIM(line)-1] = 0;
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)-1, "KEYINFO %s", hexkeygrip);
1141   line[DIM(line)-1] = 0;
1142
1143   err = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
1144                          keyinfo_status_cb, &serialno);
1145   if (!err && serialno)
1146     {
1147       /* Sanity check for bad characters.  */
1148       if (strpbrk (serialno, ":\n\r"))
1149         err = GPG_ERR_INV_VALUE;
1150     }
1151   if (err)
1152     xfree (serialno);
1153   else
1154     *r_serialno = serialno;
1155   return err;
1156 }
1157
1158
1159 \f
1160 /* Ask for the passphrase (this is used for pkcs#12 import/export.  On
1161    success the caller needs to free the string stored at R_PASSPHRASE.
1162    On error NULL will be stored at R_PASSPHRASE and an appropriate
1163    error code returned.  If REPEAT is true the agent tries to get a
1164    new passphrase (i.e. asks the user to confirm it).  */
1165 gpg_error_t
1166 gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg, int repeat,
1167                             char **r_passphrase)
1168 {
1169   gpg_error_t err;
1170   char line[ASSUAN_LINELENGTH];
1171   char *arg4 = NULL;
1172   membuf_t data;
1173   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
1174
1175   *r_passphrase = NULL;
1176
1177   err = start_agent (ctrl);
1178   if (err)
1179     return err;
1180
1181   if (desc_msg && *desc_msg && !(arg4 = percent_plus_escape (desc_msg)))
1182     return gpg_error_from_syserror ();
1183
1184   snprintf (line, DIM(line)-1, "GET_PASSPHRASE --data%s -- X X X %s",
1185             repeat? " --repeat=1 --check --qualitybar":"",
1186             arg4);
1187   xfree (arg4);
1188
1189   init_membuf_secure (&data, 64);
1190   err = assuan_transact (agent_ctx, line,
1191                          put_membuf_cb, &data,
1192                          default_inq_cb, &inq_parm, NULL, NULL);
1193
1194   if (err)
1195     xfree (get_membuf (&data, NULL));
1196   else
1197     {
1198       put_membuf (&data, "", 1);
1199       *r_passphrase = get_membuf (&data, NULL);
1200       if (!*r_passphrase)
1201         err = gpg_error_from_syserror ();
1202     }
1203   return err;
1204 }
1205
1206
1207 \f
1208 /* Retrieve a key encryption key from the agent.  With FOREXPORT true
1209    the key shall be use for export, with false for import.  On success
1210    the new key is stored at R_KEY and its length at R_KEKLEN.  */
1211 gpg_error_t
1212 gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
1213                          void **r_kek, size_t *r_keklen)
1214 {
1215   gpg_error_t err;
1216   membuf_t data;
1217   size_t len;
1218   unsigned char *buf;
1219   char line[ASSUAN_LINELENGTH];
1220   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
1221
1222   *r_kek = NULL;
1223   err = start_agent (ctrl);
1224   if (err)
1225     return err;
1226
1227   snprintf (line, DIM(line)-1, "KEYWRAP_KEY %s",
1228             forexport? "--export":"--import");
1229
1230   init_membuf_secure (&data, 64);
1231   err = assuan_transact (agent_ctx, line,
1232                          put_membuf_cb, &data,
1233                          default_inq_cb, &inq_parm, NULL, NULL);
1234   if (err)
1235     {
1236       xfree (get_membuf (&data, &len));
1237       return err;
1238     }
1239   buf = get_membuf (&data, &len);
1240   if (!buf)
1241     return gpg_error_from_syserror ();
1242   *r_kek = buf;
1243   *r_keklen = len;
1244   return 0;
1245 }
1246
1247
1248
1249 \f
1250 /* Handle the inquiry for an IMPORT_KEY command.  */
1251 static gpg_error_t
1252 inq_import_key_parms (void *opaque, const char *line)
1253 {
1254   struct import_key_parm_s *parm = opaque;
1255   gpg_error_t err;
1256
1257   if (has_leading_keyword (line, "KEYDATA"))
1258     {
1259       assuan_begin_confidential (parm->ctx);
1260       err = assuan_send_data (parm->ctx, parm->key, parm->keylen);
1261       assuan_end_confidential (parm->ctx);
1262     }
1263   else
1264     {
1265       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
1266       err = default_inq_cb (&inq_parm, line);
1267     }
1268
1269   return err;
1270 }
1271
1272
1273 /* Call the agent to import a key into the agent.  */
1274 gpg_error_t
1275 gpgsm_agent_import_key (ctrl_t ctrl, const void *key, size_t keylen)
1276 {
1277   gpg_error_t err;
1278   struct import_key_parm_s parm;
1279
1280   err = start_agent (ctrl);
1281   if (err)
1282     return err;
1283
1284   parm.ctrl   = ctrl;
1285   parm.ctx    = agent_ctx;
1286   parm.key    = key;
1287   parm.keylen = keylen;
1288
1289   err = assuan_transact (agent_ctx, "IMPORT_KEY",
1290                          NULL, NULL, inq_import_key_parms, &parm, NULL, NULL);
1291   return err;
1292 }
1293
1294
1295 \f
1296 /* Receive a secret key from the agent.  KEYGRIP is the hexified
1297    keygrip, DESC a prompt to be displayed with the agent's passphrase
1298    question (needs to be plus+percent escaped).  On success the key is
1299    stored as a canonical S-expression at R_RESULT and R_RESULTLEN. */
1300 gpg_error_t
1301 gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip, const char *desc,
1302                         unsigned char **r_result, size_t *r_resultlen)
1303 {
1304   gpg_error_t err;
1305   membuf_t data;
1306   size_t len;
1307   unsigned char *buf;
1308   char line[ASSUAN_LINELENGTH];
1309   struct default_inq_parm_s inq_parm = { ctrl, agent_ctx };
1310
1311   *r_result = NULL;
1312
1313   err = start_agent (ctrl);
1314   if (err)
1315     return err;
1316
1317   if (desc)
1318     {
1319       snprintf (line, DIM(line)-1, "SETKEYDESC %s", desc);
1320       err = assuan_transact (agent_ctx, line,
1321                              NULL, NULL, NULL, NULL, NULL, NULL);
1322       if (err)
1323         return err;
1324     }
1325
1326   snprintf (line, DIM(line)-1, "EXPORT_KEY %s", keygrip);
1327
1328   init_membuf_secure (&data, 1024);
1329   err = assuan_transact (agent_ctx, line,
1330                          put_membuf_cb, &data,
1331                          default_inq_cb, &inq_parm, NULL, NULL);
1332   if (err)
1333     {
1334       xfree (get_membuf (&data, &len));
1335       return err;
1336     }
1337   buf = get_membuf (&data, &len);
1338   if (!buf)
1339     return gpg_error_from_syserror ();
1340   *r_result = buf;
1341   *r_resultlen = len;
1342   return 0;
1343 }