agent: When the password cache is cleared, also clear the ext. cache.
[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 handle sigusr2.  */
62   int sigusr2_enabled;
63
64   /* Environment settings gathered at program start or changed using the
65      Assuan command UPDATESTARTUPTTY. */
66   session_env_t startup_env;
67   char *startup_lc_ctype;
68   char *startup_lc_messages;
69
70   /* Enable pinentry debugging (--debug 1024 should also be used).  */
71   int debug_pinentry;
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   /* Allow the use of an external password cache.  If this option is
132      enabled (which is the default) we send an option to Pinentry
133      to allow it to enable such a cache.  */
134   int allow_external_cache;
135
136   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
137   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
138
139   /* This global option enables the ssh-agent subsystem.  */
140   int ssh_support;
141
142   /* This global options indicates the use of an extra socket. Note
143      that we use a hack for cleanup handling in gpg-agent.c: If the
144      value is less than 2 the name has not yet been malloced. */
145   int extra_socket;
146 } opt;
147
148
149 /* Bit values for the --debug option.  */
150 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
151 #define DBG_MPI_VALUE     2     /* debug mpi details */
152 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
153 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
154 #define DBG_CACHE_VALUE   64    /* debug the caching */
155 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
156 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
157 #define DBG_IPC_VALUE     1024  /* Enable Assuan debugging.  */
158
159 /* Test macros for the debug option.  */
160 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
161 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
162 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
163 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
164 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
165 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
166
167 /* Forward reference for local definitions in command.c.  */
168 struct server_local_s;
169
170 /* Declaration of objects from command-ssh.c.  */
171 struct ssh_control_file_s;
172 typedef struct ssh_control_file_s *ssh_control_file_t;
173
174 /* Forward reference for local definitions in call-scd.c.  */
175 struct scd_local_s;
176
177 /* Collection of data per session (aka connection). */
178 struct server_control_s
179 {
180   /* Private data used to fire up the connection thread.  We use this
181      structure do avoid an extra allocation for only a few bytes while
182      spawning a new connection thread.  */
183   struct {
184     gnupg_fd_t fd;
185   } thread_startup;
186
187   /* Flag indicating the connection is run in restricted mode.  */
188   int restricted;
189
190   /* Private data of the server (command.c). */
191   struct server_local_s *server_local;
192
193   /* Private data of the SCdaemon (call-scd.c). */
194   struct scd_local_s *scd_local;
195
196   /* Environment settings for the connection.  */
197   session_env_t session_env;
198   char *lc_ctype;
199   char *lc_messages;
200
201   /* The current pinentry mode.  */
202   pinentry_mode_t pinentry_mode;
203
204   /* The TTL used for the --preset option of certain commands.  */
205   int cache_ttl_opt_preset;
206
207   /* Information on the currently used digest (for signing commands).  */
208   struct {
209     int algo;
210     unsigned char value[MAX_DIGEST_LEN];
211     int valuelen;
212     int raw_value: 1;
213   } digest;
214   unsigned char keygrip[20];
215   int have_keygrip;
216
217   /* A flag to enable a hack to send the PKAUTH command instead of the
218      PKSIGN command to the scdaemon.  */
219   int use_auth_call;
220
221   /* A flag to inhibit enforced passphrase change during an explicit
222      passwd command.  */
223   int in_passwd;
224
225   /* The current S2K which might be different from the calibrated
226      count. */
227   unsigned long s2k_count;
228 };
229
230
231 /* Information pertaining to pinentry requests.  */
232 struct pin_entry_info_s
233 {
234   int min_digits; /* min. number of digits required or 0 for freeform entry */
235   int max_digits; /* max. number of allowed digits allowed*/
236   int max_tries;  /* max. number of allowed tries.  */
237   int failed_tries; /* Number of tries so far failed.  */
238   int with_qualitybar; /* Set if the quality bar should be displayed.  */
239   int with_repeat;  /* Request repetition of the passphrase.  */
240   int repeat_okay;  /* Repetition worked. */
241   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
242   void *check_cb_arg;  /* optional argument which might be of use in the CB */
243   const char *cb_errtext; /* used by the cb to display a specific error */
244   size_t max_length;   /* Allocated length of the buffer PIN. */
245   char pin[1];         /* The buffer to hold the PIN or passphrase.
246                           It's actual allocated length is given by
247                           MAX_LENGTH (above).  */
248 };
249
250
251 /* Types of the private keys.  */
252 enum
253   {
254     PRIVATE_KEY_UNKNOWN = 0,      /* Type of key is not known.  */
255     PRIVATE_KEY_CLEAR = 1,        /* The key is not protected.  */
256     PRIVATE_KEY_PROTECTED = 2,    /* The key is protected.  */
257     PRIVATE_KEY_SHADOWED = 3,     /* The key is a stub for a smartcard
258                                      based key.  */
259     PROTECTED_SHARED_SECRET = 4,  /* RFU.  */
260     PRIVATE_KEY_OPENPGP_NONE = 5  /* openpgp-native with protection "none". */
261   };
262
263
264 /* Values for the cache_mode arguments. */
265 typedef enum
266   {
267     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
268     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
269     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
270     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
271     CACHE_MODE_SSH,        /* SSH related cache. */
272     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
273   }
274 cache_mode_t;
275
276 /* The TTL is seconds used for adding a new nonce mode cache item.  */
277 #define CACHE_TTL_NONCE 120
278
279 /* The TTL in seconds used by the --preset option of some commands.
280    This is the default value changeable by an OPTION command.  */
281 #define CACHE_TTL_OPT_PRESET 900
282
283
284 /* The type of a function to lookup a TTL by a keygrip.  */
285 typedef int (*lookup_ttl_t)(const char *hexgrip);
286
287
288 /*-- gpg-agent.c --*/
289 void agent_exit (int rc) GPGRT_GCC_A_NR; /* Also implemented in other tools */
290 gpg_error_t agent_copy_startup_env (ctrl_t ctrl);
291 const char *get_agent_socket_name (void);
292 const char *get_agent_ssh_socket_name (void);
293 #ifdef HAVE_W32_SYSTEM
294 void *get_agent_scd_notify_event (void);
295 #endif
296 void agent_sighup_action (void);
297 int map_pk_openpgp_to_gcry (int openpgp_algo);
298
299 /*-- command.c --*/
300 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid);
301 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
302      GNUPG_GCC_A_SENTINEL(0);
303 gpg_error_t agent_print_status (ctrl_t ctrl, const char *keyword,
304                                 const char *format, ...)
305      GPGRT_GCC_A_PRINTF(3,4);
306 void bump_key_eventcounter (void);
307 void bump_card_eventcounter (void);
308 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
309 gpg_error_t pinentry_loopback (ctrl_t, const char *keyword,
310                                unsigned char **buffer, size_t *size,
311                                size_t max_length);
312
313 #ifdef HAVE_W32_SYSTEM
314 int serve_mmapped_ssh_request (ctrl_t ctrl,
315                                unsigned char *request, size_t maxreqlen);
316 #endif /*HAVE_W32_SYSTEM*/
317
318 /*-- command-ssh.c --*/
319 ssh_control_file_t ssh_open_control_file (void);
320 void ssh_close_control_file (ssh_control_file_t cf);
321 gpg_error_t ssh_read_control_file (ssh_control_file_t cf,
322                                    char *r_hexgrip, int *r_disabled,
323                                    int *r_ttl, int *r_confirm);
324 gpg_error_t ssh_search_control_file (ssh_control_file_t cf,
325                                      const char *hexgrip,
326                                      int *r_disabled,
327                                      int *r_ttl, int *r_confirm);
328
329 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
330
331 /*-- findkey.c --*/
332 int agent_write_private_key (const unsigned char *grip,
333                              const void *buffer, size_t length, int force);
334 gpg_error_t agent_key_from_file (ctrl_t ctrl,
335                                  const char *cache_nonce,
336                                  const char *desc_text,
337                                  const unsigned char *grip,
338                                  unsigned char **shadow_info,
339                                  cache_mode_t cache_mode,
340                                  lookup_ttl_t lookup_ttl,
341                                  gcry_sexp_t *result,
342                                  char **r_passphrase);
343 gpg_error_t agent_raw_key_from_file (ctrl_t ctrl, const unsigned char *grip,
344                                      gcry_sexp_t *result);
345 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
346                                         const unsigned char *grip,
347                                         gcry_sexp_t *result);
348 int agent_is_dsa_key (gcry_sexp_t s_key);
349 int agent_is_eddsa_key (gcry_sexp_t s_key);
350 int agent_key_available (const unsigned char *grip);
351 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
352                                       int *r_keytype,
353                                       unsigned char **r_shadow_info);
354 gpg_error_t agent_delete_key (ctrl_t ctrl, const char *desc_text,
355                               const unsigned char *grip);
356
357 /*-- call-pinentry.c --*/
358 void initialize_module_call_pinentry (void);
359 void agent_query_dump_state (void);
360 void agent_reset_query (ctrl_t ctrl);
361 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
362 int agent_askpin (ctrl_t ctrl,
363                   const char *desc_text, const char *prompt_text,
364                   const char *inital_errtext,
365                   struct pin_entry_info_s *pininfo,
366                   const char *keyinfo, cache_mode_t cache_mode);
367 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
368                           const char *desc, const char *prompt,
369                           const char *errtext, int with_qualitybar,
370                           const char *keyinfo, cache_mode_t cache_mode);
371 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
372                             const char *notokay, int with_cancel);
373 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
374 int agent_popup_message_start (ctrl_t ctrl,
375                                const char *desc, const char *ok_btn);
376 void agent_popup_message_stop (ctrl_t ctrl);
377 int agent_clear_passphrase (ctrl_t ctrl,
378                             const char *keyinfo, cache_mode_t cache_mode);
379
380 /*-- cache.c --*/
381 void initialize_module_cache (void);
382 void deinitialize_module_cache (void);
383 void agent_flush_cache (void);
384 int agent_put_cache (const char *key, cache_mode_t cache_mode,
385                      const char *data, int ttl);
386 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
387 void agent_store_cache_hit (const char *key);
388
389
390 /*-- pksign.c --*/
391 int agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
392                      const char *desc_text,
393                      gcry_sexp_t *signature_sexp,
394                      cache_mode_t cache_mode, lookup_ttl_t lookup_ttl,
395                      const void *overridedata, size_t overridedatalen);
396 int agent_pksign (ctrl_t ctrl, const char *cache_nonce,
397                   const char *desc_text,
398                   membuf_t *outbuf, cache_mode_t cache_mode);
399
400 /*-- pkdecrypt.c --*/
401 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
402                      const unsigned char *ciphertext, size_t ciphertextlen,
403                      membuf_t *outbuf, int *r_padding);
404
405 /*-- genkey.c --*/
406 int check_passphrase_constraints (ctrl_t ctrl, const char *pw, int silent);
407 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
408                                       char **r_passphrase);
409 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
410                   const char *keyparam, size_t keyparmlen,
411                   int no_protection, const char *override_passphrase,
412                   int preset, membuf_t *outbuf);
413 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
414                                      char **passphrase_addr);
415
416 /*-- protect.c --*/
417 unsigned long get_standard_s2k_count (void);
418 unsigned char get_standard_s2k_count_rfc4880 (void);
419 int agent_protect (const unsigned char *plainkey, const char *passphrase,
420                    unsigned char **result, size_t *resultlen,
421                    unsigned long s2k_count);
422 int agent_unprotect (ctrl_t ctrl,
423                      const unsigned char *protectedkey, const char *passphrase,
424                      gnupg_isotime_t protected_at,
425                      unsigned char **result, size_t *resultlen);
426 int agent_private_key_type (const unsigned char *privatekey);
427 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
428 int agent_shadow_key (const unsigned char *pubkey,
429                       const unsigned char *shadow_info,
430                       unsigned char **result);
431 int agent_get_shadow_info (const unsigned char *shadowkey,
432                            unsigned char const **shadow_info);
433 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
434                                char **r_hexsn, char **r_idstr, int *r_pinlen);
435 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
436                                  int s2kmode,
437                                  const unsigned char *s2ksalt,
438                                  unsigned int s2kcount,
439                                  unsigned char *key, size_t keylen);
440
441
442 /*-- trustlist.c --*/
443 void initialize_module_trustlist (void);
444 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
445 gpg_error_t agent_listtrusted (void *assuan_context);
446 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
447                                const char *fpr, int flag);
448 void agent_reload_trustlist (void);
449
450
451 /*-- divert-scd.c --*/
452 int divert_pksign (ctrl_t ctrl,
453                    const unsigned char *digest, size_t digestlen, int algo,
454                    const unsigned char *shadow_info, unsigned char **r_sig,
455                    size_t *r_siglen);
456 int divert_pkdecrypt (ctrl_t ctrl,
457                       const unsigned char *cipher,
458                       const unsigned char *shadow_info,
459                       char **r_buf, size_t *r_len, int *r_padding);
460 int divert_generic_cmd (ctrl_t ctrl,
461                         const char *cmdline, void *assuan_context);
462 int divert_writekey (ctrl_t ctrl, int force, const char *serialno,
463                      const char *id, const char *keydata, size_t keydatalen);
464
465
466 /*-- call-scd.c --*/
467 void initialize_module_call_scd (void);
468 void agent_scd_dump_state (void);
469 int agent_scd_check_running (void);
470 void agent_scd_check_aliveness (void);
471 int agent_reset_scd (ctrl_t ctrl);
472 int agent_card_learn (ctrl_t ctrl,
473                       void (*kpinfo_cb)(void*, const char *),
474                       void *kpinfo_cb_arg,
475                       void (*certinfo_cb)(void*, const char *),
476                       void *certinfo_cb_arg,
477                       void (*sinfo_cb)(void*, const char *,
478                                        size_t, const char *),
479                       void *sinfo_cb_arg);
480 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
481 int agent_card_pksign (ctrl_t ctrl,
482                        const char *keyid,
483                        int (*getpin_cb)(void *, const char *, char*, size_t),
484                        void *getpin_cb_arg,
485                        int mdalgo,
486                        const unsigned char *indata, size_t indatalen,
487                        unsigned char **r_buf, size_t *r_buflen);
488 int agent_card_pkdecrypt (ctrl_t ctrl,
489                           const char *keyid,
490                           int (*getpin_cb)(void *, const char *, char*,size_t),
491                           void *getpin_cb_arg,
492                           const unsigned char *indata, size_t indatalen,
493                           char **r_buf, size_t *r_buflen, int *r_padding);
494 int agent_card_readcert (ctrl_t ctrl,
495                          const char *id, char **r_buf, size_t *r_buflen);
496 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
497 int agent_card_writekey (ctrl_t ctrl, int force, const char *serialno,
498                          const char *id, const char *keydata,
499                          size_t keydatalen,
500                          int (*getpin_cb)(void *, const char *, char*, size_t),
501                          void *getpin_cb_arg);
502 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
503 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
504                     int (*getpin_cb)(void *, const char *, char*, size_t),
505                     void *getpin_cb_arg, void *assuan_context);
506
507
508 /*-- learncard.c --*/
509 int agent_handle_learn (ctrl_t ctrl, int send, void *assuan_context, int force);
510
511
512 /*-- cvt-openpgp.c --*/
513 gpg_error_t
514 extract_private_key (gcry_sexp_t s_key, int req_private_key_data,
515                      const char **r_algoname, int *r_npkey, int *r_nskey,
516                      const char **r_format,
517                      gcry_mpi_t *mpi_array, int arraysize,
518                      gcry_sexp_t *r_curve, gcry_sexp_t *r_flags);
519
520 #endif /*AGENT_H*/