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