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