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