.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PCSC-SPY 1"
.TH PCSC-SPY 1 2024-02-23 "pcsc-lite 2.0.1" "PC/SC lite"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
pcsc\-spy \- A PC/SC spy command
.SH SYNOPSIS
.IX Header "SYNOPSIS"
pcsc-spy [\fB\-n\fR|\fB\-\-nocolor\fR] [\fB\-d\fR|\fB\-\-diffable\fR] [\fB\-h\fR|\fB\-\-help\fR]
[\fB\-v\fR|\fB\-\-version\fR] [\fB\-t\fR|\fB\-\-thread\fR] [\fIfifo_filename\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
pcsc-spy displays PC/SC calls of an application. It must be used with
the \fIlibpcscspy.so\fR library.
.PP
To be able to spy the PC/SC layer, the application flow must be
modified so that all PC/SC calls are redirected. Two options are
available:
.IP "\- the application is linked with \fIlibpcsclite.so.1\fR" 4
.IX Item "- the application is linked with libpcsclite.so.1"
.PD 0
.IP "\- the application loads the \fIlibpcsclite.so.1\fR library using \fBdlopen\fR\|(3)" 4
.IX Item "- the application loads the libpcsclite.so.1 library using dlopen"
.PD
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-d\fR, \fB\-\-diffable\fR" 4
.IX Item "-d, --diffable"
Remove the variable parts (like handler values) from the output so that
two execution can be more easily compared.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Display a short help text.
.IP "\fB\-n\fR, \fB\-\-nocolor\fR" 4
.IX Item "-n, --nocolor"
Disable the output colorization (if you want redirect the output in a
file for example).
.IP "\fB\-v\fR, \fB\-\-version\fR" 4
.IX Item "-v, --version"
Print the version of the \fIpcsc-spy\fR program plus a copyright, a list of
authors.
.IP "\fB\-t\fR, \fB\-\-thread\fR" 4
.IX Item "-t, --thread"
Add a thread number before each line of log to identify the calls from
the same threads.
.SH EXAMPLES
.IX Header "EXAMPLES"
.SS "Applications linked with libpcsclite.so.1"
.IX Subsection "Applications linked with libpcsclite.so.1"
We will use the standard \f(CW\*(C`LD_PRELOAD\*(C'\fR loader option to load our spying
library.
.PP
Example:
.PP
.Vb 1
\& LD_PRELOAD=/usr/lib/x86_64\-linux\-gnu/libpcscspy.so pcsc_scan
.Ve
.SS "Application loading libpcsclite.so.1"
.IX Subsection "Application loading libpcsclite.so.1"
This is the case for the PC/SC wrappers like pyscard (for Python) and
pcsc-perl (for Perl). The LD_PRELOAD mechanism can't be used. Instead
we replace the \fIlibpcsclite.so.1\fR library by the spying one.
.PP
You may use \fIinstall_spy.sh\fR and \fIuninstall_spy.sh\fR to install and
uninstall the spying library.
.PP
Using the spying library without \fIpcsc-spy\fR is not a problem but has
side effects:
.PP
\&\- a line "libpcsclite_nospy.so.1: cannot open shared object file:
No such file or directory" will be displayed
.PP
\&\- some CPU time will be lost because of the PC/SC calls redirection
.SS "Starting the spy tool"
.IX Subsection "Starting the spy tool"
.Vb 1
\& pcsc\-spy
.Ve
.PP
If a command argument is passed we use it instead of the default
\&\fI~/pcsc\-spy\fR FIFO file. It is then possible to record an execution log
and use pcsc-spy multiple times on the same log.
.PP
To create the log file just do:
.PP
.Vb 2
\& mkfifo ~/pcsc\-spy
\& cat ~/pcsc\-spy > logfile
.Ve
.PP
and run your PC/SC application.
.SH FILES
.IX Header "FILES"
\&\fI~/pcsc\-spy\fR FIFO file is used by \fIlibpcsclite.so.1\fR to send the raw
log lines
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpcscd\fR\|(8)
.SH AUTHOR
.IX Header "AUTHOR"
This manual page was written by Ludovic Rousseau <rousseau@free.fr>