gpg: Sanitize diagnostic with the original file name.
[gnupg.git] / g10 / call-agent.h
1 /* call-agent.h - Divert operations to the agent
2  * Copyright (C) 2003 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 3 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, see <https://www.gnu.org/licenses/>.
18  */
19 #ifndef GNUPG_G10_CALL_AGENT_H
20 #define GNUPG_G10_CALL_AGENT_H
21
22 struct key_attr {
23   int algo;              /* Algorithm identifier.  */
24   union {
25     unsigned int nbits;  /* Supported keysize.  */
26     const char *curve;   /* Name of curve.  */
27   };
28 };
29
30 struct agent_card_info_s
31 {
32   int error;         /* private. */
33   char *reader;      /* Reader information.  */
34   char *apptype;     /* Malloced application type string.  */
35   char *serialno;    /* malloced hex string. */
36   char *disp_name;   /* malloced. */
37   char *disp_lang;   /* malloced. */
38   int  disp_sex;     /* 0 = unspecified, 1 = male, 2 = female */
39   char *pubkey_url;  /* malloced. */
40   char *login_data;  /* malloced. */
41   char *private_do[4]; /* malloced. */
42   char cafpr1valid;
43   char cafpr2valid;
44   char cafpr3valid;
45   char cafpr1[20];
46   char cafpr2[20];
47   char cafpr3[20];
48   char fpr1valid;
49   char fpr2valid;
50   char fpr3valid;
51   char fpr1[20];
52   char fpr2[20];
53   char fpr3[20];
54   u32  fpr1time;
55   u32  fpr2time;
56   u32  fpr3time;
57   char grp1[20];     /* The keygrip for OPENPGP.1 */
58   char grp2[20];     /* The keygrip for OPENPGP.2 */
59   char grp3[20];     /* The keygrip for OPENPGP.3 */
60   unsigned long sig_counter;
61   int chv1_cached;   /* True if a PIN is not required for each
62                         signing.  Note that the gpg-agent might cache
63                         it anyway. */
64   int is_v2;         /* True if this is a v2 card.  */
65   int chvmaxlen[3];  /* Maximum allowed length of a CHV. */
66   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
67   struct key_attr key_attr[3];
68   struct {
69     unsigned int ki:1;     /* Key import available.  */
70     unsigned int aac:1;    /* Algorithm attributes are changeable.  */
71     unsigned int kdf:1;    /* KDF object to support PIN hashing available.  */
72   } extcap;
73   unsigned int status_indicator;
74 };
75
76
77
78 /* Release the card info structure. */
79 void agent_release_card_info (struct agent_card_info_s *info);
80
81 /* Return card info. */
82 int agent_scd_learn (struct agent_card_info_s *info, int force);
83
84 /* Return list of cards.  */
85 int agent_scd_cardlist (strlist_t *result);
86
87 /* Return the serial number, possibly select by DEMAND.  */
88 int agent_scd_serialno (char **r_serialno, const char *demand);
89
90 /* Send an APDU to the card.  */
91 gpg_error_t agent_scd_apdu (const char *hexapdu, unsigned int *r_sw);
92
93 /* Update INFO with the attribute NAME. */
94 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
95
96 /* Send the KEYTOCARD command. */
97 int agent_keytocard (const char *hexgrip, int keyno, int force,
98                      const char *serialno, const char *timestamp);
99
100 /* Send a SETATTR command to the SCdaemon. */
101 int agent_scd_setattr (const char *name,
102                        const unsigned char *value, size_t valuelen,
103                        const char *serialno);
104
105 /* Send a WRITECERT command to the SCdaemon. */
106 int agent_scd_writecert (const char *certidstr,
107                           const unsigned char *certdata, size_t certdatalen);
108
109 /* Send a WRITEKEY command to the SCdaemon. */
110 int agent_scd_writekey (int keyno, const char *serialno,
111                         const unsigned char *keydata, size_t keydatalen);
112
113 /* Send a GENKEY command to the SCdaemon. */
114 int agent_scd_genkey (int keyno, int force, u32 *createtime);
115
116 /* Send a READKEY command to the SCdaemon. */
117 int agent_scd_readcert (const char *certidstr,
118                         void **r_buf, size_t *r_buflen);
119
120 /* Change the PIN of an OpenPGP card or reset the retry counter. */
121 int agent_scd_change_pin (int chvno, const char *serialno);
122
123 /* Send the CHECKPIN command to the SCdaemon. */
124 int agent_scd_checkpin  (const char *serialno);
125
126 /* Dummy function, only implemented by gpg 1.4. */
127 void agent_clear_pin_cache (const char *sn);
128
129
130 /* Send the GET_PASSPHRASE command to the agent.  */
131 gpg_error_t agent_get_passphrase (const char *cache_id,
132                                   const char *err_msg,
133                                   const char *prompt,
134                                   const char *desc_msg,
135                                   int repeat,
136                                   int check,
137                                   char **r_passphrase);
138
139 /* Send the CLEAR_PASSPHRASE command to the agent.  */
140 gpg_error_t agent_clear_passphrase (const char *cache_id);
141
142 /* Present the prompt DESC and ask the user to confirm.  */
143 gpg_error_t gpg_agent_get_confirmation (const char *desc);
144
145 /* Return the S2K iteration count as computed by gpg-agent.  */
146 gpg_error_t agent_get_s2k_count (unsigned long *r_count);
147
148 /* Check whether a secret key for public key PK is available.  Returns
149    0 if the secret key is available. */
150 gpg_error_t agent_probe_secret_key (ctrl_t ctrl, PKT_public_key *pk);
151
152 /* Ask the agent whether a secret key is availabale for any of the
153    keys (primary or sub) in KEYBLOCK.  Returns 0 if available.  */
154 gpg_error_t agent_probe_any_secret_key (ctrl_t ctrl, kbnode_t keyblock);
155
156
157 /* Return infos about the secret key with HEXKEYGRIP.  */
158 gpg_error_t agent_get_keyinfo (ctrl_t ctrl, const char *hexkeygrip,
159                                char **r_serialno, int *r_cleartext);
160
161 /* Generate a new key.  */
162 gpg_error_t agent_genkey (ctrl_t ctrl,
163                           char **cache_nonce_addr, char **passwd_nonce_addr,
164                           const char *keyparms, int no_protection,
165                           const char *passphrase,
166                           gcry_sexp_t *r_pubkey);
167
168 /* Read a public key.  */
169 gpg_error_t agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
170                            unsigned char **r_pubkey);
171
172 /* Create a signature.  */
173 gpg_error_t agent_pksign (ctrl_t ctrl, const char *cache_nonce,
174                           const char *hexkeygrip, const char *desc,
175                           u32 *keyid, u32 *mainkeyid, int pubkey_algo,
176                           unsigned char *digest, size_t digestlen,
177                           int digestalgo,
178                           gcry_sexp_t *r_sigval);
179
180 /* Decrypt a ciphertext.  */
181 gpg_error_t agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
182                              u32 *keyid, u32 *mainkeyid, int pubkey_algo,
183                              gcry_sexp_t s_ciphertext,
184                              unsigned char **r_buf, size_t *r_buflen,
185                              int *r_padding);
186
187 /* Retrieve a key encryption key.  */
188 gpg_error_t agent_keywrap_key (ctrl_t ctrl, int forexport,
189                                void **r_kek, size_t *r_keklen);
190
191 /* Send a key to the agent.  */
192 gpg_error_t agent_import_key (ctrl_t ctrl, const char *desc,
193                               char **cache_nonce_addr, const void *key,
194                               size_t keylen, int unattended, int force,
195                               u32 *keyid, u32 *mainkeyid, int pubkey_algo);
196
197 /* Receive a key from the agent.  */
198 gpg_error_t agent_export_key (ctrl_t ctrl, const char *keygrip,
199                               const char *desc, int openpgp_protected,
200                               char **cache_nonce_addr,
201                               unsigned char **r_result, size_t *r_resultlen,
202                               u32 *keyid, u32 *mainkeyid, int pubkey_algo);
203
204 /* Delete a key from the agent.  */
205 gpg_error_t agent_delete_key (ctrl_t ctrl, const char *hexkeygrip,
206                               const char *desc, int force);
207
208 /* Change the passphrase of a key.  */
209 gpg_error_t agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc,
210                           int verify,
211                           char **cache_nonce_addr, char **passwd_nonce_addr);
212 /* Get the version reported by gpg-agent.  */
213 gpg_error_t agent_get_version (ctrl_t ctrl, char **r_version);
214
215
216 #endif /*GNUPG_G10_CALL_AGENT_H*/