Various changes
[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 default and maximum TTL of cache entries. */
76   unsigned long def_cache_ttl;     /* Default. */
77   unsigned long def_cache_ttl_ssh; /* for SSH. */
78   unsigned long max_cache_ttl;     /* Default. */
79   unsigned long max_cache_ttl_ssh; /* for SSH. */
80
81
82   int running_detached; /* We are running detached from the tty. */
83
84   int ignore_cache_for_signing;
85   int allow_mark_trusted;
86   int allow_preset_passphrase;
87   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
88   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
89   int ssh_support;   /* Enable ssh-agent emulation.  */
90 } opt;
91
92
93 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
94 #define DBG_MPI_VALUE     2     /* debug mpi details */
95 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
96 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
97 #define DBG_CACHE_VALUE   64    /* debug the caching */
98 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
99 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
100 #define DBG_ASSUAN_VALUE 1024   
101
102 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
103 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
104 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
105 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
106 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
107 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
108
109 struct server_local_s;
110 struct scd_local_s;
111
112 /* Collection of data per session (aka connection). */
113 struct server_control_s 
114 {
115   /* Private data of the server (command.c). */
116   struct server_local_s *server_local;
117
118   /* Private data of the SCdaemon (call-scd.c). */
119   struct scd_local_s *scd_local;
120
121   int   connection_fd; /* -1 or an identifier for the current connection. */
122
123   char *display;
124   char *ttyname;
125   char *ttytype;
126   char *lc_ctype;
127   char *lc_messages;
128   struct {
129     int algo;
130     unsigned char value[MAX_DIGEST_LEN];
131     int valuelen;
132     int raw_value: 1;
133   } digest;
134   unsigned char keygrip[20];
135   int have_keygrip;
136
137   int use_auth_call; /* Hack to send the PKAUTH command instead of the
138                         PKSIGN command to the scdaemon.  */
139 };
140
141 typedef struct server_control_s *ctrl_t;
142
143
144 struct pin_entry_info_s 
145 {
146   int min_digits; /* min. number of digits required or 0 for freeform entry */
147   int max_digits; /* max. number of allowed digits allowed*/
148   int max_tries;
149   int failed_tries;
150   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
151   void *check_cb_arg;  /* optional argument which might be of use in the CB */
152   const char *cb_errtext; /* used by the cb to displaye a specific error */
153   size_t max_length; /* allocated length of the buffer */
154   char pin[1];
155 };
156
157
158 enum 
159   {
160     PRIVATE_KEY_UNKNOWN = 0,
161     PRIVATE_KEY_CLEAR = 1,
162     PRIVATE_KEY_PROTECTED = 2,
163     PRIVATE_KEY_SHADOWED = 3
164   };
165
166
167 /* Values for the cache_mode arguments. */
168 typedef enum 
169   {
170     CACHE_MODE_IGNORE = 0, /* Special mode to by pass the cache. */
171     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
172     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
173     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
174     CACHE_MODE_SSH         /* SSH related cache. */
175   }
176 cache_mode_t;
177
178
179 /*-- gpg-agent.c --*/
180 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
181 void agent_init_default_ctrl (struct server_control_s *ctrl);
182
183 /*-- command.c --*/
184 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...);
185 void start_command_handler (int, int);
186
187 /*-- command-ssh.c --*/
188 void start_command_handler_ssh (int);
189
190 /*-- findkey.c --*/
191 int agent_write_private_key (const unsigned char *grip,
192                              const void *buffer, size_t length, int force);
193 gpg_error_t agent_key_from_file (ctrl_t ctrl, 
194                                  const char *desc_text,
195                                  const unsigned char *grip,
196                                  unsigned char **shadow_info,
197                                  cache_mode_t cache_mode,
198                                  gcry_sexp_t *result);
199 gpg_error_t agent_public_key_from_file (ctrl_t ctrl, 
200                                         const unsigned char *grip,
201                                         gcry_sexp_t *result);
202 int agent_key_available (const unsigned char *grip);
203
204 /*-- query.c --*/
205 void initialize_module_query (void);
206 void agent_query_dump_state (void);
207 void agent_reset_query (ctrl_t ctrl);
208 int agent_askpin (ctrl_t ctrl,
209                   const char *desc_text, const char *prompt_text,
210                   const char *inital_errtext,
211                   struct pin_entry_info_s *pininfo);
212 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
213                           const char *desc, const char *prompt,
214                           const char *errtext);
215 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
216                             const char *cancel);
217 int agent_popup_message_start (ctrl_t ctrl, const char *desc,
218                                const char *ok_btn, const char *cancel_btn);
219 void agent_popup_message_stop (ctrl_t ctrl);
220
221
222 /*-- cache.c --*/
223 void agent_flush_cache (void);
224 int agent_put_cache (const char *key, cache_mode_t cache_mode,
225                      const char *data, int ttl);
226 const char *agent_get_cache (const char *key, cache_mode_t cache_mode,
227                              void **cache_id);
228 void agent_unlock_cache_entry (void **cache_id);
229
230
231 /*-- pksign.c --*/
232 int agent_pksign_do (ctrl_t ctrl, const char *desc_text,
233                      gcry_sexp_t *signature_sexp,
234                      cache_mode_t cache_mode);
235 int agent_pksign (ctrl_t ctrl, const char *desc_text,
236                   membuf_t *outbuf, cache_mode_t cache_mode);
237
238 /*-- pkdecrypt.c --*/
239 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
240                      const unsigned char *ciphertext, size_t ciphertextlen,
241                      membuf_t *outbuf);
242
243 /*-- genkey.c --*/
244 int agent_genkey (ctrl_t ctrl, 
245                   const char *keyparam, size_t keyparmlen, membuf_t *outbuf);
246 int agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey);
247
248 /*-- protect.c --*/
249 int agent_protect (const unsigned char *plainkey, const char *passphrase,
250                    unsigned char **result, size_t *resultlen);
251 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
252                      unsigned char **result, size_t *resultlen);
253 int agent_private_key_type (const unsigned char *privatekey);
254 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
255 int agent_shadow_key (const unsigned char *pubkey,
256                       const unsigned char *shadow_info,
257                       unsigned char **result);
258 int agent_get_shadow_info (const unsigned char *shadowkey,
259                            unsigned char const **shadow_info);
260
261
262 /*-- trustlist.c --*/
263 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr);
264 gpg_error_t agent_listtrusted (void *assuan_context);
265 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
266                                const char *fpr, int flag);
267 void agent_reload_trustlist (void);
268
269
270 /*-- divert-scd.c --*/
271 int divert_pksign (ctrl_t ctrl, 
272                    const unsigned char *digest, size_t digestlen, int algo,
273                    const unsigned char *shadow_info, unsigned char **r_sig);
274 int divert_pkdecrypt (ctrl_t ctrl,
275                       const unsigned char *cipher,
276                       const unsigned char *shadow_info,
277                       char **r_buf, size_t *r_len);
278 int divert_generic_cmd (ctrl_t ctrl,
279                         const char *cmdline, void *assuan_context);
280
281
282 /*-- call-scd.c --*/
283 void initialize_module_call_scd (void);
284 void agent_scd_dump_state (void);
285 void agent_scd_check_aliveness (void);
286 int agent_reset_scd (ctrl_t ctrl);
287 int agent_card_learn (ctrl_t ctrl,
288                       void (*kpinfo_cb)(void*, const char *),
289                       void *kpinfo_cb_arg,
290                       void (*certinfo_cb)(void*, const char *),
291                       void *certinfo_cb_arg,
292                       void (*sinfo_cb)(void*, const char *,
293                                        size_t, const char *),
294                       void *sinfo_cb_arg);
295 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
296 int agent_card_pksign (ctrl_t ctrl,
297                        const char *keyid,
298                        int (*getpin_cb)(void *, const char *, char*, size_t),
299                        void *getpin_cb_arg,
300                        const unsigned char *indata, size_t indatalen,
301                        unsigned char **r_buf, size_t *r_buflen);
302 int agent_card_pkdecrypt (ctrl_t ctrl,
303                           const char *keyid,
304                           int (*getpin_cb)(void *, const char *, char*,size_t),
305                           void *getpin_cb_arg,
306                           const unsigned char *indata, size_t indatalen,
307                           char **r_buf, size_t *r_buflen);
308 int agent_card_readcert (ctrl_t ctrl,
309                          const char *id, char **r_buf, size_t *r_buflen);
310 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
311 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
312 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
313                     int (*getpin_cb)(void *, const char *, char*, size_t),
314                     void *getpin_cb_arg, void *assuan_context);
315
316
317 /*-- learncard.c --*/
318 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
319
320
321 #endif /*AGENT_H*/