* g10.c (main): Default {export|import}-unusable-sigs to off until the
[gnupg.git] / g10 / cardglue.h
1 /* cardglue.h - Divert operations to the agent
2  * Copyright (C) 2003, 2004 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 #ifndef GNUPG_G10_CARDGLUE_H
21 #define GNUPG_G10_CARDGLUE_H 
22
23 #ifdef ENABLE_CARD_SUPPORT
24 /* 
25    Note, that most card related code has been taken from 1.9.x branch
26    and is maintained over there if at all possible.  Thus, if you make
27    changes here, please check that a similar change has been commited
28    to the 1.9.x branch.
29 */
30
31
32 struct agent_card_info_s {
33   int error;         /* private. */
34   char *serialno;    /* malloced hex string. */
35   char *disp_name;   /* malloced. */
36   char *disp_lang;   /* malloced. */
37   int  disp_sex;     /* 0 = unspecified, 1 = male, 2 = female */
38   char *pubkey_url;  /* malloced. */
39   char *login_data;  /* malloced. */
40   char *private_do[4]; /* malloced. */
41   char cafpr1valid;
42   char cafpr2valid;
43   char cafpr3valid;
44   char cafpr1[20];
45   char cafpr2[20];
46   char cafpr3[20];
47   char fpr1valid;
48   char fpr2valid;
49   char fpr3valid;
50   char fpr1[20];
51   char fpr2[20];
52   char fpr3[20];
53   u32  fpr1time;
54   u32  fpr2time;
55   u32  fpr3time;
56   unsigned long sig_counter;
57   int chv1_cached;   /* True if a PIN is not required for each
58                         signing.  Note that the gpg-agent might cache
59                         it anyway. */
60   int chvmaxlen[3];  /* Maximum allowed length of a CHV. */
61   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
62 };
63
64 struct agent_card_genkey_s {
65   char fprvalid;
66   char fpr[20];
67   u32  created_at;
68   MPI  n;
69   MPI  e;
70 };
71
72
73 struct app_ctx_s;
74 struct ctrl_ctx_s;
75
76 typedef struct app_ctx_s *APP; /* deprecated. */
77 typedef struct app_ctx_s *app_t;
78 typedef struct ctrl_ctx_s *CTRL; /* deprecated. */
79 typedef struct ctrl_ctx_s *ctrl_t;
80
81
82 #define GPG_ERR_GENERAL           G10ERR_GENERAL
83 #define GPG_ERR_BAD_PIN           G10ERR_BAD_PASS
84 #define GPG_ERR_BAD_KEy           G10ERR_BAD_KEY
85 #define GPG_ERR_CARD              G10ERR_GENERAL
86 #define GPG_ERR_EEXIST            G10ERR_FILE_EXISTS
87 #define GPG_ERR_ENOMEM            G10ERR_RESOURCE_LIMIT
88 #define GPG_ERR_GENERAL           G10ERR_GENERAL
89 #define GPG_ERR_HARDWARE          G10ERR_GENERAL
90 #define GPG_ERR_INV_CARD          G10ERR_GENERAL
91 #define GPG_ERR_INV_ID            G10ERR_GENERAL
92 #define GPG_ERR_INV_NAME          G10ERR_GENERAL
93 #define GPG_ERR_INV_VALUE         G10ERR_INV_ARG
94 #define GPG_ERR_NOT_SUPPORTED     G10ERR_UNSUPPORTED
95 #define GPG_ERR_NO_OBJ            G10ERR_GENERAL
96 #define GPG_ERR_PIN_BLOCKED       G10ERR_PASSPHRASE
97 #define GPG_ERR_UNSUPPORTED_ALGORITHM G10ERR_PUBKEY_ALGO 
98 #define GPG_ERR_USE_CONDITIONS    G10ERR_GENERAL
99 #define GPG_ERR_WRONG_CARD        G10ERR_GENERAL
100 #define GPG_ERR_WRONG_SECKEY      G10ERR_WRONG_SECKEY
101 #define GPG_ERR_PIN_NOT_SYNCED    G10ERR_GENERAL
102 #define GPG_ERR_NOT_FOUND         G10ERR_GENERAL
103 #define GPG_ERR_BUG               G10ERR_GENERAL
104 #define GPG_ERR_NOT_IMPLEMENTED   G10ERR_GENERAL
105 #define GPG_ERR_BAD_BER           G10ERR_GENERAL
106 #define GPG_ERR_EOF               (-1)
107 #define GPG_ERR_CARD_NOT_PRESENT  G10ERR_NO_CARD
108 #define GPG_ERR_CARD_RESET        G10ERR_GENERAL
109 #define GPG_ERR_WRONG_PUBKEY_ALGO G10ERR_PUBKEY_ALGO
110 #define GPG_ERR_UNKNOWN_SEXP      G10ERR_INV_ARG
111 #define GPG_ERR_DUP_VALUE         G10ERR_INV_ARG
112 #define GPG_ERR_BAD_SECKEY        G10ERR_BAD_SECKEY
113
114 #define GPG_ERR_EBUSY             G10ERR_GENERAL
115 #define GPG_ERR_ENOENT            G10ERR_OPEN_FILE
116 #define GPG_ERR_EACCES            G10ERR_UNSUPPORTED
117 #define GPG_ERR_EIO               G10ERR_GENERAL
118 #define GPG_ERR_ENODEV            G10ERR_GENERAL
119 #define GPG_ERR_CANCELED          G10ERR_CANCELED
120
121 typedef int gpg_error_t;
122 typedef int gpg_err_code_t;
123
124 #define gpg_error(n) (n)
125 #define gpg_err_code(n) (n)
126 #define gpg_strerror(n) g10_errstr ((n))
127 #define gpg_error_from_errno(n) (G10ERR_GENERAL) /*FIXME*/
128 #define gpg_err_code_from_errno(n) (G10ERR_GENERAL)
129
130 /* We are not using it in a library, so we even let xtrymalloc
131    abort. Because we won't never return from these malloc functions,
132    we also don't need the out_of_core function, we simply define it to
133    return -1 */
134 #define xtrymalloc(n)    xmalloc((n))
135 #define xtrycalloc(n,m)  xcalloc((n),(m))
136 #define xtryrealloc(n,m) xrealloc((n),(m))
137 #define xtrymalloc_secure(n)  xmalloc_secure((n))
138 #define out_of_core()    (-1) 
139
140 #define gnupg_get_time() make_timestamp ()
141
142
143 void card_set_reader_port (const char *portstr);
144
145 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
146                                 PKT_secret_key *sk);
147 void send_status_info (ctrl_t ctrl, const char *keyword, ...);
148 void gcry_md_hash_buffer (int algo, void *digest,
149                           const void *buffer, size_t length);
150 void log_printf (const char *fmt, ...);
151 void log_printhex (const char *text, const void *buffer, size_t length);
152
153
154 #define GCRY_MD_SHA1 DIGEST_ALGO_SHA1
155 #define GCRY_MD_RMD160 DIGEST_ALGO_RMD160
156
157 void card_close (void);
158
159
160 /* Release the card info structure. */
161 void agent_release_card_info (struct agent_card_info_s *info);
162
163 /* Return card info. */
164 int agent_learn (struct agent_card_info_s *info);
165
166 /* Check whether the secret key for the key identified by HEXKEYGRIP
167    is available.  Return 0 for yes or an error code. */
168 int agent_havekey (const char *hexkeygrip);
169
170 /* Return card info. */
171 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
172
173 /* Send a SETATTR command to the SCdaemon. */
174 int agent_scd_setattr (const char *name,
175                        const unsigned char *value, size_t valuelen);
176
177 /* Send a WRITEKEY command to the SCdaemon. */
178 int agent_scd_writekey (int keyno,
179                         const unsigned char *keydata, size_t keydatalen);
180
181 /* Send a GENKEY command to the SCdaemon. */
182 int agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force);
183
184 /* Send a PKSIGN command to the SCdaemon. */
185 int agent_scd_pksign (const char *keyid, int hashalgo,
186                       const unsigned char *indata, size_t indatalen,
187                       unsigned char **r_buf, size_t *r_buflen);
188
189 /* Send a PKDECRYPT command to the SCdaemon. */
190 int agent_scd_pkdecrypt (const char *serialno,
191                          const unsigned char *indata, size_t indatalen,
192                          unsigned char **r_buf, size_t *r_buflen);
193
194 /* Change the PIN of an OpenPGP card or reset the retry counter. */
195 int agent_scd_change_pin (int chvno);
196
197 /* Send a CHECKPIN command. */
198 int agent_scd_checkpin (const char *serialnobuf);
199
200 /* Clear a cached PIN. */
201 void agent_clear_pin_cache (const char *sn);
202
203
204 #endif /*ENABLE_CARD_SUPPORT*/
205 #endif /*GNUPG_G10_CARDGLUE_H*/
206