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