33f23127b3761b180163090522e87ef5f5d4b0c7
[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 struct app_ctx_s {
25   int initialized;  /* The application has been initialied and the
26                        function pointers may be used.  Note that for
27                        unsupported operations the particular
28                        function pointer is set to NULL */
29   int slot;         /* Used reader. */
30   unsigned char *serialno; /* Serialnumber in raw form, allocated. */
31   size_t serialnolen;      /* Length in octets of serialnumber. */
32   unsigned int card_version;
33   int did_chv1;
34   int force_chv1;   /* True if the card does not cache CHV1. */
35   int did_chv2;
36   int did_chv3;
37   struct {
38     int (*learn_status) (APP app, CTRL ctrl);
39     int (*getattr) (APP app, CTRL ctrl, const char *name);
40     int (*setattr) (APP app, const char *name,
41                     int (*pincb)(void*, const char *, char **),
42                     void *pincb_arg,
43                     const unsigned char *value, size_t valuelen);
44     int (*sign) (APP app,
45                  const char *keyidstr, int hashalgo,
46                  int (pincb)(void*, const char *, char **),
47                  void *pincb_arg,
48                  const void *indata, size_t indatalen,
49                  unsigned char **outdata, size_t *outdatalen );
50     int (*auth) (APP app, const char *keyidstr,
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 (*decipher) (APP 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 (*genkey) (APP app, CTRL ctrl,
61                    const char *keynostr, unsigned int flags,
62                    int (*pincb)(void*, const char *, char **),
63                    void *pincb_arg);
64     int (*change_pin) (APP app, CTRL ctrl,
65                        const char *chvnostr, int reset_mode,
66                        int (*pincb)(void*, const char *, char **),
67                        void *pincb_arg);
68   } fnc;
69
70
71 };
72
73 #if GNUPG_MAJOR_VERSION == 1
74 int app_select_openpgp (APP app, unsigned char **sn, size_t *snlen);
75 int app_get_serial_and_stamp (APP app, char **serial, time_t *stamp);
76 #else
77 /*-- app.c --*/
78 void app_set_default_reader_port (const char *portstr);
79 APP select_application (void);
80 int app_get_serial_and_stamp (APP app, char **serial, time_t *stamp);
81 int app_write_learn_status (APP app, CTRL ctrl);
82 int app_getattr (APP app, CTRL ctrl, const char *name);
83 int app_setattr (APP app, const char *name,
84                  int (*pincb)(void*, const char *, char **),
85                  void *pincb_arg,
86                  const unsigned char *value, size_t valuelen);
87 int app_sign (APP app, const char *keyidstr, int hashalgo,
88               int (pincb)(void*, const char *, char **),
89               void *pincb_arg,
90               const void *indata, size_t indatalen,
91               unsigned char **outdata, size_t *outdatalen );
92 int app_auth (APP app, const char *keyidstr,
93               int (*pincb)(void*, const char *, char **),
94               void *pincb_arg,
95               const void *indata, size_t indatalen,
96               unsigned char **outdata, size_t *outdatalen);
97 int app_decipher (APP app, const char *keyidstr,
98                   int (pincb)(void*, const char *, char **),
99                   void *pincb_arg,
100                   const void *indata, size_t indatalen,
101                   unsigned char **outdata, size_t *outdatalen );
102 int app_genkey (APP app, CTRL ctrl, const char *keynostr, unsigned int flags,
103                 int (*pincb)(void*, const char *, char **),
104                 void *pincb_arg);
105 int app_get_challenge (APP app, size_t nbytes, unsigned char *buffer);
106 int app_change_pin (APP app, CTRL ctrl, const char *chvnostr, int reset_mode,
107                     int (*pincb)(void*, const char *, char **),
108                     void *pincb_arg);
109
110
111 /*-- app-openpgp.c --*/
112 int app_select_openpgp (APP app, unsigned char **sn, size_t *snlen);
113
114 int app_openpgp_cardinfo (APP app,
115                           char **serialno,
116                           char **disp_name,
117                           char **pubkey_url,
118                           unsigned char **fpr1,
119                           unsigned char **fpr2,
120                           unsigned char **fpr3);
121 int app_openpgp_storekey (APP app, int keyno,
122                           unsigned char *template, size_t template_len,
123                           time_t created_at,
124                           const unsigned char *m, size_t mlen,
125                           const unsigned char *e, size_t elen,
126                           int (*pincb)(void*, const char *, char **),
127                           void *pincb_arg);
128 int app_openpgp_readkey (APP app, int keyno,
129                          unsigned char **m, size_t *mlen,
130                          unsigned char **e, size_t *elen);
131 #endif
132
133
134
135 #endif /*GNUPG_SCD_APP_COMMON_H*/
136
137
138