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