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