Add OPTION:cache-ttl-opt-preset to gpg-agent.
[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
38 /* To convey some special hash algorithms we use algorithm numbers
39    reserved for application use. */
40 #ifndef GCRY_MODULE_ID_USER
41 #define GCRY_MODULE_ID_USER 1024
42 #endif
43 #define MD_USER_TLS_MD5SHA1 (GCRY_MODULE_ID_USER+1)
44
45 /* Maximum length of a digest.  */
46 #define MAX_DIGEST_LEN 64
47
48
49 /* Values for the pinentry mode.  */
50 typedef enum
51   {
52     PINENTRY_MODE_ASK = 0, /* Ask via pinentry (default).  */
53     PINENTRY_MODE_CANCEL,  /* Always return a cancel error.  */
54     PINENTRY_MODE_ERROR,   /* Return error code for no pinentry.  */
55     PINENTRY_MODE_LOOPBACK,/* Use an inquiry to get the value.    */
56   }
57 pinentry_mode_t;
58
59
60 /* A large struct name "opt" to keep global flags */
61 struct
62 {
63   unsigned int debug;  /* Debug flags (DBG_foo_VALUE) */
64   int verbose;         /* Verbosity level */
65   int quiet;           /* Be as quiet as possible */
66   int dry_run;         /* Don't change any persistent data */
67   int batch;           /* Batch mode */
68   const char *homedir; /* Configuration directory name */
69
70   /* True if we are listening on the standard socket.  */
71   int use_standard_socket;
72
73   /* True if we handle sigusr2.  */
74   int sigusr2_enabled;
75
76   /* Environment setting gathered at program start or changed using the
77      Assuan command UPDATESTARTUPTTY. */
78   session_env_t startup_env;
79   char *startup_lc_ctype;
80   char *startup_lc_messages;
81
82   const char *pinentry_program; /* Filename of the program to start as
83                                    pinentry.  */
84   const char *scdaemon_program; /* Filename of the program to handle
85                                    smartcard tasks.  */
86   int disable_scdaemon;         /* Never use the SCdaemon. */
87   int no_grab;         /* Don't let the pinentry grab the keyboard */
88
89   /* The name of the file pinentry shall tocuh before exiting.  If
90      this is not set the filoe name of the standard socket is used. */
91   const char *pinentry_touch_file;
92
93   /* The default and maximum TTL of cache entries. */
94   unsigned long def_cache_ttl;     /* Default. */
95   unsigned long def_cache_ttl_ssh; /* for SSH. */
96   unsigned long max_cache_ttl;     /* Default. */
97   unsigned long max_cache_ttl_ssh; /* for SSH. */
98
99   /* Flag disallowing bypassing of the warning.  */
100   int enforce_passphrase_constraints;
101   /* The require minmum length of a passphrase. */
102   unsigned int min_passphrase_len;
103   /* The minimum number of non-alpha characters in a passphrase.  */
104   unsigned int min_passphrase_nonalpha;
105   /* File name with a patternfile or NULL if not enabled.  */
106   const char *check_passphrase_pattern;
107   /* If not 0 the user is asked to change his passphrase after these
108      number of days.  */
109   unsigned int max_passphrase_days;
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   int ignore_cache_for_signing;
117   int allow_mark_trusted;
118   int allow_preset_passphrase;
119   int allow_loopback_pinentry;
120   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
121   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
122   int ssh_support;   /* Enable ssh-agent emulation.  */
123 } opt;
124
125
126 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
127 #define DBG_MPI_VALUE     2     /* debug mpi details */
128 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
129 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
130 #define DBG_CACHE_VALUE   64    /* debug the caching */
131 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
132 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
133 #define DBG_ASSUAN_VALUE 1024
134
135 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
136 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
137 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
138 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
139 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
140 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
141
142 struct server_local_s;
143 struct scd_local_s;
144
145 /* Collection of data per session (aka connection). */
146 struct server_control_s
147 {
148   /* Private data used to fire up the connection thread.  We use this
149      structure do avoid an extra allocation for just a few bytes. */
150   struct {
151     gnupg_fd_t fd;
152   } thread_startup;
153
154   /* Private data of the server (command.c). */
155   struct server_local_s *server_local;
156
157   /* Private data of the SCdaemon (call-scd.c). */
158   struct scd_local_s *scd_local;
159
160   session_env_t session_env;
161   char *lc_ctype;
162   char *lc_messages;
163
164   /* The current pinentry mode.  */
165   pinentry_mode_t pinentry_mode;
166
167   /* The TTL used for the --preset option of certain commands.  */
168   int cache_ttl_opt_preset;
169
170   /* Information on the currently used digest (for signing commands).  */
171   struct {
172     int algo;
173     unsigned char value[MAX_DIGEST_LEN];
174     int valuelen;
175     int raw_value: 1;
176   } digest;
177   unsigned char keygrip[20];
178   int have_keygrip;
179
180   int use_auth_call; /* Hack to send the PKAUTH command instead of the
181                         PKSIGN command to the scdaemon.  */
182   int in_passwd;     /* Hack to inhibit enforced passphrase change
183                         during an explicit passwd command.  */
184 };
185
186
187 struct pin_entry_info_s
188 {
189   int min_digits; /* min. number of digits required or 0 for freeform entry */
190   int max_digits; /* max. number of allowed digits allowed*/
191   int max_tries;
192   int failed_tries;
193   int with_qualitybar; /* Set if the quality bar should be displayed.  */
194   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
195   void *check_cb_arg;  /* optional argument which might be of use in the CB */
196   const char *cb_errtext; /* used by the cb to display a specific error */
197   size_t max_length;      /* allocated length of the buffer */
198   char pin[1];
199 };
200
201
202 enum
203   {
204     PRIVATE_KEY_UNKNOWN = 0,
205     PRIVATE_KEY_CLEAR = 1,
206     PRIVATE_KEY_PROTECTED = 2,
207     PRIVATE_KEY_SHADOWED = 3,
208     PROTECTED_SHARED_SECRET = 4
209   };
210
211
212 /* Values for the cache_mode arguments. */
213 typedef enum
214   {
215     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
216     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
217     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
218     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
219     CACHE_MODE_SSH,        /* SSH related cache. */
220     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
221   }
222 cache_mode_t;
223
224 /* The TTL is seconds used for adding a new nonce mode cache item.  */
225 #define CACHE_TTL_NONCE 120
226
227 /* The TTL in seconds used by the --preset option of some commands.
228    This is the default value changeable by an OPTION command.  */
229 #define CACHE_TTL_OPT_PRESET 900
230
231
232 /* The type of a function to lookup a TTL by a keygrip.  */
233 typedef int (*lookup_ttl_t)(const char *hexgrip);
234
235
236 /*-- gpg-agent.c --*/
237 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
238 const char *get_agent_socket_name (void);
239 const char *get_agent_ssh_socket_name (void);
240 #ifdef HAVE_W32_SYSTEM
241 void *get_agent_scd_notify_event (void);
242 #endif
243 void agent_sighup_action (void);
244 int map_pk_openpgp_to_gcry (int openpgp_algo);
245
246 /*-- command.c --*/
247 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid);
248 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
249      GNUPG_GCC_A_SENTINEL(0);
250 void bump_key_eventcounter (void);
251 void bump_card_eventcounter (void);
252 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
253
254 /*-- command-ssh.c --*/
255 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
256
257 /*-- findkey.c --*/
258 int agent_write_private_key (const unsigned char *grip,
259                              const void *buffer, size_t length, int force);
260 gpg_error_t agent_key_from_file (ctrl_t ctrl,
261                                  const char *cache_nonce,
262                                  const char *desc_text,
263                                  const unsigned char *grip,
264                                  unsigned char **shadow_info,
265                                  cache_mode_t cache_mode,
266                                  lookup_ttl_t lookup_ttl,
267                                  gcry_sexp_t *result,
268                                  char **r_passphrase);
269 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
270                                         const unsigned char *grip,
271                                         gcry_sexp_t *result);
272 int agent_is_dsa_key (gcry_sexp_t s_key);
273 int agent_key_available (const unsigned char *grip);
274 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
275                                       int *r_keytype,
276                                       unsigned char **r_shadow_info);
277
278 /*-- call-pinentry.c --*/
279 void initialize_module_call_pinentry (void);
280 void agent_query_dump_state (void);
281 void agent_reset_query (ctrl_t ctrl);
282 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
283 int agent_askpin (ctrl_t ctrl,
284                   const char *desc_text, const char *prompt_text,
285                   const char *inital_errtext,
286                   struct pin_entry_info_s *pininfo);
287 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
288                           const char *desc, const char *prompt,
289                           const char *errtext, int with_qualitybar);
290 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
291                             const char *notokay, int with_cancel);
292 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
293 int agent_popup_message_start (ctrl_t ctrl,
294                                const char *desc, const char *ok_btn);
295 void agent_popup_message_stop (ctrl_t ctrl);
296
297
298 /*-- cache.c --*/
299 void initialize_module_cache (void);
300 void deinitialize_module_cache (void);
301 void agent_flush_cache (void);
302 int agent_put_cache (const char *key, cache_mode_t cache_mode,
303                      const char *data, int ttl);
304 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
305
306
307 /*-- pksign.c --*/
308 int agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
309                      const char *desc_text,
310                      gcry_sexp_t *signature_sexp,
311                      cache_mode_t cache_mode, lookup_ttl_t lookup_ttl);
312 int agent_pksign (ctrl_t ctrl, const char *cache_nonce,
313                   const char *desc_text,
314                   membuf_t *outbuf, cache_mode_t cache_mode);
315
316 /*-- pkdecrypt.c --*/
317 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
318                      const unsigned char *ciphertext, size_t ciphertextlen,
319                      membuf_t *outbuf);
320
321 /*-- genkey.c --*/
322 int check_passphrase_constraints (ctrl_t ctrl, const char *pw, int silent);
323 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
324                                       char **r_passphrase);
325 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
326                   const char *keyparam, size_t keyparmlen,
327                   int no_protection, int preset, membuf_t *outbuf);
328 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
329                                      char **passphrase_addr);
330
331 /*-- protect.c --*/
332 unsigned long get_standard_s2k_count (void);
333 int agent_protect (const unsigned char *plainkey, const char *passphrase,
334                    unsigned char **result, size_t *resultlen);
335 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
336                      gnupg_isotime_t protected_at,
337                      unsigned char **result, size_t *resultlen);
338 int agent_private_key_type (const unsigned char *privatekey);
339 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
340 int agent_shadow_key (const unsigned char *pubkey,
341                       const unsigned char *shadow_info,
342                       unsigned char **result);
343 int agent_get_shadow_info (const unsigned char *shadowkey,
344                            unsigned char const **shadow_info);
345 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
346                                char **r_hexsn, char **r_idstr);
347 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
348                                  int s2kmode,
349                                  const unsigned char *s2ksalt,
350                                  unsigned int s2kcount,
351                                  unsigned char *key, size_t keylen);
352
353
354 /*-- trustlist.c --*/
355 void initialize_module_trustlist (void);
356 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
357 gpg_error_t agent_listtrusted (void *assuan_context);
358 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
359                                const char *fpr, int flag);
360 void agent_reload_trustlist (void);
361
362
363 /*-- divert-scd.c --*/
364 int divert_pksign (ctrl_t ctrl,
365                    const unsigned char *digest, size_t digestlen, int algo,
366                    const unsigned char *shadow_info, unsigned char **r_sig);
367 int divert_pkdecrypt (ctrl_t ctrl,
368                       const unsigned char *cipher,
369                       const unsigned char *shadow_info,
370                       char **r_buf, size_t *r_len);
371 int divert_generic_cmd (ctrl_t ctrl,
372                         const char *cmdline, void *assuan_context);
373
374
375 /*-- call-scd.c --*/
376 void initialize_module_call_scd (void);
377 void agent_scd_dump_state (void);
378 int agent_scd_check_running (void);
379 void agent_scd_check_aliveness (void);
380 int agent_reset_scd (ctrl_t ctrl);
381 int agent_card_learn (ctrl_t ctrl,
382                       void (*kpinfo_cb)(void*, const char *),
383                       void *kpinfo_cb_arg,
384                       void (*certinfo_cb)(void*, const char *),
385                       void *certinfo_cb_arg,
386                       void (*sinfo_cb)(void*, const char *,
387                                        size_t, const char *),
388                       void *sinfo_cb_arg);
389 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
390 int agent_card_pksign (ctrl_t ctrl,
391                        const char *keyid,
392                        int (*getpin_cb)(void *, const char *, char*, size_t),
393                        void *getpin_cb_arg,
394                        int mdalgo,
395                        const unsigned char *indata, size_t indatalen,
396                        unsigned char **r_buf, size_t *r_buflen);
397 int agent_card_pkdecrypt (ctrl_t ctrl,
398                           const char *keyid,
399                           int (*getpin_cb)(void *, const char *, char*,size_t),
400                           void *getpin_cb_arg,
401                           const unsigned char *indata, size_t indatalen,
402                           char **r_buf, size_t *r_buflen);
403 int agent_card_readcert (ctrl_t ctrl,
404                          const char *id, char **r_buf, size_t *r_buflen);
405 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
406 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
407 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
408                     int (*getpin_cb)(void *, const char *, char*, size_t),
409                     void *getpin_cb_arg, void *assuan_context);
410
411
412 /*-- learncard.c --*/
413 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
414
415
416 #endif /*AGENT_H*/