This file is indexed.

/usr/lib/perl5/Chipcard/PCSC/Card.pod is in libpcsc-perl 1.4.13-1build1.

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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
=head1 NAME

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

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

=head1 DESCRIPTION

The C<Chipcard::PCSC::Card> module implements the
C<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 F<pcscd(1)> man page.

A C<Chipcard::PCSC::Card> object uses the following property:

=over 4

=item *
 B<$pcsccard_object-E<gt>{hContext}>

the reference to the underlying PCSC object

=item *
 B<$pcsccard_object-E<gt>{hCard}>

the current PCSC connection handle

=item *
 B<$pcsccard_object-E<gt>{dwProtocol}>

the protocol being used

=back

=head1 CONSTRUCTORS

The following methods construct a C<Chipcard::PCSC::Card> object:

=over 4

=item *
 B<$hCard = new Chipcard::PCSC::Card ($hContext);>


Constructs a new C<Chipcard::PCSC::Card> object without connecting to
any reader.

C<$hContext> is mandatory and contains the reference to a valid PCSC
object.

=item *
 B<$hCard = new Chipcard::PCSC::Card ($hContext, $reader_name, $share_mode, $preferred_protocol);>

Constructs a new Chipcard::PCSC::Card object and connect to the
specified reader.

=over 4

=item *
 $hContext

is mandatory and contains the reference to a valid PCSC object.

=item *
 $reader_name

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 C<$hContext-E<gt>ListReaders()>. (See the section named F<PCSC
METHODS> in the F<Chipcard::PCSC> man page for more information on
C<ListReaders>).

=item *
 $share_mode

is the desired mode of connection to the reader. It can be
any of the following:

=over 4

=item *
 $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE

the application do not share the reader

=item *
 $Chipcard::PCSC::SCARD_SHARE_SHARED

the application will allow others to share the reader.

=item *
 $Chipcard::PCSC::SCARD_SHARE_DIRECT

(not used by PC/SC-lite)

=back

=item *
 $preferred_protocol

is the protocol which should be used if possible.  If the protocol is
not available, another protocol will be used and
C<$hCard-E<gt>{dwProtocol}> will be set accordingly. Both
C<$hCard-E<gt>{dwProtocol}> and C<$preferred_protocol> accept the
following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0

the T=0 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1

the T=1 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW

raw protocol

=back

=back

=item *
 B<$hCard = new Chipcard::PCSC::Card ($hContext, $reader_name, $share_mode);>

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

=item *
 B<$hCard = new Chipcard::PCSC::Card ($hContext, $reader_name);>

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

=back

=head1 CONSTRUCTION FAILURE

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

=head1 Chipcard::PCSC::Card METHODS

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

=head2
 $hCard-E<gt>Connect($reader_name, $share_mode, $preferred_protocol);

C<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:

=over 4

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0

the T=0 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1

the T=1 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW

raw protocol

=back

=over 4

=item *
 $reader_name

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 C<$hContext-E<gt>ListReaders()>. (See the section named F<PCSC
METHODS> in the F<Chipcard::PCSC> man page for more information on
C<ListReaders>).

=item *
 $share_mode

is the desired mode of connection to the reader. It can be any of the
following:

=over 4

=item *
 $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE

the application do not share the reader

=item *
 $Chipcard::PCSC::SCARD_SHARE_SHARED

the application will allow others to share the reader.

=item *
 $Chipcard::PCSC::SCARD_SHARE_DIRECT

(not used by PCSClite)

=back

=item *
 $preferred_protocol

is the protocol which should be used if possible. If the protocol is not
available, another protocol will be used and
C<$hCard-E<gt>{dwProtocol}> will be set accordingly.
C<$preferred_protocol> accept the following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0

the T=0 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1

the T=1 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW

raw protocol

=back

=back

=head2
 $hCard-E<gt>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);

=head2
 $hCard-E<gt>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);

=head2
 $hCard-E<gt>Reconnect($share_mode, $preferred_protocol, $initialization);

