A bunch of minor changes for Windows.
[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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef AGENT_H
23 #define AGENT_H
24
25 #ifdef GPG_ERR_SOURCE_DEFAULT
26 #error GPG_ERR_SOURCE_DEFAULT already defined
27 #endif
28 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGAGENT
29 #include <gpg-error.h>
30 #define map_assuan_err(a) \
31         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
32 #include <errno.h>
33
34 #include <gcrypt.h>
35 #include "../common/util.h"
36 #include "../common/errors.h"
37 #include "membuf.h"
38
39 /* To convey some special hash algorithms we use algorithm numbers
40    reserved for application use. */
41 #ifndef GCRY_MD_USER
42 #define GCRY_MD_USER 1024
43 #endif
44 #define GCRY_MD_USER_TLS_MD5SHA1 (GCRY_MD_USER+1)
45
46 /* Maximum length of a digest.  */
47 #define MAX_DIGEST_LEN 36
48
49 /* A large struct name "opt" to keep global flags */
50 struct
51 {
52   unsigned int debug;  /* Debug flags (DBG_foo_VALUE) */
53   int verbose;         /* Verbosity level */
54   int quiet;           /* Be as quiet as possible */
55   int dry_run;         /* Don't change any persistent data */
56   int batch;           /* Batch mode */
57   const char *homedir; /* Configuration directory name */
58
59   /* Environment setting gathered at program start or changed using the
60      Assuan command UPDATESTARTUPTTY. */
61   char *startup_display;
62   char *startup_ttyname;
63   char *startup_ttytype;
64   char *startup_lc_ctype;
65   char *startup_lc_messages;
66
67
68   const char *pinentry_program; /* Filename of the program to start as
69                                    pinentry.  */
70   const char *scdaemon_program; /* Filename of the program to handle
71                                    smartcard tasks.  */
72   int disable_scdaemon;         /* Never use the SCdaemon. */
73   int no_grab;         /* Don't let the pinentry grab the keyboard */
74
75   /* The name of the file pinentry shall tocuh before exiting.  If
76      this is not set the filoe name of the standard socket is used. */
77   const char *pinentry_touch_file;
78
79   /* The default and maximum TTL of cache entries. */
80   unsigned long def_cache_ttl;     /* Default. */
81   unsigned long def_cache_ttl_ssh; /* for SSH. */
82   unsigned long max_cache_ttl;     /* Default. */
83   unsigned long max_cache_ttl_ssh; /* for SSH. */
84
85   /* The require minmum length of a passphrase. */
86   unsigned int min_passphrase_len;
87
88   int running_detached; /* We are running detached from the tty. */
89
90   int ignore_cache_for_signing;
91   int allow_mark_trusted;
92   int allow_preset_passphrase;
93   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
94   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
95   int ssh_support;   /* Enable ssh-agent emulation.  */
96 } opt;
97
98
99 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
100 #define DBG_MPI_VALUE     2     /* debug mpi details */
101 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
102 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
103 #define DBG_CACHE_VALUE   64    /* debug the caching */
104 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
105 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
106 #define DBG_ASSUAN_VALUE 1024   
107
108 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
109 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
110 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
111 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
112 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
113 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
114
115 struct server_local_s;
116 struct scd_local_s;
117
118 /* Collection of data per session (aka connection). */
119 struct server_control_s 
120 {
121   /* Private data used to fire up the connection thread.  We use this
122      structure do avoid an extra allocation for just a few bytes. */
123   struct {
124     int fd;
125   } thread_startup;
126   
127   /* Private data of the server (command.c). */
128   struct server_local_s *server_local;
129
130   /* Private data of the SCdaemon (call-scd.c). */
131   struct scd_local_s *scd_local;
132
133   int   connection_fd; /* -1 or an identifier for the current connection. */
134
135   char *display;
136   char *ttyname;
137   char *ttytype;
138   char *lc_ctype;
139   char *lc_messages;
140   struct {
141     int algo;
142     unsigned char value[MAX_DIGEST_LEN];
143     int valuelen;
144     int raw_value: 1;
145   } digest;
146   unsigned char keygrip[20];
147   int have_keygrip;
148
149   int use_auth_call; /* Hack to send the PKAUTH command instead of the
150                         PKSIGN command to the scdaemon.  */
151 };
152
153
154 struct pin_entry_info_s 
155 {
156   int min_digits; /* min. number of digits required or 0 for freeform entry */
157   int max_digits; /* max. number of allowed digits allowed*/
158   int max_tries;
159   int failed_tries;
160   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
161   void *check_cb_arg;  /* optional argument which might be of use in the CB */
162   const char *cb_errtext; /* used by the cb to displaye a specific error */
163   size_t max_length; /* allocated length of the buffer */
164   char pin[1];
165 };
166
167
168 enum 
169   {
170     PRIVATE_KEY_UNKNOWN = 0,
171     PRIVATE_KEY_CLEAR = 1,
172     PRIVATE_KEY_PROTECTED = 2,
173     PRIVATE_KEY_SHADOWED = 3
174   };
175
176
177 /* Values for the cache_mode arguments. */
178 typedef enum 
179   {
180     CACHE_MODE_IGNORE = 0, /* Special mode to by pass the cache. */
181     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
182     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
183     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
184     CACHE_MODE_SSH         /* SSH related cache. */
185   }
186 cache_mode_t;
187
188
189 /*-- gpg-agent.c --*/
190 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
191 const char *get_agent_socket_name (void);
192 const char *get_agent_ssh_socket_name (void);
193 void agent_sighup_action (void);
194
195 /*-- command.c --*/
196 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...);
197 void bump_key_eventcounter (void);
198 void bump_card_eventcounter (void);
199 void start_command_handler (ctrl_t, int, int);
200
201 /*-- command-ssh.c --*/
202 void start_command_handler_ssh (ctrl_t, int);
203
204 /*-- findkey.c --*/
205 int agent_write_private_key (const unsigned char *grip,
206                              const void *buffer, size_t length, int force);
207 gpg_error_t agent_key_from_file (ctrl_t ctrl, 
208                                  const char *desc_text,
209                                  const unsigned char *grip,
210                                  unsigned char **shadow_info,
211                                  cache_mode_t cache_mode,
212                                  gcry_sexp_t *result);
213 gpg_error_t agent_public_key_from_file (ctrl_t ctrl, 
214                                         const unsigned char *grip,
215                                         gcry_sexp_t *result);
216 int agent_key_available (const unsigned char *grip);
217
218 /*-- call-pinentry.c --*/
219 void initialize_module_call_pinentry (void);
220 void agent_query_dump_state (void);
221 void agent_reset_query (ctrl_t ctrl);
222 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
223 int agent_askpin (ctrl_t ctrl,
224                   const char *desc_text, const char *prompt_text,
225                   const char *inital_errtext,
226                   struct pin_entry_info_s *pininfo);
227 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
228                           const char *desc, const char *prompt,
229                           const char *errtext);
230 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
231                             const char *cancel);
232 int agent_popup_message_start (ctrl_t ctrl,
233                                const char *desc, const char *ok_btn);
234 void agent_popup_message_stop (ctrl_t ctrl);
235
236
237 /*-- cache.c --*/
238 void agent_flush_cache (void);
239 int agent_put_cache (const char *key, cache_mode_t cache_mode,
240                      const char *data, int ttl);
241 const char *agent_get_cache (const char *key, cache_mode_t cache_mode,
242                              void **cache_id);
243 void agent_unlock_cache_entry (void **cache_id);
244
245
246 /*-- pksign.c --*/
247 int agent_pksign_do (ctrl_t ctrl, const char *desc_text,
248                      gcry_sexp_t *signature_sexp,
249                      cache_mode_t cache_mode);
250 int agent_pksign (ctrl_t ctrl, const char *desc_text,
251                   membuf_t *outbuf, cache_mode_t cache_mode);
252
253 /*-- pkdecrypt.c --*/
254 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
255                      const unsigned char *ciphertext, size_t ciphertextlen,
256                      membuf_t *outbuf);
257
258 /*-- genkey.c --*/
259 int check_passphrase_constraints (ctrl_t ctrl, const char *pw);
260 int agent_genkey (ctrl_t ctrl, 
261                   const char *keyparam, size_t keyparmlen, membuf_t *outbuf);
262 int agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey);
263
264 /*-- protect.c --*/
265 int agent_protect (const unsigned char *plainkey, const char *passphrase,
266                    unsigned char **result, size_t *resultlen);
267 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
268                      unsigned char **result, size_t *resultlen);
269 int agent_private_key_type (const unsigned char *privatekey);
270 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
271 int agent_shadow_key (const unsigned char *pubkey,
272                       const unsigned char *shadow_info,
273                       unsigned char **result);
274 int agent_get_shadow_info (const unsigned char *shadowkey,
275                            unsigned char const **shadow_info);
276
277
278 /*-- trustlist.c --*/
279 void initialize_module_trustlist (void);
280 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr);
281 gpg_error_t agent_listtrusted (void *assuan_context);
282 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
283                                const char *fpr, int flag);
284 void agent_reload_trustlist (void);
285
286
287 /*-- divert-scd.c --*/
288 int divert_pksign (ctrl_t ctrl, 
289                    const unsigned char *digest, size_t digestlen, int algo,
290                    const unsigned char *shadow_info, unsigned char **r_sig);
291 int divert_pkdecrypt (ctrl_t ctrl,
292                       const unsigned char *cipher,
293                       const unsigned char *shadow_info,
294                       char **r_buf, size_t *r_len);
295 int divert_generic_cmd (ctrl_t ctrl,
296                         const char *cmdline, void *assuan_context);
297
298
299 /*-- call-scd.c --*/
300 void initialize_module_call_scd (void);
301 void agent_scd_dump_state (void);
302 void agent_scd_check_aliveness (void);
303 int agent_reset_scd (ctrl_t ctrl);
304 int agent_card_learn (ctrl_t ctrl,
305                       void (*kpinfo_cb)(void*, const char *),
306                       void *kpinfo_cb_arg,
307                       void (*certinfo_cb)(void*, const char *),
308                       void *certinfo_cb_arg,
309                       void (*sinfo_cb)(void*, const char *,
310                                        size_t, const char *),
311                       void *sinfo_cb_arg);
312 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
313 int agent_card_pksign (ctrl_t ctrl,
314                        const char *keyid,
315                        int (*getpin_cb)(void *, const char *, char*, size_t),
316                        void *getpin_cb_arg,
317                        const unsigned char *indata, size_t indatalen,
318                        unsigned char **r_buf, size_t *r_buflen);
319 int agent_card_pkdecrypt (ctrl_t ctrl,
320                           const char *keyid,
321                           int (*getpin_cb)(void *, const char *, char*,size_t),
322                           void *getpin_cb_arg,
323                           const unsigned char *indata, size_t indatalen,
324                           char **r_buf, size_t *r_buflen);
325 int agent_card_readcert (ctrl_t ctrl,
326                          const char *id, char **r_buf, size_t *r_buflen);
327 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
328 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
329 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
330                     int (*getpin_cb)(void *, const char *, char*, size_t),
331                     void *getpin_cb_arg, void *assuan_context);
332
333
334 /*-- learncard.c --*/
335 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
336
337
338 #endif /*AGENT_H*/