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.
5 * This file is part of GnuPG.
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.
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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <https://www.gnu.org/licenses/>.
38 #include "keydb.h" /* fixme: Move this to import.c */
40 #include "shareddefs.h"
41 #include "passphrase.h"
44 static assuan_context_t agent_ctx = NULL;
51 const unsigned char *ciphertext;
59 const unsigned char *sexp;
71 struct import_key_parm_s
79 struct default_inq_parm_s
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. */
89 warn_version_mismatch (ctrl_t ctrl, assuan_context_t ctx,
90 const char *servername, int mode)
94 const char *myversion = strusage (13);
96 err = get_assuan_server_version (ctx, mode, &serverversion);
98 log_error (_("error getting version from '%s': %s\n"),
99 servername, gpg_strerror (err));
100 else if (compare_version_strings (serverversion, myversion) < 0)
104 warn = xtryasprintf (_("server '%s' is older than us (%s < %s)"),
105 servername, serverversion, myversion);
107 err = gpg_error_from_syserror ();
110 log_info (_("WARNING: %s\n"), warn);
111 gpgsm_status2 (ctrl, STATUS_WARNING, "server_version_mismatch 0",
116 xfree (serverversion);
121 /* Try to connect to the agent via socket or fork it off and work by
122 pipes. Handle the server's initial greeting */
124 start_agent (ctrl_t ctrl)
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. */
134 rc = start_new_gpg_agent (&agent_ctx,
135 GPG_ERR_SOURCE_DEFAULT,
137 opt.lc_ctype, opt.lc_messages,
139 opt.autostart, opt.verbose, DBG_IPC,
140 gpgsm_status2, ctrl);
142 if (!opt.autostart && gpg_err_code (rc) == GPG_ERR_NO_AGENT)
149 log_info (_("no gpg-agent running in this session\n"));
152 else if (!rc && !(rc = warn_version_mismatch (ctrl, agent_ctx,
155 /* Tell the agent that we support Pinentry notifications. No
156 error checking so that it will work also with older
158 assuan_transact (agent_ctx, "OPTION allow-pinentry-notify",
159 NULL, NULL, NULL, NULL, NULL, NULL);
161 /* Pass on the pinentry mode. */
162 if (opt.pinentry_mode)
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);
170 log_error ("setting pinentry mode '%s' failed: %s\n",
171 str_pinentry_mode (opt.pinentry_mode),
177 if (!ctrl->agent_seen)
179 ctrl->agent_seen = 1;
180 audit_log_ok (ctrl->audit, AUDIT_AGENT_READY, rc);
186 /* This is the default inquiry callback. It mainly handles the
187 Pinentry notifications. */
189 default_inq_cb (void *opaque, const char *line)
192 struct default_inq_parm_s *parm = opaque;
193 ctrl_t ctrl = parm->ctrl;
195 if (has_leading_keyword (line, "PINENTRY_LAUNCHED"))
197 err = gpgsm_proxy_pinentry_notify (ctrl, line);
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. */
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 ())
208 const char *s = get_static_passphrase ();
209 err = assuan_send_data (parm->ctx, s, strlen (s));
212 log_error ("ignoring gpg-agent inquiry '%s'\n", line);
220 /* Call the agent to do a sign operation using the key identified by
221 the hex string KEYGRIP. */
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 )
228 char *p, line[ASSUAN_LINELENGTH];
231 struct default_inq_parm_s inq_parm;
234 rc = start_agent (ctrl);
237 inq_parm.ctrl = ctrl;
238 inq_parm.ctx = agent_ctx;
240 if (digestlen*2 + 50 > DIM(line))
241 return gpg_error (GPG_ERR_GENERAL);
243 rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
247 snprintf (line, DIM(line), "SIGKEY %s", keygrip);
248 rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
254 snprintf (line, DIM(line), "SETKEYDESC %s", desc);
255 rc = assuan_transact (agent_ctx, line,
256 NULL, NULL, NULL, NULL, NULL, NULL);
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);
269 init_membuf (&data, 1024);
270 rc = assuan_transact (agent_ctx, "PKSIGN",
271 put_membuf_cb, &data, default_inq_cb, &inq_parm,
275 xfree (get_membuf (&data, &len));
278 *r_buf = get_membuf (&data, r_buflen);
280 if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
282 xfree (*r_buf); *r_buf = NULL;
283 return gpg_error (GPG_ERR_INV_VALUE);
286 return *r_buf? 0 : out_of_core ();
290 /* Call the scdaemon to do a sign operation using the key identified by
291 the hex string KEYID. */
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 )
298 char *p, line[ASSUAN_LINELENGTH];
302 unsigned char *sigbuf;
304 struct default_inq_parm_s inq_parm;
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;
317 return gpg_error (GPG_ERR_DIGEST_ALGO);
320 rc = start_agent (ctrl);
323 inq_parm.ctrl = ctrl;
324 inq_parm.ctx = agent_ctx;
326 if (digestlen*2 + 50 > DIM(line))
327 return gpg_error (GPG_ERR_GENERAL);
329 p = stpcpy (line, "SCD SETDATA " );
330 for (i=0; i < digestlen ; i++, p += 2 )
331 sprintf (p, "%02X", digest[i]);
332 rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
336 init_membuf (&data, 1024);
338 snprintf (line, DIM(line), "SCD PKSIGN %s %s", hashopt, keyid);
339 rc = assuan_transact (agent_ctx, line,
340 put_membuf_cb, &data, default_inq_cb, &inq_parm,
344 xfree (get_membuf (&data, &len));
347 sigbuf = get_membuf (&data, &sigbuflen);
349 /* Create an S-expression from it which is formatted like this:
350 "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" Fixme: If a card ever
351 creates non-RSA keys we need to change things. */
352 *r_buflen = 21 + 11 + sigbuflen + 4;
353 p = xtrymalloc (*r_buflen);
354 *r_buf = (unsigned char*)p;
360 p = stpcpy (p, "(7:sig-val(3:rsa(1:s" );
361 sprintf (p, "%u:", (unsigned int)sigbuflen);
363 memcpy (p, sigbuf, sigbuflen);
368 assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
375 /* Handle a CIPHERTEXT inquiry. Note, we only send the data,
376 assuan_transact takes care of flushing and writing the end */
378 inq_ciphertext_cb (void *opaque, const char *line)
380 struct cipher_parm_s *parm = opaque;
383 if (has_leading_keyword (line, "CIPHERTEXT"))
385 assuan_begin_confidential (parm->ctx);
386 rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
387 assuan_end_confidential (parm->ctx);
391 struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
392 rc = default_inq_cb (&inq_parm, line);
399 /* Call the agent to do a decrypt operation using the key identified by
400 the hex string KEYGRIP. */
402 gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
403 ksba_const_sexp_t ciphertext,
404 char **r_buf, size_t *r_buflen )
407 char line[ASSUAN_LINELENGTH];
409 struct cipher_parm_s cipher_parm;
411 char *p, *buf, *endp;
412 size_t ciphertextlen;
414 if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
415 return gpg_error (GPG_ERR_INV_VALUE);
418 ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
420 return gpg_error (GPG_ERR_INV_VALUE);
422 rc = start_agent (ctrl);
426 rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
430 assert ( DIM(line) >= 50 );
431 snprintf (line, DIM(line), "SETKEY %s", keygrip);
432 rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
438 snprintf (line, DIM(line), "SETKEYDESC %s", desc);
439 rc = assuan_transact (agent_ctx, line,
440 NULL, NULL, NULL, NULL, NULL, NULL);
445 init_membuf (&data, 1024);
446 cipher_parm.ctrl = ctrl;
447 cipher_parm.ctx = agent_ctx;
448 cipher_parm.ciphertext = ciphertext;
449 cipher_parm.ciphertextlen = ciphertextlen;
450 rc = assuan_transact (agent_ctx, "PKDECRYPT",
451 put_membuf_cb, &data,
452 inq_ciphertext_cb, &cipher_parm, NULL, NULL);
455 xfree (get_membuf (&data, &len));
459 put_membuf (&data, "", 1); /* Make sure it is 0 terminated. */
460 buf = get_membuf (&data, &len);
462 return gpg_error (GPG_ERR_ENOMEM);
463 assert (len); /* (we forced Nul termination.) */
467 if (len < 13 || memcmp (buf, "(5:value", 8) ) /* "(5:valueN:D)\0" */
468 return gpg_error (GPG_ERR_INV_SEXP);
469 len -= 11; /* Count only the data of the second part. */
470 p = buf + 8; /* Skip leading parenthesis and the value tag. */
474 /* For compatibility with older gpg-agents handle the old style
475 incomplete S-exps. */
476 len--; /* Do not count the Nul. */
480 n = strtoul (p, &endp, 10);
481 if (!n || *endp != ':')
482 return gpg_error (GPG_ERR_INV_SEXP);
485 return gpg_error (GPG_ERR_INV_SEXP); /* Oops: Inconsistent S-Exp. */
487 memmove (buf, endp, n);
498 /* Handle a KEYPARMS inquiry. Note, we only send the data,
499 assuan_transact takes care of flushing and writing the end */
501 inq_genkey_parms (void *opaque, const char *line)
503 struct genkey_parm_s *parm = opaque;
506 if (has_leading_keyword (line, "KEYPARAM"))
508 rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
512 struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
513 rc = default_inq_cb (&inq_parm, line);
521 /* Call the agent to generate a newkey */
523 gpgsm_agent_genkey (ctrl_t ctrl,
524 ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey)
527 struct genkey_parm_s gk_parm;
533 rc = start_agent (ctrl);
537 rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
541 init_membuf (&data, 1024);
543 gk_parm.ctx = agent_ctx;
544 gk_parm.sexp = keyparms;
545 gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
546 if (!gk_parm.sexplen)
547 return gpg_error (GPG_ERR_INV_VALUE);
548 rc = assuan_transact (agent_ctx, "GENKEY",
549 put_membuf_cb, &data,
550 inq_genkey_parms, &gk_parm, NULL, NULL);
553 xfree (get_membuf (&data, &len));
556 buf = get_membuf (&data, &len);
558 return gpg_error (GPG_ERR_ENOMEM);
559 if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
562 return gpg_error (GPG_ERR_INV_SEXP);
569 /* Call the agent to read the public key part for a given keygrip. If
570 FROMCARD is true, the key is directly read from the current
571 smartcard. In this case HEXKEYGRIP should be the keyID
574 gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
575 ksba_sexp_t *r_pubkey)
581 char line[ASSUAN_LINELENGTH];
582 struct default_inq_parm_s inq_parm;
585 rc = start_agent (ctrl);
588 inq_parm.ctrl = ctrl;
589 inq_parm.ctx = agent_ctx;
591 rc = assuan_transact (agent_ctx, "RESET",NULL, NULL, NULL, NULL, NULL, NULL);
595 snprintf (line, DIM(line), "%sREADKEY %s",
596 fromcard? "SCD ":"", hexkeygrip);
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);
604 xfree (get_membuf (&data, &len));
607 buf = get_membuf (&data, &len);
609 return gpg_error (GPG_ERR_ENOMEM);
610 if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
613 return gpg_error (GPG_ERR_INV_SEXP);
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
625 store_serialno (const char *line)
630 for (s=line; hexdigitp (s); s++)
632 p = xtrymalloc (s + 1 - line);
635 memcpy (p, line, s-line);
642 /* Callback for the gpgsm_agent_serialno function. */
644 scd_serialno_status_cb (void *opaque, const char *line)
646 char **r_serialno = opaque;
647 const char *keyword = line;
650 for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
652 while (spacep (line))
655 if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
658 *r_serialno = store_serialno (line);
665 /* Call the agent to read the serial number of the current card. */
667 gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno)
670 char *serialno = NULL;
671 struct default_inq_parm_s inq_parm;
674 rc = start_agent (ctrl);
677 inq_parm.ctrl = ctrl;
678 inq_parm.ctx = agent_ctx;
680 rc = assuan_transact (agent_ctx, "SCD SERIALNO",
682 default_inq_cb, &inq_parm,
683 scd_serialno_status_cb, &serialno);
684 if (!rc && !serialno)
685 rc = gpg_error (GPG_ERR_INTERNAL);
691 *r_serialno = serialno;
697 /* Callback for the gpgsm_agent_serialno function. */
699 scd_keypairinfo_status_cb (void *opaque, const char *line)
701 strlist_t *listaddr = opaque;
702 const char *keyword = line;
707 for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
709 while (spacep (line))
712 if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
714 sl = append_to_strlist (listaddr, line);
716 /* Make sure that we only have two tokes so that future
717 extensions of the format won't change the format expected by
719 while (*p && !spacep (p))
725 while (*p && !spacep (p))
735 /* Call the agent to read the keypairinfo lines of the current card.
736 The list is returned as a string made up of the keygrip, a space
739 gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list)
742 strlist_t list = NULL;
743 struct default_inq_parm_s inq_parm;
746 rc = start_agent (ctrl);
749 inq_parm.ctrl = ctrl;
750 inq_parm.ctx = agent_ctx;
752 rc = assuan_transact (agent_ctx, "SCD LEARN --force",
754 default_inq_cb, &inq_parm,
755 scd_keypairinfo_status_cb, &list);
757 rc = gpg_error (GPG_ERR_NO_DATA);
770 istrusted_status_cb (void *opaque, const char *line)
772 struct rootca_flags_s *flags = opaque;
775 if ((s = has_leading_keyword (line, "TRUSTLISTFLAG")))
778 if (has_leading_keyword (line, "relax"))
780 else if (has_leading_keyword (line, "cm"))
781 flags->chain_model = 1;
788 /* Ask the agent whether the certificate is in the list of trusted
789 keys. The certificate is either specified by the CERT object or by
790 the fingerprint HEXFPR. ROOTCA_FLAGS is guaranteed to be cleared
793 gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
794 struct rootca_flags_s *rootca_flags)
797 char line[ASSUAN_LINELENGTH];
799 memset (rootca_flags, 0, sizeof *rootca_flags);
802 return gpg_error (GPG_ERR_INV_ARG);
804 rc = start_agent (ctrl);
810 snprintf (line, DIM(line), "ISTRUSTED %s", hexfpr);
816 fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
819 log_error ("error getting the fingerprint\n");
820 return gpg_error (GPG_ERR_GENERAL);
823 snprintf (line, DIM(line), "ISTRUSTED %s", fpr);
827 rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
828 istrusted_status_cb, rootca_flags);
830 rootca_flags->valid = 1;
834 /* Ask the agent to mark CERT as a trusted Root-CA one */
836 gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert)
839 char *fpr, *dn, *dnfmt;
840 char line[ASSUAN_LINELENGTH];
841 struct default_inq_parm_s inq_parm;
843 rc = start_agent (ctrl);
846 inq_parm.ctrl = ctrl;
847 inq_parm.ctx = agent_ctx;
849 fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
852 log_error ("error getting the fingerprint\n");
853 return gpg_error (GPG_ERR_GENERAL);
856 dn = ksba_cert_get_issuer (cert, 0);
860 return gpg_error (GPG_ERR_GENERAL);
862 dnfmt = gpgsm_format_name2 (dn, 0);
865 return gpg_error_from_syserror ();
866 snprintf (line, DIM(line), "MARKTRUSTED %s S %s", fpr, dnfmt);
870 rc = assuan_transact (agent_ctx, line, NULL, NULL,
871 default_inq_cb, &inq_parm, NULL, NULL);
877 /* Ask the agent whether the a corresponding secret key is available
878 for the given keygrip */
880 gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip)
883 char line[ASSUAN_LINELENGTH];
885 rc = start_agent (ctrl);
889 if (!hexkeygrip || strlen (hexkeygrip) != 40)
890 return gpg_error (GPG_ERR_INV_VALUE);
892 snprintf (line, DIM(line), "HAVEKEY %s", hexkeygrip);
894 rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
900 learn_status_cb (void *opaque, const char *line)
902 struct learn_parm_s *parm = opaque;
905 /* Pass progress data to the caller. */
906 if ((s = has_leading_keyword (line, "PROGRESS")))
911 if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, line))
912 return gpg_error (GPG_ERR_ASS_CANCELED);
919 learn_cb (void *opaque, const void *buffer, size_t length)
921 struct learn_parm_s *parm = opaque;
932 put_membuf (parm->data, buffer, length);
935 /* END encountered - process what we have */
936 buf = get_membuf (parm->data, &len);
939 parm->error = gpg_error (GPG_ERR_ENOMEM);
943 if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, "learncard C 0 0"))
944 return gpg_error (GPG_ERR_ASS_CANCELED);
946 /* FIXME: this should go into import.c */
947 rc = ksba_cert_new (&cert);
953 rc = ksba_cert_init_from_mem (cert, buf, len);
956 log_error ("failed to parse a certificate: %s\n", gpg_strerror (rc));
957 ksba_cert_release (cert);
962 /* We do not store a certifciate with missing issuers as ephemeral
963 because we can assume that the --learn-card command has been used
965 rc = gpgsm_basic_cert_check (parm->ctrl, cert);
966 if (rc && gpg_err_code (rc) != GPG_ERR_MISSING_CERT
967 && gpg_err_code (rc) != GPG_ERR_MISSING_ISSUER_CERT)
968 log_error ("invalid certificate: %s\n", gpg_strerror (rc));
973 if (!keydb_store_cert (parm->ctrl, cert, 0, &existed))
975 if (opt.verbose > 1 && existed)
976 log_info ("certificate already in DB\n");
977 else if (opt.verbose && !existed)
978 log_info ("certificate imported\n");
982 ksba_cert_release (cert);
983 init_membuf (parm->data, 4096);
987 /* Call the agent to learn about a smartcard */
989 gpgsm_agent_learn (ctrl_t ctrl)
992 struct learn_parm_s learn_parm;
996 rc = start_agent (ctrl);
1000 rc = warn_version_mismatch (ctrl, agent_ctx, SCDAEMON_NAME, 2);
1004 init_membuf (&data, 4096);
1005 learn_parm.error = 0;
1006 learn_parm.ctrl = ctrl;
1007 learn_parm.ctx = agent_ctx;
1008 learn_parm.data = &data;
1009 rc = assuan_transact (agent_ctx, "LEARN --send",
1010 learn_cb, &learn_parm,
1012 learn_status_cb, &learn_parm);
1013 xfree (get_membuf (&data, &len));
1016 return learn_parm.error;
1020 /* Ask the agent to change the passphrase of the key identified by
1021 HEXKEYGRIP. If DESC is not NULL, display instead of the default
1022 description message. */
1024 gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc)
1027 char line[ASSUAN_LINELENGTH];
1028 struct default_inq_parm_s inq_parm;
1030 rc = start_agent (ctrl);
1033 inq_parm.ctrl = ctrl;
1034 inq_parm.ctx = agent_ctx;
1036 if (!hexkeygrip || strlen (hexkeygrip) != 40)
1037 return gpg_error (GPG_ERR_INV_VALUE);
1041 snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1042 rc = assuan_transact (agent_ctx, line,
1043 NULL, NULL, NULL, NULL, NULL, NULL);
1048 snprintf (line, DIM(line), "PASSWD %s", hexkeygrip);
1050 rc = assuan_transact (agent_ctx, line, NULL, NULL,
1051 default_inq_cb, &inq_parm, NULL, NULL);
1057 /* Ask the agent to pop up a confirmation dialog with the text DESC
1058 and an okay and cancel button. */
1060 gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc)
1063 char line[ASSUAN_LINELENGTH];
1064 struct default_inq_parm_s inq_parm;
1066 rc = start_agent (ctrl);
1069 inq_parm.ctrl = ctrl;
1070 inq_parm.ctx = agent_ctx;
1072 snprintf (line, DIM(line), "GET_CONFIRMATION %s", desc);
1074 rc = assuan_transact (agent_ctx, line, NULL, NULL,
1075 default_inq_cb, &inq_parm, NULL, NULL);
1081 /* Return 0 if the agent is alive. This is useful to make sure that
1082 an agent has been started. */
1084 gpgsm_agent_send_nop (ctrl_t ctrl)
1088 rc = start_agent (ctrl);
1090 rc = assuan_transact (agent_ctx, "NOP",
1091 NULL, NULL, NULL, NULL, NULL, NULL);
1098 keyinfo_status_cb (void *opaque, const char *line)
1100 char **serialno = opaque;
1103 if ((s = has_leading_keyword (line, "KEYINFO")) && !*serialno)
1105 s = strchr (s, ' ');
1106 if (s && s[1] == 'T' && s[2] == ' ' && s[3])
1109 s2 = strchr (s, ' ');
1112 *serialno = xtrymalloc ((s2 - s)+1);
1115 memcpy (*serialno, s, s2 - s);
1116 (*serialno)[s2 - s] = 0;
1124 /* Return the serial number for a secret key. If the returned serial
1125 number is NULL, the key is not stored on a smartcard. Caller needs
1126 to free R_SERIALNO. */
1128 gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip, char **r_serialno)
1131 char line[ASSUAN_LINELENGTH];
1132 char *serialno = NULL;
1136 err = start_agent (ctrl);
1140 if (!hexkeygrip || strlen (hexkeygrip) != 40)
1141 return gpg_error (GPG_ERR_INV_VALUE);
1143 snprintf (line, DIM(line), "KEYINFO %s", hexkeygrip);
1145 err = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
1146 keyinfo_status_cb, &serialno);
1147 if (!err && serialno)
1149 /* Sanity check for bad characters. */
1150 if (strpbrk (serialno, ":\n\r"))
1151 err = GPG_ERR_INV_VALUE;
1156 *r_serialno = serialno;
1162 /* Ask for the passphrase (this is used for pkcs#12 import/export. On
1163 success the caller needs to free the string stored at R_PASSPHRASE.
1164 On error NULL will be stored at R_PASSPHRASE and an appropriate
1165 error code returned. If REPEAT is true the agent tries to get a
1166 new passphrase (i.e. asks the user to confirm it). */
1168 gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg, int repeat,
1169 char **r_passphrase)
1172 char line[ASSUAN_LINELENGTH];
1175 struct default_inq_parm_s inq_parm;
1177 *r_passphrase = NULL;
1179 err = start_agent (ctrl);
1182 inq_parm.ctrl = ctrl;
1183 inq_parm.ctx = agent_ctx;
1185 if (desc_msg && *desc_msg && !(arg4 = percent_plus_escape (desc_msg)))
1186 return gpg_error_from_syserror ();
1188 snprintf (line, DIM(line), "GET_PASSPHRASE --data%s -- X X X %s",
1189 repeat? " --repeat=1 --check --qualitybar":"",
1193 init_membuf_secure (&data, 64);
1194 err = assuan_transact (agent_ctx, line,
1195 put_membuf_cb, &data,
1196 default_inq_cb, &inq_parm, NULL, NULL);
1199 xfree (get_membuf (&data, NULL));
1202 put_membuf (&data, "", 1);
1203 *r_passphrase = get_membuf (&data, NULL);
1205 err = gpg_error_from_syserror ();
1212 /* Retrieve a key encryption key from the agent. With FOREXPORT true
1213 the key shall be use for export, with false for import. On success
1214 the new key is stored at R_KEY and its length at R_KEKLEN. */
1216 gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
1217 void **r_kek, size_t *r_keklen)
1223 char line[ASSUAN_LINELENGTH];
1224 struct default_inq_parm_s inq_parm;
1227 err = start_agent (ctrl);
1230 inq_parm.ctrl = ctrl;
1231 inq_parm.ctx = agent_ctx;
1233 snprintf (line, DIM(line), "KEYWRAP_KEY %s",
1234 forexport? "--export":"--import");
1236 init_membuf_secure (&data, 64);
1237 err = assuan_transact (agent_ctx, line,
1238 put_membuf_cb, &data,
1239 default_inq_cb, &inq_parm, NULL, NULL);
1242 xfree (get_membuf (&data, &len));
1245 buf = get_membuf (&data, &len);
1247 return gpg_error_from_syserror ();
1256 /* Handle the inquiry for an IMPORT_KEY command. */
1258 inq_import_key_parms (void *opaque, const char *line)
1260 struct import_key_parm_s *parm = opaque;
1263 if (has_leading_keyword (line, "KEYDATA"))
1265 assuan_begin_confidential (parm->ctx);
1266 err = assuan_send_data (parm->ctx, parm->key, parm->keylen);
1267 assuan_end_confidential (parm->ctx);
1271 struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
1272 err = default_inq_cb (&inq_parm, line);
1279 /* Call the agent to import a key into the agent. */
1281 gpgsm_agent_import_key (ctrl_t ctrl, const void *key, size_t keylen)
1284 struct import_key_parm_s parm;
1286 err = start_agent (ctrl);
1291 parm.ctx = agent_ctx;
1293 parm.keylen = keylen;
1295 err = assuan_transact (agent_ctx, "IMPORT_KEY",
1296 NULL, NULL, inq_import_key_parms, &parm, NULL, NULL);
1302 /* Receive a secret key from the agent. KEYGRIP is the hexified
1303 keygrip, DESC a prompt to be displayed with the agent's passphrase
1304 question (needs to be plus+percent escaped). On success the key is
1305 stored as a canonical S-expression at R_RESULT and R_RESULTLEN. */
1307 gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip, const char *desc,
1308 unsigned char **r_result, size_t *r_resultlen)
1314 char line[ASSUAN_LINELENGTH];
1315 struct default_inq_parm_s inq_parm;
1319 err = start_agent (ctrl);
1322 inq_parm.ctrl = ctrl;
1323 inq_parm.ctx = agent_ctx;
1327 snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1328 err = assuan_transact (agent_ctx, line,
1329 NULL, NULL, NULL, NULL, NULL, NULL);
1334 snprintf (line, DIM(line), "EXPORT_KEY %s", keygrip);
1336 init_membuf_secure (&data, 1024);
1337 err = assuan_transact (agent_ctx, line,
1338 put_membuf_cb, &data,
1339 default_inq_cb, &inq_parm, NULL, NULL);
1342 xfree (get_membuf (&data, &len));
1345 buf = get_membuf (&data, &len);
1347 return gpg_error_from_syserror ();