* command.c (cmd_setkeydesc): New.
[gnupg.git] / agent / agent.h
1 /* agent.h - Global definitions for the agent
2  *      Copyright (C) 2001, 2002, 2003 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 #include <errno.h>
30
31 #include <gcrypt.h>
32 #include "../common/util.h"
33 #include "../common/errors.h"
34
35 /* Convenience function to be used instead of returning the old
36    GNUPG_Out_Of_Core. */
37 static __inline__ gpg_error_t
38 out_of_core (void)
39 {
40   return gpg_error (gpg_err_code_from_errno (errno));
41 }
42
43 #define MAX_DIGEST_LEN 24 
44
45 /* A large struct name "opt" to keep global flags */
46 struct {
47   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
48   int verbose;      /* verbosity level */
49   int quiet;        /* be as quiet as possible */
50   int dry_run;      /* don't change any persistent data */
51   int batch;        /* batch mode */
52   const char *homedir; /* configuration directory name */
53   const char *pinentry_program; 
54   const char *scdaemon_program; 
55   int no_grab;      /* don't let the pinentry grab the keyboard */
56   unsigned long def_cache_ttl;
57
58   int running_detached; /* we are running detached from the tty. */
59
60   int ignore_cache_for_signing;
61   int keep_tty;  /* don't switch the TTY (for pinentry) on request */
62   int keep_display;  /* don't switch the DISPLAY (for pinentry) on request */
63 } opt;
64
65
66 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
67 #define DBG_MPI_VALUE     2     /* debug mpi details */
68 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
69 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
70 #define DBG_CACHE_VALUE   64    /* debug the caching */
71 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
72 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
73 #define DBG_ASSUAN_VALUE 1024   
74
75 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
76 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
77 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
78 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
79 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
80 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
81
82 struct server_local_s;
83
84 struct server_control_s {
85   struct server_local_s *server_local;
86   int   connection_fd; /* -1 or an identifier for the current connection. */
87   char *display;
88   char *ttyname;
89   char *ttytype;
90   char *lc_ctype;
91   char *lc_messages;
92   struct {
93     int algo;
94     unsigned char value[MAX_DIGEST_LEN];
95     int valuelen;
96   } digest;
97   char keygrip[20];
98   int have_keygrip;
99
100 };
101 typedef struct server_control_s *CTRL;
102 typedef struct server_control_s *ctrl_t;
103
104
105 struct pin_entry_info_s {
106   int min_digits; /* min. number of digits required or 0 for freeform entry */
107   int max_digits; /* max. number of allowed digits allowed*/
108   int max_tries;
109   int failed_tries;
110   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
111   void *check_cb_arg;  /* optional argument which might be of use in the CB */
112   const char *cb_errtext; /* used by the cb to displaye a specific error */
113   size_t max_length; /* allocated length of the buffer */
114   char pin[1];
115 };
116
117
118 enum {
119   PRIVATE_KEY_UNKNOWN = 0,
120   PRIVATE_KEY_CLEAR = 1,
121   PRIVATE_KEY_PROTECTED = 2,
122   PRIVATE_KEY_SHADOWED = 3
123 };
124
125 /*-- gpg-agent.c --*/
126 void agent_exit (int rc); /* also implemented in other tools */
127 void agent_init_default_ctrl (struct server_control_s *ctrl);
128
129 /*-- command.c --*/
130 void start_command_handler (int, int);
131
132 /*-- findkey.c --*/
133 int agent_write_private_key (const unsigned char *grip,
134                              const void *buffer, size_t length, int force);
135 gpg_error_t agent_key_from_file (ctrl_t ctrl, 
136                                  const char *desc_text,
137                                  const unsigned char *grip,
138                                  unsigned char **shadow_info,
139                                  int ignore_cache, gcry_sexp_t *result);
140 int agent_key_available (const unsigned char *grip);
141
142 /*-- query.c --*/
143 int agent_askpin (ctrl_t ctrl,
144                   const char *desc_text, struct pin_entry_info_s *pininfo);
145 int agent_get_passphrase (ctrl_t ctrl, char **retpass,
146                           const char *desc, const char *prompt,
147                           const char *errtext);
148 int agent_get_confirmation (ctrl_t ctrl, const char *desc, const char *ok,
149                             const char *cancel);
150
151 /*-- cache.c --*/
152 void agent_flush_cache (void);
153 int agent_put_cache (const char *key, const char *data, int ttl);
154 const char *agent_get_cache (const char *key, void **cache_id);
155 void agent_unlock_cache_entry (void **cache_id);
156
157
158 /*-- pksign.c --*/
159 int agent_pksign (ctrl_t ctrl, const char *desc_text,
160                   FILE *outfp, int ignore_cache);
161
162 /*-- pkdecrypt.c --*/
163 int agent_pkdecrypt (ctrl_t ctrl, const char *desc_text,
164                      const unsigned char *ciphertext, size_t ciphertextlen,
165                      FILE *outfp);
166
167 /*-- genkey.c --*/
168 int agent_genkey (ctrl_t ctrl, 
169                   const char *keyparam, size_t keyparmlen, FILE *outfp);
170 int agent_protect_and_store (ctrl_t ctrl, gcry_sexp_t s_skey);
171
172 /*-- protect.c --*/
173 int agent_protect (const unsigned char *plainkey, const char *passphrase,
174                    unsigned char **result, size_t *resultlen);
175 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
176                      unsigned char **result, size_t *resultlen);
177 int agent_private_key_type (const unsigned char *privatekey);
178 int agent_shadow_key (const unsigned char *pubkey,
179                       const unsigned char *shadow_info,
180                       unsigned char **result);
181 int agent_get_shadow_info (const unsigned char *shadowkey,
182                            unsigned char const **shadow_info);
183
184
185 /*-- trustlist.c --*/
186 int agent_istrusted (const char *fpr);
187 int agent_listtrusted (void *assuan_context);
188 int agent_marktrusted (ctrl_t ctrl, const char *name,
189                        const char *fpr, int flag);
190
191
192 /*-- divert-scd.c --*/
193 int divert_pksign (ctrl_t ctrl, 
194                    const unsigned char *digest, size_t digestlen, int algo,
195                    const unsigned char *shadow_info, unsigned char **r_sig);
196 int divert_pkdecrypt (ctrl_t ctrl,
197                       const unsigned char *cipher,
198                       const unsigned char *shadow_info,
199                       char **r_buf, size_t *r_len);
200 int divert_generic_cmd (ctrl_t ctrl,
201                         const char *cmdline, void *assuan_context);
202
203
204 /*-- call-scd.c --*/
205 int agent_reset_scd (ctrl_t ctrl);
206 int agent_card_learn (ctrl_t ctrl,
207                       void (*kpinfo_cb)(void*, const char *),
208                       void *kpinfo_cb_arg,
209                       void (*certinfo_cb)(void*, const char *),
210                       void *certinfo_cb_arg,
211                       void (*sinfo_cb)(void*, const char *,
212                                        size_t, const char *),
213                       void *sinfo_cb_arg);
214 int agent_card_serialno (ctrl_t ctrl, char **r_serialno);
215 int agent_card_pksign (ctrl_t ctrl,
216                        const char *keyid,
217                        int (*getpin_cb)(void *, const char *, char*, size_t),
218                        void *getpin_cb_arg,
219                        const unsigned char *indata, size_t indatalen,
220                        char **r_buf, size_t *r_buflen);
221 int agent_card_pkdecrypt (ctrl_t ctrl,
222                           const char *keyid,
223                           int (*getpin_cb)(void *, const char *, char*,size_t),
224                           void *getpin_cb_arg,
225                           const unsigned char *indata, size_t indatalen,
226                           char **r_buf, size_t *r_buflen);
227 int agent_card_readcert (ctrl_t ctrl,
228                          const char *id, char **r_buf, size_t *r_buflen);
229 int agent_card_readkey (ctrl_t ctrl, const char *id, unsigned char **r_buf);
230 int agent_card_scd (ctrl_t ctrl, const char *cmdline,
231                     int (*getpin_cb)(void *, const char *, char*, size_t),
232                     void *getpin_cb_arg, void *assuan_context);
233
234
235 /*-- learncard.c --*/
236 int agent_handle_learn (ctrl_t ctrl, void *assuan_context);
237
238
239 #endif /*AGENT_H*/