/* * opensc.h: OpenSC library header file * * Copyright (C) 2001 Juha Yrjölä * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _OPENSC_H #define _OPENSC_H #include #include #include #ifdef __cplusplus extern "C" { #endif #define SC_ERROR_MIN -1000 #define SC_ERROR_UNKNOWN -1000 #define SC_ERROR_CMD_TOO_SHORT -1001 #define SC_ERROR_CMD_TOO_LONG -1002 #define SC_ERROR_NOT_SUPPORTED -1003 #define SC_ERROR_TRANSMIT_FAILED -1004 #define SC_ERROR_FILE_NOT_FOUND -1005 #define SC_ERROR_INVALID_ARGUMENTS -1006 #define SC_ERROR_PKCS15_CARD_NOT_FOUND -1007 #define SC_ERROR_REQUIRED_PARAMETER_NOT_FOUND -1008 #define SC_ERROR_OUT_OF_MEMORY -1009 #define SC_ERROR_NO_READERS_FOUND -1010 #define SC_ERROR_OBJECT_NOT_VALID -1011 #define SC_ERROR_ILLEGAL_RESPONSE -1012 #define SC_ERROR_PIN_CODE_INCORRECT -1013 #define SC_ERROR_SECURITY_STATUS_NOT_SATISFIED -1014 #define SC_ERROR_CONNECTING_TO_RES_MGR -1015 #define SC_ERROR_INVALID_ASN1_OBJECT -1016 #define SC_ERROR_BUFFER_TOO_SMALL -1017 #define SC_ERROR_CARD_NOT_PRESENT -1018 #define SC_ERROR_RESOURCE_MANAGER -1019 #define SC_ERROR_CARD_REMOVED -1020 #define SC_ERROR_INVALID_PIN_LENGTH -1021 #define SC_ERROR_UNKNOWN_SMARTCARD -1022 #define SC_ERROR_UNKNOWN_REPLY -1023 #define SC_ERROR_OBJECT_NOT_FOUND -1024 #define SC_ERROR_CARD_RESET -1025 #define SC_ERROR_ASN1_OBJECT_NOT_FOUND -1026 #define SC_ERROR_ASN1_END_OF_CONTENTS -1027 #define SC_ERROR_TOO_MANY_OBJECTS -1028 #define SC_APDU_CASE_NONE 0 #define SC_APDU_CASE_1 1 #define SC_APDU_CASE_2_SHORT 2 #define SC_APDU_CASE_3_SHORT 3 #define SC_APDU_CASE_4_SHORT 4 #define SC_APDU_CASE_2_EXT 5 #define SC_APDU_CASE_3_EXT 6 #define SC_APDU_CASE_4_EXT 7 #define SC_ISO7816_4_SELECT_FILE 0xA4 #define SC_ISO7816_4_GET_RESPONSE 0xC0 #define SC_ISO7616_4_READ_BINARY 0xB0 #define SC_ISO7616_4_VERIFY 0x20 #define SC_ISO7616_4_UPDATE_BINARY 0xD6 #define SC_ISO7616_4_ERASE_BINARY 0x0E #define SC_SELECT_FILE_RECORD_FIRST 0x00 #define SC_SELECT_FILE_RECORD_LAST 0x01 #define SC_SELECT_FILE_RECORD_NEXT 0x02 #define SC_SELECT_FILE_RECORD_PREVIOUS 0x03 #define SC_SELECT_FILE_BY_FILE_ID 0x00 #define SC_SELECT_FILE_BY_DF_NAME 0x01 #define SC_SELECT_FILE_BY_PATH 0x02 #define SC_FILE_MAGIC 0x10203040 #define SC_FILE_TYPE_DF 0x03 #define SC_FILE_TYPE_INTERNAL_EF 0x01 #define SC_FILE_TYPE_WORKING_EF 0x00 #define SC_FILE_EF_TRANSPARENT 0x01 #define SC_FILE_EF_LINEAR_FIXED 0x02 #define SC_FILE_EF_LINEAR_FIXED_TLV 0x03 #define SC_MAX_READERS 4 #define SC_MAX_APDU_BUFFER_SIZE 255 #define SC_MAX_PATH_SIZE 16 #define SC_MAX_PIN_SIZE 16 #define SC_MAX_ATR_SIZE 33 #define SC_MAX_SEC_ATTR_SIZE 16 #define SC_MAX_PROP_ATTR_SIZE 16 #define SC_ASN1_MAX_OBJECT_ID_OCTETS 16 typedef unsigned char u8; struct sc_object_id { int value[SC_ASN1_MAX_OBJECT_ID_OCTETS]; }; struct sc_path { u8 value[SC_MAX_PATH_SIZE]; size_t len; int index; }; struct sc_file { struct sc_path path; u8 name[16]; size_t namelen; int type, shareable, ef_structure; size_t size; int id; u8 sec_attr[SC_MAX_SEC_ATTR_SIZE]; size_t sec_attr_len; u8 prop_attr[SC_MAX_SEC_ATTR_SIZE]; size_t prop_attr_len; unsigned int magic; }; #define SC_SEC_OPERATION_DECIPHER 0 #define SC_SEC_OPERATION_SIGN 1 struct sc_security_env { int algorithm_ref; struct sc_path key_file_id; /* operation=1 ==> digital signing, signature=0 ==> decipher */ int operation; int key_ref; }; struct sc_card; struct sc_card_operations { int (*init)(struct sc_card *card); int (*finish)(struct sc_card *card); int (*read_binary)(struct sc_card *card, unsigned int idx, u8 * buf, size_t count); int (*write_binary)(struct sc_card *card, unsigned int idx, const u8 * buf, size_t count); int (*update_binary)(struct sc_card *card, unsigned int idx, const u8 * buf, size_t count); int (*erase_binary)(struct sc_card *card, unsigned int idx, size_t count); int (*read_binary_large)(struct sc_card *card, unsigned int idx, u8 * buf, size_t count); int (*write_binary_large)(struct sc_card *card, unsigned int idx, const u8 * buf, size_t count); int (*update_binary_large)(struct sc_card *card, unsigned int idx, const u8 * buf, size_t count); /* possibly TODO: record handling */ int (*select_file)(struct sc_card *card, struct sc_file *file, const struct sc_path *path, int selection_type); int (*get_response)(struct sc_card *card, u8 * buf, size_t count); int (*get_challenge)(struct sc_card *card, u8 * buf, size_t count); /* ISO 7816-8 */ int (*verify)(struct sc_card *card, int ref_qualifier, const u8 *data, size_t data_len, int *tries_left); int (*restore_security_env)(struct sc_card *card, int se_num); int (*set_security_env)(struct sc_card *card, const struct sc_security_env *env); int (*decipher)(struct sc_card *card, const u8 * crgram, size_t crgram_len, u8 * out, size_t outlen); int (*compute_signature)(struct sc_card *card, const u8 * data, size_t data_len, u8 * out, size_t outlen); int (*change_reference_data)(struct sc_card *card, int ref_qualifier, const u8 *old, size_t oldlen, const u8 *newref, size_t newlen, int *tries_left); int (*reset_retry_counter)(struct sc_card *card, int ref_qualifier, const u8 *puk, size_t puklen, const u8 *newref, size_t newlen); }; struct sc_card { int cla; struct sc_context *ctx; SCARDHANDLE pcsc_card; int reader; u8 atr[SC_MAX_ATR_SIZE]; size_t atr_len; pthread_mutex_t mutex; struct sc_card_operations *ops; }; struct sc_context { SCARDCONTEXT pcsc_ctx; char *readers[SC_MAX_READERS]; int reader_count; int debug; int use_std_output, use_cache; }; struct sc_apdu { int cse; /* APDU case */ u8 cla, ins, p1, p2; size_t lc, le; const u8 *data; /* C-APDU */ size_t datalen; /* length of C-APDU */ u8 *resp; /* R-APDU */ size_t resplen; /* length of R-APDU */ int no_response; /* No response required */ unsigned int sw1, sw2; }; struct sc_defaults { const char *atr; int (*defaults_func)(void *); int (*pkcs15_defaults_func)(void *); }; /* Base64 encoding/decoding functions */ int sc_base64_encode(const u8 *in, size_t inlen, u8 *out, size_t outlen, size_t linelength); int sc_base64_decode(const char *in, u8 *out, size_t outlen); /* APDU handling functions */ int sc_transmit_apdu(struct sc_card *card, struct sc_apdu *apdu); void sc_format_apdu(struct sc_card *card, struct sc_apdu *apdu, int cse, int ins, int p1, int p2); int sc_establish_context(struct sc_context **ctx); int sc_destroy_context(struct sc_context *ctx); int sc_connect_card(struct sc_context *ctx, int reader, struct sc_card **card); int sc_disconnect_card(struct sc_card *card); /* Checks if a card is present on the supplied reader * Returns: 1 if card present, 0 if card absent and < 0 in case of an error */ int sc_detect_card(struct sc_context *ctx, int reader); /* Waits for card insertion on the supplied reader * timeout of -1 means forever, reader of -1 means all readers * Returns: 1 if a card was found, 0 if timeout occured * and < 0 in case of an error */ int sc_wait_for_card(struct sc_context *ctx, int reader, int timeout); int sc_lock(struct sc_card *card); int sc_unlock(struct sc_card *card); /* ISO 7816-4 related functions */ int sc_select_file(struct sc_card *card, struct sc_file *file, const struct sc_path *path, int pathtype); int sc_read_binary(struct sc_card *card, int idx, u8 * buf, size_t count); int sc_get_random(struct sc_card *card, u8 * rndout, size_t len); /* ISO 7816-8 related functions */ int sc_restore_security_env(struct sc_card *card, int se_num); int sc_set_security_env(struct sc_card *card, const struct sc_security_env *env); int sc_decipher(struct sc_card *card, const u8 * crgram, size_t crgram_len, u8 * out, size_t outlen); int sc_compute_signature(struct sc_card *card, const u8 * data, size_t data_len, u8 * out, size_t outlen); int sc_verify(struct sc_card *card, int ref, const u8 *buf, size_t buflen, int *tries_left); int sc_change_reference_data(struct sc_card *card, int ref, const u8 *old, size_t oldlen, const u8 *newref, size_t newlen, int *tries_left); int sc_reset_retry_counter(struct sc_card *card, int ref, const u8 *puk, size_t puklen, const u8 *newref, size_t newlen); /* ISO 7816-9 */ int sc_create_file(struct sc_card *card, const struct sc_file *file); int sc_delete_file(struct sc_card *card, int file_id); /* Possibly only on Setec cards */ int sc_list_files(struct sc_card *card, u8 * buf, int buflen); const char *sc_strerror(int error); /* Internal use only */ int sc_file_valid(const struct sc_file *file); void sc_print_binary(FILE *f, const u8 *buf, int len); int sc_hex_to_bin(const char *in, u8 *out, size_t *outlen); int sc_sw_to_errorcode(struct sc_card *card, int sw1, int sw2); extern const char *sc_version; extern const struct sc_defaults sc_card_table[]; #ifdef __cplusplus } #endif #endif