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