Fix last change.
[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 settings 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   /* Filename of the program to start as pinentry.  */
83   const char *pinentry_program;
84
85   /* Filename of the program to handle smartcard tasks.  */
86   const char *scdaemon_program;
87
88   int disable_scdaemon;         /* Never use the SCdaemon. */
89
90   int no_grab;         /* Don't let the pinentry grab the keyboard */
91
92   /* The name of the file pinentry shall tocuh before exiting.  If
93      this is not set the filoe name of the standard socket is used. */
94   const char *pinentry_touch_file;
95
96   /* The default and maximum TTL of cache entries. */
97   unsigned long def_cache_ttl;     /* Default. */
98   unsigned long def_cache_ttl_ssh; /* for SSH. */
99   unsigned long max_cache_ttl;     /* Default. */
100   unsigned long max_cache_ttl_ssh; /* for SSH. */
101
102   /* Flag disallowing bypassing of the warning.  */
103   int enforce_passphrase_constraints;
104
105   /* The require minmum length of a passphrase. */
106   unsigned int min_passphrase_len;
107
108   /* The minimum number of non-alpha characters in a passphrase.  */
109   unsigned int min_passphrase_nonalpha;
110
111   /* File name with a patternfile or NULL if not enabled.  */
112   const char *check_passphrase_pattern;
113
114   /* If not 0 the user is asked to change his passphrase after these
115      number of days.  */
116   unsigned int max_passphrase_days;
117
118   /* If set, a passphrase history will be written and checked at each
119      passphrase change.  */
120   int enable_passhrase_history;
121
122   int running_detached; /* We are running detached from the tty. */
123
124   /* If this global option is true, the passphrase cache is ignored
125      for signing operations.  */
126   int ignore_cache_for_signing;
127
128   /* If this global option is true, the user is allowed to
129      interactively mark certificate in trustlist.txt as trusted. */
130   int allow_mark_trusted;
131
132   /* If this global option is true, the Assuan command
133      PRESET_PASSPHRASE is allowed.  */
134   int allow_preset_passphrase;
135
136   /* If this global option is true, the Assuan option
137      pinentry-mode=loopback is allowed.  */
138   int allow_loopback_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 } opt;
146
147
148 /* Bit values for the --debug option.  */
149 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
150 #define DBG_MPI_VALUE     2     /* debug mpi details */
151 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
152 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
153 #define DBG_CACHE_VALUE   64    /* debug the caching */
154 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
155 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
156 #define DBG_ASSUAN_VALUE 1024   /* Enable Assuan debugging.  */
157
158 /* Test macros for the debug option.  */
159 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
160 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
161 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
162 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
163 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
164 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
165
166 /* Forward reference for local definitions in command.c.  */
167 struct server_local_s;
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   /* 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 (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
232   void *check_cb_arg;  /* optional argument which might be of use in the CB */
233   const char *cb_errtext; /* used by the cb to display a specific error */
234   size_t max_length;   /* Allocated length of the buffer PIN. */
235   char pin[1];         /* The buffer to hold the PIN or passphrase.
236                           It's actual allocated length is given by
237                           MAX_LENGTH (above).  */
238 };
239
240
241 /* Types of the private keys.  */
242 enum
243   {
244     PRIVATE_KEY_UNKNOWN = 0,      /* Type of key is not known.  */
245     PRIVATE_KEY_CLEAR = 1,        /* The key is not protected.  */
246     PRIVATE_KEY_PROTECTED = 2,    /* The key is protected.  */
247     PRIVATE_KEY_SHADOWED = 3,     /* The key is a stub for a smartcard
248                                      based key.  */
249     PROTECTED_SHARED_SECRET = 4   /* RFU.  */
250   };
251
252
253 /* Values for the cache_mode arguments. */
254 typedef enum
255   {
256     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
257     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
258     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
259     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
260     CACHE_MODE_SSH,        /* SSH related cache. */
261     CACHE_MODE_NONCE       /* This is a non-predictable nonce.  */
262   }
263 cache_mode_t;
264
265 /* The TTL is seconds used for adding a new nonce mode cache item.  */
266 #define CACHE_TTL_NONCE 120
267
268 /* The TTL in seconds used by the --preset option of some commands.
269    This is the default value changeable by an OPTION command.  */
270 #define CACHE_TTL_OPT_PRESET 900
271
272
273 /* The type of a function to lookup a TTL by a keygrip.  */
274 typedef int (*lookup_ttl_t)(const char *hexgrip);
275
276
277 /*-- gpg-agent.c --*/
278 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
279 const char *get_agent_socket_name (void);
280 const char *get_agent_ssh_socket_name (void);
281 #ifdef HAVE_W32_SYSTEM
282 void *get_agent_scd_notify_event (void);
283 #endif
284 void agent_sighup_action (void);
285 int map_pk_openpgp_to_gcry (int openpgp_algo);
286
287 /*-- command.c --*/
288 gpg_error_t agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid);
289 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...)
290      GNUPG_GCC_A_SENTINEL(0);
291 void bump_key_eventcounter (void);
292 void bump_card_eventcounter (void);
293 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
294 gpg_error_t pinentry_loopback(ctrl_t, const char *keyword,
295                               unsigned char **buffer, size_t *size,
296                               size_t max_length);
297
298 /*-- command-ssh.c --*/
299 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
300
301 /*-- findkey.c --*/
302 int agent_write_private_key (const unsigned char *grip,
303                              const void *buffer, size_t length, int force);
304 gpg_error_t agent_key_from_file (ctrl_t ctrl,
305                                  const char *cache_nonce,
306                                  const char *desc_text,
307                                  const unsigned char *grip,
308                                  unsigned char **shadow_info,
309                                  cache_mode_t cache_mode,
310                                  lookup_ttl_t lookup_ttl,
311                                  gcry_sexp_t *result,
312                                  char **r_passphrase);
313 gpg_error_t agent_raw_key_from_file (ctrl_t ctrl, const unsigned char *grip,
314                                      gcry_sexp_t *result);
315 gpg_error_t agent_public_key_from_file (ctrl_t ctrl,
316                                         const unsigned char *grip,
317                                         gcry_sexp_t *result);
318 int agent_is_dsa_key (gcry_sexp_t s_key);
319 int agent_key_available (const unsigned char *grip);
320 gpg_error_t agent_key_info_from_file (ctrl_t ctrl, const unsigned char *grip,
321                                       int *r_keytype,
322                                       unsigned char **r_shadow_info);
323
324 /*-- call-pinentry.c --*/
325 void initialize_module_call_pinentry (void);
326 void agent_query_dump_state (void);
327 void agent_reset_query (ctrl_t ctrl);
328 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
329 int agent_askpin (ctrl_t ctrl,
330                   const char *desc_text, const char *prompt_text,
331                   const char *inital_errtext,
332                   struct pin_entry_info_s *pininfo);
333 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
334                           const char *desc, const char *prompt,
335                           const char *errtext, int with_qualitybar);
336 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
337                             const char *notokay, int with_cancel);
338 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
339 int agent_popup_message_start (ctrl_t ctrl,
340                                const char *desc, const char *ok_btn);
341 void agent_popup_message_stop (ctrl_t ctrl);
342
343
344 /*-- cache.c --*/
345 void initialize_module_cache (void);
346 void deinitialize_module_cache (void);
347 void agent_flush_cache (void);
348 int agent_put_cache (const char *key, cache_mode_t cache_mode,
349                      const char *data, int ttl);
350 char *agent_get_cache (const char *key, cache_mode_t cache_mode);
351
352
353 /*-- pksign.c --*/
354 int agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
355                      const char *desc_text,
356                      gcry_sexp_t *signature_sexp,
357                      cache_mode_t cache_mode, lookup_ttl_t lookup_ttl);
358 int agent_pksign (ctrl_t ctrl, const char *cache_nonce,
359                   const char *desc_text,
360                   membuf_t *outbuf, cache_mode_t cache_mode);
361
362 /*-- pkdecrypt.c --*/
363 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
364                      const unsigned char *ciphertext, size_t ciphertextlen,
365                      membuf_t *outbuf);
366
367 /*-- genkey.c --*/
368 int check_passphrase_constraints (ctrl_t ctrl, const char *pw, int silent);
369 gpg_error_t agent_ask_new_passphrase (ctrl_t ctrl, const char *prompt,
370                                       char **r_passphrase);
371 int agent_genkey (ctrl_t ctrl, const char *cache_nonce,
372                   const char *keyparam, size_t keyparmlen,
373                   int no_protection, int preset, membuf_t *outbuf);
374 gpg_error_t agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey,
375                                      char **passphrase_addr);
376
377 /*-- protect.c --*/
378 unsigned long get_standard_s2k_count (void);
379 unsigned char get_standard_s2k_count_rfc4880 (void);
380 int agent_protect (const unsigned char *plainkey, const char *passphrase,
381                    unsigned char **result, size_t *resultlen,
382                    unsigned long s2k_count);
383 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
384                      gnupg_isotime_t protected_at,
385                      unsigned char **result, size_t *resultlen);
386 int agent_private_key_type (const unsigned char *privatekey);
387 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
388 int agent_shadow_key (const unsigned char *pubkey,
389                       const unsigned char *shadow_info,
390                       unsigned char **result);
391 int agent_get_shadow_info (const unsigned char *shadowkey,
392                            unsigned char const **shadow_info);
393 gpg_error_t parse_shadow_info (const unsigned char *shadow_info,
394                                char **r_hexsn, char **r_idstr);
395 gpg_error_t s2k_hash_passphrase (const char *passphrase, int hashalgo,
396                                  int s2kmode,
397                                  const unsigned char *s2ksalt,
398                                  unsigned int s2kcount,
399                                  unsigned char *key, size_t keylen);
400
401
402 /*-- trustlist.c --*/
403 void initialize_module_trustlist (void);
404 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr, int *r_disabled);
405 gpg_error_t agent_listtrusted (void *assuan_context);
406 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
407                                const char *fpr, int flag);
408 void agent_reload_trustlist (void);
409
410
411 /*-- divert-scd.c --*/
412 int divert_pksign (ctrl_t ctrl,
413                    const unsigned char *digest, size_t digestlen, int algo,
414                    const unsigned char *shadow_info, unsigned char **r_sig);
415 int divert_pkdecrypt (ctrl_t ctrl,
416                       const unsigned char *cipher,
417                       const unsigned char *shadow_info,
418                       char **r_buf, size_t *r_len);
419 int divert_generic_cmd (ctrl_t ctrl,
420                         const char *cmdline, void *assuan_context);
421
422
423 /*-- call-scd.c --*/
424 void initialize_module_call_scd (void);
425 void agent_scd_dump_state (void);
426 int agent_scd_check_running (void);
427 void agent_scd_check_aliveness (void);
428 int agent_reset_scd (ctrl_t ctrl);
429 int agent_card_learn (ctrl_t ctrl,
430                       void (*kpinfo_cb)(void*, const char *),
431                       void *kpinfo_cb_arg,
432                       void (*certinfo_cb)(void*, const char *),
433                       void *certinfo_cb_arg,
434                       void (*sinfo_cb)(void*, const char *,
435                                        size_t, const char *),
436                       void *sinfo_cb_arg);
437 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
438 int agent_card_pksign (ctrl_t ctrl,
439                        const char *keyid,
440                        int (*getpin_cb)(void *, const char *, char*, size_t),
441                        void *getpin_cb_arg,
442                        int mdalgo,
443                        const unsigned char *indata, size_t indatalen,
444                        unsigned char **r_buf, size_t *r_buflen);
445 int agent_card_pkdecrypt (ctrl_t ctrl,
446                           const char *keyid,
447                           int (*getpin_cb)(void *, const char *, char*,size_t),
448                           void *getpin_cb_arg,
449                           const unsigned char *indata, size_t indatalen,
450                           char **r_buf, size_t *r_buflen);
451 int agent_card_readcert (ctrl_t ctrl,
452                          const char *id, char **r_buf, size_t *r_buflen);
453 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
454 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
455 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
456                     int (*getpin_cb)(void *, const char *, char*, size_t),
457                     void *getpin_cb_arg, void *assuan_context);
458
459
460 /*-- learncard.c --*/
461 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
462
463
464 #endif /*AGENT_H*/