The Agent does now call the pin entry program; however because we have
[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   const char *homedir; /* configuration directory name */
37   const char *pinentry_program; 
38
39 } opt;
40
41
42 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
43 #define DBG_MPI_VALUE     2     /* debug mpi details */
44 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
45 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
46 #define DBG_CACHE_VALUE   64    /* debug the caching */
47 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
48 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
49
50 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
51 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
52 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
53 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
54 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
55
56 struct server_local_s;
57
58 struct server_control_s {
59   struct server_local_s *server_local;
60   struct {
61     int algo;
62     unsigned char value[MAX_DIGEST_LEN];
63     int valuelen;
64   } digest;
65   char keygrip[20];
66   int have_keygrip;
67
68 };
69 typedef struct server_control_s *CTRL;
70
71
72 struct pin_entry_info_s {
73   int min_digits; /* min. number of digits required or 0 for freeform entry */
74   int max_digits; /* max. number of allowed digits allowed*/
75   int max_tries;
76   int failed_tries;
77   size_t max_length; /* allocated length of the buffer */
78   char pin[1];
79 };
80
81
82 /*-- gpg-agent.c --*/
83 void agent_exit (int rc);
84
85 /*-- trans.c --*/
86 const char *trans (const char *text);
87
88 /*-- command.c --*/
89 void start_command_handler (void);
90
91 /*-- findkey.c --*/
92 GCRY_SEXP agent_key_from_file (const unsigned char *grip);
93
94 /*-- query.c --*/
95 int agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo);
96
97 /*-- pksign.c --*/
98 int agent_pksign (CTRL ctrl, FILE *outfp);
99
100 /*-- pkdecrypt.c --*/
101 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
102                      FILE *outfp);
103
104
105 #endif /*AGENT_H*/