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