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