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