fix up 6562de7475b21cd03c7b1a83a591fa563c589f5b
[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 cafpr1len;     /* Length of the CA-fingerprint or 0 if invalid.  */
43   char cafpr2len;
44   char cafpr3len;
45   char cafpr1[20];
46   char cafpr2[20];
47   char cafpr3[20];
48   unsigned char fpr1len; /* Length of the fingerprint or 0 if invalid.  */
49   unsigned char fpr2len;
50   unsigned char fpr3len;
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     unsigned int bt:1;     /* Button for confirmation available.  */
73   } extcap;
74   unsigned int status_indicator;
75   int kdf_do_enabled;      /* True if card has a KDF object.  */
76   int uif[3];              /* True if User Interaction Flag is on.  */
77 };
78
79
80
81 /* Release the card info structure. */
82 void agent_release_card_info (struct agent_card_info_s *info);
83
84 /* Return card info. */
85 int agent_scd_learn (struct agent_card_info_s *info, int force);
86
87 /* Get the keypariinfo directly from scdaemon.  */
88 gpg_error_t agent_scd_keypairinfo (ctrl_t ctrl, const char *keyref,
89                                    strlist_t *r_list);
90
91 /* Return list of cards.  */
92 int agent_scd_cardlist (strlist_t *result);
93
94 /* Return the serial number, possibly select by DEMAND.  */
95 int agent_scd_serialno (char **r_serialno, const char *demand);
96
97 /* Send an APDU to the card.  */
98 gpg_error_t agent_scd_apdu (const char *hexapdu, unsigned int *r_sw);
99
100 /* Get attribute NAME from the card and store at R_VALUE.  */
101 gpg_error_t agent_scd_getattr_one (const char *name, char **r_value);
102
103 /* Update INFO with the attribute NAME. */
104 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
105
106 /* Send the KEYTOCARD command. */
107 int agent_keytocard (const char *hexgrip, int keyno, int force,
108                      const char *serialno, const char *timestamp);
109
110 /* Send a SETATTR command to the SCdaemon. */
111 gpg_error_t agent_scd_setattr (const char *name,
112                                const void *value, size_t valuelen);
113
114 /* Send a WRITECERT command to the SCdaemon. */
115 int agent_scd_writecert (const char *certidstr,
116                           const unsigned char *certdata, size_t certdatalen);
117
118 /* Send a GENKEY command to the SCdaemon. */
119 int agent_scd_genkey (int keyno, int force, u32 *createtime);
120
121 /* Send a READCERT command to the SCdaemon. */
122 int agent_scd_readcert (const char *certidstr,
123                         void **r_buf, size_t *r_buflen);
124
125 /* Send a READKEY command to the SCdaemon.  */
126 gpg_error_t agent_scd_readkey (const char *keyrefstr, gcry_sexp_t *r_result);
127
128 /* Change the PIN of an OpenPGP card or reset the retry counter. */
129 int agent_scd_change_pin (int chvno, const char *serialno);
130
131 /* Send the CHECKPIN command to the SCdaemon. */
132 int agent_scd_checkpin  (const char *serialno);
133
134 /* Send the GET_PASSPHRASE command to the agent.  */
135 gpg_error_t agent_get_passphrase (const char *cache_id,
136                                   const char *err_msg,
137                                   const char *prompt,
138                                   const char *desc_msg,
139                                   int repeat,
140                                   int check,
141                                   char **r_passphrase);
142
143 /* Send the CLEAR_PASSPHRASE command to the agent.  */
144 gpg_error_t agent_clear_passphrase (const char *cache_id);
145
146 /* Present the prompt DESC and ask the user to confirm.  */
147 gpg_error_t gpg_agent_get_confirmation (const char *desc);
148
149 /* Return the S2K iteration count as computed by gpg-agent.  */
150 unsigned long agent_get_s2k_count (void);
151
152 /* Check whether a secret key for public key PK is available.  Returns
153    0 if the secret key is available. */
154 gpg_error_t agent_probe_secret_key (ctrl_t ctrl, PKT_public_key *pk);
155
156 /* Ask the agent whether a secret key is availabale for any of the
157    keys (primary or sub) in KEYBLOCK.  Returns 0 if available.  */
158 gpg_error_t agent_probe_any_secret_key (ctrl_t ctrl, kbnode_t keyblock);
159
160
161 /* Return infos about the secret key with HEXKEYGRIP.  */
162 gpg_error_t agent_get_keyinfo (ctrl_t ctrl, const char *hexkeygrip,
163                                char **r_serialno, int *r_cleartext);
164
165 /* Generate a new key.  */
166 gpg_error_t agent_genkey (ctrl_t ctrl,
167                           char **cache_nonce_addr, char **passwd_nonce_addr,
168                           const char *keyparms, int no_protection,
169                           const char *passphrase,
170                           gcry_sexp_t *r_pubkey);
171
172 /* Read a public key.  */
173 gpg_error_t agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
174                            unsigned char **r_pubkey);
175
176 /* Create a signature.  */
177 gpg_error_t agent_pksign (ctrl_t ctrl, const char *cache_nonce,
178                           const char *hexkeygrip, const char *desc,
179                           u32 *keyid, u32 *mainkeyid, int pubkey_algo,
180                           unsigned char *digest, size_t digestlen,
181                           int digestalgo,
182                           gcry_sexp_t *r_sigval);
183
184 /* Decrypt a ciphertext.  */
185 gpg_error_t agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
186                              u32 *keyid, u32 *mainkeyid, int pubkey_algo,
187                              gcry_sexp_t s_ciphertext,
188                              unsigned char **r_buf, size_t *r_buflen,
189                              int *r_padding);
190
191 /* Retrieve a key encryption key.  */
192 gpg_error_t agent_keywrap_key (ctrl_t ctrl, int forexport,
193                                void **r_kek, size_t *r_keklen);
194
195 /* Send a key to the agent.  */
196 gpg_error_t agent_import_key (ctrl_t ctrl, const char *desc,
197                               char **cache_nonce_addr, const void *key,
198                               size_t keylen, int unattended, int force,
199                               u32 *keyid, u32 *mainkeyid, int pubkey_algo);
200
201 /* Receive a key from the agent.  */
202 gpg_error_t agent_export_key (ctrl_t ctrl, const char *keygrip,
203                               const char *desc, int openpgp_protected,
204                               char **cache_nonce_addr,
205                               unsigned char **r_result, size_t *r_resultlen,
206                               u32 *keyid, u32 *mainkeyid, int pubkey_algo);
207
208 /* Delete a key from the agent.  */
209 gpg_error_t agent_delete_key (ctrl_t ctrl, const char *hexkeygrip,
210                               const char *desc, int force);
211
212 /* Change the passphrase of a key.  */
213 gpg_error_t agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc,
214                           int verify,
215                           char **cache_nonce_addr, char **passwd_nonce_addr);
216 /* Get the version reported by gpg-agent.  */
217 gpg_error_t agent_get_version (ctrl_t ctrl, char **r_version);
218
219
220 #endif /*GNUPG_G10_CALL_AGENT_H*/