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