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