* query.c (agent_askpin): Provide the default desc text depending
[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   int running_detached; /* we are running detached from the tty. */
49
50   int ignore_cache_for_signing;
51
52 } opt;
53
54
55 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
56 #define DBG_MPI_VALUE     2     /* debug mpi details */
57 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
58 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
59 #define DBG_CACHE_VALUE   64    /* debug the caching */
60 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
61 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
62 #define DBG_ASSUAN_VALUE 1024   
63
64 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
65 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
66 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
67 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
68 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
69 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
70
71 struct server_local_s;
72
73 struct server_control_s {
74   struct server_local_s *server_local;
75   struct {
76     int algo;
77     unsigned char value[MAX_DIGEST_LEN];
78     int valuelen;
79   } digest;
80   char keygrip[20];
81   int have_keygrip;
82
83 };
84 typedef struct server_control_s *CTRL;
85
86
87 struct pin_entry_info_s {
88   int min_digits; /* min. number of digits required or 0 for freeform entry */
89   int max_digits; /* max. number of allowed digits allowed*/
90   int max_tries;
91   int failed_tries;
92   int (*check_cb)(struct pin_entry_info_s *); /* CB used to check the PIN */
93   void *check_cb_arg;  /* optional argument which might be of use in the CB */
94   const char *cb_errtext; /* used by the cb to displaye a specific error */
95   size_t max_length; /* allocated length of the buffer */
96   char pin[1];
97 };
98
99
100 enum {
101   PRIVATE_KEY_UNKNOWN = 0,
102   PRIVATE_KEY_CLEAR = 1,
103   PRIVATE_KEY_PROTECTED = 2,
104   PRIVATE_KEY_SHADOWED = 3
105 };
106
107 /*-- gpg-agent.c --*/
108 void agent_exit (int rc); /* also implemented in other tools */
109
110 /*-- command.c --*/
111 void start_command_handler (int, int);
112
113 /*-- findkey.c --*/
114 int agent_write_private_key (const unsigned char *grip,
115                              const void *buffer, size_t length, int force);
116 GCRY_SEXP agent_key_from_file (const unsigned char *grip,
117                                unsigned char **shadow_info, int ignore_cache);
118 int agent_key_available (const unsigned char *grip);
119
120 /*-- query.c --*/
121 int agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo);
122 int agent_get_passphrase (char **retpass,
123                           const char *desc, const char *prompt,
124                           const char *errtext);
125 int agent_get_confirmation (const char *desc, const char *ok,
126                             const char *cancel);
127
128 /*-- cache.c --*/
129 int agent_put_cache (const char *key, const char *data, int ttl);
130 const char *agent_get_cache (const char *key, void **cache_id);
131 void agent_unlock_cache_entry (void **cache_id);
132
133
134 /*-- pksign.c --*/
135 int agent_pksign (CTRL ctrl, FILE *outfp, int ignore_cache);
136
137 /*-- pkdecrypt.c --*/
138 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
139                      FILE *outfp);
140
141 /*-- genkey.c --*/
142 int agent_genkey (CTRL ctrl,
143                   const char *keyparam, size_t keyparmlen, FILE *outfp);
144
145 /*-- protect.c --*/
146 int agent_protect (const unsigned char *plainkey, const char *passphrase,
147                    unsigned char **result, size_t *resultlen);
148 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
149                      unsigned char **result, size_t *resultlen);
150 int agent_private_key_type (const unsigned char *privatekey);
151 int agent_shadow_key (const unsigned char *pubkey,
152                       const unsigned char *shadow_info,
153                       unsigned char **result);
154 int agent_get_shadow_info (const unsigned char *shadowkey,
155                            unsigned char const **shadow_info);
156
157
158 /*-- trustlist.c --*/
159 int agent_istrusted (const char *fpr);
160 int agent_listtrusted (void *assuan_context);
161 int agent_marktrusted (const char *name, const char *fpr, int flag);
162
163
164 /*-- divert-scd.c --*/
165 int divert_pksign (const unsigned char *digest, size_t digestlen, int algo,
166                    const unsigned char *shadow_info, unsigned char **r_sig);
167 int divert_pkdecrypt (const unsigned char *cipher,
168                       const unsigned char *shadow_info,
169                       char **r_buf, size_t *r_len);
170
171 /*-- call-scd.c --*/
172 int agent_card_learn (void (*kpinfo_cb)(void*, const char *),
173                       void *kpinfo_cb_arg,
174                       void (*certinfo_cb)(void*, const char *),
175                       void *certinfo_cb_arg);
176 int agent_card_serialno (char **r_serialno);
177 int agent_card_pksign (const char *keyid,
178                        int (*getpin_cb)(void *, const char *, char*, size_t),
179                        void *getpin_cb_arg,
180                        const unsigned char *indata, size_t indatalen,
181                        char **r_buf, size_t *r_buflen);
182 int agent_card_pkdecrypt (const char *keyid,
183                           int (*getpin_cb)(void *, const char *, char*,size_t),
184                           void *getpin_cb_arg,
185                           const unsigned char *indata, size_t indatalen,
186                           char **r_buf, size_t *r_buflen);
187 int agent_card_readcert (const char *id, char **r_buf, size_t *r_buflen);
188 int agent_card_readkey (const char *id, unsigned char **r_buf);
189
190
191 /*-- learncard.c --*/
192 int agent_handle_learn (void *assuan_context);
193
194
195 #endif /*AGENT_H*/