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