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