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