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