Added ID keywords because these files are often used in other packages.
[gnupg.git] / scd / app-common.h
1 /* app-common.h - Common declarations for all card applications
2  *      Copyright (C) 2003 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 (*getattr) (app_t app, ctrl_t ctrl, const char *name);
53     int (*setattr) (app_t app, const char *name,
54                     int (*pincb)(void*, const char *, char **),
55                     void *pincb_arg,
56                     const unsigned char *value, size_t valuelen);
57     int (*sign) (app_t app,
58                  const char *keyidstr, int hashalgo,
59                  int (pincb)(void*, const char *, char **),
60                  void *pincb_arg,
61                  const void *indata, size_t indatalen,
62                  unsigned char **outdata, size_t *outdatalen );
63     int (*auth) (app_t app, const char *keyidstr,
64                  int (*pincb)(void*, const char *, char **),
65                  void *pincb_arg,
66                  const void *indata, size_t indatalen,
67                  unsigned char **outdata, size_t *outdatalen);
68     int (*decipher) (app_t app, const char *keyidstr,
69                      int (pincb)(void*, const char *, char **),
70                      void *pincb_arg,
71                      const void *indata, size_t indatalen,
72                      unsigned char **outdata, size_t *outdatalen);
73     int (*genkey) (app_t app, ctrl_t ctrl,
74                    const char *keynostr, unsigned int flags,
75                    int (*pincb)(void*, const char *, char **),
76                    void *pincb_arg);
77     int (*change_pin) (app_t app, ctrl_t ctrl,
78                        const char *chvnostr, int reset_mode,
79                        int (*pincb)(void*, const char *, char **),
80                        void *pincb_arg);
81     int (*check_pin) (app_t app, const char *keyidstr,
82                       int (pincb)(void*, const char *, char **),
83                       void *pincb_arg);
84   } fnc;
85
86 };
87
88 #if GNUPG_MAJOR_VERSION == 1
89 int app_select_openpgp (app_t app);
90 int app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
91 #else
92 /*-- app-help.c --*/
93 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
94 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
95
96
97 /*-- app.c --*/
98 app_t select_application (ctrl_t ctrl, int slot, const char *name);
99 void release_application (app_t app);
100 int app_munge_serialno (app_t app);
101 int app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
102 int app_write_learn_status (app_t app, ctrl_t ctrl);
103 int app_readcert (app_t app, const char *certid,
104                   unsigned char **cert, size_t *certlen);
105 int app_getattr (app_t app, ctrl_t ctrl, const char *name);
106 int app_setattr (app_t app, const char *name,
107                  int (*pincb)(void*, const char *, char **),
108                  void *pincb_arg,
109                  const unsigned char *value, size_t valuelen);
110 int app_sign (app_t app, const char *keyidstr, int hashalgo,
111               int (pincb)(void*, const char *, char **),
112               void *pincb_arg,
113               const void *indata, size_t indatalen,
114               unsigned char **outdata, size_t *outdatalen );
115 int app_auth (app_t app, const char *keyidstr,
116               int (*pincb)(void*, const char *, char **),
117               void *pincb_arg,
118               const void *indata, size_t indatalen,
119               unsigned char **outdata, size_t *outdatalen);
120 int app_decipher (app_t app, const char *keyidstr,
121                   int (pincb)(void*, const char *, char **),
122                   void *pincb_arg,
123                   const void *indata, size_t indatalen,
124                   unsigned char **outdata, size_t *outdatalen );
125 int app_genkey (app_t app, ctrl_t ctrl,
126                 const char *keynostr, unsigned int flags,
127                 int (*pincb)(void*, const char *, char **),
128                 void *pincb_arg);
129 int app_get_challenge (app_t app, size_t nbytes, unsigned char *buffer);
130 int app_change_pin (app_t app, ctrl_t ctrl,
131                     const char *chvnostr, int reset_mode,
132                     int (*pincb)(void*, const char *, char **),
133                     void *pincb_arg);
134 int app_check_pin (app_t app, const char *keyidstr,
135                    int (*pincb)(void*, const char *, char **),
136                    void *pincb_arg);
137
138
139 /*-- app-openpgp.c --*/
140 int app_select_openpgp (app_t app);
141
142 int app_openpgp_cardinfo (app_t app,
143                           char **serialno,
144                           char **disp_name,
145                           char **pubkey_url,
146                           unsigned char **fpr1,
147                           unsigned char **fpr2,
148                           unsigned char **fpr3);
149 int app_openpgp_storekey (app_t app, int keyno,
150                           unsigned char *template, size_t template_len,
151                           time_t created_at,
152                           const unsigned char *m, size_t mlen,
153                           const unsigned char *e, size_t elen,
154                           int (*pincb)(void*, const char *, char **),
155                           void *pincb_arg);
156 int app_openpgp_readkey (app_t app, int keyno,
157                          unsigned char **m, size_t *mlen,
158                          unsigned char **e, size_t *elen);
159 /*-- app-nks.c --*/
160 int app_select_nks (app_t app);
161
162 /*-- app-dinsig.c --*/
163 int app_select_dinsig (app_t app);
164
165 /*-- app-p15.c --*/
166 int app_select_p15 (app_t app);
167
168
169 #endif
170
171
172
173 #endif /*GNUPG_SCD_APP_COMMON_H*/
174
175
176