Add server option with-ephemeral-keys.
[gnupg.git] / scd / app-common.h
1 /* app-common.h - Common declarations for all card applications
2  * Copyright (C) 2003, 2005, 2008 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 3 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, see <http://www.gnu.org/licenses/>.
18  *
19  * $Id$
20  */
21
22 #ifndef GNUPG_SCD_APP_COMMON_H
23 #define GNUPG_SCD_APP_COMMON_H
24
25 #if GNUPG_MAJOR_VERSION == 1
26 # ifdef ENABLE_AGENT_SUPPORT
27 # include "assuan.h"
28 # endif 
29 #else
30 # include <ksba.h>
31 #endif
32
33
34 #define APP_CHANGE_FLAG_RESET    1
35 #define APP_CHANGE_FLAG_NULLPIN  2
36
37
38 struct app_local_s;  /* Defined by all app-*.c.  */
39
40 struct app_ctx_s {
41   unsigned int ref_count;  /* Number of connections currently using
42                               this application context.  If this is
43                               not 0 the application has been
44                               initialized and the function pointers
45                               may be used.  Note that for unsupported
46                               operations the particular function
47                               pointer is set to NULL */
48
49   int slot;         /* Used reader. */
50
51   /* If this is used by GnuPG 1.4 we need to know the assuan context
52      in case we need to divert the operation to an already running
53      agent.  This if ASSUAN_CTX is not NULL we take this as indication
54      that all operations are diverted to gpg-agent. */
55 #if GNUPG_MAJOR_VERSION == 1
56   assuan_context_t assuan_ctx;
57 #endif /*GNUPG_MAJOR_VERSION == 1*/
58
59   unsigned char *serialno; /* Serialnumber in raw form, allocated. */
60   size_t serialnolen;      /* Length in octets of serialnumber. */
61   const char *apptype;
62   unsigned int card_version;
63   int did_chv1;
64   int force_chv1;   /* True if the card does not cache CHV1. */
65   int did_chv2;
66   int did_chv3;
67   struct app_local_s *app_local;  /* Local to the application. */
68   struct {
69     void (*deinit) (app_t app);
70     gpg_error_t (*learn_status) (app_t app, ctrl_t ctrl, unsigned int flags);
71     gpg_error_t (*readcert) (app_t app, const char *certid,
72                      unsigned char **cert, size_t *certlen);
73     gpg_error_t (*readkey) (app_t app, const char *certid,
74                     unsigned char **pk, size_t *pklen);
75     gpg_error_t (*getattr) (app_t app, ctrl_t ctrl, const char *name);
76     gpg_error_t (*setattr) (app_t app, const char *name,
77                     gpg_error_t (*pincb)(void*, const char *, char **),
78                     void *pincb_arg,
79                     const unsigned char *value, size_t valuelen);
80     gpg_error_t (*sign) (app_t app,
81                  const char *keyidstr, int hashalgo,
82                  gpg_error_t (*pincb)(void*, const char *, char **),
83                  void *pincb_arg,
84                  const void *indata, size_t indatalen,
85                  unsigned char **outdata, size_t *outdatalen );
86     gpg_error_t (*auth) (app_t app, const char *keyidstr,
87                  gpg_error_t (*pincb)(void*, const char *, char **),
88                  void *pincb_arg,
89                  const void *indata, size_t indatalen,
90                  unsigned char **outdata, size_t *outdatalen);
91     gpg_error_t (*decipher) (app_t app, const char *keyidstr,
92                      gpg_error_t (*pincb)(void*, const char *, char **),
93                      void *pincb_arg,
94                      const void *indata, size_t indatalen,
95                      unsigned char **outdata, size_t *outdatalen);
96     gpg_error_t (*writecert) (app_t app, ctrl_t ctrl,
97                               const char *certid,
98                               gpg_error_t (*pincb)(void*,const char *,char **),
99                               void *pincb_arg,
100                               const unsigned char *data, size_t datalen);
101     gpg_error_t (*writekey) (app_t app, ctrl_t ctrl,
102                              const char *keyid, unsigned int flags,
103                              gpg_error_t (*pincb)(void*,const char *,char **),
104                              void *pincb_arg,
105                              const unsigned char *pk, size_t pklen);
106     gpg_error_t (*genkey) (app_t app, ctrl_t ctrl,
107                            const char *keynostr, unsigned int flags,
108                            time_t createtime,
109                            gpg_error_t (*pincb)(void*, const char *, char **),
110                            void *pincb_arg);
111     gpg_error_t (*change_pin) (app_t app, ctrl_t ctrl,
112                        const char *chvnostr, unsigned int flags,
113                        gpg_error_t (*pincb)(void*, const char *, char **),
114                        void *pincb_arg);
115     gpg_error_t (*check_pin) (app_t app, const char *keyidstr,
116                       gpg_error_t (*pincb)(void*, const char *, char **),
117                       void *pincb_arg);
118   } fnc;
119
120 };
121
122 #if GNUPG_MAJOR_VERSION == 1
123 gpg_error_t app_select_openpgp (app_t app);
124 gpg_error_t app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
125 gpg_error_t app_openpgp_storekey (app_t app, int keyno,
126                           unsigned char *template, size_t template_len,
127                           time_t created_at,
128                           const unsigned char *m, size_t mlen,
129                           const unsigned char *e, size_t elen,
130                           gpg_error_t (*pincb)(void*, const char *, char **),
131                           void *pincb_arg);
132 #else
133 /*-- app-help.c --*/
134 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
135 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
136
137
138 /*-- app.c --*/
139 void app_dump_state (void);
140 void application_notify_card_reset (int slot);
141 gpg_error_t check_application_conflict (ctrl_t ctrl, const char *name);
142 gpg_error_t select_application (ctrl_t ctrl, int slot, const char *name,
143                                 app_t *r_app);
144 char *get_supported_applications (void);
145 void release_application (app_t app);
146 gpg_error_t app_munge_serialno (app_t app);
147 gpg_error_t app_get_serial_and_stamp (app_t app, char **serial, time_t *stamp);
148 gpg_error_t app_write_learn_status (app_t app, ctrl_t ctrl, 
149                                     unsigned int flags);
150 gpg_error_t app_readcert (app_t app, const char *certid,
151                   unsigned char **cert, size_t *certlen);
152 gpg_error_t app_readkey (app_t app, const char *keyid,
153                  unsigned char **pk, size_t *pklen);
154 gpg_error_t app_getattr (app_t app, ctrl_t ctrl, const char *name);
155 gpg_error_t app_setattr (app_t app, const char *name,
156                  gpg_error_t (*pincb)(void*, const char *, char **),
157                  void *pincb_arg,
158                  const unsigned char *value, size_t valuelen);
159 gpg_error_t app_sign (app_t app, const char *keyidstr, int hashalgo,
160               gpg_error_t (*pincb)(void*, const char *, char **),
161               void *pincb_arg,
162               const void *indata, size_t indatalen,
163               unsigned char **outdata, size_t *outdatalen );
164 gpg_error_t app_auth (app_t app, const char *keyidstr,
165               gpg_error_t (*pincb)(void*, const char *, char **),
166               void *pincb_arg,
167               const void *indata, size_t indatalen,
168               unsigned char **outdata, size_t *outdatalen);
169 gpg_error_t app_decipher (app_t app, const char *keyidstr,
170                   gpg_error_t (*pincb)(void*, const char *, char **),
171                   void *pincb_arg,
172                   const void *indata, size_t indatalen,
173                   unsigned char **outdata, size_t *outdatalen );
174 gpg_error_t app_writecert (app_t app, ctrl_t ctrl,
175                            const char *certidstr,
176                            gpg_error_t (*pincb)(void*, const char *, char **),
177                            void *pincb_arg,
178                            const unsigned char *keydata, size_t keydatalen);
179 gpg_error_t app_writekey (app_t app, ctrl_t ctrl,
180                           const char *keyidstr, unsigned int flags,
181                           gpg_error_t (*pincb)(void*, const char *, char **),
182                           void *pincb_arg,
183                           const unsigned char *keydata, size_t keydatalen);
184 gpg_error_t app_genkey (app_t app, ctrl_t ctrl,
185                         const char *keynostr, unsigned int flags,
186                         time_t createtime,
187                         gpg_error_t (*pincb)(void*, const char *, char **),
188                         void *pincb_arg);
189 gpg_error_t app_get_challenge (app_t app, size_t nbytes,
190                                unsigned char *buffer);
191 gpg_error_t app_change_pin (app_t app, ctrl_t ctrl,
192                     const char *chvnostr, int reset_mode,
193                     gpg_error_t (*pincb)(void*, const char *, char **),
194                     void *pincb_arg);
195 gpg_error_t app_check_pin (app_t app, const char *keyidstr,
196                    gpg_error_t (*pincb)(void*, const char *, char **),
197                    void *pincb_arg);
198
199
200 /*-- app-openpgp.c --*/
201 gpg_error_t app_select_openpgp (app_t app);
202
203 /*-- app-nks.c --*/
204 gpg_error_t app_select_nks (app_t app);
205
206 /*-- app-dinsig.c --*/
207 gpg_error_t app_select_dinsig (app_t app);
208
209 /*-- app-p15.c --*/
210 gpg_error_t app_select_p15 (app_t app);
211
212 /*-- app-geldkarte.c --*/
213 gpg_error_t app_select_geldkarte (app_t app);
214
215
216 #endif
217
218
219
220 #endif /*GNUPG_SCD_APP_COMMON_H*/
221
222
223