ace57d98cf91851c9ba437319e89dfc1cec769ab
[gnupg.git] / scd / app-common.h
1 /* app-common.h - Common declarations for all card applications
2  *      Copyright (C) 2003, 2005 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  *
20  * $Id$
21  */
22
23 #ifndef GNUPG_SCD_APP_COMMON_H
24 #define GNUPG_SCD_APP_COMMON_H
25
26 #if GNUPG_MAJOR_VERSION != 1
27 #include <ksba.h>
28 #endif
29
30 struct app_local_s;  /* Defined by all app-*.c.  */
31
32 struct app_ctx_s {
33   int initialized;  /* The application has been initialied and the
34                        function pointers may be used.  Note that for
35                        unsupported operations the particular
36                        function pointer is set to NULL */
37   int slot;         /* Used reader. */
38   unsigned char *serialno; /* Serialnumber in raw form, allocated. */
39   size_t serialnolen;      /* Length in octets of serialnumber. */
40   const char *apptype;
41   unsigned int card_version;
42   int did_chv1;
43   int force_chv1;   /* True if the card does not cache CHV1. */
44   int did_chv2;
45   int did_chv3;
46   struct app_local_s *app_local;  /* Local to the application. */
47   struct {
48     void (*deinit) (app_t app);
49     int (*learn_status) (app_t app, ctrl_t ctrl);
50     int (*readcert) (app_t app, const char *certid,
51                      unsigned char **cert, size_t *certlen);
52     int (*readkey) (app_t app, const char *certid,
53                     unsigned char **pk, size_t *pklen);
54     int (*getattr) (app_t app, ctrl_t ctrl, const char *name);
55     int (*setattr) (app_t app, const char *name,
56                     int (*pincb)(void*, const char *, char **),
57                     void *pincb_arg,
58                     const unsigned char *value, size_t valuelen);
59     int (*sign) (app_t app,
60                  const char *keyidstr, int hashalgo,
61                  int (pincb)(void*, const char *, char **),
62                  void *pincb_arg,
63                  const void *indata, size_t indatalen,
64                  unsigned char **outdata, size_t *outdatalen );
65     int (*auth) (app_t app, const char *keyidstr,
66                  int (*pincb)(void*, const char *, char **),
67                  void *pincb_arg,
68                  const void *indata, size_t indatalen,
69                  unsigned char **outdata, size_t *outdatalen);
70     int (*decipher) (app_t app, const char *keyidstr,
71                      int (pincb)(void*, const char *, char **),
72                      void *pincb_arg,
73                      const void *indata, size_t indatalen,
74                      unsigned char **outdata, size_t *outdatalen);
75     int (*genkey) (app_t app, ctrl_t ctrl,
76                    const char *keynostr, unsigned int flags,
77                    int (*pincb)(void*, const char *, char **),
78                    void *pincb_arg);
79     int (*change_pin) (app_t app, ctrl_t ctrl,
80                        const char *chvnostr, int reset_mode,
81                        int (*pincb)(void*, const char *, char **),
82                        void *pincb_arg);
83     int (*check_pin) (app_t app, const char *keyidstr,
84                       int (pincb)(void*, const char *, char **),
85                       void *pincb_arg);
86   } fnc;
87
88 };
89
90 #if GNUPG_MAJOR_VERSION == 1
91 int app_select_openpgp (app_t app);
92 int app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
93 int app_openpgp_storekey (app_t app, int keyno,
94                           unsigned char *template, size_t template_len,
95                           time_t created_at,
96                           const unsigned char *m, size_t mlen,
97                           const unsigned char *e, size_t elen,
98                           int (*pincb)(void*, const char *, char **),
99                           void *pincb_arg);
100 #else
101 /*-- app-help.c --*/
102 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
103 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
104
105
106 /*-- app.c --*/
107 app_t select_application (ctrl_t ctrl, int slot, const char *name);
108 void release_application (app_t app);
109 int app_munge_serialno (app_t app);
110 int app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
111 int app_write_learn_status (app_t app, ctrl_t ctrl);
112 int app_readcert (app_t app, const char *certid,
113                   unsigned char **cert, size_t *certlen);
114 int app_readkey (app_t app, const char *keyid,
115                  unsigned char **pk, size_t *pklen);
116 int app_getattr (app_t app, ctrl_t ctrl, const char *name);
117 int app_setattr (app_t app, const char *name,
118                  int (*pincb)(void*, const char *, char **),
119                  void *pincb_arg,
120                  const unsigned char *value, size_t valuelen);
121 int app_sign (app_t app, const char *keyidstr, int hashalgo,
122               int (pincb)(void*, const char *, char **),
123               void *pincb_arg,
124               const void *indata, size_t indatalen,
125               unsigned char **outdata, size_t *outdatalen );
126 int app_auth (app_t app, const char *keyidstr,
127               int (*pincb)(void*, const char *, char **),
128               void *pincb_arg,
129               const void *indata, size_t indatalen,
130               unsigned char **outdata, size_t *outdatalen);
131 int app_decipher (app_t app, const char *keyidstr,
132                   int (pincb)(void*, const char *, char **),
133                   void *pincb_arg,
134                   const void *indata, size_t indatalen,
135                   unsigned char **outdata, size_t *outdatalen );
136 int app_genkey (app_t app, ctrl_t ctrl,
137                 const char *keynostr, unsigned int flags,
138                 int (*pincb)(void*, const char *, char **),
139                 void *pincb_arg);
140 int app_get_challenge (app_t app, size_t nbytes, unsigned char *buffer);
141 int app_change_pin (app_t app, ctrl_t ctrl,
142                     const char *chvnostr, int reset_mode,
143                     int (*pincb)(void*, const char *, char **),
144                     void *pincb_arg);
145 int app_check_pin (app_t app, const char *keyidstr,
146                    int (*pincb)(void*, const char *, char **),
147                    void *pincb_arg);
148
149
150 /*-- app-openpgp.c --*/
151 int app_select_openpgp (app_t app);
152
153 int app_openpgp_cardinfo (app_t app,
154                           char **serialno,
155                           char **disp_name,
156                           char **pubkey_url,
157                           unsigned char **fpr1,
158                           unsigned char **fpr2,
159                           unsigned char **fpr3);
160 int app_openpgp_storekey (app_t app, int keyno,
161                           unsigned char *template, size_t template_len,
162                           time_t created_at,
163                           const unsigned char *m, size_t mlen,
164                           const unsigned char *e, size_t elen,
165                           int (*pincb)(void*, const char *, char **),
166                           void *pincb_arg);
167 int app_openpgp_readkey (app_t app, int keyno,
168                          unsigned char **m, size_t *mlen,
169                          unsigned char **e, size_t *elen);
170 /*-- app-nks.c --*/
171 int app_select_nks (app_t app);
172
173 /*-- app-dinsig.c --*/
174 int app_select_dinsig (app_t app);
175
176 /*-- app-p15.c --*/
177 int app_select_p15 (app_t app);
178
179
180 #endif
181
182
183
184 #endif /*GNUPG_SCD_APP_COMMON_H*/
185
186
187