Chipcard::PCSC::Card - Smarcard communication library

 $hCard = new Chipcard::PCSC::Card ($hContext, "GemPC430 0 0",
        $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE);

 $RecvData = $hCard->Transmit([0xBC,0xB0,0x09,0xC8, 2]);

 $hCard->Disconnect($Chipcard::PCSC::SCARD_LEAVE_CARD);

 $hCard->Status();

 $hCard->BeginTransaction();

 $hCard->EndTransaction();

 $hCard->TransmitWithCheck($apdu, $sw_expected [, $debug]);

 $hCard->Control($control_code, \@data);

 ISO7816Error($sw);

The CWChipcard::PCSC::Card module implements the CWChipcard::PCSC::Card class. Objects from this class are used to communicate with a given reader. They are constructed out of a reference to a PCSC object that drives the reader.

For more information about PC/SC please read the pcscd(1) man page.

A CWChipcard::PCSC::Card object uses the following property:

* $pcsccard_object->{hContext}

the reference to the underlying PCSC object

* $pcsccard_object->{hCard}

the current PCSC connection handle

* $pcsccard_object->{dwProtocol}

the protocol being used

The following methods construct a CWChipcard::PCSC::Card object:

* $hCard = new Chipcard::PCSC::Card ($hContext);

Constructs a new CWChipcard::PCSC::Card object without connecting to any reader. CW$hContext is mandatory and contains the reference to a valid PCSC object. Constructs a new Chipcard::PCSC::Card object and connect to the specified reader. is mandatory and contains the reference to a valid PCSC oject. is the name of the reader you want to connect to. It is of the form GemPC410 0 0. Please note that the list of available readers can be obtained with a call to CW$hContext->ListReaders(). (See the section named PCSC METHODS in the Chipcard::PCSC man page for more informations on CWListReaders). is the desired mode of connection to the reader. It can be any of the following: the application do not share the reader the application will allow others to share the reader. (not used by PC/SC-lite) is the protocol which should be used if possible. If the protocol is not available, another protocol will be used and CW$hCard->{dwProtocol} will be set accordingly. Both CW$hCard->{dwProtocol} and CW$prefered_protocol accept the following values: the T=0 protocol the T=1 protocol raw protocol This method is equivalent to:

 $hCard = new Chipcard::PCSC::Card ($hContext, $reader_name,
    $share_mode,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1);

This method is equivalent to:

 $hCard = new Chipcard::PCSC::Card ($hContext, $reader_name,
    $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1);

CWChipcard::PCSC::Card constructors return an CWundef value when the object can not be created. CW$Chipcard::PCSC::errno can be used to get more information about the error. See section ERROR HANDLING in Chipcard::PCSC man page for more information.

Here is a list of all the methods that can be used with a CWChipcard::PCSC::Card object. CWConnect() can be used to connect to the reader and its smartcard if the connection has not been established yet. The default constructor can establish the connection if given enough parameters.

The return value upon successful completion is the protocol used to communicate with the smartcard. It can be any of the following: the T=0 protocol the T=1 protocol raw protocol is mandatory. It contains the name of the reader you want to connect to. It is of the form GemPC410 0 0. Please note that the list of available readers can be obtained with a call to CW$hContext->ListReaders(). (See the section named PCSC METHODS in the Chipcard::PCSC man page for more informations on CWListReaders). is the desired mode of connection to the reader. It can be any of the following: the application do not share the reader the application will allow others to share the reader. (not used by PCSClite) is the protocol which should be used if possible. If the protocol is not available, an other protocol will be used and CW$hCard->{dwProtocol} will be set accordingly. CW$prefered_protocol accept the following values: the T=0 protocol the T=1 protocol raw protocol This method is equivalent to:

 $hCard->Connect($reader_name, $share_mode,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1);

This method is equivalent to:

 $hCard->Connect($reader_name, $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1);

Reconnecting to a smartcard is used to change the share mode and the current protocol.

The return value upon successful completion is the protocol choosed to communicate with the smartcard. It can be any of the following: the T=0 protocol the T=1 protocol raw protocol is the desired mode of connection to the reader. It can be any of the following: the application do not share the reader the application will allow others to share the reader. (not used by PCSClite) is the protocol which should be used if possible. If the protocol is not available, an other protocol will be used and CW$hCard->{dwProtocol} will be set accordingly. CW$prefered_protocol accept the following values: the T=0 protocol the T=1 protocol raw protocol is the action to take when reconnecting to the smartcard. It can be any of the following values: do nothing on close reset on close power down on close eject on close This method is equivalent to:

 $hCard->Reconnect($share_mode, $prefered_protocol,
    $Chipcard::PCSC::SCARD_LEAVE_CARD);

