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