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