This method is equivalent to:

 $hCard->Reconnect($share_mode,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1,
    $Chipcard::PCSC::SCARD_LEAVE_CARD);

This method is equivalent to:

 $hCard->Reconnect($Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE,
    $Chipcard::PCSC::SCARD_PROTOCOL_T0 |
    $Chipcard::PCSC::SCARD_PROTOCOL_T1,
    $Chipcard::PCSC::SCARD_LEAVE_CARD);

CWDisconnect() closes the connection to the smartcard reader. It returns true upon successful completion or undef otherwise. CW$hCard->{hContext} will be set to undef if the connection is successfuly closed. is the action to take when reconnecting to the smartcard. It can be any of the following values: do nothing on close reset on close power down on close eject on close

This method is equivalent to:

 $hCard->Disconnect($Chipcard::PCSC::SCARD_EJECT_CARD);

CWStatus() returns the current status of the connection to a smartcard. It is used to retrieve the ATR (Answer To Reset) value as well as the protocol being used to communicate.

The return value is the CWundef value if an error occurs. In such a case, CW$! should be set with a string describing the error. Upon successful completion CWStatus returns an array as follows: (CW$reader_name, CW$reader_state, CW$protocol, CW\@atr) is a string containing the name of the reader is a scalar containing the current state of the reader. It can be any combination of the following values: unknown state card is absent card is present card not powered card is powered ready for PTS

$Chipcard::PCSC::SCARD_SPECIFIC

PTS has been set is the protocol being used. It can be any of the following values:

* \@atr

is a reference to an array containing the ATR. Each cell of the array contains one byte of the ATR. This parameter is however optional as the ATR may not be available under some circumstances. For instance when the card is not inserted, no ATR can be returned and this parameter will be CWundef.

CWTransmit() is used to exchange data with the card.

It returns a reference to an anonymous array holding the answer to the emitted data. In case of an error, the reference is the CWundef value.

* \@data

is a reference to the data to be sent to the card.

Here is a small sample of how to use CWtransmit:

 $SendData = [0x00, 0xA4, 0x01, 0x00, 0x02, 0x01, 0x00];
 $RecvData = $hCard->Transmit($SendData);

 print "  Recv = ";
 foreach $tmpVal (@{$RecvData}) {
     printf ("%02X ", $tmpVal);
 } print "\n";

CWBeginTransaction() is used to temporarily get exclusive control over the smart card.

It returns TRUE upon succesful completion and FALSE otherwise. CW$Chipcard::PCSC::errno should be set accordingly in case of an error. See section ERROR HANDLING in Chipcard::PCSC man page for more information.

CWEndTransaction() is used to end a transaction initiated with CWBeginTransaction().

It returns CWTRUE upon succesful completion and FALSE otherwise. CW$Chipcard::PCSC::errno should be set accordingly in case of an error. See section ERROR HANDLING in Chipcard::PCSC man page for more information. is the action to take when ending the transaction. It can be any of the following values: do nothing on close reset on close power down on close eject on close

This method is equivalent to:

 $hCard->EndTransaction($Chipcard::PCSC::SCARD_LEAVE_CARD);

If the status word returned matches the expression CW$sw_expected the method returns a list ($sw, CW$recv). CW$sw is the status word (like 90 00) of the command, CW$recv is the result of the command.

If the status word do not match the expression CW$sw_expected the method returns undef and the variable CW$Chipcard::PCSC::Card::Error is set.

The CW$debug argument is optionnal. If present the method will print on stdout the command sent and the response from the card.

Example:

 ($sw, $RecvData) = $hCard->TransmitWithCheck($SendData, "6E 00", 1);
 warn "TransmitWithCheck: $Chipcard::PCSC::Card::Error" unless defined $sw;

This method uses PC/SC SCardControl() to send data specific to the reader driver. See your driver documentation to know what data to use.

Example:

 $data = Chipcard::PCSC::ascii_to_array ("01 23 45");
 $RecvData = $hCard->Control(0x42000001, $SendData);
 die ("Can't Control data: $Chipcard::PCSC::errno") unless (defined ($RecvData));

This method returns the ASCII text corresponding to the status word CW$sw according to ISO 7816-4 specifications.

Example:

 $sw = "90 00";
 print "$sw: " . &Chipcard::PCSC::Card::ISO7816Error($sw) . "\n";

pcscd manpage has useful informations about PC/SC-lite. Chipcard::PCSC manpage holds all the necessary information to create the PCSC object which will be the basis of CWChipcard::PCSC::Card.

(C) Lionel VICTOR & Ludovic ROUSSEAU, 2001-2003, GNU GPL

 Lionel VICTOR <lionel.victor@unforgettable.com>
               <lionel.victor@free.fr>

 Ludovic ROUSSEAU <ludovic.rousseau@free.fr>