* options.h, g10.c, keyedit.c, keylist.c, mainproc.c: Clarify the
[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 did_chv2;
35   int did_chv3;
36   struct {
37     int (*learn_status) (APP app, CTRL ctrl);
38     int (*setattr) (APP app, const char *name,
39                     int (*pincb)(void*, const char *, char **),
40                     void *pincb_arg,
41                     const unsigned char *value, size_t valuelen);
42     int (*sign) (APP app,
43                  const char *keyidstr, int hashalgo,
44                  int (pincb)(void*, const char *, char **),
45                  void *pincb_arg,
46                  const void *indata, size_t indatalen,
47                  unsigned char **outdata, size_t *outdatalen );
48     int (*auth) (APP app, const char *keyidstr,
49                  int (*pincb)(void*, const char *, char **),
50                  void *pincb_arg,
51                  const void *indata, size_t indatalen,
52                  unsigned char **outdata, size_t *outdatalen);
53     int (*decipher) (APP app, const char *keyidstr,
54                      int (pincb)(void*, const char *, char **),
55                      void *pincb_arg,
56                      const void *indata, size_t indatalen,
57                      unsigned char **outdata, size_t *outdatalen);
58     int (*genkey) (APP app, CTRL ctrl,
59                    const char *keynostr, unsigned int flags,
60                    int (*pincb)(void*, const char *, char **),
61                    void *pincb_arg);
62     int (*change_pin) (APP app, CTRL ctrl,
63                        const char *chvnostr, int reset_mode,
64                        int (*pincb)(void*, const char *, char **),
65                        void *pincb_arg);
66   } fnc;
67
68
69 };
70
71 /*-- app.c --*/
72 APP select_application (void);
73 int app_get_serial_and_stamp (APP app, char **serial, time_t *stamp);
74 int app_write_learn_status (APP app, CTRL ctrl);
75 int app_setattr (APP app, const char *name,
76                  int (*pincb)(void*, const char *, char **),
77                  void *pincb_arg,
78                  const unsigned char *value, size_t valuelen);
79 int app_sign (APP app, const char *keyidstr, int hashalgo,
80               int (pincb)(void*, const char *, char **),
81               void *pincb_arg,
82               const void *indata, size_t indatalen,
83               unsigned char **outdata, size_t *outdatalen );
84 int app_auth (APP app, const char *keyidstr,
85               int (*pincb)(void*, const char *, char **),
86               void *pincb_arg,
87               const void *indata, size_t indatalen,
88               unsigned char **outdata, size_t *outdatalen);
89 int app_decipher (APP app, const char *keyidstr,
90                   int (pincb)(void*, const char *, char **),
91                   void *pincb_arg,
92                   const void *indata, size_t indatalen,
93                   unsigned char **outdata, size_t *outdatalen );
94 int app_genkey (APP app, CTRL ctrl, const char *keynostr, unsigned int flags,
95                 int (*pincb)(void*, const char *, char **),
96                 void *pincb_arg);
97 int app_get_challenge (APP app, size_t nbytes, unsigned char *buffer);
98 int app_change_pin (APP app, CTRL ctrl, const char *chvnostr, int reset_mode,
99                     int (*pincb)(void*, const char *, char **),
100                     void *pincb_arg);
101
102
103 /*-- app-openpgp.c --*/
104 int app_select_openpgp (APP app, unsigned char **sn, size_t *snlen);
105
106 int app_openpgp_cardinfo (APP app,
107                           char **serialno,
108                           char **disp_name,
109                           char **pubkey_url,
110                           unsigned char **fpr1,
111                           unsigned char **fpr2,
112                           unsigned char **fpr3);
113 int app_openpgp_storekey (APP app, int keyno,
114                           unsigned char *template, size_t template_len,
115                           time_t created_at,
116                           const unsigned char *m, size_t mlen,
117                           const unsigned char *e, size_t elen,
118                           int (*pincb)(void*, const char *, char **),
119                           void *pincb_arg);
120 int app_openpgp_readkey (APP app, int keyno,
121                          unsigned char **m, size_t *mlen,
122                          unsigned char **e, size_t *elen);
123
124
125 #endif /*GNUPG_SCD_APP_COMMON_H*/
126
127
128