2002-04-25 Marcus Brinkmann <marcus@g10code.de>
[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   size_t max_length; /* allocated length of the buffer */
89   char pin[1];
90 };
91
92
93 enum {
94   PRIVATE_KEY_UNKNOWN = 0,
95   PRIVATE_KEY_CLEAR = 1,
96   PRIVATE_KEY_PROTECTED = 2,
97   PRIVATE_KEY_SHADOWED = 3
98 };
99
100 /*-- gpg-agent.c --*/
101 void agent_exit (int rc); /* also implemented in other tools */
102
103 /*-- trans.c --*/
104 const char *trans (const char *text);
105
106 /*-- command.c --*/
107 void start_command_handler (int);
108
109 /*-- findkey.c --*/
110 int agent_write_private_key (const unsigned char *grip,
111                              const void *buffer, size_t length, int force);
112 GCRY_SEXP agent_key_from_file (const unsigned char *grip,
113                                unsigned char **shadow_info);
114 int agent_key_available (const unsigned char *grip);
115
116 /*-- query.c --*/
117 int agent_askpin (const char *desc_text, const char *err_text,
118                   struct pin_entry_info_s *pininfo);
119 int agent_get_passphrase (char **retpass,
120                           const char *desc, const char *prompt,
121                           const char *errtext);
122 int agent_get_confirmation (const char *desc, const char *ok,
123                             const char *cancel);
124
125 /*-- cache.c --*/
126 int agent_put_cache (const char *key, const char *data, int ttl);
127 const char *agent_get_cache (const char *key);
128
129
130
131 /*-- pksign.c --*/
132 int agent_pksign (CTRL ctrl, FILE *outfp);
133
134 /*-- pkdecrypt.c --*/
135 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
136                      FILE *outfp);
137
138 /*-- genkey.c --*/
139 int agent_genkey (CTRL ctrl,
140                   const char *keyparam, size_t keyparmlen, FILE *outfp);
141
142 /*-- protect.c --*/
143 int agent_protect (const unsigned char *plainkey, const char *passphrase,
144                    unsigned char **result, size_t *resultlen);
145 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
146                      unsigned char **result, size_t *resultlen);
147 int agent_private_key_type (const unsigned char *privatekey);
148 int agent_shadow_key (const unsigned char *pubkey,
149                       const unsigned char *shadow_info,
150                       unsigned char **result);
151 int agent_get_shadow_info (const unsigned char *shadowkey,
152                            unsigned char const **shadow_info);
153
154
155 /*-- trustlist.c --*/
156 int agent_istrusted (const char *fpr);
157 int agent_listtrusted (void *assuan_context);
158 int agent_marktrusted (const char *name, const char *fpr, int flag);
159
160
161 /*-- divert-scd.c --*/
162 int divert_pksign (const unsigned char *digest, size_t digestlen, int algo,
163                    const unsigned char *shadow_info, unsigned char **r_sig);
164 int divert_pkdecrypt (const unsigned char *cipher,
165                       const unsigned char *shadow_info,
166                       char **r_buf, size_t *r_len);
167
168 /*-- call-scd.c --*/
169 int agent_card_learn (void (*kpinfo_cb)(void*, const char *),
170                       void *kpinfo_cb_arg);
171 int agent_card_serialno (char **r_serialno);
172 int agent_card_pksign (const char *keyid,
173                        int (*getpin_cb)(void *, const char *, char*, size_t),
174                        void *getpin_cb_arg,
175                        const unsigned char *indata, size_t indatalen,
176                        char **r_buf, size_t *r_buflen);
177 int agent_card_pkdecrypt (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_readcert (const char *id, char **r_buf, size_t *r_buflen);
183 int agent_card_readkey (const char *id, unsigned char **r_buf);
184
185
186 /*-- learncard.c --*/
187 int agent_handle_learn (void *assuan_context);
188
189
190 #endif /*AGENT_H*/