/usr/include/libchipcard5/chipcard/card.h is in libchipcard-dev 5.0.3beta-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | /***************************************************************************
begin : Mon Mar 01 2004
copyright : (C) 2004-2010 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* Please see toplevel file COPYING for license details *
***************************************************************************/
#ifndef CHIPCARD_CLIENT_CARD_H
#define CHIPCARD_CLIENT_CARD_H
/** @addtogroup chipcardc_card_basic
*/
/*@{*/
#include <gwenhywfar/inherit.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct LC_CARD LC_CARD;
#ifdef __cplusplus
}
#endif
#include <chipcard/chipcard.h>
#include <chipcard/client.h>
#include <chipcard/sharedstuff/pininfo.h>
#ifdef __cplusplus
extern "C" {
#endif
GWEN_INHERIT_FUNCTION_LIB_DEFS(LC_CARD, CHIPCARD_API)
GWEN_LIST2_FUNCTION_LIB_DEFS(LC_CARD, LC_Card, CHIPCARD_API)
/** @name Flags for ISO Commands
*
*/
/*@{*/
#define LC_CARD_ISO_FLAGS_EFID_MASK 0x00000001f
/** Mask for flags used with record based functions (like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_MASK 0x0000000e0
/** Select first record (used with record based functions like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_FIRST (0 << 5)
/** Select last record (used with record based functions like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_LAST (1 << 5)
/** Select next record (used with record based functions like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_NEXT (2 << 5)
/** Select previous record (used with record based functions like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_PREV (3 << 5)
/** Select given record (used with record based functions like
* @ref LC_Card_IsoReadRecord) */
#define LC_CARD_ISO_FLAGS_RECSEL_GIVEN (4 << 5)
/*@}*/
/** @name Opening, Closing, Destroying
*
*/
/*@{*/
/**
* Release all ressources associated with the given card. You @b must call
* this function in order to avoid memory leaks.
*/
CHIPCARD_API
void LC_Card_free(LC_CARD *cd);
CHIPCARD_API
void LC_Card_List2_freeAll(LC_CARD_LIST2 *l);
/**
* Opens a card obtained via @ref LC_Client_GetNextCard.
* The action taken here depends on the derived card class (e.g.
* LC_DdvCard).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_Open(LC_CARD *card);
/**
* Closes the given card.
* The action taken here depends on the derived card class (e.g.
* LC_DdvCard).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_Close(LC_CARD *card);
/*@}*/
/** @name Executing Card Commands
*
* There are two ways of letting Libchipcard execute card commands:
* <ul>
* <li>directly sending a prebuilt APDU</li>
* <li>
* referencing a command by name so that Libchipcard can built the
* APDU for the particular reader and card combination.
* </ul>
* When working with Libchipcard the latter method is preferred since only
* in this case Libchipcard can adapt APDUs in order to make them work
* with a given combination of card and reader. Otherwise the application
* has to take care of the specialties of a given reader or card by itself.
*/
/*@{*/
/**
* Execute a prebuilt APDU and return the result.
* This function can be used when relaying APDUs from other APIs (such as
* the CTAPI shipped with Libchipcard which allows to access the service of
* Libchipcard via CTAPI).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_ExecApdu(LC_CARD *card,
const char *apdu,
unsigned int len,
GWEN_BUFFER *rbuf,
LC_CLIENT_CMDTARGET t);
/**
* Executes a command referenced by name.
* This function looks for the given command in the description files
* of the currently selected card and reader which holds the card.
* This way the resulting APDU will work with that particular combination.
*
* This function only works after the functions @ref LC_Card_SelectApp
* and LC_Card_SelectCard have been called (which is done implicitly by
* the open-functions set by e.g. @ref LC_DDVCard_ExtendCard() etc.
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_ExecCommand(LC_CARD *card,
const char *commandName,
GWEN_DB_NODE *cmdData,
GWEN_DB_NODE *rspData);
/**
* This function is used internally by @ref LC_Card_ExecCommand to create
* an APDU from a command for a particular combination of card and reader.
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_BuildApdu(LC_CARD *card,
const char *command,
GWEN_DB_NODE *cmdData,
GWEN_BUFFER *gbuf);
/*@}*/
/** @name Select Card/Application Type
*
* Functions in this group tell Libchipcard which instruction set is to be
* used for @ref LC_Card_ExecApdu(). It also selects the XML descriptions
* appropriate for the card application to be used by the functions
* @ref LC_Card_SelectDf() and LC_Card_SelectEf().
*
* A card can contain multiple applications, e.g. some HBCI cards additionally
* contain the GeldKarte application. Different card applications contain
* different files/folders (EF/DF), so Libchipcard needs to be told which
* card application is to be used.
*/
/*@{*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_SelectCard(LC_CARD *card, const char *s);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_SelectApp(LC_CARD *card, const char *appName);
/*@}*/
/** @name Select MF/DF/EF
*
*/
/*@{*/
/**
* This function selects the master file (corresponds to root on a
* filesystem).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_SelectMf(LC_CARD *card);
/**
* Select a dedicated file below the currently selected one (or the master
* file). A DF can be thought of as a folder in a filesystem.
* Libchipcard looks this DF up in the XML description files of the current
* card and application an creates the appropriate APDU to select the DF
* either by short or long id (as determined by the XML files).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_SelectDf(LC_CARD *card, const char *fname);
/**
* Select an elementary file below the currently selected DF (or MF).
* An EF can be thought of as a file in a filesystem.
* Libchipcard looks this EF up in the XML description files of the current
* card and application an creates the appropriate APDU to select the EF
* either by short or long id (as determined by the XML files).
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_SelectEf(LC_CARD *card, const char *fname);
/*@}*/
/** @name XML Descriptions
*
*/
/*@{*/
CHIPCARD_API
GWEN_XMLNODE *LC_Card_GetCardNode(const LC_CARD *card);
CHIPCARD_API
GWEN_XMLNODE *LC_Card_GetAppNode(const LC_CARD *card);
CHIPCARD_API
GWEN_XMLNODE *LC_Card_GetDfNode(const LC_CARD *card);
CHIPCARD_API
GWEN_XMLNODE *LC_Card_GetEfNode(const LC_CARD *card);
/*@}*/
/** @name Informational Functions
*
*/
/*@{*/
/**
* The chipcard2 server identifies cards by ids which are unique in the
* server environment. No two cards can have the same id.
*/
CHIPCARD_API
uint32_t LC_Card_GetCardId(const LC_CARD *cd);
CHIPCARD_API
const char *LC_Card_GetReaderType(const LC_CARD *cd);
CHIPCARD_API
const char *LC_Card_GetDriverType(const LC_CARD *cd);
/**
* Returns the reader flags of the reader the given card is in (see
* @ref LC_READER_FLAGS_KEYPAD and others).
*/
CHIPCARD_API
uint32_t LC_Card_GetReaderFlags(const LC_CARD *cd);
/**
* Returns the type of the given card. Possible values are "MEMORY" and
* "PROCESSOR".
*/
CHIPCARD_API
const char *LC_Card_GetCardType(const LC_CARD *cd);
/**
* Returns a stringlist containing all types which match the ATR string of
* the given card. Possibly contents are "ddv0", "ddv1", "geldkarte" etc.
*/
CHIPCARD_API
const GWEN_STRINGLIST *LC_Card_GetCardTypes(const LC_CARD *cd);
/**
* Returns the <i>Answer To Reset</i> string returned by the card upon
* power up. These bytes indicate some properties of the card
* (e.g. card type, manufacturer, memory size etc).
* This function returns a pointer to the internally stored ATR. The card
* object still remains the owner of the object returned (if any) so you
* must neither manipulate nor free it.
*/
CHIPCARD_API
unsigned int LC_Card_GetAtr(const LC_CARD *cd,
const unsigned char **pbuf);
/**
* Returns the pointer to the client object this card belongs to.
*/
CHIPCARD_API
LC_CLIENT *LC_Card_GetClient(const LC_CARD *cd);
/*@}*/
/** @name Last Result
*
* These functions return the result of the last command executed via
* @ref LC_Card_ExecCommand (nearly all functions internally call that one)
*/
/*@{*/
CHIPCARD_API
int LC_Card_GetLastSW1(const LC_CARD *card);
CHIPCARD_API
int LC_Card_GetLastSW2(const LC_CARD *card);
CHIPCARD_API
const char *LC_Card_GetLastResult(const LC_CARD *card);
CHIPCARD_API
const char *LC_Card_GetLastText(const LC_CARD *card);
CHIPCARD_API
void LC_Card_CreateResultString(const LC_CARD *card,
const char *lastCommand,
LC_CLIENT_RESULT res,
GWEN_BUFFER *buf);
/*@}*/
/** @name Debugging Functions
*/
/*@{*/
CHIPCARD_API
void LC_Card_Dump(const LC_CARD *cd, int indent);
/*@}*/
/** @name Pin Functions
*
*/
/*@{*/
/**
* Returns a pininfo object of the pin given by its id.
* The caller becomes the owner of the object returned (if any) and must
* call @ref LC_PinInfo_free on it to avoid memory leaks.
*/
CHIPCARD_API
LC_PININFO *LC_Card_GetPinInfoById(LC_CARD *card, uint32_t pid);
/**
* Returns a pininfo object of the pin given by its name.
* The caller becomes the owner of the object returned (if any) and must
* call @ref LC_PinInfo_free on it to avoid memory leaks.
* Standard names are "ch_pin" for the cardholder pin and "eg_pin" for
* the device pin (needed by STARCOS cards to modify security data on a card).
*/
CHIPCARD_API
LC_PININFO *LC_Card_GetPinInfoByName(LC_CARD *card, const char *name);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_GetPinStatus(LC_CARD *card,
unsigned int pid,
int *maxErrors,
int *currentErrors);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_GetInitialPin(LC_CARD *card,
int id,
unsigned char *buffer,
unsigned int maxLen,
unsigned int *pinLength);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoVerifyPin(LC_CARD *card,
uint32_t flags,
const LC_PININFO *pi,
const unsigned char *ptr,
unsigned int size,
int *triesLeft);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoModifyPin(LC_CARD *card,
uint32_t flags,
const LC_PININFO *pi,
const unsigned char *oldptr,
unsigned int oldsize,
const unsigned char *newptr,
unsigned int newsize,
int *triesLeft);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoPerformVerification(LC_CARD *card,
uint32_t flags,
const LC_PININFO *pi,
int *triesLeft);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoPerformModification(LC_CARD *card,
uint32_t flags,
const LC_PININFO *pi,
int *triesLeft);
/*@}*/
/** @name Reading and Writing Data
*
*/
/*@{*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoReadBinary(LC_CARD *card,
uint32_t flags,
int offset,
int size,
GWEN_BUFFER *buf);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoWriteBinary(LC_CARD *card,
uint32_t flags,
int offset,
const char *ptr,
unsigned int size);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoUpdateBinary(LC_CARD *card,
uint32_t flags,
int offset,
const char *ptr,
unsigned int size);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoEraseBinary(LC_CARD *card,
uint32_t flags,
int offset,
unsigned int size);
/**
* This functions reads any number of bytes from an already selected file
* of the card. It therefore issues multiple read requests until all bytes
* are read.
*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_ReadBinary(LC_CARD *card,
int offset,
int size,
GWEN_BUFFER *buf);
/*@}*/
/** @name Reading and Writing Records
*
*/
/*@{*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoReadRecord(LC_CARD *card,
uint32_t flags,
int recNum,
GWEN_BUFFER *buf);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoWriteRecord(LC_CARD *card,
uint32_t flags,
int recNum,
const char *ptr,
unsigned int size);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoAppendRecord(LC_CARD *card,
uint32_t flags,
const char *ptr,
unsigned int size);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoUpdateRecord(LC_CARD *card,
uint32_t flags,
int recNum,
const char *ptr,
unsigned int size);
/*@}*/
/** @name Crypto Functions
*
*/
/*@{*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoManageSe(LC_CARD *card,
int tmpl, int kids, int kidp, int ar);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoEncipher(LC_CARD *card,
const char *ptr,
unsigned int size,
GWEN_BUFFER *codeBuf);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoDecipher(LC_CARD *card,
const char *ptr,
unsigned int size,
GWEN_BUFFER *plainBuf);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoSign(LC_CARD *card,
const char *ptr,
unsigned int size,
GWEN_BUFFER *sigBuf);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_IsoVerify(LC_CARD *card,
const char *dptr,
unsigned int dsize,
const char *sigptr,
unsigned int sigsize);
LC_CLIENT_RESULT
LC_Card_IsoInternalAuth(LC_CARD *card,
int kid,
const unsigned char *ptr,
unsigned int size,
GWEN_BUFFER *rBuf);
/*@}*/
/** @name Data Formats (Parsing and Generating)
*
*/
/*@{*/
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_ParseData(LC_CARD *card,
const char *format,
GWEN_BUFFER *buf,
GWEN_DB_NODE *dbData);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_CreateData(LC_CARD *card,
const char *format,
GWEN_BUFFER *buf,
GWEN_DB_NODE *dbData);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_ParseRecord(LC_CARD *card,
int recNum,
GWEN_BUFFER *buf,
GWEN_DB_NODE *dbRecord);
CHIPCARD_API
LC_CLIENT_RESULT LC_Card_CreateRecord(LC_CARD *card,
int recNum,
GWEN_BUFFER *buf,
GWEN_DB_NODE *dbRecord);
/*@}*/
#ifdef __cplusplus
}
#endif
/*@}*/ /* addtogroup */
#endif /* CHIPCARD_CLIENT_CARD_H */
|