agent: Clean up pinentry access locking.
[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   int client_uid;
230
231   /* The current pinentry mode.  */
232   pinentry_mode_t pinentry_mode;
233
234   /* The TTL used for the --preset option of certain commands.  */
235   int cache_ttl_opt_preset;
236
237   /* Information on the currently used digest (for signing commands).  */
238   struct {
239     int algo;
240     unsigned char value[MAX_DIGEST_LEN];
241     int valuelen;
242     int raw_value: 1;
243   } digest;
244   unsigned char keygrip[20];
245   int have_keygrip;
246
247   /* A flag to enable a hack to send the PKAUTH command instead of the
248      PKSIGN command to the scdaemon.  */
249   int use_auth_call;
250
251   /* A flag to inhibit enforced passphrase change during an explicit
252      passwd command.  */
253   int in_passwd;
254
255   /* The current S2K which might be different from the calibrated
256      count. */
257   unsigned long s2k_count;
258
259   /* If pinentry is active for this thread.  It can be more than 1,
260      when pinentry is called recursively.  */
261   int pinentry_active;
262 };
263
264
265 /* Information pertaining to pinentry requests.  */
266 struct pin_entry_info_s
267 {
268   int min_digits; /* min. number of digits required or 0 for freeform entry */
269   int max_digits; /* max. number of allowed digits allowed*/
270   int max_tries;  /* max. number of allowed tries.  */
271   int failed_tries; /* Number of tries so far failed.  */
272   int with_qualitybar; /* Set if the quality bar should be displayed.  */
273   int with_repeat;  /* Request repetition of the passphrase.  */
274   int repeat_okay;  /* Repetition worked. */
275   gpg_error_t (*check_cb)(struct pin_entry_info_s *); /* CB used to check
276                                                          the PIN */
277   void *check_cb_arg;  /* optional argument which might be of use in the CB */
278   const char *cb_errtext; /* used by the cb to display a specific error */
279   size_t max_length;   /* Allocated length of the buffer PIN. */
280   char pin[1];         /* The buffer to hold the PIN or passphrase.
281                           It's actual allocated length is given by
282                           MAX_LENGTH (above).  */
283 };
284
285
286 /* Types of the private keys.  */
287 enum
288   {
289     PRIVATE_KEY_UNKNOWN = 0,      /* Type of key is not known.  */
290     PRIVATE_KEY_CLEAR = 1,        /* The key is not protected.  */
291     PRIVATE_KEY_PROTECTED = 2,    /* The key is protected.  */
292     PRIVATE_KEY_SHADOWED = 3,     /* The key is a stub for a smartcard
293                                      based key.  */
294     PROTECTED_SHARED_SECRET = 4,  /* RFU.  */
295     PRIVATE_KEY_OPENPGP_NONE = 5  /* openpgp-native with protection "none". */
296   };
297
298
299 /* Values for the cache_mode arguments. */
300 typedef enum
301   {
302     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
303     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
304     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
305     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
306     CACHE_MODE_SSH,        /* SSH related cache. */
307     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
308   }
309 cache_mode_t;
310
311 /* The TTL is seconds used for adding a new nonce mode cache item.  */
312 #define CACHE_TTL_NONCE 120
313
314 /* The TTL in seconds used by the --preset option of some commands.
315    This is the default value changeable by an OPTION command.  */
316 #define CACHE_TTL_OPT_PRESET 900
317
318
319 /* The type of a function to lookup a TTL by a keygrip.  */
320 typedef int (*lookup_ttl_t)(const char *hexgrip);
321
322
323 /* This is a special version of the usual _() gettext macro.  It
324    assumes a server connection control variable with the name "ctrl"
325    and uses that to translate a string according to the locale set for
326    the connection.  The macro LunderscoreIMPL is used by i18n to
327    actually define the inline function when needed.  */
328 #if defined (ENABLE_NLS) || defined (USE_SIMPLE_GETTEXT)
329 #define L_(a) agent_Lunderscore (ctrl, (a))
330 #define LunderscorePROTO                                            \
331   static inline const char *agent_Lunderscore (ctrl_t ctrl,         \
332                                                const char *string)  \
333     GNUPG_GCC_ATTR_FORMAT_ARG(2);
334 #define LunderscoreIMPL                                         \
335   static inline const char *                                    \
336   agent_Lunderscore (ctrl_t ctrl, const char *string)           \
337   {                                                             \
338     return ctrl? i18n_localegettext (ctrl->lc_messages, string) \
339       /*     */: gettext (string);                              \
340   }
341 #else
342 #define L_(a) (a)
343 #endif
344
345
346 /*-- gpg-agent.c --*/
347 void agent_exit (int rc)
348                 GPGRT_ATTR_NORETURN; /* Also implemented in other tools */
349 void agent_set_progress_cb (void (*cb)(ctrl_t ctrl, const char *what,
350                                        int printchar, int current, int total),
351                             ctrl_t ctrl);
352 gpg_error_t agent_copy_startup_env (ctrl_t ctrl);
353 const char *get_agent_socket_name (void);
354 const char *get_agent_ssh_socket_name (void);
355 int get_agent_active_connection_count (void);
356 #ifdef HAVE_W32_SYSTEM
357 void *get_agent_scd_notify_event (void);
358 #endif
359 void agent_sighup_action (void);
360 int map_pk_openpgp_to_gcry (int openpgp_algo);
361
362 /*-- command.c --*/
363 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid,
364                                          const char *extra);
365 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
366      GPGRT_ATTR_SENTINEL(0);
367 gpg_error_t agent_print_status (ctrl_t ctrl, const char *keyword,
368                                 const char *format, ...)
369      GPGRT_ATTR_PRINTF(3,4);
370 void bump_key_eventcounter (void);
371 void bump_card_eventcounter (void);
372 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
373 gpg_error_t pinentry_loopback (ctrl_t, const char *keyword,
374                                unsigned char **buffer, size_t *size,
375                                size_t max_length);
376
377 #ifdef HAVE_W32_SYSTEM
378 int serve_mmapped_ssh_request (ctrl_t ctrl,
379                                unsigned char *request, size_t maxreqlen);
380 #endif /*HAVE_W32_SYSTEM*/
381
382 /*-- command-ssh.c --*/
383 ssh_control_file_t ssh_open_control_file (void);
384 void ssh_close_control_file (ssh_control_file_t cf);
385 gpg_error_t ssh_read_control_file (ssh_control_file_t cf,
386                                    char *r_hexgrip, int *r_disabled,
387                                    int *r_ttl, int *r_confirm);
388 gpg_error_t ssh_search_control_file (ssh_control_file_t cf,
389                                      const char *hexgrip,
390                                      int *r_disabled,
391                                      int *r_ttl, int *r_confirm);
392
393 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
394
395 /*-- findkey.c --*/
396 gpg_error_t agent_modify_description (const char *in, const char *comment,
397                                       const gcry_sexp_t key, char **result);
398 int agent_write_private_key (const unsigned char *grip,
399                              const void *buffer, size_t length, int force);
400 gpg_error_t agent_key_from_file (ctrl_t ctrl,
401                                  const char *cache_nonce,
402                                  const char *desc_text,
403                                  const unsigned char *grip,
404                                  unsigned char **shadow_info,
405                                  cache_mode_t cache_mode,
406                                  lookup_ttl_t lookup_ttl,
407                                  gcry_sexp_t *result,
408                                  char **r_passphrase);
409 gpg_error_t agent_raw_key_from_file (ctrl_t ctrl, const unsigned char *grip,
410                                      gcry_sexp_t *result);
411 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
412                                         const unsigned char *grip,
413                                         gcry_sexp_t *result);
414 int agent_is_dsa_key (gcry_sexp_t s_key);
415 int agent_is_eddsa_key (gcry_sexp_t s_key);
416 int agent_key_available (const unsigned char *grip);
417 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
418                                       int *r_keytype,
419                                       unsigned char **r_shadow_info);
420 gpg_error_t agent_delete_key (ctrl_t ctrl, const char *desc_text,
421                               const unsigned char *grip,
422                               int force, int only_stubs);
423
424 /*-- call-pinentry.c --*/
425 void initialize_module_call_pinentry (void);
426 void agent_query_dump_state (void);
427 void agent_reset_query (ctrl_t ctrl);
428 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
429 gpg_error_t agent_askpin (ctrl_t ctrl,
430                           const char *desc_text, const char *prompt_text,
431                           const char *inital_errtext,
432                           struct pin_entry_info_s *pininfo,
433                           const char *keyinfo, cache_mode_t cache_mode);
434 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
435                           const char *desc, const char *prompt,
436                           const char *errtext, int with_qualitybar,
437                           const char *keyinfo, cache_mode_t cache_mode);
438 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
439                             const char *notokay, int with_cancel);
440 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
441 int agent_popup_message_start (ctrl_t ctrl,
442                                const char *desc, const char *ok_btn);
443 void agent_popup_message_stop (ctrl_t ctrl);
444 int agent_clear_passphrase (ctrl_t ctrl,
445                             const char *keyinfo, cache_mode_t cache_mode);
446
447 /*-- cache.c --*/
448 void initialize_module_cache (void);
449 void deinitialize_module_cache (void);
450 void agent_flush_cache (void);
451 int agent_put_cache (const char *key, cache_mode_t cache_mode,
452                      const char *data, int ttl);
453 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
454 void agent_store_cache_hit (const char *key);
455
456
457 /*-- pksign.c --*/
458 gpg_error_t agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
459                              const char *desc_text,
460                              gcry_sexp_t *signature_sexp,
461                              cache_mode_t cache_mode, lookup_ttl_t lookup_ttl,
462                              const void *overridedata, size_t overridedatalen);
463 gpg_error_t agent_pksign (ctrl_t ctrl, const char *cache_nonce,
464                           const char *desc_text,
465                           membuf_t *outbuf, cache_mode_t cache_mode);
466
467 /*-- pkdecrypt.c --*/
468 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
469                      const unsigned char *ciphertext, size_t ciphertextlen,
470                      membuf_t *outbuf, int *r_padding);
471
472 /*-- genkey.c --*/
473 int check_passphrase_constraints (ctrl_t ctrl, const char *pw,
474                                   char **failed_constraint);
475 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
476                                       char **r_passphrase);
477 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
478                   const char *keyparam, size_t keyparmlen,
479                   int no_protection, const char *override_passphrase,
480                   int preset, membuf_t *outbuf);
481 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
482                                      char **passphrase_addr);
483
484 /*-- protect.c --*/
485 unsigned long get_standard_s2k_count (void);
486 unsigned char get_standard_s2k_count_rfc4880 (void);
487 int agent_protect (const unsigned char *plainkey, const char *passphrase,
488                    unsigned char **result, size_t *resultlen,
489                    unsigned long s2k_count, int use_ocb);
490 gpg_error_t agent_unprotect (ctrl_t ctrl,
491                      const unsigned char *protectedkey, const char *passphrase,
492                      gnupg_isotime_t protected_at,
493                      unsigned char **result, size_t *resultlen);
494 int agent_private_key_type (const unsigned char *privatekey);
495 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
496 int agent_shadow_key (const unsigned char *pubkey,
497                       const unsigned char *shadow_info,
498                       unsigned char **result);
499 gpg_error_t agent_get_shadow_info (const unsigned char *shadowkey,
500                                    unsigned char const **shadow_info);
501 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
502                                char **r_hexsn, char **r_idstr, int *r_pinlen);
503 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
504                                  int s2kmode,
505                                  const unsigned char *s2ksalt,
506                                  unsigned int s2kcount,
507                                  unsigned char *key, size_t keylen);
508 gpg_error_t agent_write_shadow_key (const unsigned char *grip,
509                                     const char *serialno, const char *keyid,
510                                     const unsigned char *pkbuf, int force);
511
512
513 /*-- trustlist.c --*/
514 void initialize_module_trustlist (void);
515 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
516 gpg_error_t agent_listtrusted (void *assuan_context);
517 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
518                                const char *fpr, int flag);
519 void agent_reload_trustlist (void);
520
521
522 /*-- divert-scd.c --*/
523 int divert_pksign (ctrl_t ctrl, const char *desc_text,
524                    const unsigned char *digest, size_t digestlen, int algo,
525                    const unsigned char *shadow_info, unsigned char **r_sig,
526                    size_t *r_siglen);
527 int divert_pkdecrypt (ctrl_t ctrl, const char *desc_text,
528                       const unsigned char *cipher,
529                       const unsigned char *shadow_info,
530                       char **r_buf, size_t *r_len, int *r_padding);
531 int divert_generic_cmd (ctrl_t ctrl,
532                         const char *cmdline, void *assuan_context);
533 int divert_writekey (ctrl_t ctrl, int force, const char *serialno,
534                      const char *id, const char *keydata, size_t keydatalen);
535
536
537 /*-- call-scd.c --*/
538 void initialize_module_call_scd (void);
539 void agent_scd_dump_state (void);
540 int agent_scd_check_running (void);
541 void agent_scd_check_aliveness (void);
542 int agent_reset_scd (ctrl_t ctrl);
543 int agent_card_learn (ctrl_t ctrl,
544                       void (*kpinfo_cb)(void*, const char *),
545                       void *kpinfo_cb_arg,
546                       void (*certinfo_cb)(void*, const char *),
547                       void *certinfo_cb_arg,
548                       void (*sinfo_cb)(void*, const char *,
549                                        size_t, const char *),
550                       void *sinfo_cb_arg);
551 int agent_card_serialno (ctrl_t ctrl, char **r_serialno, const char *demand);
552 int agent_card_pksign (ctrl_t ctrl,
553                        const char *keyid,
554                        int (*getpin_cb)(void *, const char *,
555                                         const char *, char*, size_t),
556                        void *getpin_cb_arg,
557                        const char *desc_text,
558                        int mdalgo,
559                        const unsigned char *indata, size_t indatalen,
560                        unsigned char **r_buf, size_t *r_buflen);
561 int agent_card_pkdecrypt (ctrl_t ctrl,
562                           const char *keyid,
563                           int (*getpin_cb)(void *, const char *,
564                                            const char *, char*,size_t),
565                           void *getpin_cb_arg,
566                           const char *desc_text,
567                           const unsigned char *indata, size_t indatalen,
568                           char **r_buf, size_t *r_buflen, int *r_padding);
569 int agent_card_readcert (ctrl_t ctrl,
570                          const char *id, char **r_buf, size_t *r_buflen);
571 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
572 int agent_card_writekey (ctrl_t ctrl, int force, const char *serialno,
573                          const char *id, const char *keydata,
574                          size_t keydatalen,
575                          int (*getpin_cb)(void *, const char *,
576                                           const char *, char*, size_t),
577                          void *getpin_cb_arg);
578 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
579 gpg_error_t agent_card_cardlist (ctrl_t ctrl, strlist_t *result);
580 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
581                     int (*getpin_cb)(void *, const char *,
582                                      const char *, char*, size_t),
583                     void *getpin_cb_arg, void *assuan_context);
584
585
586 /*-- learncard.c --*/
587 int agent_handle_learn (ctrl_t ctrl, int send, void *assuan_context, int force);
588
589
590 /*-- cvt-openpgp.c --*/
591 gpg_error_t
592 extract_private_key (gcry_sexp_t s_key, int req_private_key_data,
593                      const char **r_algoname, int *r_npkey, int *r_nskey,
594                      const char **r_format,
595                      gcry_mpi_t *mpi_array, int arraysize,
596                      gcry_sexp_t *r_curve, gcry_sexp_t *r_flags);
597
598 #endif /*AGENT_H*/