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