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