* gpg-agent.c: Removed unused cruft and implement the socket
[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
40 } opt;
41
42
43 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
44 #define DBG_MPI_VALUE     2     /* debug mpi details */
45 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
46 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
47 #define DBG_CACHE_VALUE   64    /* debug the caching */
48 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
49 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
50 #define DBG_ASSUAN_VALUE 1024   
51
52 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
53 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
54 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
55 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
56 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
57 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
58
59 struct server_local_s;
60
61 struct server_control_s {
62   struct server_local_s *server_local;
63   struct {
64     int algo;
65     unsigned char value[MAX_DIGEST_LEN];
66     int valuelen;
67   } digest;
68   char keygrip[20];
69   int have_keygrip;
70
71 };
72 typedef struct server_control_s *CTRL;
73
74
75 struct pin_entry_info_s {
76   int min_digits; /* min. number of digits required or 0 for freeform entry */
77   int max_digits; /* max. number of allowed digits allowed*/
78   int max_tries;
79   int failed_tries;
80   size_t max_length; /* allocated length of the buffer */
81   char pin[1];
82 };
83
84
85 /*-- gpg-agent.c --*/
86 void agent_exit (int rc);
87
88 /*-- trans.c --*/
89 const char *trans (const char *text);
90
91 /*-- command.c --*/
92 void start_command_handler (int);
93
94 /*-- findkey.c --*/
95 GCRY_SEXP agent_key_from_file (const unsigned char *grip);
96
97 /*-- query.c --*/
98 int agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo);
99 int agent_get_passphrase (char **retpass,
100                           const char *desc, const char *prompt,
101                           const char *errtext);
102
103 /*-- pksign.c --*/
104 int agent_pksign (CTRL ctrl, FILE *outfp);
105
106 /*-- pkdecrypt.c --*/
107 int agent_pkdecrypt (CTRL ctrl, const char *ciphertext, size_t ciphertextlen,
108                      FILE *outfp);
109
110 /*-- genkey.c --*/
111 int agent_genkey (CTRL ctrl,
112                   const char *keyparam, size_t keyparmlen, FILE *outfp);
113
114 /*-- trustlist.c --*/
115 int agent_istrusted (const char *fpr);
116 int agent_listtrusted (void *assuan_context);
117
118
119
120 #endif /*AGENT_H*/