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