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