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