Open eCard

{{toc}}

h1. Modules

The following modules are derived from the high level project structure. Information about the architecture, data structures and other things can be found in the respective links.

h2. Add-on Framework

Contains the implementation of the Add-on Framework. This includes the mapping of the abstract XML description into Java data structure, interface specifications and classes for the management of the add-ons.

h2. CardInfo files

Here you'll find all CardInfo files of the eID client which are used to recognize cards. Furthermore there are images of the specific card and a static recognition tree which is executed when a new card is inserted.

h2. Card Recognition

The Card Recognition module uses the abstract XML descriptions of the CardInfo module to provide functionality to the system.

h2. Client Implementations

Contains sub modules which implement a client for a specific platform. Currently there are the following two client available:

h3. Rich Client

Contains the code for the Rich client application based on the Swing implementation of the GUI. The main target of this client version are desktop pcs and laptop.

h3. Android Client

A client version for the Android operating system which is primary located on smart phones and tablet pcs.

h3. Open eCard Java Version Checker

The Open eCard App requires currently Java 7 if it is available this little tool will warn the user.

h2. Control Interface Bindings

This package contains all available Binding implementations which are listed below.

h3. HTTP Binding

Contains the implementation of the HTTP Binding which is used to offer HTTP Services to the external world.

h2. Crypto packages

h3. Open eCard Bouncy Castle

This module contains the Bouncy Castle code.

h3. Crypto common

Contains common cryptography classes for e.g. ASN1 objects used in the EAC process. Furthermore there are utility classes for easier access to DID's and their features.

h3. Open eCard TLS

Contains TLS client implementations used to communicate with remote parties. The clients are implemented according to the guideline that are related to TLS cryptography.

h2. Event Manager

The Event Manager module is 

h2. GUI implementations

h3. About Dialog

Swing implementation of the About dialog.

h3. Graphics

Graphic utilities to retrieve the Open eCard logo in different sizes and different backgrounds.

h3. GUI common

Provides the abstract definition of the GUI elements which are implemented by the specific platforms. Their are also executors for GUI steps.

h3. Swing GUI

Contains the Swing implementation of the abstract GUI definitions of the GUI common package.

h3. Android GUI

Contains the Android specific GUI.

h2. IFD implementations

h3. IFD common

Contains common interfaces and classes for an IFD implementation.

h3. IFD Protocols -> PACE

Implementation of the PACE protocol as IFD protocol.

h3. SmartcardIO implementations -> PC/SC for OS X

SmartcardIO stuff specific for OS X

h3. SmartcardIO implementations -> PCSC SmartcardIO

This sub module contains the implementations of the interfaces specified in IFD common for PC/SC.

h3. SmartcardIO implementations -> NFC SmartcardIO

Contains an implementation of the interfaces specified in the IFD common module which is able to interact with the NFC interface of modern smart phones.

h3. IFD core

Provides the general functionality of the IFD.

h2. Integrated Add-ons

h3. PIN Management Add-on

Currently this contains the code for a PIN Management which is only capable to handle the German eID card.

h3. Generic cryptography protocol

Implementation of the Genric Cryptography Protocol according to BSI-TR03112-7 (Not complete)

h3. TR-03112 Add-on

Provides the classes for a TCToken based activation of the eID client. This mechanism supports the German eID card and cards used for an TLS authentication.

h3. Status

Implementation of an Add-on which provides status information about the eID client.

h2. Management

h2. Open eCard Common Libs

Provides several classes for the handling of APDUs for smart cards. It is easier to use them instead of using the plain hex codes. Furthermore there are utility classes for different purposes.

h2. Open eCard I18n

Module containing the translations of the Open eCard App.

h2. Open eCard Webservice Definitions

h3. class-list Plugin

h3. Open eCard WS common

Contains ab Open eCard implementation of a Marshaller 

h3. Open eCardd WS classes

Contains web service definitions (.xsd, .wsdl).

h3. JAXB Marshaller

h3. Android Marshaller

h2. SAL

h3. SAL common

Provides some utility classes and exception definitions.

h3. TinySAL

Implementation of the Service access layer providing functions according to BSI-TR03112 part 4 and 7.

h2. Transport 

h3. Dispatcher

Implementation of the Dispatcher which is responsible for the message passing between the components.

h3. Apache shadded HTTP core

h3. Open eCard HTTP core