9236ef07a922961db2489dcfae2b9b7735c59166
[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   int no_grab;      /* don't let the pinentry grab the keyboard */
40   unsigned long def_cache_ttl;
41
42 } opt;
43
44
45 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
46 #define DBG_MPI_VALUE     2     /* debug mpi details */
47 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
48 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
49 #define DBG_CACHE_VALUE   64    /* debug the caching */
50 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
51 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
52 #define DBG_ASSUAN_VALUE 1024   
53
54 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
55 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
56 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
57 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
58 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
59 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
60
61 struct server_local_s;
62
63 struct server_control_s {
64   struct server_local_s *server_local;
65   struct {
66     int algo;
67     unsigned char value[MAX_DIGEST_LEN];
68     int valuelen;
69   } digest;
70   char keygrip[20];
71   int have_keygrip;
72
73 };
74 typedef struct server_control_s *CTRL;
75
76
77 struct pin_entry_info_s {
78   int min_digits; /* min. number of digits required or 0 for freeform entry */
79   int max_digits; /* max. number of allowed digits allowed*/
80   int max_tries;
81   int failed_tries;
82   size_t max_length; /* allocated length of the buffer */
83   char pin[1];
84 };
85
86
87 enum {
88   PRIVATE_KEY_UNKNOWN = 0,
89   PRIVATE_KEY_CLEAR = 1,
90   PRIVATE_KEY_PROTECTED = 2,
91   PRIVATE_KEY_SHADOWED = 3
92 };
93
94 /*-- gpg-agent.c --*/
95 void agent_exit (int rc); /* also implemented in other tools */
96
97 /*-- trans.c --*/
98 const char *trans (const char *text);
99
100 /*-- command.c --*/
101 void start_command_handler (int);
102
103 /*-- findkey.c --*/
104 GCRY_SEXP agent_key_from_file (const unsigned char *grip);
105 int agent_key_available (const unsigned char *grip);
106
107 /*-- query.c --*/
108 int agent_askpin (const char *desc_text, const char *err_text,
109                   struct pin_entry_info_s *pininfo);
110 int agent_get_passphrase (char **retpass,
111                           const char *desc, const char *prompt,
112                           const char *errtext);
113
114 /*-- cache.c --*/
115 int agent_put_cache (const char *key, const char *data, int ttl);
116 const char *agent_get_cache (const char *key);
117
118
119
120 /*-- pksign.c --*/
121 int agent_pksign (CTRL ctrl, FILE *outfp);
122
123 /*-- pkdecrypt.c --*/
124 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
125                      FILE *outfp);
126
127 /*-- genkey.c --*/
128 int agent_genkey (CTRL ctrl,
129                   const char *keyparam, size_t keyparmlen, FILE *outfp);
130
131 /*-- protect.c --*/
132 int agent_protect (const unsigned char *plainkey, const char *passphrase,
133                    unsigned char **result, size_t *resultlen);
134 int agent_unprotect (const unsigned char *protectedkey, const char *passphrase,
135                      unsigned char **result, size_t *resultlen);
136 int agent_private_key_type (const unsigned char *privatekey);
137
138
139 /*-- trustlist.c --*/
140 int agent_istrusted (const char *fpr);
141 int agent_listtrusted (void *assuan_context);
142
143
144
145 #endif /*AGENT_H*/