Project-Structure¶

• Table of contents
• Project-Structure
• Modules
  • wsdef
    • class-list-plugin
    • wsdef-client
  • common
  • crypto
    • bouncycastle
    • crypto-common
  • saml
  • esign
  • transport
    • dispatcher
    • paos
    • tls
  • gui
    • gui-common
    • swing
    • android
  • ifd
    • ifd-common
    • protocols
    • scio-backend
    • ifd-core
  • sal
    • sal-common
    • protocols
    • tiny-sal
  • recognition
  • event-manager
  • browser
    • object-handler
    • pkcs11
    • tls-channel-binding
  • control-interface
  • client
    • applet
    • richclient
    • android

The overall project structure has been derived from the high level design of the Open eCard App (see Sicherheit 2012 paper) and is depicted in the following figure:

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.

wsdef¶

Contains web service definitions (.xsd, .wsdl) and related utilities.

class-list-plugin¶

wsdef-client¶

common¶

Contains common utilities and helper classes.

crypto¶

Contains basic crypto modules.

bouncycastle¶

Relocated bouncycastle classes (moved from org.bouncycastle to org.openecard.bouncycastle) with some patches regarding TLS-PSK.

crypto-common¶

Other crypto related code. E.g. ASN.1 classes for EAC and CVC.

saml¶

Contains the functionality for [[SAML-ECP]].

esign¶

Contains signature-related functionality.

transport¶

Contains modules related to the transport of messages.

dispatcher¶

paos¶

tls¶

The TLS design can be found here.

gui¶

Contains user interfaces (User Consent) for the different platforms.

gui-common¶

Data structure definitions and common GUI execution code.

swing¶

Swing based User Consent implementation.

android¶

Android UI based User Consent implementation.

ifd¶

Contains the interface device (IFD) components for the different platforms. The following figure provides an overview of the relationship between the different ifd modules:

ifd-common¶

Code and data structures common to core and protocol modules.

protocols¶

Contains IFD-related trusted channel protocols, which can be used with EstablishChannel. Currently the following protocols are supported:

• pace
  Password Authenticated Connection Establishment [[PACE]]

scio-backend¶

Provides an implementation of [[javax.smartcardio]] for different platforms.

• oma
  Maps [[javax.smartcardio]] to the [[Transport API within the Open Mobile API]].
• android-nfc
  Maps [[javax.smartcardio]] to [[android.nfc]].
• android-scio
  Maps [[javax.smartcardio]] to a native PCSC implementation [[pcsclite]] compiled for Android.
  More information can be found here.
• pcsc
  Is necessary to embed the java default implementation of the SmartcardIO into the scio-backend context.

ifd-core¶

Implements the IFD-API including the mapping to [[javax.smartcardio]].

sal¶

Contains the service access layer (SAL) components.

sal-common¶

• State management
  More information can be found here.

protocols¶

• eac
• crypto-lite
• Generic Cryptography
• PinCompare

More information can be found here.

tiny-sal¶

recognition¶

Features CardInfo-based card type recognition. This module also bundles CardInfo files for the recognisable cards.

event-manager¶

Provides an easy to use interface for IFD related events.

browser¶

Contains components for the integration of the Open eCard App into popular browsers.

object-handler¶

pkcs11¶

tls-channel-binding¶

control-interface¶

This module is used to activate the client and authenticate against a server.
The eCard-API Framework part 7 defines the TCToken-Interface to trigger the activation.
More sophisticated activation scenarios need the possibility to request information about the App and available token. The Status-Interface extends the TCToken-Interface respectively.

client¶

Contains modules for the different forms of the Open eCard App.

applet¶

richclient¶

android¶