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