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