Wolfgang Hommel > pcsc-perl-1.4.10 > Chipcard::PCSC::Card

Download:
pcsc-perl-1.4.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.02   Source   Latest Release: pcsc-perl-1.4.13

NAME ^

Chipcard::PCSC::Card - Smart card communication library

SYNOPSIS ^

 $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);

DESCRIPTION ^

The Chipcard::PCSC::Card module implements the Chipcard::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 Chipcard::PCSC::Card object uses the following property:

CONSTRUCTORS ^

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

CONSTRUCTION FAILURE ^

Chipcard::PCSC::Card constructors return an undef value when the object can not be created. $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.

Chipcard::PCSC::Card METHODS ^

Here is a list of all the methods that can be used with a Chipcard::PCSC::Card object.

$hCard->Connect($reader_name, $share_mode, $preferred_protocol);

Connect() can be used to connect to the reader and its smart card 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 smart card. It can be any of the following:

$hCard->Connect($reader_name, $share_mode);

This method is equivalent to:

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

$hCard->Connect($reader_name);

This method is equivalent to:

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

$hCard->Reconnect($share_mode, $preferred_protocol, $initialization);

Reconnect() can be used to re-negotiate an already opened connection. This implies that the Chipcard::PCSC::Card object is connected and has $hCard->{hCard} set accordingly.

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

The return value upon successful completion is the protocol choose to communicate with the smart card. It can be any of the following:

$hCard->Reconnect($share_mode, $preferred_protocol);

This method is equivalent to:

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

$hCard->Reconnect($share_mode);

This method is equivalent to:

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

$hCard->Reconnect();

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);

$hCard->Disconnect($initialization);

Disconnect() closes the connection to the smart card reader. It returns true upon successful completion or undef otherwise. $hCard->{hContext} will be set to undef if the connection is successfully closed.

$hCard->Disconnect();

This method is equivalent to:

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

$hCard->Status();

Status() returns the current status of the connection to a smart card. 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 undef value if an error occurs. In such a case, $! should be set with a string describing the error. Upon successful completion Status returns an array as follows: ($reader_name, $reader_state, $protocol, \@atr)

$hCard->Transmit(\@data);

Transmit() 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 undef value.

Here is a small sample of how to use transmit:

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

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

$hCard->BeginTransaction();

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

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

$hCard->EndTransaction($disposition);

EndTransaction() is used to end a transaction initiated with BeginTransaction().

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

$hCard->EndTransaction();

This method is equivalent to:

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

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

This method is a wrapper around $hCard->Transmit(). The $apdu parameter is an ASCII text like "00 A4 01 00 02 01 00", $sw_expected is a Perl regular expression like "90 [01]0".

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

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

The $debug argument is optional. 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;

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

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));

ISO7816Error($sw);

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

Example:

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

SEE ALSO ^

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

COPYRIGHT ^

(C) Lionel VICTOR, 2001, GNU GPL

(C) Ludovic ROUSSEAU, 2003-2008, GNU GPL

AUTHORS / ACKNOWLEDGEMENT ^

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

 Ludovic ROUSSEAU <ludovic.rousseau@free.fr>
syntax highlighting: