.TH "chipcardd.conf" "5" "0.9.1" "Martin Preuss" "Server Config File Format"
.SH "NAME"
.LP 
\fBchipcardd.conf\fR \- LibChipCard server configuration file format
.SH "DESCRIPTION"
.LP 
LibChipCard uses a card server to access your card readers, called \fBchipcardd\fR. This server uses a configuration file called \fBchipcardd.conf\fR. It is expected to be in \fI/etc/chipcardd.conf\fR.
.BR 

Please see \fIlibchipcard.conf(5)\fR for a description of the basic syntax of configuration files for LibChipCard.
.BR 

.SH "ROOT"
.LP 
The root contains general information about the server mode.

\fBtimeout\fR 
.IP 
Time to wait in milliseconds for client requests per round. In each round the server first waits up the the time given here for client requests. After that it handles these requests. 
.BR 

Recommended values are 500\-1000 (best is 750)
.BR 

.LP 
\fBmaxmsg\fR
.IP 
Maximum number of response to handle per loop (see above for an explanation for the round)
.BR 

Recommended value is 20.
.BR 

.LP 
\fBenabled\fR
.IP 
A value of zero indicates that the server is not to be started.
.BR 

Please note that this value is only checked by the chipcard server itself upon startup. If after loading the configuration file the server detects that this variable has a value of "0" then it will go down immediately.
.BR 

.SH "READER"
.LP 
The configuration file holds one or more reader groups which describe the card readers. These groups are enumerated, so that the second element of the groupname is the sequence number in a list of readers (e.g. \fI[reader/1]\fR is the first reader, \fI[reader/2]\fR is the second and so on.
.BR 
If you have the \fBPCSC\fR daemon running (called \fIpcscd\fR) then you don't have to setup the readers supported by that daemon in this configuration file. The chipcard server of LibChipCard (\fIchipcardd\fR) automatically enumerates all PCSC driven readers upon startup (if PCSC support is compiled in).
.BR 

However, if you want to use the keypad of your reader with PCSC drivers, then you need to setup your readers here, since PCSC does not provide the information about whether the reader has a keypad or not. So you need to tell libchipcard about it. The example at the end of this doucument shows how to make it.
.BR 

\fBreadertype\fR 
.IP 
Generally LibChipCard works with any reader that provides a \fBCTAPI\fR driver. However, each manufacturer has it's own implementation details which must be cared for.
.BR 
Therefore you have to give the manufacturer here. Possible values are: \fIkobil\fR (for Kobil devices), \fItowitoko\fR (for Towitoko devices), \fIcyberjack\fR (for Reiner SCT Cyberjacks) and \fIother\fR (for any other type)
.BR 

\fBPlease note\fR: If you only want to use local services (i.e. not sharing the readers between multiple hosts) then you should use the address \fI127.0.0.1\fR (or \fIlocalhost\fR).
.BR 

.LP 
\fBdrivertype\fR
.IP 
Currently LibChipCard supports the most important driver types: \fICTAPI\fR (which is available for most readers) and \fIPCSC\fR (for SCard drivers).
.BR 

Most manufacturers provide a CTAPI driver, so I recommend trying this first. But if you have a PCSC server running (you can check that with "ps ax | grep pcscd") then you are in most cases forced to use that type.
.BR 

.LP 
\fBdriver\fR
.IP 
Specify the path and name of the driver. Most Towitoko CTAPI drivers are called \fIlibtowitoko.so\fR, Kobil drivers are called \fIlibct_kaan.so\fR or \fIlibct_b1.so\fR and Cyberjack drivers are called \fIlibctapi_cyberjack.so\fR.
.BR 

For PCSC drivers set the name to \fIlibpcsclite.so\fR.
.BR 

A special note on \fBKobil\fR drivers: If you have a \fBKobil Kaan Standard\fR then you must use the driver \fIlibct_kaan.so\fR. The \fBKobil Kaan Professional\fR needs \fIlibct_b1.so\fR.
.BR 

.LP 
\fBname\fR
.IP 
Specify the name of your reader. For CTAPI drivers the name chosen here doesn't matter, you can any name you like (but it is best to make it a name which allows you to identify it).
.BR 

PCSC driver need the exact name under which the reader is known to PCSC. You can get the name to be used by observing the PCSC daemon (pcscd), or by inspecting the PCSC configuration file. Under Linux the name to be given here is that given as \fBFRIENDLYNAME\fR in the file \fI/etc/reader.conf\fR. So if the friendly name is \fITowitoko\fR then the name to give here is \fITowitoko 0 0\fR.
.BR 


.LP 
\fBport\fR
.IP 
Specify the port at which the reader is connected to your computer.
This typically is one of \fICOM1\fR to \fICOM4\fR, \fILP1\fR to \fILP2\fR or \fIUSB0\fR to \fIUSB3\fR.
.BR 

If the drivertype is \fBother\fR then you must give a numeric value here. Most drivers accept values between 0 and 5, just check them.
.BR 

If you have a reader which you have setup with drivertype=\fBother\fR then please let me know about it by sending me an email (\fBmartin@libchipcard.de\fR) so that your configuration can be included in one of the next releases.
.BR 

.LP 
\fBflags\fR
.IP 
This variable specifies some attributes of the reader. This value consists of several values \fBORed\fR to build the final value.
.BR 
The following list shows the meaning of each bit:
.BR 

Bit 0 (LSB) \- reader has it's own keypad
.BR 

Bit 1 \- reader has it's own display
.BR 

If the reader has a keypad but the secure pin verification (where you enter the pin directly into the readers keypad) does not work, then please pretend not to have a keypad (by zeroing out the appropriate bits).
.BR 

.SH "EXAMPLE"
.LP 
This is a simple configuration file which sets up a local card server listening at port 32891 (which is the default port). This server handles two readers: A CTAPI driven reader and a PCSC driven one with a keypad and a display.
.BR 

.IP 
timeout=750
.BR 

maxmsg=10
.BR 

enabled=1
.BR 

# this is the CTAPI driven KOBIL Kaan Professional
.BR 

# at COM1 which has a keypad
.BR 

[reader/1]
.BR 

readertype="kobil"
.BR 

drivertype="ctapi"
.BR 

driver="/usr/local/lib/libct_b1.so"
.BR 

name="term1"
.BR 

port="COM1"
.BR 

flags="3"
.BR 

# this is a PCSC driven KOBIL Kaan Professional
.BR 

# at COM2 which has a keypad
.BR 

[reader/2]
.BR 

readertype="kobil"
.BR 

drivertype="pcsc"
.BR 

driver="libpcsclite.so"
.BR 

name="Kobil 0 0"
.BR 

port="COM2"
.BR 

flags="3"
.BR 


.LP 

.SH "FILES"
.LP 
/etc/chipcardd.conf
.SH "SEE ALSO"
.LP 
libchipcard.conf(5) chipcardc.conf(5)