scd:piv: Allow writecert to only write matching certs.
[gnupg.git] / scd / app-common.h
1 /* app-common.h - Common declarations for all card applications
2  * Copyright (C) 2003, 2005, 2008 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  * $Id$
20  */
21
22 #ifndef GNUPG_SCD_APP_COMMON_H
23 #define GNUPG_SCD_APP_COMMON_H
24
25 #include <npth.h>
26 #include <ksba.h>
27
28 /* Flags used with app_change_pin.  */
29 #define APP_CHANGE_FLAG_RESET    1  /* PIN Reset mode.  */
30 #define APP_CHANGE_FLAG_NULLPIN  2  /* NULL PIN mode.  */
31 #define APP_CHANGE_FLAG_CLEAR    4  /* Clear the given PIN.  */
32
33 /* Flags used with app_genkey.  */
34 #define APP_GENKEY_FLAG_FORCE    1  /* Force overwriting existing key.  */
35
36 /* Bit flags set by the decipher function into R_INFO.  */
37 #define APP_DECIPHER_INFO_NOPAD  1  /* Padding has been removed.  */
38
39
40 struct app_local_s;  /* Defined by all app-*.c.  */
41
42 struct app_ctx_s {
43   struct app_ctx_s *next;
44
45   npth_mutex_t lock;
46
47   /* Number of connections currently using this application context.
48      If this is not 0 the application has been initialized and the
49      function pointers may be used.  Note that for unsupported
50      operations the particular function pointer is set to NULL */
51   unsigned int ref_count;
52
53   /* Used reader slot. */
54   int slot;
55
56   unsigned char *serialno; /* Serialnumber in raw form, allocated. */
57   size_t serialnolen;      /* Length in octets of serialnumber. */
58   const char *cardtype;    /* NULL or string with the token's type.  */
59   const char *apptype;
60   unsigned int card_version;
61   unsigned int card_status;
62   unsigned int reset_requested:1;
63   unsigned int periodical_check_needed:1;
64   unsigned int did_chv1:1;
65   unsigned int force_chv1:1;   /* True if the card does not cache CHV1. */
66   unsigned int did_chv2:1;
67   unsigned int did_chv3:1;
68   struct app_local_s *app_local;  /* Local to the application. */
69   struct {
70     void (*deinit) (app_t app);
71     gpg_error_t (*learn_status) (app_t app, ctrl_t ctrl, unsigned int flags);
72     gpg_error_t (*readcert) (app_t app, const char *certid,
73                      unsigned char **cert, size_t *certlen);
74     gpg_error_t (*readkey) (app_t app, const char *certid,
75                     unsigned char **pk, size_t *pklen);
76     gpg_error_t (*getattr) (app_t app, ctrl_t ctrl, const char *name);
77     gpg_error_t (*setattr) (app_t app, const char *name,
78                     gpg_error_t (*pincb)(void*, const char *, char **),
79                     void *pincb_arg,
80                     const unsigned char *value, size_t valuelen);
81     gpg_error_t (*sign) (app_t app,
82                  const char *keyidstr, int hashalgo,
83                  gpg_error_t (*pincb)(void*, const char *, char **),
84                  void *pincb_arg,
85                  const void *indata, size_t indatalen,
86                  unsigned char **outdata, size_t *outdatalen );
87     gpg_error_t (*auth) (app_t app, const char *keyidstr,
88                  gpg_error_t (*pincb)(void*, const char *, char **),
89                  void *pincb_arg,
90                  const void *indata, size_t indatalen,
91                  unsigned char **outdata, size_t *outdatalen);
92     gpg_error_t (*decipher) (app_t app, const char *keyidstr,
93                              gpg_error_t (*pincb)(void*, const char *, char **),
94                              void *pincb_arg,
95                              const void *indata, size_t indatalen,
96                              unsigned char **outdata, size_t *outdatalen,
97                              unsigned int *r_info);
98     gpg_error_t (*writecert) (app_t app, ctrl_t ctrl,
99                               const char *certid,
100                               gpg_error_t (*pincb)(void*,const char *,char **),
101                               void *pincb_arg,
102                               const unsigned char *data, size_t datalen);
103     gpg_error_t (*writekey) (app_t app, ctrl_t ctrl,
104                              const char *keyid, unsigned int flags,
105                              gpg_error_t (*pincb)(void*,const char *,char **),
106                              void *pincb_arg,
107                              const unsigned char *pk, size_t pklen);
108     gpg_error_t (*genkey) (app_t app, ctrl_t ctrl,
109                            const char *keyref, const char *keytype,
110                            unsigned int flags, time_t createtime,
111                            gpg_error_t (*pincb)(void*, const char *, char **),
112                            void *pincb_arg);
113     gpg_error_t (*change_pin) (app_t app, ctrl_t ctrl,
114                        const char *chvnostr, unsigned int flags,
115                        gpg_error_t (*pincb)(void*, const char *, char **),
116                        void *pincb_arg);
117     gpg_error_t (*check_pin) (app_t app, const char *keyidstr,
118                       gpg_error_t (*pincb)(void*, const char *, char **),
119                       void *pincb_arg);
120   } fnc;
121 };
122
123 /*-- app-help.c --*/
124 unsigned int app_help_count_bits (const unsigned char *a, size_t len);
125 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
126 gpg_error_t app_help_pubkey_from_cert (const void *cert, size_t certlen,
127                                        unsigned char **r_pk, size_t *r_pklen);
128 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
129
130
131 /*-- app.c --*/
132 void app_send_card_list (ctrl_t ctrl);
133 char *app_get_serialno (app_t app);
134
135 void app_dump_state (void);
136 void application_notify_card_reset (int slot);
137 gpg_error_t check_application_conflict (const char *name, app_t app);
138 gpg_error_t app_reset (app_t app, ctrl_t ctrl, int send_reset);
139 gpg_error_t select_application (ctrl_t ctrl, const char *name, app_t *r_app,
140                                 int scan, const unsigned char *serialno_bin,
141                                 size_t serialno_bin_len);
142 char *get_supported_applications (void);
143 void release_application (app_t app, int locked_already);
144 gpg_error_t app_munge_serialno (app_t app);
145 gpg_error_t app_write_learn_status (app_t app, ctrl_t ctrl,
146                                     unsigned int flags);
147 gpg_error_t app_readcert (app_t app, ctrl_t ctrl, const char *certid,
148                   unsigned char **cert, size_t *certlen);
149 gpg_error_t app_readkey (app_t app, ctrl_t ctrl,
150                  const char *keyid, unsigned char **pk, size_t *pklen);
151 gpg_error_t app_getattr (app_t app, ctrl_t ctrl, const char *name);
152 gpg_error_t app_setattr (app_t app, ctrl_t ctrl, const char *name,
153                  gpg_error_t (*pincb)(void*, const char *, char **),
154                  void *pincb_arg,
155                  const unsigned char *value, size_t valuelen);
156 gpg_error_t app_sign (app_t app, ctrl_t ctrl, const char *keyidstr, int hashalgo,
157               gpg_error_t (*pincb)(void*, const char *, char **),
158               void *pincb_arg,
159               const void *indata, size_t indatalen,
160               unsigned char **outdata, size_t *outdatalen );
161 gpg_error_t app_auth (app_t app, ctrl_t ctrl, const char *keyidstr,
162                       gpg_error_t (*pincb)(void*, const char *, char **),
163                       void *pincb_arg,
164                       const void *indata, size_t indatalen,
165                       unsigned char **outdata, size_t *outdatalen);
166 gpg_error_t app_decipher (app_t app, ctrl_t ctrl, const char *keyidstr,
167                           gpg_error_t (*pincb)(void*, const char *, char **),
168                           void *pincb_arg,
169                           const void *indata, size_t indatalen,
170                           unsigned char **outdata, size_t *outdatalen,
171                           unsigned int *r_info);
172 gpg_error_t app_writecert (app_t app, ctrl_t ctrl,
173                            const char *certidstr,
174                            gpg_error_t (*pincb)(void*, const char *, char **),
175                            void *pincb_arg,
176                            const unsigned char *keydata, size_t keydatalen);
177 gpg_error_t app_writekey (app_t app, ctrl_t ctrl,
178                           const char *keyidstr, unsigned int flags,
179                           gpg_error_t (*pincb)(void*, const char *, char **),
180                           void *pincb_arg,
181                           const unsigned char *keydata, size_t keydatalen);
182 gpg_error_t app_genkey (app_t app, ctrl_t ctrl,
183                         const char *keynostr, const char *keytype,
184                         unsigned int flags, time_t createtime,
185                         gpg_error_t (*pincb)(void*, const char *, char **),
186                         void *pincb_arg);
187 gpg_error_t app_get_challenge (app_t app, ctrl_t ctrl, size_t nbytes,
188                                unsigned char *buffer);
189 gpg_error_t app_change_pin (app_t app, ctrl_t ctrl,
190                             const char *chvnostr, unsigned int flags,
191                             gpg_error_t (*pincb)(void*, const char *, char **),
192                             void *pincb_arg);
193 gpg_error_t app_check_pin (app_t app, ctrl_t ctrl, const char *keyidstr,
194                    gpg_error_t (*pincb)(void*, const char *, char **),
195                    void *pincb_arg);
196
197
198 /*-- app-openpgp.c --*/
199 gpg_error_t app_select_openpgp (app_t app);
200
201 /*-- app-nks.c --*/
202 gpg_error_t app_select_nks (app_t app);
203
204 /*-- app-dinsig.c --*/
205 gpg_error_t app_select_dinsig (app_t app);
206
207 /*-- app-p15.c --*/
208 gpg_error_t app_select_p15 (app_t app);
209
210 /*-- app-geldkarte.c --*/
211 gpg_error_t app_select_geldkarte (app_t app);
212
213 /*-- app-sc-hsm.c --*/
214 gpg_error_t app_select_sc_hsm (app_t app);
215
216 /*-- app-piv.c --*/
217 gpg_error_t app_select_piv (app_t app);
218
219
220 #endif /*GNUPG_SCD_APP_COMMON_H*/