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