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 <https://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 #include <npth.h>
  26 #include <ksba.h>
  27
  28
  29 #define APP_CHANGE_FLAG_RESET    1
  30 #define APP_CHANGE_FLAG_NULLPIN  2
  31
  32 /* Bit flags set by the decipher function into R_INFO.  */
  33 #define APP_DECIPHER_INFO_NOPAD  1  /* Padding has been removed.  */
  34
  35
  36 struct app_local_s;  /* Defined by all app-*.c.  */
  37
  38 struct app_ctx_s {
  39   struct app_ctx_s *next;
  40
  41   npth_mutex_t lock;
  42
  43   /* Number of connections currently using this application context.
  44      If this is not 0 the application has been initialized and the
  45      function pointers may be used.  Note that for unsupported
  46      operations the particular function pointer is set to NULL */
  47   unsigned int ref_count;
  48
  49   /* Used reader slot. */
  50   int slot;
  51
  52   unsigned char *serialno; /* Serialnumber in raw form, allocated. */
  53   size_t serialnolen;      /* Length in octets of serialnumber. */
  54   const char *apptype;
  55   unsigned int card_version;
  56   unsigned int card_status;
  57   unsigned int reset_requested:1;
  58   unsigned int require_get_status:1;
  59   unsigned int did_chv1:1;
  60   unsigned int force_chv1:1;   /* True if the card does not cache CHV1. */
  61   unsigned int did_chv2:1;
  62   unsigned int did_chv3:1;
  63   struct app_local_s *app_local;  /* Local to the application. */
  64   struct {
  65     void (*deinit) (app_t app);
  66     gpg_error_t (*learn_status) (app_t app, ctrl_t ctrl, unsigned int flags);
  67     gpg_error_t (*readcert) (app_t app, const char *certid,
  68                      unsigned char **cert, size_t *certlen);
  69     gpg_error_t (*readkey) (app_t app, int advanced, const char *certid,
  70                     unsigned char **pk, size_t *pklen);
  71     gpg_error_t (*getattr) (app_t app, ctrl_t ctrl, const char *name);
  72     gpg_error_t (*setattr) (app_t app, const char *name,
  73                     gpg_error_t (*pincb)(void*, const char *, char **),
  74                     void *pincb_arg,
  75                     const unsigned char *value, size_t valuelen);
  76     gpg_error_t (*sign) (app_t app,
  77                  const char *keyidstr, int hashalgo,
  78                  gpg_error_t (*pincb)(void*, const char *, char **),
  79                  void *pincb_arg,
  80                  const void *indata, size_t indatalen,
  81                  unsigned char **outdata, size_t *outdatalen );
  82     gpg_error_t (*auth) (app_t app, const char *keyidstr,
  83                  gpg_error_t (*pincb)(void*, const char *, char **),
  84                  void *pincb_arg,
  85                  const void *indata, size_t indatalen,
  86                  unsigned char **outdata, size_t *outdatalen);
  87     gpg_error_t (*decipher) (app_t app, const char *keyidstr,
  88                              gpg_error_t (*pincb)(void*, const char *, char **),
  89                              void *pincb_arg,
  90                              const void *indata, size_t indatalen,
  91                              unsigned char **outdata, size_t *outdatalen,
  92                              unsigned int *r_info);
  93     gpg_error_t (*writecert) (app_t app, ctrl_t ctrl,
  94                               const char *certid,
  95                               gpg_error_t (*pincb)(void*,const char *,char **),
  96                               void *pincb_arg,
  97                               const unsigned char *data, size_t datalen);
  98     gpg_error_t (*writekey) (app_t app, ctrl_t ctrl,
  99                              const char *keyid, unsigned int flags,
 100                              gpg_error_t (*pincb)(void*,const char *,char **),
 101                              void *pincb_arg,
 102                              const unsigned char *pk, size_t pklen);
 103     gpg_error_t (*genkey) (app_t app, ctrl_t ctrl,
 104                            const char *keynostr, unsigned int flags,
 105                            time_t createtime,
 106                            gpg_error_t (*pincb)(void*, const char *, char **),
 107                            void *pincb_arg);
 108     gpg_error_t (*change_pin) (app_t app, ctrl_t ctrl,
 109                        const char *chvnostr, unsigned int flags,
 110                        gpg_error_t (*pincb)(void*, const char *, char **),
 111                        void *pincb_arg);
 112     gpg_error_t (*check_pin) (app_t app, const char *keyidstr,
 113                       gpg_error_t (*pincb)(void*, const char *, char **),
 114                       void *pincb_arg);
 115   } fnc;
 116 };
 117
 118 /*-- app-help.c --*/
 119 unsigned int app_help_count_bits (const unsigned char *a, size_t len);
 120 gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip);
 121 size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
 122
 123
 124 /*-- app.c --*/
 125 app_t app_list_start (void);
 126 void app_list_finish (void);
 127 void app_send_card_list (ctrl_t ctrl);
 128 char *app_get_serialno (app_t app);
 129
 130 void app_dump_state (void);
 131 void application_notify_card_reset (int slot);
 132 gpg_error_t check_application_conflict (const char *name, app_t app);
 133 gpg_error_t app_reset (app_t app, ctrl_t ctrl, int send_reset);
 134 gpg_error_t select_application (ctrl_t ctrl, const char *name, app_t *r_app,
 135                                 int scan, const unsigned char *serialno_bin,
 136                                 size_t serialno_bin_len);
 137 char *get_supported_applications (void);
 138 void release_application (app_t app, int locked_already);
 139 gpg_error_t app_munge_serialno (app_t app);
 140 gpg_error_t app_write_learn_status (app_t app, ctrl_t ctrl,
 141                                     unsigned int flags);
 142 gpg_error_t app_readcert (app_t app, ctrl_t ctrl, const char *certid,
 143                   unsigned char **cert, size_t *certlen);
 144 gpg_error_t app_readkey (app_t app, ctrl_t ctrl, int advanced,
 145                  const char *keyid, unsigned char **pk, size_t *pklen);
 146 gpg_error_t app_getattr (app_t app, ctrl_t ctrl, const char *name);
 147 gpg_error_t app_setattr (app_t app, ctrl_t ctrl, const char *name,
 148                  gpg_error_t (*pincb)(void*, const char *, char **),
 149                  void *pincb_arg,
 150                  const unsigned char *value, size_t valuelen);
 151 gpg_error_t app_sign (app_t app, ctrl_t ctrl, const char *keyidstr, int hashalgo,
 152               gpg_error_t (*pincb)(void*, const char *, char **),
 153               void *pincb_arg,
 154               const void *indata, size_t indatalen,
 155               unsigned char **outdata, size_t *outdatalen );
 156 gpg_error_t app_auth (app_t app, ctrl_t ctrl, const char *keyidstr,
 157                       gpg_error_t (*pincb)(void*, const char *, char **),
 158                       void *pincb_arg,
 159                       const void *indata, size_t indatalen,
 160                       unsigned char **outdata, size_t *outdatalen);
 161 gpg_error_t app_decipher (app_t app, ctrl_t ctrl, const char *keyidstr,
 162                           gpg_error_t (*pincb)(void*, const char *, char **),
 163                           void *pincb_arg,
 164                           const void *indata, size_t indatalen,
 165                           unsigned char **outdata, size_t *outdatalen,
 166                           unsigned int *r_info);
 167 gpg_error_t app_writecert (app_t app, ctrl_t ctrl,
 168                            const char *certidstr,
 169                            gpg_error_t (*pincb)(void*, const char *, char **),
 170                            void *pincb_arg,
 171                            const unsigned char *keydata, size_t keydatalen);
 172 gpg_error_t app_writekey (app_t app, ctrl_t ctrl,
 173                           const char *keyidstr, unsigned int flags,
 174                           gpg_error_t (*pincb)(void*, const char *, char **),
 175                           void *pincb_arg,
 176                           const unsigned char *keydata, size_t keydatalen);
 177 gpg_error_t app_genkey (app_t app, ctrl_t ctrl,
 178                         const char *keynostr, unsigned int flags,
 179                         time_t createtime,
 180                         gpg_error_t (*pincb)(void*, const char *, char **),
 181                         void *pincb_arg);
 182 gpg_error_t app_get_challenge (app_t app, ctrl_t ctrl, size_t nbytes,
 183                                unsigned char *buffer);
 184 gpg_error_t app_change_pin (app_t app, ctrl_t ctrl,
 185                     const char *chvnostr, int reset_mode,
 186                     gpg_error_t (*pincb)(void*, const char *, char **),
 187                     void *pincb_arg);
 188 gpg_error_t app_check_pin (app_t app, ctrl_t ctrl, const char *keyidstr,
 189                    gpg_error_t (*pincb)(void*, const char *, char **),
 190                    void *pincb_arg);
 191
 192
 193 /*-- app-openpgp.c --*/
 194 gpg_error_t app_select_openpgp (app_t app);
 195
 196 /*-- app-nks.c --*/
 197 gpg_error_t app_select_nks (app_t app);
 198
 199 /*-- app-dinsig.c --*/
 200 gpg_error_t app_select_dinsig (app_t app);
 201
 202 /*-- app-p15.c --*/
 203 gpg_error_t app_select_p15 (app_t app);
 204
 205 /*-- app-geldkarte.c --*/
 206 gpg_error_t app_select_geldkarte (app_t app);
 207
 208 /*-- app-sc-hsm.c --*/
 209 gpg_error_t app_select_sc_hsm (app_t app);
 210
 211
 212 #endif /*GNUPG_SCD_APP_COMMON_H*/