agent: Allow recursive use of pinentry.
[gnupg.git] / agent / agent.h
1 /* agent.h - Global definitions for the agent
2  * Copyright (C) 2001, 2002, 2003, 2005, 2011 Free Software Foundation, Inc.
3  * Copyright (C) 2015 g10 Code GmbH.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
19  */
20
21 #ifndef AGENT_H
22 #define AGENT_H
23
24 #ifdef GPG_ERR_SOURCE_DEFAULT
25 #error GPG_ERR_SOURCE_DEFAULT already defined
26 #endif
27 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGAGENT
28 #include <gpg-error.h>
29 #define map_assuan_err(a) \
30         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
31 #include <errno.h>
32
33 #include <gcrypt.h>
34 #include "../common/util.h"
35 #include "../common/membuf.h"
36 #include "../common/sysutils.h" /* (gnupg_fd_t) */
37 #include "../common/session-env.h"
38 #include "../common/shareddefs.h"
39
40 /* To convey some special hash algorithms we use algorithm numbers
41    reserved for application use. */
42 #ifndef GCRY_MODULE_ID_USER
43 #define GCRY_MODULE_ID_USER 1024
44 #endif
45 #define MD_USER_TLS_MD5SHA1 (GCRY_MODULE_ID_USER+1)
46
47 /* Maximum length of a digest.  */
48 #define MAX_DIGEST_LEN 64
49
50 /* The maximum length of a passphrase (in bytes).  Note: this is
51    further contrained by the Assuan line length (and any other text on
52    the same line).  However, the Assuan line length is 1k bytes so
53    this shouldn't be a problem in practice.  */
54 #define MAX_PASSPHRASE_LEN 255
55
56
57 /* A large struct name "opt" to keep global flags */
58 struct
59 {
60   unsigned int debug;  /* Debug flags (DBG_foo_VALUE) */
61   int verbose;         /* Verbosity level */
62   int quiet;           /* Be as quiet as possible */
63   int dry_run;         /* Don't change any persistent data */
64   int batch;           /* Batch mode */
65
66   /* True if we handle sigusr2.  */
67   int sigusr2_enabled;
68
69   /* Environment settings gathered at program start or changed using the
70      Assuan command UPDATESTARTUPTTY. */
71   session_env_t startup_env;
72   char *startup_lc_ctype;
73   char *startup_lc_messages;
74
75   /* Enable pinentry debugging (--debug 1024 should also be used).  */
76   int debug_pinentry;
77
78   /* Filename of the program to start as pinentry.  */
79   const char *pinentry_program;
80
81   /* Filename of the program to handle smartcard tasks.  */
82   const char *scdaemon_program;
83
84   int disable_scdaemon;         /* Never use the SCdaemon. */
85
86   int no_grab;         /* Don't let the pinentry grab the keyboard */
87
88   /* The name of the file pinentry shall touch before exiting.  If
89      this is not set the file name of the standard socket is used. */
90   const char *pinentry_touch_file;
91
92   /* A string where the first character is used by the pinentry as a
93      custom invisible character.  */
94   char *pinentry_invisible_char;
95
96   /* The timeout value for the Pinentry in seconds.  This is passed to
97      the pinentry if it is not 0.  It is up to the pinentry to act
98      upon this timeout value.  */
99   unsigned long pinentry_timeout;
100
101   /* The default and maximum TTL of cache entries. */
102   unsigned long def_cache_ttl;     /* Default. */
103   unsigned long def_cache_ttl_ssh; /* for SSH. */
104   unsigned long max_cache_ttl;     /* Default. */
105   unsigned long max_cache_ttl_ssh; /* for SSH. */
106
107   /* Flag disallowing bypassing of the warning.  */
108   int enforce_passphrase_constraints;
109
110   /* The require minmum length of a passphrase. */
111   unsigned int min_passphrase_len;
112
113   /* The minimum number of non-alpha characters in a passphrase.  */
114   unsigned int min_passphrase_nonalpha;
115
116   /* File name with a patternfile or NULL if not enabled.  */
117   const char *check_passphrase_pattern;
118
119   /* If not 0 the user is asked to change his passphrase after these
120      number of days.  */
121   unsigned int max_passphrase_days;
122
123   /* If set, a passphrase history will be written and checked at each
124      passphrase change.  */
125   int enable_passphrase_history;
126
127   /* If set the extended key format is used for new keys.  */
128   int enable_extended_key_format;
129
130   int running_detached; /* We are running detached from the tty. */
131
132   /* If this global option is true, the passphrase cache is ignored
133      for signing operations.  */
134   int ignore_cache_for_signing;
135
136   /* If this global option is true, the user is allowed to
137      interactively mark certificate in trustlist.txt as trusted. */
138   int allow_mark_trusted;
139
140   /* If this global option is true, the Assuan command
141      PRESET_PASSPHRASE is allowed.  */
142   int allow_preset_passphrase;
143
144   /* If this global option is true, the Assuan option
145      pinentry-mode=loopback is allowed.  */
146   int allow_loopback_pinentry;
147
148   /* Allow the use of an external password cache.  If this option is
149      enabled (which is the default) we send an option to Pinentry
150      to allow it to enable such a cache.  */
151   int allow_external_cache;
152
153   /* If this global option is true, the Assuan option of Pinentry
154      allow-emacs-prompt is allowed.  */
155   int allow_emacs_pinentry;
156
157   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
158   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
159
160   /* This global option indicates the use of an extra socket. Note
161      that we use a hack for cleanup handling in gpg-agent.c: If the
162      value is less than 2 the name has not yet been malloced. */
163   int extra_socket;
164
165   /* This global option indicates the use of an extra socket for web
166      browsers. Note that we use a hack for cleanup handling in
167      gpg-agent.c: If the value is less than 2 the name has not yet
168      been malloced. */
169   int browser_socket;
170
171   /* The digest algorithm to use for ssh fingerprints when
172    * communicating with the user.  */
173   int ssh_fingerprint_digest;
174 } opt;
175
176
177 /* Bit values for the --debug option.  */
178 #define DBG_MPI_VALUE     2     /* debug mpi details */
179 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
180 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
181 #define DBG_CACHE_VALUE   64    /* debug the caching */
182 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
183 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
184 #define DBG_IPC_VALUE     1024  /* Enable Assuan debugging.  */
185
186 /* Test macros for the debug option.  */
187 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
188 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
189 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
190 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
191 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
192
193 /* Forward reference for local definitions in command.c.  */
194 struct server_local_s;
195
196 /* Declaration of objects from command-ssh.c.  */
197 struct ssh_control_file_s;
198 typedef struct ssh_control_file_s *ssh_control_file_t;
199
200 /* Forward reference for local definitions in call-scd.c.  */
201 struct scd_local_s;
202
203 /* Collection of data per session (aka connection). */
204 struct server_control_s
205 {
206   /* Private data used to fire up the connection thread.  We use this
207      structure do avoid an extra allocation for only a few bytes while
208      spawning a new connection thread.  */
209   struct {
210     gnupg_fd_t fd;
211   } thread_startup;
212
213   /* Flag indicating the connection is run in restricted mode.
214      A value of 1 if used for --extra-socket,
215      a value of 2 is used for --browser-socket.  */
216   int restricted;
217
218   /* Private data of the server (command.c). */
219   struct server_local_s *server_local;
220
221   /* Private data of the SCdaemon (call-scd.c). */
222   struct scd_local_s *scd_local;
223
224   /* Environment settings for the connection.  */
225   session_env_t session_env;
226   char *lc_ctype;
227   char *lc_messages;
228   unsigned long client_pid;
229
230   /* The current pinentry mode.  */
231   pinentry_mode_t pinentry_mode;
232
233   /* The TTL used for the --preset option of certain commands.  */
234   int cache_ttl_opt_preset;
235
236   /* Information on the currently used digest (for signing commands).  */
237   struct {
238     int algo;
239     unsigned char value[MAX_DIGEST_LEN];
240     int valuelen;
241     int raw_value: 1;
242   } digest;
243   unsigned char keygrip[20];
244   int have_keygrip;
245
246   /* A flag to enable a hack to send the PKAUTH command instead of the
247      PKSIGN command to the scdaemon.  */
248   int use_auth_call;
249
250   /* A flag to inhibit enforced passphrase change during an explicit
251      passwd command.  */
252   int in_passwd;
253
254   /* The current S2K which might be different from the calibrated
255      count. */
256   unsigned long s2k_count;
257
258   /* Recursion level of pinentry.  */
259   int pinentry_level;
260 };
261
262
263 /* Information pertaining to pinentry requests.  */
264 struct pin_entry_info_s
265 {
266   int min_digits; /* min. number of digits required or 0 for freeform entry */
267   int max_digits; /* max. number of allowed digits allowed*/
268   int max_tries;  /* max. number of allowed tries.  */
269   int failed_tries; /* Number of tries so far failed.  */
270   int with_qualitybar; /* Set if the quality bar should be displayed.  */
271   int with_repeat;  /* Request repetition of the passphrase.  */
272   int repeat_okay;  /* Repetition worked. */
273   gpg_error_t (*check_cb)(struct pin_entry_info_s *); /* CB used to check
274                                                          the PIN */
275   void *check_cb_arg;  /* optional argument which might be of use in the CB */
276   const char *cb_errtext; /* used by the cb to display a specific error */
277   size_t max_length;   /* Allocated length of the buffer PIN. */
278   char pin[1];         /* The buffer to hold the PIN or passphrase.
279                           It's actual allocated length is given by
280                           MAX_LENGTH (above).  */
281 };
282
283
284 /* Types of the private keys.  */
285 enum
286   {
287     PRIVATE_KEY_UNKNOWN = 0,      /* Type of key is not known.  */
288     PRIVATE_KEY_CLEAR = 1,        /* The key is not protected.  */
289     PRIVATE_KEY_PROTECTED = 2,    /* The key is protected.  */
290     PRIVATE_KEY_SHADOWED = 3,     /* The key is a stub for a smartcard
291                                      based key.  */
292     PROTECTED_SHARED_SECRET = 4,  /* RFU.  */
293     PRIVATE_KEY_OPENPGP_NONE = 5  /* openpgp-native with protection "none". */
294   };
295
296
297 /* Values for the cache_mode arguments. */
298 typedef enum
299   {
300     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
301     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
302     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
303     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
304     CACHE_MODE_SSH,        /* SSH related cache. */
305     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
306   }
307 cache_mode_t;
308
309 /* The TTL is seconds used for adding a new nonce mode cache item.  */
310 #define CACHE_TTL_NONCE 120
311
312 /* The TTL in seconds used by the --preset option of some commands.
313    This is the default value changeable by an OPTION command.  */
314 #define CACHE_TTL_OPT_PRESET 900
315
316
317 /* The type of a function to lookup a TTL by a keygrip.  */
318 typedef int (*lookup_ttl_t)(const char *hexgrip);
319
320
321 /* This is a special version of the usual _() gettext macro.  It
322    assumes a server connection control variable with the name "ctrl"
323    and uses that to translate a string according to the locale set for
324    the connection.  The macro LunderscoreIMPL is used by i18n to
325    actually define the inline function when needed.  */
326 #if defined (ENABLE_NLS) || defined (USE_SIMPLE_GETTEXT)
327 #define L_(a) agent_Lunderscore (ctrl, (a))
328 #define LunderscorePROTO                                            \
329   static inline const char *agent_Lunderscore (ctrl_t ctrl,         \
330                                                const char *string)  \
331     GNUPG_GCC_ATTR_FORMAT_ARG(2);
332 #define LunderscoreIMPL                                         \
333   static inline const char *                                    \
334   agent_Lunderscore (ctrl_t ctrl, const char *string)           \
335   {                                                             \
336     return ctrl? i18n_localegettext (ctrl->lc_messages, string) \
337       /*     */: gettext (string);                              \
338   }
339 #else
340 #define L_(a) (a)
341 #endif
342
343
344 /*-- gpg-agent.c --*/
345 void agent_exit (int rc)
346                 GPGRT_ATTR_NORETURN; /* Also implemented in other tools */
347 void agent_set_progress_cb (void (*cb)(ctrl_t ctrl, const char *what,
348                                        int printchar, int current, int total),
349                             ctrl_t ctrl);
350 gpg_error_t agent_copy_startup_env (ctrl_t ctrl);
351 const char *get_agent_socket_name (void);
352 const char *get_agent_ssh_socket_name (void);
353 int get_agent_active_connection_count (void);
354 #ifdef HAVE_W32_SYSTEM
355 void *get_agent_scd_notify_event (void);
356 #endif
357 void agent_sighup_action (void);
358 int map_pk_openpgp_to_gcry (int openpgp_algo);
359
360 /*-- command.c --*/
361 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid,
362                                          const char *extra);
363 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
364      GPGRT_ATTR_SENTINEL(0);
365 gpg_error_t agent_print_status (ctrl_t ctrl, const char *keyword,
366                                 const char *format, ...)
367      GPGRT_ATTR_PRINTF(3,4);
368 void bump_key_eventcounter (void);
369 void bump_card_eventcounter (void);
370 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
371 gpg_error_t pinentry_loopback (ctrl_t, const char *keyword,
372                                unsigned char **buffer, size_t *size,
373                                size_t max_length);
374
375 #ifdef HAVE_W32_SYSTEM
376 int serve_mmapped_ssh_request (ctrl_t ctrl,
377                                unsigned char *request, size_t maxreqlen);
378 #endif /*HAVE_W32_SYSTEM*/
379
380 /*-- command-ssh.c --*/
381 ssh_control_file_t ssh_open_control_file (void);
382 void ssh_close_control_file (ssh_control_file_t cf);
383 gpg_error_t ssh_read_control_file (ssh_control_file_t cf,
384                                    char *r_hexgrip, int *r_disabled,
385                                    int *r_ttl, int *r_confirm);
386 gpg_error_t ssh_search_control_file (ssh_control_file_t cf,
387                                      const char *hexgrip,
388                                      int *r_disabled,
389                                      int *r_ttl, int *r_confirm);
390
391 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
392
393 /*-- findkey.c --*/
394 gpg_error_t agent_modify_description (const char *in, const char *comment,
395                                       const gcry_sexp_t key, char **result);
396 int agent_write_private_key (const unsigned char *grip,
397                              const void *buffer, size_t length, int force);
398 gpg_error_t agent_key_from_file (ctrl_t ctrl,
399                                  const char *cache_nonce,
400                                  const char *desc_text,
401                                  const unsigned char *grip,
402                                  unsigned char **shadow_info,
403                                  cache_mode_t cache_mode,
404                                  lookup_ttl_t lookup_ttl,
405                                  gcry_sexp_t *result,
406                                  char **r_passphrase);
407 gpg_error_t agent_raw_key_from_file (ctrl_t ctrl, const unsigned char *grip,
408                                      gcry_sexp_t *result);
409 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
410                                         const unsigned char *grip,
411                                         gcry_sexp_t *result);
412 int agent_is_dsa_key (gcry_sexp_t s_key);
413 int agent_is_eddsa_key (gcry_sexp_t s_key);
414 int agent_key_available (const unsigned char *grip);
415 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
416                                       int *r_keytype,
417                                       unsigned char **r_shadow_info);
418 gpg_error_t agent_delete_key (ctrl_t ctrl, const char *desc_text,
419                               const unsigned char *grip,
420                               int force, int only_stubs);
421
422 /*-- call-pinentry.c --*/
423 void initialize_module_call_pinentry (void);
424 void agent_query_dump_state (void);
425 void agent_reset_query (ctrl_t ctrl);
426 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
427 gpg_error_t agent_askpin (ctrl_t ctrl,
428                           const char *desc_text, const char *prompt_text,
429                           const char *inital_errtext,
430                           struct pin_entry_info_s *pininfo,
431                           const char *keyinfo, cache_mode_t cache_mode);
432 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
433                           const char *desc, const char *prompt,
434                           const char *errtext, int with_qualitybar,
435                           const char *keyinfo, cache_mode_t cache_mode);
436 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
437                             const char *notokay, int with_cancel);
438 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
439 int agent_popup_message_start (ctrl_t ctrl,
440                                const char *desc, const char *ok_btn);
441 void agent_popup_message_stop (ctrl_t ctrl);
442 int agent_clear_passphrase (ctrl_t ctrl,
443                             const char *keyinfo, cache_mode_t cache_mode);
444
445 /*-- cache.c --*/
446 void initialize_module_cache (void);
447 void deinitialize_module_cache (void);
448 void agent_flush_cache (void);
449 int agent_put_cache (const char *key, cache_mode_t cache_mode,
450                      const char *data, int ttl);
451 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
452 void agent_store_cache_hit (const char *key);
453
454
455 /*-- pksign.c --*/
456 gpg_error_t agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
457                              const char *desc_text,
458                              gcry_sexp_t *signature_sexp,
459                              cache_mode_t cache_mode, lookup_ttl_t lookup_ttl,
460                              const void *overridedata, size_t overridedatalen);
461 gpg_error_t agent_pksign (ctrl_t ctrl, const char *cache_nonce,
462                           const char *desc_text,
463                           membuf_t *outbuf, cache_mode_t cache_mode);
464
465 /*-- pkdecrypt.c --*/
466 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
467                      const unsigned char *ciphertext, size_t ciphertextlen,
468                      membuf_t *outbuf, int *r_padding);
469
470 /*-- genkey.c --*/
471 int check_passphrase_constraints (ctrl_t ctrl, const char *pw,
472                                   char **failed_constraint);
473 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
474                                       char **r_passphrase);
475 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
476                   const char *keyparam, size_t keyparmlen,
477                   int no_protection, const char *override_passphrase,
478                   int preset, membuf_t *outbuf);
479 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
480                                      char **passphrase_addr);
481
482 /*-- protect.c --*/
483 unsigned long get_standard_s2k_count (void);
484 unsigned char get_standard_s2k_count_rfc4880 (void);
485 int agent_protect (const unsigned char *plainkey, const char *passphrase,
486                    unsigned char **result, size_t *resultlen,
487                    unsigned long s2k_count, int use_ocb);
488 gpg_error_t agent_unprotect (ctrl_t ctrl,
489                      const unsigned char *protectedkey, const char *passphrase,
490                      gnupg_isotime_t protected_at,
491                      unsigned char **result, size_t *resultlen);
492 int agent_private_key_type (const unsigned char *privatekey);
493 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
494 int agent_shadow_key (const unsigned char *pubkey,
495                       const unsigned char *shadow_info,
496                       unsigned char **result);
497 gpg_error_t agent_get_shadow_info (const unsigned char *shadowkey,
498                                    unsigned char const **shadow_info);
499 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
500                                char **r_hexsn, char **r_idstr, int *r_pinlen);
501 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
502                                  int s2kmode,
503                                  const unsigned char *s2ksalt,
504                                  unsigned int s2kcount,
505                                  unsigned char *key, size_t keylen);
506 gpg_error_t agent_write_shadow_key (const unsigned char *grip,
507                                     const char *serialno, const char *keyid,
508                                     const unsigned char *pkbuf, int force);
509
510
511 /*-- trustlist.c --*/
512 void initialize_module_trustlist (void);
513 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
514 gpg_error_t agent_listtrusted (void *assuan_context);
515 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
516                                const char *fpr, int flag);
517 void agent_reload_trustlist (void);
518
519
520 /*-- divert-scd.c --*/
521 int divert_pksign (ctrl_t ctrl, const char *desc_text,
522                    const unsigned char *digest, size_t digestlen, int algo,
523                    const unsigned char *shadow_info, unsigned char **r_sig,
524                    size_t *r_siglen);
525 int divert_pkdecrypt (ctrl_t ctrl, const char *desc_text,
526                       const unsigned char *cipher,
527                       const unsigned char *shadow_info,
528                       char **r_buf, size_t *r_len, int *r_padding);
529 int divert_generic_cmd (ctrl_t ctrl,
530                         const char *cmdline, void *assuan_context);
531 int divert_writekey (ctrl_t ctrl, int force, const char *serialno,
532                      const char *id, const char *keydata, size_t keydatalen);
533
534
535 /*-- call-scd.c --*/
536 void initialize_module_call_scd (void);
537 void agent_scd_dump_state (void);
538 int agent_scd_check_running (void);
539 void agent_scd_check_aliveness (void);
540 int agent_reset_scd (ctrl_t ctrl);
541 int agent_card_learn (ctrl_t ctrl,
542                       void (*kpinfo_cb)(void*, const char *),
543                       void *kpinfo_cb_arg,
544                       void (*certinfo_cb)(void*, const char *),
545                       void *certinfo_cb_arg,
546                       void (*sinfo_cb)(void*, const char *,
547                                        size_t, const char *),
548                       void *sinfo_cb_arg);
549 int agent_card_serialno (ctrl_t ctrl, char **r_serialno, const char *demand);
550 int agent_card_pksign (ctrl_t ctrl,
551                        const char *keyid,
552                        int (*getpin_cb)(void *, const char *,
553                                         const char *, char*, size_t),
554                        void *getpin_cb_arg,
555                        const char *desc_text,
556                        int mdalgo,
557                        const unsigned char *indata, size_t indatalen,
558                        unsigned char **r_buf, size_t *r_buflen);
559 int agent_card_pkdecrypt (ctrl_t ctrl,
560                           const char *keyid,
561                           int (*getpin_cb)(void *, const char *,
562                                            const char *, char*,size_t),
563                           void *getpin_cb_arg,
564                           const char *desc_text,
565                           const unsigned char *indata, size_t indatalen,
566                           char **r_buf, size_t *r_buflen, int *r_padding);
567 int agent_card_readcert (ctrl_t ctrl,
568                          const char *id, char **r_buf, size_t *r_buflen);
569 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
570 int agent_card_writekey (ctrl_t ctrl, int force, const char *serialno,
571                          const char *id, const char *keydata,
572                          size_t keydatalen,
573                          int (*getpin_cb)(void *, const char *,
574                                           const char *, char*, size_t),
575                          void *getpin_cb_arg);
576 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
577 gpg_error_t agent_card_cardlist (ctrl_t ctrl, strlist_t *result);
578 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
579                     int (*getpin_cb)(void *, const char *,
580                                      const char *, char*, size_t),
581                     void *getpin_cb_arg, void *assuan_context);
582
583
584 /*-- learncard.c --*/
585 int agent_handle_learn (ctrl_t ctrl, int send, void *assuan_context, int force);
586
587
588 /*-- cvt-openpgp.c --*/
589 gpg_error_t
590 extract_private_key (gcry_sexp_t s_key, int req_private_key_data,
591                      const char **r_algoname, int *r_npkey, int *r_nskey,
592                      const char **r_format,
593                      gcry_mpi_t *mpi_array, int arraysize,
594                      gcry_sexp_t *r_curve, gcry_sexp_t *r_flags);
595
596 #endif /*AGENT_H*/