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