scd: Fix use case of PC/SC.
[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 periodical_check_needed:1;
58   unsigned int did_chv1:1;
59   unsigned int force_chv1:1;   /* True if the card does not cache CHV1. */
60   unsigned int did_chv2:1;
61   unsigned int did_chv3:1;
62   struct app_local_s *app_local;  /* Local to the application. */
63   struct {
64     void (*deinit) (app_t app);
65     gpg_error_t (*learn_status) (app_t app, ctrl_t ctrl, unsigned int flags);
66     gpg_error_t (*readcert) (app_t app, const char *certid,
67                      unsigned char **cert, size_t *certlen);
68     gpg_error_t (*readkey) (app_t app, int advanced, const char *certid,
69                     unsigned char **pk, size_t *pklen);
70     gpg_error_t (*getattr) (app_t app, ctrl_t ctrl, const char *name);
71     gpg_error_t (*setattr) (app_t app, const char *name,
72                     gpg_error_t (*pincb)(void*, const char *, char **),
73                     void *pincb_arg,
74                     const unsigned char *value, size_t valuelen);
75     gpg_error_t (*sign) (app_t app,
76                  const char *keyidstr, int hashalgo,
77                  gpg_error_t (*pincb)(void*, const char *, char **),
78                  void *pincb_arg,
79                  const void *indata, size_t indatalen,
80                  unsigned char **outdata, size_t *outdatalen );
81     gpg_error_t (*auth) (app_t app, const char *keyidstr,
82                  gpg_error_t (*pincb)(void*, const char *, char **),
83                  void *pincb_arg,
84                  const void *indata, size_t indatalen,
85                  unsigned char **outdata, size_t *outdatalen);
86     gpg_error_t (*decipher) (app_t app, const char *keyidstr,
87                              gpg_error_t (*pincb)(void*, const char *, char **),
88                              void *pincb_arg,
89                              const void *indata, size_t indatalen,
90                              unsigned char **outdata, size_t *outdatalen,
91                              unsigned int *r_info);
92     gpg_error_t (*writecert) (app_t app, ctrl_t ctrl,
93                               const char *certid,
94                               gpg_error_t (*pincb)(void*,const char *,char **),
95                               void *pincb_arg,
96                               const unsigned char *data, size_t datalen);
97     gpg_error_t (*writekey) (app_t app, ctrl_t ctrl,
98                              const char *keyid, unsigned int flags,
99                              gpg_error_t (*pincb)(void*,const char *,char **),
100                              void *pincb_arg,
101                              const unsigned char *pk, size_t pklen);
102     gpg_error_t (*genkey) (app_t app, ctrl_t ctrl,
103                            const char *keynostr, unsigned int flags,
104                            time_t createtime,
105                            gpg_error_t (*pincb)(void*, const char *, char **),
106                            void *pincb_arg);
107     gpg_error_t (*change_pin) (app_t app, ctrl_t ctrl,
108                        const char *chvnostr, unsigned int flags,
109                        gpg_error_t (*pincb)(void*, const char *, char **),
110                        void *pincb_arg);
111     gpg_error_t (*check_pin) (app_t app, const char *keyidstr,
112                       gpg_error_t (*pincb)(void*, const char *, char **),
113                       void *pincb_arg);
114   } fnc;
115 };
116
117 /*-- app-help.c --*/
118 unsigned int app_help_count_bits (const unsigned char *a, size_t len);
119 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
120 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
121
122
123 /*-- app.c --*/
124 void app_send_card_list (ctrl_t ctrl);
125 char *app_get_serialno (app_t app);
126
127 void app_dump_state (void);
128 void application_notify_card_reset (int slot);
129 gpg_error_t check_application_conflict (const char *name, app_t app);
130 gpg_error_t app_reset (app_t app, ctrl_t ctrl, int send_reset);
131 gpg_error_t select_application (ctrl_t ctrl, const char *name, app_t *r_app,
132                                 int scan, const unsigned char *serialno_bin,
133                                 size_t serialno_bin_len);
134 char *get_supported_applications (void);
135 void release_application (app_t app);
136 gpg_error_t app_munge_serialno (app_t app);
137 gpg_error_t app_write_learn_status (app_t app, ctrl_t ctrl,
138                                     unsigned int flags);
139 gpg_error_t app_readcert (app_t app, ctrl_t ctrl, const char *certid,
140                   unsigned char **cert, size_t *certlen);
141 gpg_error_t app_readkey (app_t app, ctrl_t ctrl, int advanced,
142                  const char *keyid, unsigned char **pk, size_t *pklen);
143 gpg_error_t app_getattr (app_t app, ctrl_t ctrl, const char *name);
144 gpg_error_t app_setattr (app_t app, ctrl_t ctrl, const char *name,
145                  gpg_error_t (*pincb)(void*, const char *, char **),
146                  void *pincb_arg,
147                  const unsigned char *value, size_t valuelen);
148 gpg_error_t app_sign (app_t app, ctrl_t ctrl, const char *keyidstr, int hashalgo,
149               gpg_error_t (*pincb)(void*, const char *, char **),
150               void *pincb_arg,
151               const void *indata, size_t indatalen,
152               unsigned char **outdata, size_t *outdatalen );
153 gpg_error_t app_auth (app_t app, ctrl_t ctrl, const char *keyidstr,
154                       gpg_error_t (*pincb)(void*, const char *, char **),
155                       void *pincb_arg,
156                       const void *indata, size_t indatalen,
157                       unsigned char **outdata, size_t *outdatalen);
158 gpg_error_t app_decipher (app_t app, ctrl_t ctrl, const char *keyidstr,
159                           gpg_error_t (*pincb)(void*, const char *, char **),
160                           void *pincb_arg,
161                           const void *indata, size_t indatalen,
162                           unsigned char **outdata, size_t *outdatalen,
163                           unsigned int *r_info);
164 gpg_error_t app_writecert (app_t app, ctrl_t ctrl,
165                            const char *certidstr,
166                            gpg_error_t (*pincb)(void*, const char *, char **),
167                            void *pincb_arg,
168                            const unsigned char *keydata, size_t keydatalen);
169 gpg_error_t app_writekey (app_t app, ctrl_t ctrl,
170                           const char *keyidstr, unsigned int flags,
171                           gpg_error_t (*pincb)(void*, const char *, char **),
172                           void *pincb_arg,
173                           const unsigned char *keydata, size_t keydatalen);
174 gpg_error_t app_genkey (app_t app, ctrl_t ctrl,
175                         const char *keynostr, unsigned int flags,
176                         time_t createtime,
177                         gpg_error_t (*pincb)(void*, const char *, char **),
178                         void *pincb_arg);
179 gpg_error_t app_get_challenge (app_t app, ctrl_t ctrl, size_t nbytes,
180                                unsigned char *buffer);
181 gpg_error_t app_change_pin (app_t app, ctrl_t ctrl,
182                     const char *chvnostr, int reset_mode,
183                     gpg_error_t (*pincb)(void*, const char *, char **),
184                     void *pincb_arg);
185 gpg_error_t app_check_pin (app_t app, ctrl_t ctrl, const char *keyidstr,
186                    gpg_error_t (*pincb)(void*, const char *, char **),
187                    void *pincb_arg);
188
189
190 /*-- app-openpgp.c --*/
191 gpg_error_t app_select_openpgp (app_t app);
192
193 /*-- app-nks.c --*/
194 gpg_error_t app_select_nks (app_t app);
195
196 /*-- app-dinsig.c --*/
197 gpg_error_t app_select_dinsig (app_t app);
198
199 /*-- app-p15.c --*/
200 gpg_error_t app_select_p15 (app_t app);
201
202 /*-- app-geldkarte.c --*/
203 gpg_error_t app_select_geldkarte (app_t app);
204
205 /*-- app-sc-hsm.c --*/
206 gpg_error_t app_select_sc_hsm (app_t app);
207
208
209 #endif /*GNUPG_SCD_APP_COMMON_H*/