f824fe615437e2a51d34692fc072af92ee19e95f
[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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef AGENT_H
21 #define AGENT_H
22
23 #ifdef GPG_ERR_SOURCE_DEFAULT
24 #error GPG_ERR_SOURCE_DEFAULT already defined
25 #endif
26 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGAGENT
27 #include <gpg-error.h>
28 #define map_assuan_err(a) \
29         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
30 #include <errno.h>
31
32 #include <gcrypt.h>
33 #include "../common/util.h"
34 #include "../common/membuf.h"
35 #include "../common/sysutils.h" /* (gnupg_fd_t) */
36
37 /* To convey some special hash algorithms we use algorithm numbers
38    reserved for application use. */
39 #ifndef GCRY_MD_USER
40 #define GCRY_MD_USER 1024
41 #endif
42 #define GCRY_MD_USER_TLS_MD5SHA1 (GCRY_MD_USER+1)
43
44 /* Maximum length of a digest.  */
45 #define MAX_DIGEST_LEN 36
46
47 /* A large struct name "opt" to keep global flags */
48 struct
49 {
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 changed 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   char *startup_xauthority;   
65   char *startup_pinentry_user_data; 
66
67
68   const char *pinentry_program; /* Filename of the program to start as
69                                    pinentry.  */
70   const char *scdaemon_program; /* Filename of the program to handle
71                                    smartcard tasks.  */
72   int disable_scdaemon;         /* Never use the SCdaemon. */
73   int no_grab;         /* Don't let the pinentry grab the keyboard */
74
75   /* The name of the file pinentry shall tocuh before exiting.  If
76      this is not set the filoe name of the standard socket is used. */
77   const char *pinentry_touch_file;
78
79   /* The default and maximum TTL of cache entries. */
80   unsigned long def_cache_ttl;     /* Default. */
81   unsigned long def_cache_ttl_ssh; /* for SSH. */
82   unsigned long max_cache_ttl;     /* Default. */
83   unsigned long max_cache_ttl_ssh; /* for SSH. */
84
85   /* Flag disallowing bypassing of the warning.  */
86   int enforce_passphrase_constraints;
87   /* The require minmum length of a passphrase. */
88   unsigned int min_passphrase_len;
89   /* The minimum number of non-alpha characters in a passphrase.  */
90   unsigned int min_passphrase_nonalpha;
91   /* File name with a patternfile or NULL if not enabled.  */
92   const char *check_passphrase_pattern;
93   /* If not 0 the user is asked to change his passphrase after these
94      number of days.  */
95   unsigned int max_passphrase_days;
96   /* If set, a passphrase history will be written and checked at each
97      passphrase change.  */
98   int enable_passhrase_history;
99
100   int running_detached; /* We are running detached from the tty. */
101
102   int ignore_cache_for_signing;
103   int allow_mark_trusted;
104   int allow_preset_passphrase;
105   int keep_tty;      /* Don't switch the TTY (for pinentry) on request */
106   int keep_display;  /* Don't switch the DISPLAY (for pinentry) on request */
107   int ssh_support;   /* Enable ssh-agent emulation.  */
108 } opt;
109
110
111 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
112 #define DBG_MPI_VALUE     2     /* debug mpi details */
113 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
114 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
115 #define DBG_CACHE_VALUE   64    /* debug the caching */
116 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
117 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
118 #define DBG_ASSUAN_VALUE 1024   
119
120 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
121 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
122 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
123 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
124 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
125 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
126
127 struct server_local_s;
128 struct scd_local_s;
129
130 /* Collection of data per session (aka connection). */
131 struct server_control_s 
132 {
133   /* Private data used to fire up the connection thread.  We use this
134      structure do avoid an extra allocation for just a few bytes. */
135   struct {
136     gnupg_fd_t fd;
137   } thread_startup;
138   
139   /* Private data of the server (command.c). */
140   struct server_local_s *server_local;
141
142   /* Private data of the SCdaemon (call-scd.c). */
143   struct scd_local_s *scd_local;
144
145   char *display;
146   char *ttyname;
147   char *ttytype;
148   char *lc_ctype;
149   char *lc_messages;
150   char *xauthority;   
151   char *pinentry_user_data; 
152   struct {
153     int algo;
154     unsigned char value[MAX_DIGEST_LEN];
155     int valuelen;
156     int raw_value: 1;
157   } digest;
158   unsigned char keygrip[20];
159   int have_keygrip;
160
161   int use_auth_call; /* Hack to send the PKAUTH command instead of the
162                         PKSIGN command to the scdaemon.  */
163   int in_passwd;     /* Hack to inhibit enforced passphrase change
164                         during an explicit passwd command.  */
165 };
166
167
168 struct pin_entry_info_s 
169 {
170   int min_digits; /* min. number of digits required or 0 for freeform entry */
171   int max_digits; /* max. number of allowed digits allowed*/
172   int max_tries;
173   int failed_tries;
174   int with_qualitybar; /* Set if the quality bar should be displayed.  */
175   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
176   void *check_cb_arg;  /* optional argument which might be of use in the CB */
177   const char *cb_errtext; /* used by the cb to displaye a specific error */
178   size_t max_length; /* allocated length of the buffer */
179   char pin[1];
180 };
181
182
183 enum 
184   {
185     PRIVATE_KEY_UNKNOWN = 0,
186     PRIVATE_KEY_CLEAR = 1,
187     PRIVATE_KEY_PROTECTED = 2,
188     PRIVATE_KEY_SHADOWED = 3
189   };
190
191
192 /* Values for the cache_mode arguments. */
193 typedef enum 
194   {
195     CACHE_MODE_IGNORE = 0, /* Special mode to bypass the cache. */
196     CACHE_MODE_ANY,        /* Any mode except ignore matches. */
197     CACHE_MODE_NORMAL,     /* Normal cache (gpg-agent). */
198     CACHE_MODE_USER,       /* GET_PASSPHRASE related cache. */
199     CACHE_MODE_SSH         /* SSH related cache. */
200   }
201 cache_mode_t;
202
203
204 /*-- gpg-agent.c --*/
205 void agent_exit (int rc) JNLIB_GCC_A_NR; /* Also implemented in other tools */
206 const char *get_agent_socket_name (void);
207 const char *get_agent_ssh_socket_name (void);
208 #ifdef HAVE_W32_SYSTEM
209 void *get_agent_scd_notify_event (void);
210 #endif
211 void agent_sighup_action (void);
212
213 /*-- command.c --*/
214 gpg_error_t agent_write_status (ctrl_t ctrl, const char *keyword, ...);
215 void bump_key_eventcounter (void);
216 void bump_card_eventcounter (void);
217 void start_command_handler (ctrl_t, gnupg_fd_t, gnupg_fd_t);
218
219 /*-- command-ssh.c --*/
220 void start_command_handler_ssh (ctrl_t, gnupg_fd_t);
221
222 /*-- findkey.c --*/
223 int agent_write_private_key (const unsigned char *grip,
224                              const void *buffer, size_t length, int force);
225 gpg_error_t agent_key_from_file (ctrl_t ctrl, 
226                                  const char *desc_text,
227                                  const unsigned char *grip,
228                                  unsigned char **shadow_info,
229                                  cache_mode_t cache_mode,
230                                  gcry_sexp_t *result);
231 gpg_error_t agent_public_key_from_file (ctrl_t ctrl, 
232                                         const unsigned char *grip,
233                                         gcry_sexp_t *result);
234 int agent_key_available (const unsigned char *grip);
235
236 /*-- call-pinentry.c --*/
237 void initialize_module_call_pinentry (void);
238 void agent_query_dump_state (void);
239 void agent_reset_query (ctrl_t ctrl);
240 int pinentry_active_p (ctrl_t ctrl, int waitseconds);
241 int agent_askpin (ctrl_t ctrl,
242                   const char *desc_text, const char *prompt_text,
243                   const char *inital_errtext,
244                   struct pin_entry_info_s *pininfo);
245 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
246                           const char *desc, const char *prompt,
247                           const char *errtext);
248 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
249                             const char *cancel);
250 int agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn);
251 int agent_popup_message_start (ctrl_t ctrl,
252                                const char *desc, const char *ok_btn);
253 void agent_popup_message_stop (ctrl_t ctrl);
254
255
256 /*-- cache.c --*/
257 void agent_flush_cache (void);
258 int agent_put_cache (const char *key, cache_mode_t cache_mode,
259                      const char *data, int ttl);
260 const char *agent_get_cache (const char *key, cache_mode_t cache_mode,
261                              void **cache_id);
262 void agent_unlock_cache_entry (void **cache_id);
263
264
265 /*-- pksign.c --*/
266 int agent_pksign_do (ctrl_t ctrl, const char *desc_text,
267                      gcry_sexp_t *signature_sexp,
268                      cache_mode_t cache_mode);
269 int agent_pksign (ctrl_t ctrl, const char *desc_text,
270                   membuf_t *outbuf, cache_mode_t cache_mode);
271
272 /*-- pkdecrypt.c --*/
273 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
274                      const unsigned char *ciphertext, size_t ciphertextlen,
275                      membuf_t *outbuf);
276
277 /*-- genkey.c --*/
278 int check_passphrase_constraints (ctrl_t ctrl, const char *pw, int silent);
279 int agent_genkey (ctrl_t ctrl, 
280                   const char *keyparam, size_t keyparmlen, membuf_t *outbuf);
281 int agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey);
282
283 /*-- protect.c --*/
284 int agent_protect (const unsigned char *plainkey, const char *passphrase,
285                    unsigned char **result, size_t *resultlen);
286 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
287                      gnupg_isotime_t protected_at, 
288                      unsigned char **result, size_t *resultlen);
289 int agent_private_key_type (const unsigned char *privatekey);
290 unsigned char *make_shadow_info (const char *serialno, const char *idstring);
291 int agent_shadow_key (const unsigned char *pubkey,
292                       const unsigned char *shadow_info,
293                       unsigned char **result);
294 int agent_get_shadow_info (const unsigned char *shadowkey,
295                            unsigned char const **shadow_info);
296
297
298 /*-- trustlist.c --*/
299 void initialize_module_trustlist (void);
300 gpg_error_t agent_istrusted (ctrl_t ctrl, const char *fpr);
301 gpg_error_t agent_listtrusted (void *assuan_context);
302 gpg_error_t agent_marktrusted (ctrl_t ctrl, const char *name,
303                                const char *fpr, int flag);
304 void agent_reload_trustlist (void);
305
306
307 /*-- divert-scd.c --*/
308 int divert_pksign (ctrl_t ctrl, 
309                    const unsigned char *digest, size_t digestlen, int algo,
310                    const unsigned char *shadow_info, unsigned char **r_sig);
311 int divert_pkdecrypt (ctrl_t ctrl,
312                       const unsigned char *cipher,
313                       const unsigned char *shadow_info,
314                       char **r_buf, size_t *r_len);
315 int divert_generic_cmd (ctrl_t ctrl,
316                         const char *cmdline, void *assuan_context);
317
318
319 /*-- call-scd.c --*/
320 void initialize_module_call_scd (void);
321 void agent_scd_dump_state (void);
322 void agent_scd_check_aliveness (void);
323 int agent_reset_scd (ctrl_t ctrl);
324 int agent_card_learn (ctrl_t ctrl,
325                       void (*kpinfo_cb)(void*, const char *),
326                       void *kpinfo_cb_arg,
327                       void (*certinfo_cb)(void*, const char *),
328                       void *certinfo_cb_arg,
329                       void (*sinfo_cb)(void*, const char *,
330                                        size_t, const char *),
331                       void *sinfo_cb_arg);
332 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
333 int agent_card_pksign (ctrl_t ctrl,
334                        const char *keyid,
335                        int (*getpin_cb)(void *, const char *, char*, size_t),
336                        void *getpin_cb_arg,
337                        const unsigned char *indata, size_t indatalen,
338                        unsigned char **r_buf, size_t *r_buflen);
339 int agent_card_pkdecrypt (ctrl_t ctrl,
340                           const char *keyid,
341                           int (*getpin_cb)(void *, const char *, char*,size_t),
342                           void *getpin_cb_arg,
343                           const unsigned char *indata, size_t indatalen,
344                           char **r_buf, size_t *r_buflen);
345 int agent_card_readcert (ctrl_t ctrl,
346                          const char *id, char **r_buf, size_t *r_buflen);
347 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
348 gpg_error_t agent_card_getattr (ctrl_t ctrl, const char *name, char **result);
349 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
350                     int (*getpin_cb)(void *, const char *, char*, size_t),
351                     void *getpin_cb_arg, void *assuan_context);
352
353
354 /*-- learncard.c --*/
355 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
356
357
358 #endif /*AGENT_H*/