C<Reconnect()> can be used to re-negotiate an already opened connection.
This implies that the C<Chipcard::PCSC::Card> object is connected and
has C<$hCard-E<gt>{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:

=over 4

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0

the T=0 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1

the T=1 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW 

raw protocol

=back

=over 4

=item *
 $share_mode

is the desired mode of connection to the reader. It can be any of the
following:

=over 4

=item *
 $Chipcard::PCSC::SCARD_SHARE_EXCLUSIVE

the application do not share the reader

=item *
 $Chipcard::PCSC::SCARD_SHARE_SHARED

the application will allow others to share the reader.

=item *
 $Chipcard::PCSC::SCARD_SHARE_DIRECT

(not used by PCSClite)

=back

=item *
 $preferred_protocol

is the protocol which should be used if possible. If the protocol is not
available, another protocol will be used and
C<$hCard-E<gt>{dwProtocol}> will be set accordingly.
C<$preferred_protocol> accept the following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0

the T=0 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1

the T=1 protocol

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW

raw protocol

=back

=item *
 $initialization

is the action to take when reconnecting to the smart card. It can be any
of the following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_LEAVE_CARD

do nothing on close

=item *
 $Chipcard::PCSC::SCARD_RESET_CARD

reset on close

=item *
 $Chipcard::PCSC::SCARD_UNPOWER_CARD

power down on close

=item *
 $Chipcard::PCSC::SCARD_EJECT_CARD

eject on close

=back

=back

=head2
 $hCard-E<gt>Reconnect($share_mode, $preferred_protocol);

This method is equivalent to:

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

=head2
 $hCard-E<gt>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);

=head2
 $hCard-E<gt>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);

=head2
 $hCard-E<gt>Disconnect($initialization);

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

=over 4

=item *
 $initialization

is the action to take when reconnecting to the smart card. It can be any
of the following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_LEAVE_CARD

do nothing on close

=item *
 $Chipcard::PCSC::SCARD_RESET_CARD

reset on close

=item *
 $Chipcard::PCSC::SCARD_UNPOWER_CARD

power down on close

=item *
 $Chipcard::PCSC::SCARD_EJECT_CARD

eject on close

=back

=back

=head2
 $hCard-E<gt>Disconnect();

This method is equivalent to:

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

=head2
 $hCard-E<gt>Status();

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

=over 4

=item *
 $reader_name

is a string containing the name of the reader

=item *
 $reader_state

is a scalar containing the current state of the reader.

It can be any combination of the following values:

=over 5

=item *
 $Chipcard::PCSC::SCARD_UNKNOWN

unknown state

=item *
 $Chipcard::PCSC::SCARD_ABSENT

card is absent

=item *
 $Chipcard::PCSC::SCARD_PRESENT

card is present

=item *
 $Chipcard::PCSC::SCARD_SWALLOWED

card not powered

=item *
 $Chipcard::PCSC::SCARD_POWERED

card is powered

=item *
 $Chipcard::PCSC::SCARD_NEGOTIABLE

ready for PTS

=item *
 $Chipcard::PCSC::SCARD_SPECIFIC

PTS has been set

=back

=item *
 $protocol

is the protocol being used. It can be any of the following values:

=over 5

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T0,

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_T1,

=item *
 $Chipcard::PCSC::SCARD_PROTOCOL_RAW

=back

=item *
 \@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
C<undef>.

=back

=head2
 $hCard-E<gt>Transmit(\@data);

C<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 C<undef> value.

=over 4

=item *
 \@data

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

=back

Here is a small sample of how to use C<transmit>:

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

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

=head2
 $hCard-E<gt>BeginTransaction();

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

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

=head2
 $hCard-E<gt>EndTransaction($disposition);

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

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

=over 4

=item *
 $disposition

is the action to take when ending the transaction. It can be any of the
following values:

=over 4

=item *
 $Chipcard::PCSC::SCARD_LEAVE_CARD

do nothing on close

=item *
 $Chipcard::PCSC::SCARD_RESET_CARD

reset on close

=item *
 $Chipcard::PCSC::SCARD_UNPOWER_CARD

power down on close

=item *
 $Chipcard::PCSC::SCARD_EJECT_CARD

eject on close

=back

=back

=head2
 $hCard-E<gt>EndTransaction();

This method is equivalent to:

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

=head2
 $hCard-E<gt>TransmitWithCheck($apdu, $sw_expected [, $debug]);

This method is a wrapper around $hCard-E<gt>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;

=head2
 $hCard-E<gt>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));

=head2
 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";

=head1 SEE ALSO

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

=head1 COPYRIGHT

(C) Lionel VICTOR, 2001, GNU GPL

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

=head1 AUTHORS / ACKNOWLEDGEMENT

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

 Ludovic ROUSSEAU <ludovic.rousseau@free.fr>

=cut