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