scd/ccid-driver.h

   1 /* ccid-driver.c - USB ChipCardInterfaceDevices driver
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  19  * USA.
  20  *
  21  * ALTERNATIVELY, this file may be distributed under the terms of the
  22  * following license, in which case the provisions of this license are
  23  * required INSTEAD OF the GNU General Public License. If you wish to
  24  * allow use of your version of this file only under the terms of the
  25  * GNU General Public License, and not to allow others to use your
  26  * version of this file under the terms of the following license,
  27  * indicate your decision by deleting this paragraph and the license
  28  * below.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, and the entire permission notice in its entirety,
  35  *    including the disclaimer of warranties.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  * 3. The name of the author may not be used to endorse or promote
  40  *    products derived from this software without specific prior
  41  *    written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  44  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  45  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  46  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  47  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  48  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  49  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  51  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  52  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  53  * OF THE POSSIBILITY OF SUCH DAMAGE.
  54  *
  55  * $Id$
  56  */
  57
  58 #ifndef CCID_DRIVER_H
  59 #define CCID_DRIVER_H
  60
  61 /* The CID driver returns the same error codes as the status words
  62    used by GnuPG's apdu.h.  For ease of maintenance they should always
  63    match.  */
  64 #define CCID_DRIVER_ERR_OUT_OF_CORE    0x10001
  65 #define CCID_DRIVER_ERR_INV_VALUE      0x10002
  66 #define CCID_DRIVER_ERR_INCOMPLETE_CARD_RESPONSE = 0x10003
  67 #define CCID_DRIVER_ERR_NO_DRIVER      0x10004
  68 #define CCID_DRIVER_ERR_NOT_SUPPORTED  0x10005
  69 #define CCID_DRIVER_ERR_LOCKING_FAILED 0x10006
  70 #define CCID_DRIVER_ERR_BUSY           0x10007
  71 #define CCID_DRIVER_ERR_NO_CARD        0x10008
  72 #define CCID_DRIVER_ERR_CARD_INACTIVE  0x10009
  73 #define CCID_DRIVER_ERR_CARD_IO_ERROR  0x1000a
  74 #define CCID_DRIVER_ERR_GENERAL_ERROR  0x1000b
  75 #define CCID_DRIVER_ERR_NO_READER      0x1000c
  76 #define CCID_DRIVER_ERR_ABORTED        0x1000d
  77 #define CCID_DRIVER_ERR_NO_KEYPAD      0x1000e
  78
  79 struct ccid_driver_s;
  80 typedef struct ccid_driver_s *ccid_driver_t;
  81
  82 int ccid_set_debug_level (int level);
  83 char *ccid_get_reader_list (void);
  84 int ccid_open_reader (ccid_driver_t *handle, const char *readerid);
  85 int ccid_shutdown_reader (ccid_driver_t handle);
  86 int ccid_close_reader (ccid_driver_t handle);
  87 int ccid_get_atr (ccid_driver_t handle,
  88                   unsigned char *atr, size_t maxatrlen, size_t *atrlen);
  89 int ccid_slot_status (ccid_driver_t handle, int *statusbits);
  90 int ccid_transceive (ccid_driver_t handle,
  91                      const unsigned char *apdu, size_t apdulen,
  92                      unsigned char *resp, size_t maxresplen, size_t *nresp);
  93 int ccid_transceive_secure (ccid_driver_t handle,
  94                      const unsigned char *apdu, size_t apdulen,
  95                      int pin_mode,
  96                      int pinlen_min, int pinlen_max, int pin_padlen,
  97                      unsigned char *resp, size_t maxresplen, size_t *nresp);
  98 int ccid_transceive_escape (ccid_driver_t handle,
  99                             const unsigned char *data, size_t datalen,
 100                             unsigned char *resp, size_t maxresplen,
 101                             size_t *nresp);
 102
 103
 104
 105 #endif /*CCID_DRIVER_H*/
 106
 107
 108