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