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