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