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