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