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