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