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