* passphrase.c (agent_get_passphrase): New args CUSTOM_PROMPT and
[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   unsigned long sig_counter;
54   int chv1_cached;   /* True if a PIN is not required for each
55                         signing.  Note that the gpg-agent might cache
56                         it anyway. */
57   int chvmaxlen[3];  /* Maximum allowed length of a CHV. */
58   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
59 };
60
61 struct agent_card_genkey_s {
62   char fprvalid;
63   char fpr[20];
64   u32  created_at;
65   MPI  n;
66   MPI  e;
67 };
68
69
70 struct app_ctx_s;
71 struct ctrl_ctx_s;
72
73 typedef struct app_ctx_s *APP; /* deprecated. */
74 typedef struct app_ctx_s *app_t;
75 typedef struct ctrl_ctx_s *CTRL; /* deprecated. */
76 typedef struct ctrl_ctx_s *ctrl_t;
77
78
79 #define GPG_ERR_GENERAL           G10ERR_GENERAL
80 #define GPG_ERR_BAD_PIN           G10ERR_BAD_PASS
81 #define GPG_ERR_CARD              G10ERR_GENERAL
82 #define GPG_ERR_EEXIST            G10ERR_FILE_EXISTS
83 #define GPG_ERR_ENOMEM            G10ERR_RESOURCE_LIMIT
84 #define GPG_ERR_GENERAL           G10ERR_GENERAL
85 #define GPG_ERR_HARDWARE          G10ERR_GENERAL
86 #define GPG_ERR_INV_CARD          G10ERR_GENERAL
87 #define GPG_ERR_INV_ID            G10ERR_GENERAL
88 #define GPG_ERR_INV_NAME          G10ERR_GENERAL
89 #define GPG_ERR_INV_VALUE         G10ERR_INV_ARG
90 #define GPG_ERR_NOT_SUPPORTED     G10ERR_UNSUPPORTED
91 #define GPG_ERR_NO_OBJ            G10ERR_GENERAL
92 #define GPG_ERR_PIN_BLOCKED       G10ERR_PASSPHRASE
93 #define GPG_ERR_UNSUPPORTED_ALGORITHM G10ERR_PUBKEY_ALGO 
94 #define GPG_ERR_USE_CONDITIONS    G10ERR_GENERAL
95 #define GPG_ERR_WRONG_CARD        G10ERR_GENERAL
96 #define GPG_ERR_WRONG_SECKEY      G10ERR_WRONG_SECKEY
97 #define GPG_ERR_PIN_NOT_SYNCED    G10ERR_GENERAL
98 #define GPG_ERR_NOT_FOUND         G10ERR_GENERAL
99 #define GPG_ERR_BUG               G10ERR_GENERAL
100 #define GPG_ERR_NOT_IMPLEMENTED   G10ERR_GENERAL
101 #define GPG_ERR_BAD_BER           G10ERR_GENERAL
102 #define GPG_ERR_EOF               (-1)
103 #define GPG_ERR_CARD_NOT_PRESENT  G10ERR_NO_CARD
104 #define GPG_ERR_CARD_RESET        G10ERR_GENERAL
105
106 #define GPG_ERR_EBUSY             G10ERR_GENERAL
107 #define GPG_ERR_ENOENT            G10ERR_OPEN_FILE
108 #define GPG_ERR_EACCES            G10ERR_UNSUPPORTED
109 #define GPG_ERR_EIO               G10ERR_GENERAL
110 #define GPG_ERR_ENODEV            G10ERR_GENERAL
111 #define GPG_ERR_CANCELED          G10ERR_CANCELED
112
113 typedef int gpg_error_t;
114 typedef int gpg_err_code_t;
115
116 #define gpg_error(n) (n)
117 #define gpg_err_code(n) (n)
118 #define gpg_strerror(n) g10_errstr ((n))
119 #define gpg_error_from_errno(n) (G10ERR_GENERAL) /*FIXME*/
120 #define gpg_err_code_from_errno(n) (G10ERR_GENERAL)
121
122 /* We are not using it in a library, so we even let xtrymalloc
123    abort. Because we won't never return from these malloc functions,
124    we also don't need the out_of_core function, we simply define it to
125    return -1 */
126 #define xtrymalloc(n)    xmalloc((n))
127 #define xtrycalloc(n,m)  xcalloc((n),(m))
128 #define xtryrealloc(n,m) xrealloc((n),(m))
129 #define out_of_core()    (-1) 
130
131 #define gnupg_get_time() make_timestamp ()
132
133
134 void card_set_reader_port (const char *portstr);
135
136 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
137                                 PKT_secret_key *sk);
138 void send_status_info (ctrl_t ctrl, const char *keyword, ...);
139 void gcry_md_hash_buffer (int algo, void *digest,
140                           const void *buffer, size_t length);
141 void log_printf (const char *fmt, ...);
142 void log_printhex (const char *text, const void *buffer, size_t length);
143
144
145 #define GCRY_MD_SHA1 DIGEST_ALGO_SHA1
146 #define GCRY_MD_RMD160 DIGEST_ALGO_RMD160
147
148 void card_close (void);
149
150
151 /* Release the card info structure. */
152 void agent_release_card_info (struct agent_card_info_s *info);
153
154 /* Return card info. */
155 int agent_learn (struct agent_card_info_s *info);
156
157 /* Check whether the secret key for the key identified by HEXKEYGRIP
158    is available.  Return 0 for yes or an error code. */
159 int agent_havekey (const char *hexkeygrip);
160
161 /* Return card info. */
162 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
163
164 /* Send a SETATTR command to the SCdaemon. */
165 int agent_scd_setattr (const char *name,
166                        const unsigned char *value, size_t valuelen);
167
168 /* Send a GENKEY command to the SCdaemon. */
169 int agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force);
170
171 /* Send a PKSIGN command to the SCdaemon. */
172 int agent_scd_pksign (const char *keyid, int hashalgo,
173                       const unsigned char *indata, size_t indatalen,
174                       unsigned char **r_buf, size_t *r_buflen);
175
176 /* Send a PKDECRYPT command to the SCdaemon. */
177 int agent_scd_pkdecrypt (const char *serialno,
178                          const unsigned char *indata, size_t indatalen,
179                          unsigned char **r_buf, size_t *r_buflen);
180
181 /* Change the PIN of an OpenPGP card or reset the retry counter. */
182 int agent_scd_change_pin (int chvno);
183
184 /* Send a CHECKPIN command. */
185 int agent_scd_checkpin (const char *serialnobuf);
186
187 /* Call the store key utility command. */
188 int agent_openpgp_storekey (int keyno,
189                             unsigned char *template, size_t template_len,
190                             time_t created_at,
191                             const unsigned char *m, size_t mlen,
192                             const unsigned char *e, size_t elen);
193
194 #endif /*ENABLE_CARD_SUPPORT*/
195 #endif /*GNUPG_G10_CARDGLUE_H*/
196