Use attribute __gnu_printf__ with our estream-printf functions.
[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  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef AGENT_H
21 #define AGENT_H
22
23 #ifdef GPG_ERR_SOURCE_DEFAULT
24 #error GPG_ERR_SOURCE_DEFAULT already defined
25 #endif
26 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGAGENT
27 #include <gpg-error.h>
28 #define map_assuan_err(a) \
29         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
30 #include <errno.h>
31
32 #include <gcrypt.h>
33 #include "../common/util.h"
34 #include "../common/membuf.h"
35 #include "../common/sysutils.h" /* (gnupg_fd_t) */
36 #include "../common/session-env.h"
37 #include "../common/shareddefs.h"
38
39 /* To convey some special hash algorithms we use algorithm numbers
40    reserved for application use. */
41 #ifndef GCRY_MODULE_ID_USER
42 #define GCRY_MODULE_ID_USER 1024
43 #endif
44 #define MD_USER_TLS_MD5SHA1 (GCRY_MODULE_ID_USER+1)
45
46 /* Maximum length of a digest.  */
47 #define MAX_DIGEST_LEN 64
48
49
50
51 /* A large struct name "opt" to keep global flags */
52 struct
53 {
54   unsigned int debug;  /* Debug flags (DBG_foo_VALUE) */
55   int verbose;         /* Verbosity level */
56   int quiet;           /* Be as quiet as possible */
57   int dry_run;         /* Don't change any persistent data */
58   int batch;           /* Batch mode */
59   const char *homedir; /* Configuration directory name */
60
61   /* True if we are listening on the standard socket.  */
62   int use_standard_socket;
63
64   /* True if we handle sigusr2.  */
65   int sigusr2_enabled;
66
67   /* Environment settings gathered at program start or changed using the
68      Assuan command UPDATESTARTUPTTY. */
69   session_env_t startup_env;
70   char *startup_lc_ctype;
71   char *startup_lc_messages;
72
73   /* Filename of the program to start as pinentry.  */
74   const char *pinentry_program;
75
76   /* Filename of the program to handle smartcard tasks.  */
77   const char *scdaemon_program;
78
79   int disable_scdaemon;         /* Never use the SCdaemon. */
80
81   int no_grab;         /* Don't let the pinentry grab the keyboard */
82
83   /* The name of the file pinentry shall tocuh before exiting.  If
84      this is not set the filoe name of the standard socket is used. */
85   const char *pinentry_touch_file;
86
87   /* The default and maximum TTL of cache entries. */
88   unsigned long def_cache_ttl;     /* Default. */
89   unsigned long def_cache_ttl_ssh; /* for SSH. */
90   unsigned long max_cache_ttl;     /* Default. */
91   unsigned long max_cache_ttl_ssh; /* for SSH. */
92
93   /* Flag disallowing bypassing of the warning.  */
94   int enforce_passphrase_constraints;
95
96   /* The require minmum length of a passphrase. */
97   unsigned int min_passphrase_len;
98
99   /* The minimum number of non-alpha characters in a passphrase.  */
100   unsigned int min_passphrase_nonalpha;
101
102   /* File name with a patternfile or NULL if not enabled.  */
103   const char *check_passphrase_pattern;
104
105   /* If not 0 the user is asked to change his passphrase after these
106      number of days.  */
107   unsigned int max_passphrase_days;
108
109   /* If set, a passphrase history will be written and checked at each
110      passphrase change.  */
111   int enable_passhrase_history;
112
113   int running_detached; /* We are running detached from the tty. */
114
115   /* If this global option is true, the passphrase cache is ignored
116      for signing operations.  */
117   int ignore_cache_for_signing;
118
119   /* If this global option is true, the user is allowed to
120      interactively mark certificate in trustlist.txt as trusted. */
121   int allow_mark_trusted;
122
123   /* If this global option is true, the Assuan command
124      PRESET_PASSPHRASE is allowed.  */
125   int allow_preset_passphrase;
126
127   /* If this global option is true, the Assuan option
128      pinentry-mode=loopback is allowed.  */
129   int allow_loopback_pinentry;
130
131   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
132   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
133
134   /* This global option enables the ssh-agent subsystem.  */
135   int ssh_support;
136 } opt;
137
138
139 /* Bit values for the --debug option.  */
140 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
141 #define DBG_MPI_VALUE     2     /* debug mpi details */
142 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
143 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
144 #define DBG_CACHE_VALUE   64    /* debug the caching */
145 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
146 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
147 #define DBG_ASSUAN_VALUE 1024   /* Enable Assuan debugging.  */
148
149 /* Test macros for the debug option.  */
150 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
151 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
152 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
153 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
154 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
155 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
156
157 /* Forward reference for local definitions in command.c.  */
158 struct server_local_s;
159
160 /* Declaration of objects from command-ssh.c.  */
161 struct ssh_control_file_s;
162 typedef struct ssh_control_file_s *ssh_control_file_t;
163
164 /* Forward reference for local definitions in call-scd.c.  */
165 struct scd_local_s;
166
167 /* Collection of data per session (aka connection). */
168 struct server_control_s
169 {
170   /* Private data used to fire up the connection thread.  We use this
171      structure do avoid an extra allocation for only a few bytes while
172      spawning a new connection thread.  */
173   struct {
174     gnupg_fd_t fd;
175   } thread_startup;
176
177   /* Private data of the server (command.c). */
178   struct server_local_s *server_local;
179
180   /* Private data of the SCdaemon (call-scd.c). */
181   struct scd_local_s *scd_local;
182
183   /* Environment settings for the connection.  */
184   session_env_t session_env;
185   char *lc_ctype;
186   char *lc_messages;
187
188   /* The current pinentry mode.  */
189   pinentry_mode_t pinentry_mode;
190
191   /* The TTL used for the --preset option of certain commands.  */
192   int cache_ttl_opt_preset;
193
194   /* Information on the currently used digest (for signing commands).  */
195   struct {
196     int algo;
197     unsigned char value[MAX_DIGEST_LEN];
198     int valuelen;
199     int raw_value: 1;
200   } digest;
201   unsigned char keygrip[20];
202   int have_keygrip;
203
204   /* A flag to enable a hack to send the PKAUTH command instead of the
205      PKSIGN command to the scdaemon.  */
206   int use_auth_call;
207
208   /* A flag to inhibit enforced passphrase change during an explicit
209      passwd command.  */
210   int in_passwd;
211
212   /* The current S2K which might be different from the calibrated
213      count. */
214   unsigned long s2k_count;
215 };
216
217
218 /* Information pertaining to pinentry requests.  */
219 struct pin_entry_info_s
220 {
221   int min_digits; /* min. number of digits required or 0 for freeform entry */
222   int max_digits; /* max. number of allowed digits allowed*/
223   int max_tries;  /* max. number of allowed tries.  */
224   int failed_tries; /* Number of tries so far failed.  */
225   int with_qualitybar; /* Set if the quality bar should be displayed.  */
226   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
227   void *check_cb_arg;  /* optional argument which might be of use in the CB */
228   const char *cb_errtext; /* used by the cb to display a specific error */
229   size_t max_length;   /* Allocated length of the buffer PIN. */
230   char pin[1];         /* The buffer to hold the PIN or passphrase.
231                           It's actual allocated length is given by
232                           MAX_LENGTH (above).  */
233 };
234
235
236 /* Types of the private keys.  */
237 enum
238   {
239     PRIVATE_KEY_UNKNOWN = 0,      /* Type of key is not known.  */
240     PRIVATE_KEY_CLEAR = 1,        /* The key is not protected.  */
241     PRIVATE_KEY_PROTECTED = 2,    /* The key is protected.  */
242     PRIVATE_KEY_SHADOWED = 3,     /* The key is a stub for a smartcard
243                                      based key.  */
244     PROTECTED_SHARED_SECRET = 4   /* RFU.  */
245   };
246
247
248 /* Values for the cache_mode arguments. */
249 typedef enum
250   {
251     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
252     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
253     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
254     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
255     CACHE_MODE_SSH,        /* SSH related cache. */
256     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
257   }
258 cache_mode_t;
259
260 /* The TTL is seconds used for adding a new nonce mode cache item.  */
261 #define CACHE_TTL_NONCE 120
262
263 /* The TTL in seconds used by the --preset option of some commands.
264    This is the default value changeable by an OPTION command.  */
265 #define CACHE_TTL_OPT_PRESET 900
266
267
268 /* The type of a function to lookup a TTL by a keygrip.  */
269 typedef int (*lookup_ttl_t)(const char *hexgrip);
270
271
272 /*-- gpg-agent.c --*/
273 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
274 const char *get_agent_socket_name (void);
275 const char *get_agent_ssh_socket_name (void);
276 #ifdef HAVE_W32_SYSTEM
277 void *get_agent_scd_notify_event (void);
278 #endif
279 void agent_sighup_action (void);
280 int map_pk_openpgp_to_gcry (int openpgp_algo);
281
282 /*-- command.c --*/
283 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid);
284 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
285      GNUPG_GCC_A_SENTINEL(0);
286 gpg_error_t agent_print_status (ctrl_t ctrl, const char *keyword,
287                                 const char *format, ...)
288      JNLIB_GCC_A_PRINTF(3,4);
289 void bump_key_eventcounter (void);
290 void bump_card_eventcounter (void);
291 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
292 gpg_error_t pinentry_loopback (ctrl_t, const char *keyword,
293                                unsigned char **buffer, size_t *size,
294                                size_t max_length);
295
296 #ifdef HAVE_W32_SYSTEM
297 int serve_mmapped_ssh_request (ctrl_t ctrl,
298                                unsigned char *request, size_t maxreqlen);
299 #endif /*HAVE_W32_SYSTEM*/
300
301 /*-- command-ssh.c --*/
302 ssh_control_file_t ssh_open_control_file (void);
303 void ssh_close_control_file (ssh_control_file_t cf);
304 gpg_error_t ssh_read_control_file (ssh_control_file_t cf,
305                                    char *r_hexgrip, int *r_disabled,
306                                    int *r_ttl, int *r_confirm);
307 gpg_error_t ssh_search_control_file (ssh_control_file_t cf,
308                                      const char *hexgrip,
309                                      int *r_disabled,
310                                      int *r_ttl, int *r_confirm);
311
312 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
313
314 /*-- findkey.c --*/
315 int agent_write_private_key (const unsigned char *grip,
316                              const void *buffer, size_t length, int force);
317 gpg_error_t agent_key_from_file (ctrl_t ctrl,
318                                  const char *cache_nonce,
319                                  const char *desc_text,
320                                  const unsigned char *grip,
321                                  unsigned char **shadow_info,
322                                  cache_mode_t cache_mode,
323                                  lookup_ttl_t lookup_ttl,
324                                  gcry_sexp_t *result,
325                                  char **r_passphrase);
326 gpg_error_t agent_raw_key_from_file (ctrl_t ctrl, const unsigned char *grip,
327                                      gcry_sexp_t *result);
328 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
329                                         const unsigned char *grip,
330                                         gcry_sexp_t *result);
331 int agent_is_dsa_key (gcry_sexp_t s_key);
332 int agent_is_eddsa_key (gcry_sexp_t s_key);
333 int agent_key_available (const unsigned char *grip);
334 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
335                                       int *r_keytype,
336                                       unsigned char **r_shadow_info);
337
338 /*-- call-pinentry.c --*/
339 void initialize_module_call_pinentry (void);
340 void agent_query_dump_state (void);
341 void agent_reset_query (ctrl_t ctrl);
342 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
343 int agent_askpin (ctrl_t ctrl,
344                   const char *desc_text, const char *prompt_text,
345                   const char *inital_errtext,
346                   struct pin_entry_info_s *pininfo);
347 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
348                           const char *desc, const char *prompt,
349                           const char *errtext, int with_qualitybar);
350 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
351                             const char *notokay, int with_cancel);
352 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
353 int agent_popup_message_start (ctrl_t ctrl,
354                                const char *desc, const char *ok_btn);
355 void agent_popup_message_stop (ctrl_t ctrl);
356
357
358 /*-- cache.c --*/
359 void initialize_module_cache (void);
360 void deinitialize_module_cache (void);
361 void agent_flush_cache (void);
362 int agent_put_cache (const char *key, cache_mode_t cache_mode,
363                      const char *data, int ttl);
364 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
365
366
367 /*-- pksign.c --*/
368 int agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
369                      const char *desc_text,
370                      gcry_sexp_t *signature_sexp,
371                      cache_mode_t cache_mode, lookup_ttl_t lookup_ttl);
372 int agent_pksign (ctrl_t ctrl, const char *cache_nonce,
373                   const char *desc_text,
374                   membuf_t *outbuf, cache_mode_t cache_mode);
375
376 /*-- pkdecrypt.c --*/
377 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
378                      const unsigned char *ciphertext, size_t ciphertextlen,
379                      membuf_t *outbuf, int *r_padding);
380
381 /*-- genkey.c --*/
382 int check_passphrase_constraints (ctrl_t ctrl, const char *pw, int silent);
383 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
384                                       char **r_passphrase);
385 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
386                   const char *keyparam, size_t keyparmlen,
387                   int no_protection, int preset, membuf_t *outbuf);
388 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
389                                      char **passphrase_addr);
390
391 /*-- protect.c --*/
392 unsigned long get_standard_s2k_count (void);
393 unsigned char get_standard_s2k_count_rfc4880 (void);
394 int agent_protect (const unsigned char *plainkey, const char *passphrase,
395                    unsigned char **result, size_t *resultlen,
396                    unsigned long s2k_count);
397 int agent_unprotect (ctrl_t ctrl,
398                      const unsigned char *protectedkey, const char *passphrase,
399                      gnupg_isotime_t protected_at,
400                      unsigned char **result, size_t *resultlen);
401 int agent_private_key_type (const unsigned char *privatekey);
402 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
403 int agent_shadow_key (const unsigned char *pubkey,
404                       const unsigned char *shadow_info,
405                       unsigned char **result);
406 int agent_get_shadow_info (const unsigned char *shadowkey,
407                            unsigned char const **shadow_info);
408 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
409                                char **r_hexsn, char **r_idstr, int *r_pinlen);
410 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
411                                  int s2kmode,
412                                  const unsigned char *s2ksalt,
413                                  unsigned int s2kcount,
414                                  unsigned char *key, size_t keylen);
415
416
417 /*-- trustlist.c --*/
418 void initialize_module_trustlist (void);
419 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
420 gpg_error_t agent_listtrusted (void *assuan_context);
421 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
422                                const char *fpr, int flag);
423 void agent_reload_trustlist (void);
424
425
426 /*-- divert-scd.c --*/
427 int divert_pksign (ctrl_t ctrl,
428                    const unsigned char *digest, size_t digestlen, int algo,
429                    const unsigned char *shadow_info, unsigned char **r_sig,
430                    size_t *r_siglen);
431 int divert_pkdecrypt (ctrl_t ctrl,
432                       const unsigned char *cipher,
433                       const unsigned char *shadow_info,
434                       char **r_buf, size_t *r_len, int *r_padding);
435 int divert_generic_cmd (ctrl_t ctrl,
436                         const char *cmdline, void *assuan_context);
437 int divert_writekey (ctrl_t ctrl, int force, const char *serialno,
438                      const char *id, const char *keydata, size_t keydatalen);
439
440
441 /*-- call-scd.c --*/
442 void initialize_module_call_scd (void);
443 void agent_scd_dump_state (void);
444 int agent_scd_check_running (void);
445 void agent_scd_check_aliveness (void);
446 int agent_reset_scd (ctrl_t ctrl);
447 int agent_card_learn (ctrl_t ctrl,
448                       void (*kpinfo_cb)(void*, const char *),
449                       void *kpinfo_cb_arg,
450                       void (*certinfo_cb)(void*, const char *),
451                       void *certinfo_cb_arg,
452                       void (*sinfo_cb)(void*, const char *,
453                                        size_t, const char *),
454                       void *sinfo_cb_arg);
455 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
456 int agent_card_pksign (ctrl_t ctrl,
457                        const char *keyid,
458                        int (*getpin_cb)(void *, const char *, char*, size_t),
459                        void *getpin_cb_arg,
460                        int mdalgo,
461                        const unsigned char *indata, size_t indatalen,
462                        unsigned char **r_buf, size_t *r_buflen);
463 int agent_card_pkdecrypt (ctrl_t ctrl,
464                           const char *keyid,
465                           int (*getpin_cb)(void *, const char *, char*,size_t),
466                           void *getpin_cb_arg,
467                           const unsigned char *indata, size_t indatalen,
468                           char **r_buf, size_t *r_buflen, int *r_padding);
469 int agent_card_readcert (ctrl_t ctrl,
470                          const char *id, char **r_buf, size_t *r_buflen);
471 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
472 int agent_card_writekey (ctrl_t ctrl, int force, const char *serialno,
473                          const char *id, const char *keydata,
474                          size_t keydatalen,
475                          int (*getpin_cb)(void *, const char *, char*, size_t),
476                          void *getpin_cb_arg);
477 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
478 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
479                     int (*getpin_cb)(void *, const char *, char*, size_t),
480                     void *getpin_cb_arg, void *assuan_context);
481
482
483 /*-- learncard.c --*/
484 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
485
486
487 #endif /*AGENT_H*/