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