/* $Id$
 *
 * cv2extractor - A free implementation of a reader of Carte Vitale 2 cards.
 *
 * Copyright (C) 2015 Entr'ouvert
 * https://dev.entrouvert.org/projects/cv2extractor
 *
 * Authors: See AUTHORS file in top-level directory.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

============
cv2extractor
============

A free implementation of a reader of Carte Vitale 2 cards under GNU GPLv3 and
above.

The API VITALE is needed. This library is not a free software. You must obtain
it from the SESAM VITALE group.

The application is mono-instance, so high-level library functions are used.
Those are easier to use but handle only one session that explains the
mono-instance.


Reader configuration
--------------------

You need a pc-sc card reader installed with its driver and a pcsc interface
library.

cv2extractor has only be tested with the OMNIKEY 5321 and the pcsclite1 library.

Your need to configure the reader for the API VITALE library using a file named
lecteurs_pcsc.cfg.

In the api_lec.ini file is configure the FLIP_FLOP mode (used to unlock the
Carte Vitale 2 cards with the CPS cards using a same pcsc reader). You should
not need to modify it. In the sedica.ini is configured the reader number, 1
by default should work.


Cv2extractor configuration
--------------------------

Modify constants in config.h and recompile.

Main settings are :

  * XML_FILES_PATH used to set the path where to write xml files extracted from
    the cards.

  * XML_FILE_PREFIX used to set a prefix to files written. Useful for instance
    to distinguish files of many readers if a single repository is used.

  * SSL_TRANSFER_TARGET used to indicate that the files must be send using ssh
    and to set the destination.

  * SSL_TRANSFER_SECRET use if SSL_TRANSFER_TARGET is set. If empty, scp is
    used and a secret my be asked interactively. If set, used to log in.

  * CPS_PIN_CODE used to avoid the interactive mode for asking the PIN code.


Compilation
-----------

cv2extractor only run on x86 32 bits system, a requirement due to the API
VITALE library.

The API VITALE library (libapileclux.so libcpslux.so libsedica.so
libcptablux.so) must be installed in your path (e.g. /usr/local/lib/)

The glib2.0 and gobject2.0 libraries are also required.

One way to compile it with gcc is :
$ gcc -g -lapileclux -lcpslux -lsedica -lcptablux cv2extractor.c -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -lglib-2.0 -lgobject-2.0 -o cv2extractor -Wall -DUNIX -DTARGET_OS_MAC
$ ldd cv2extractor
	linux-gate.so.1 =>  (0xb789b000)
	libapileclux.so => /usr/local/lib/libapileclux.so (0xb7849000)
	libcpslux.so => /usr/local/lib/libcpslux.so (0xb7844000)
	libsedica.so => /usr/local/lib/libsedica.so (0xb7813000)
	libcptablux.so => /usr/local/lib/libcptablux.so (0xb77f7000)
	libglib-2.0.so.0 => /lib/libglib-2.0.so.0 (0xb772e000)
	libgobject-2.0.so.0 => /usr/lib/libgobject-2.0.so.0 (0xb76f0000)
	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0xb76d2000)
	libc.so.6 => /lib/i686/cmov/libc.so.6 (0xb758a000)
	libdl.so.2 => /lib/i686/cmov/libdl.so.2 (0xb7586000)
	libm.so.6 => /lib/i686/cmov/libm.so.6 (0xb7560000)
	libpcsclite.so.1 => /usr/lib/libpcsclite.so.1 (0xb7556000)
	libpthread.so.0 => /lib/i686/cmov/libpthread.so.0 (0xb753d000)
	libpcre.so.3 => /lib/libpcre.so.3 (0xb750a000)
	libgthread-2.0.so.0 => /usr/lib/libgthread-2.0.so.0 (0xb7504000)
	librt.so.1 => /lib/i686/cmov/librt.so.1 (0xb74fb000)
	/lib/ld-linux.so.2 (0xb789c000)


Run
---

$ ./cv2extractor

Lec Dictionnary extraction
--------------------------

This script extract values from the Lec dictionnary to produice a json file.

$ gcc -g -lapileclux -lcpslux -lsedica -lcptablux cJSON.c extract_dict.c -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -lglib-2.0 -lgobject-2.0 -o extract_dict -Wall -DUNIX -DTARGET_OS_MAC
$ ./extract_dict

Roadmap
-------

* Enhance logging.
* Use autotools for building.
* Deamonize.
* Portability.
* Other language (Python) bindings, mainly to access the dictionnary of the API VITALE library with python.


Licence
-------

See COPYING.


Author
------

See AUTHORS.