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