* call-scd.c (init_membuf, put_membuf, get_membuf): Removed. We
[gnupg.git] / agent / agent.h
1 /* agent.h - Global definitions for the agent
2  *      Copyright (C) 2001, 2002, 2003 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   const char *pinentry_program; 
57   const char *scdaemon_program; 
58   int no_grab;      /* don't let the pinentry grab the keyboard */
59   unsigned long def_cache_ttl;
60   unsigned long max_cache_ttl;
61
62   int running_detached; /* we are running detached from the tty. */
63
64   int ignore_cache_for_signing;
65   int allow_mark_trusted;
66   int keep_tty;  /* don't switch the TTY (for pinentry) on request */
67   int keep_display;  /* don't switch the DISPLAY (for pinentry) on request */
68 } opt;
69
70
71 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
72 #define DBG_MPI_VALUE     2     /* debug mpi details */
73 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
74 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
75 #define DBG_CACHE_VALUE   64    /* debug the caching */
76 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
77 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
78 #define DBG_ASSUAN_VALUE 1024   
79
80 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
81 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
82 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
83 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
84 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
85 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
86
87 struct server_local_s;
88
89 struct server_control_s {
90   struct server_local_s *server_local;
91   int   connection_fd; /* -1 or an identifier for the current connection. */
92   char *display;
93   char *ttyname;
94   char *ttytype;
95   char *lc_ctype;
96   char *lc_messages;
97   struct {
98     int algo;
99     unsigned char value[MAX_DIGEST_LEN];
100     int valuelen;
101     int raw_value: 1;
102   } digest;
103   char keygrip[20];
104   int have_keygrip;
105
106 };
107 typedef struct server_control_s *CTRL;
108 typedef struct server_control_s *ctrl_t;
109
110
111 struct pin_entry_info_s {
112   int min_digits; /* min. number of digits required or 0 for freeform entry */
113   int max_digits; /* max. number of allowed digits allowed*/
114   int max_tries;
115   int failed_tries;
116   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
117   void *check_cb_arg;  /* optional argument which might be of use in the CB */
118   const char *cb_errtext; /* used by the cb to displaye a specific error */
119   size_t max_length; /* allocated length of the buffer */
120   char pin[1];
121 };
122
123
124 enum {
125   PRIVATE_KEY_UNKNOWN = 0,
126   PRIVATE_KEY_CLEAR = 1,
127   PRIVATE_KEY_PROTECTED = 2,
128   PRIVATE_KEY_SHADOWED = 3
129 };
130
131 /*-- gpg-agent.c --*/
132 void agent_exit (int rc); /* also implemented in other tools */
133 void agent_init_default_ctrl (struct server_control_s *ctrl);
134
135 /*-- command.c --*/
136 void start_command_handler (int, int);
137
138 /*-- findkey.c --*/
139 int agent_write_private_key (const unsigned char *grip,
140                              const void *buffer, size_t length, int force);
141 gpg_error_t agent_key_from_file (ctrl_t ctrl, 
142                                  const char *desc_text,
143                                  const unsigned char *grip,
144                                  unsigned char **shadow_info,
145                                  int ignore_cache, gcry_sexp_t *result);
146 int agent_key_available (const unsigned char *grip);
147
148 /*-- query.c --*/
149 void initialize_module_query (void);
150 int agent_askpin (ctrl_t ctrl,
151                   const char *desc_text, const char *inital_errtext,
152                   struct pin_entry_info_s *pininfo);
153 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
154                           const char *desc, const char *prompt,
155                           const char *errtext);
156 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
157                             const char *cancel);
158
159 /*-- cache.c --*/
160 void agent_flush_cache (void);
161 int agent_put_cache (const char *key, const char *data, int ttl);
162 const char *agent_get_cache (const char *key, void **cache_id);
163 void agent_unlock_cache_entry (void **cache_id);
164
165
166 /*-- pksign.c --*/
167 int agent_pksign_do (CTRL ctrl, const char *desc_text,
168                      gcry_sexp_t *signature_sexp, int ignore_cache);
169 int agent_pksign (ctrl_t ctrl, const char *desc_text,
170                   membuf_t *outbuf, int ignore_cache);
171
172 /*-- pkdecrypt.c --*/
173 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
174                      const unsigned char *ciphertext, size_t ciphertextlen,
175                      membuf_t *outbuf);
176
177 /*-- genkey.c --*/
178 int agent_genkey (ctrl_t ctrl, 
179                   const char *keyparam, size_t keyparmlen, membuf_t *outbuf);
180 int agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey);
181
182 /*-- protect.c --*/
183 int agent_protect (const unsigned char *plainkey, const char *passphrase,
184                    unsigned char **result, size_t *resultlen);
185 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
186                      unsigned char **result, size_t *resultlen);
187 int agent_private_key_type (const unsigned char *privatekey);
188 int agent_shadow_key (const unsigned char *pubkey,
189                       const unsigned char *shadow_info,
190                       unsigned char **result);
191 int agent_get_shadow_info (const unsigned char *shadowkey,
192                            unsigned char const **shadow_info);
193
194
195 /*-- trustlist.c --*/
196 int agent_istrusted (const char *fpr);
197 int agent_listtrusted (void *assuan_context);
198 int agent_marktrusted (ctrl_t ctrl, const char *name,
199                        const char *fpr, int flag);
200 void agent_trustlist_housekeeping (void);
201 void agent_reload_trustlist (void);
202
203
204 /*-- divert-scd.c --*/
205 int divert_pksign (ctrl_t ctrl, 
206                    const unsigned char *digest, size_t digestlen, int algo,
207                    const unsigned char *shadow_info, unsigned char **r_sig);
208 int divert_pkdecrypt (ctrl_t ctrl,
209                       const unsigned char *cipher,
210                       const unsigned char *shadow_info,
211                       char **r_buf, size_t *r_len);
212 int divert_generic_cmd (ctrl_t ctrl,
213                         const char *cmdline, void *assuan_context);
214
215
216 /*-- call-scd.c --*/
217 void initialize_module_call_scd (void);
218 int agent_reset_scd (ctrl_t ctrl);
219 int agent_card_learn (ctrl_t ctrl,
220                       void (*kpinfo_cb)(void*, const char *),
221                       void *kpinfo_cb_arg,
222                       void (*certinfo_cb)(void*, const char *),
223                       void *certinfo_cb_arg,
224                       void (*sinfo_cb)(void*, const char *,
225                                        size_t, const char *),
226                       void *sinfo_cb_arg);
227 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
228 int agent_card_pksign (ctrl_t ctrl,
229                        const char *keyid,
230                        int (*getpin_cb)(void *, const char *, char*, size_t),
231                        void *getpin_cb_arg,
232                        const unsigned char *indata, size_t indatalen,
233                        char **r_buf, size_t *r_buflen);
234 int agent_card_pkdecrypt (ctrl_t ctrl,
235                           const char *keyid,
236                           int (*getpin_cb)(void *, const char *, char*,size_t),
237                           void *getpin_cb_arg,
238                           const unsigned char *indata, size_t indatalen,
239                           char **r_buf, size_t *r_buflen);
240 int agent_card_readcert (ctrl_t ctrl,
241                          const char *id, char **r_buf, size_t *r_buflen);
242 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
243 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
244                     int (*getpin_cb)(void *, const char *, char*, size_t),
245                     void *getpin_cb_arg, void *assuan_context);
246
247
248 /*-- learncard.c --*/
249 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
250
251
252 #endif /*AGENT_H*/