* agent.h: Add a callback function to the pin_entry_info structure.
[gnupg.git] / agent / agent.h
1 /* agent.h - Global definitions for the agent
2  *      Copyright (C) 2001 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   char *display;
40   char *ttyname;
41   char *ttytype;
42   char *lc_ctype;
43   char *lc_messages;
44   const char *scdaemon_program; 
45   int no_grab;      /* don't let the pinentry grab the keyboard */
46   unsigned long def_cache_ttl;
47
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   struct {
72     int algo;
73     unsigned char value[MAX_DIGEST_LEN];
74     int valuelen;
75   } digest;
76   char keygrip[20];
77   int have_keygrip;
78
79 };
80 typedef struct server_control_s *CTRL;
81
82
83 struct pin_entry_info_s {
84   int min_digits; /* min. number of digits required or 0 for freeform entry */
85   int max_digits; /* max. number of allowed digits allowed*/
86   int max_tries;
87   int failed_tries;
88   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
89   void *check_cb_arg;  /* optional argument which might be of use in the CB */
90   const char *cb_errtext; /* used by the cb to displaye a specific error */
91   size_t max_length; /* allocated length of the buffer */
92   char pin[1];
93 };
94
95
96 enum {
97   PRIVATE_KEY_UNKNOWN = 0,
98   PRIVATE_KEY_CLEAR = 1,
99   PRIVATE_KEY_PROTECTED = 2,
100   PRIVATE_KEY_SHADOWED = 3
101 };
102
103 /*-- gpg-agent.c --*/
104 void agent_exit (int rc); /* also implemented in other tools */
105
106 /*-- trans.c --*/
107 const char *trans (const char *text);
108
109 /*-- command.c --*/
110 void start_command_handler (int, int);
111
112 /*-- findkey.c --*/
113 int agent_write_private_key (const unsigned char *grip,
114                              const void *buffer, size_t length, int force);
115 GCRY_SEXP agent_key_from_file (const unsigned char *grip,
116                                unsigned char **shadow_info);
117 int agent_key_available (const unsigned char *grip);
118
119 /*-- query.c --*/
120 int agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo);
121 int agent_get_passphrase (char **retpass,
122                           const char *desc, const char *prompt,
123                           const char *errtext);
124 int agent_get_confirmation (const char *desc, const char *ok,
125                             const char *cancel);
126
127 /*-- cache.c --*/
128 int agent_put_cache (const char *key, const char *data, int ttl);
129 const char *agent_get_cache (const char *key, void **cache_id);
130 void agent_unlock_cache_entry (void **cache_id);
131
132
133 /*-- pksign.c --*/
134 int agent_pksign (CTRL ctrl, FILE *outfp);
135
136 /*-- pkdecrypt.c --*/
137 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
138                      FILE *outfp);
139
140 /*-- genkey.c --*/
141 int agent_genkey (CTRL ctrl,
142                   const char *keyparam, size_t keyparmlen, FILE *outfp);
143
144 /*-- protect.c --*/
145 int agent_protect (const unsigned char *plainkey, const char *passphrase,
146                    unsigned char **result, size_t *resultlen);
147 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
148                      unsigned char **result, size_t *resultlen);
149 int agent_private_key_type (const unsigned char *privatekey);
150 int agent_shadow_key (const unsigned char *pubkey,
151                       const unsigned char *shadow_info,
152                       unsigned char **result);
153 int agent_get_shadow_info (const unsigned char *shadowkey,
154                            unsigned char const **shadow_info);
155
156
157 /*-- trustlist.c --*/
158 int agent_istrusted (const char *fpr);
159 int agent_listtrusted (void *assuan_context);
160 int agent_marktrusted (const char *name, const char *fpr, int flag);
161
162
163 /*-- divert-scd.c --*/
164 int divert_pksign (const unsigned char *digest, size_t digestlen, int algo,
165                    const unsigned char *shadow_info, unsigned char **r_sig);
166 int divert_pkdecrypt (const unsigned char *cipher,
167                       const unsigned char *shadow_info,
168                       char **r_buf, size_t *r_len);
169
170 /*-- call-scd.c --*/
171 int agent_card_learn (void (*kpinfo_cb)(void*, const char *),
172                       void *kpinfo_cb_arg);
173 int agent_card_serialno (char **r_serialno);
174 int agent_card_pksign (const char *keyid,
175                        int (*getpin_cb)(void *, const char *, char*, size_t),
176                        void *getpin_cb_arg,
177                        const unsigned char *indata, size_t indatalen,
178                        char **r_buf, size_t *r_buflen);
179 int agent_card_pkdecrypt (const char *keyid,
180                           int (*getpin_cb)(void *, const char *, char*,size_t),
181                           void *getpin_cb_arg,
182                           const unsigned char *indata, size_t indatalen,
183                           char **r_buf, size_t *r_buflen);
184 int agent_card_readcert (const char *id, char **r_buf, size_t *r_buflen);
185 int agent_card_readkey (const char *id, unsigned char **r_buf);
186
187
188 /*-- learncard.c --*/
189 int agent_handle_learn (void *assuan_context);
190
191
192 #endif /*AGENT_H*/