Open eCard

h1. About the Open eCard App

h2. Features

h2. Changelog

h1. Setup

h2. Richclient

The Richclient is a Java SE application intended to run as a desktop application. It is usually installed on a machine in an operating system specific manner and executed by the user on his own behalf.

h3. Prerequisites

* Java SE 6 or higher

  Windows and Mac users can get it at https://www.java.com. 

  Debian Squeeze users should install the package @openjdk-6-jre@ and @icedtea6-plugin@, while Wheezy users should install @openjdk-7-jre@ and @icedtea-7-plugin@.

h3. Installation

# Direct your Browser to https://www.openecard.org/download/pc

# Click the Open eCard App launch Button

h2. Android

h1. Operation

h2. General

h2. App Activation

h1. Configuration

Each client implementation of the Open eCard App uses a common base set of configuration options and possibly additional client specific settings. The clients provide their own configuration dialogs that are appropriate for the platform or operating system they are running on.

In the rest of this section the settings common to all client implementations are defined and explained. The sections afterwards describe the client specific settings as well as the UIs that provide a more user friendly way to modify these settings.

h2. List of Common Settings

The Open eCard App loads and saves all its settings to a "Java style property":https://en.wikipedia.org/wiki/.properties file. This file is user specific and can be found under the path @$HOME/.openecard/openecard.properties@. Besides this config file, the @.openecard@ directory may contain other client or plugin specific files, like log settings or log files.

h3. Proxy Settings

The Open eCard App supports SOCKS and HTTP(S) proxies, which are configured using the following properties:

<pre>

SOCKS:

proxy.socks.host = localhost -- Hostname or IP address of the server where the SOCKS proxy server is running on.

proxy.socks.port = 8080 -- Port on the proxy host where the proxy service is listening on.

HTTP(S):

proxy.http.scheme = http -- specifies the protocol scheme of the proxy (http or https)

proxy.http.host = localhost -- Hostname or IP address of the server where the proxy server is running on.

proxy.http.port = 8123 -- Port on the proxy host where the proxy service is listening on.

#proxy.http.user = foo -- user name for basic authentication (optional)

#proxy.http.pass = bar -- password for basic authentication (optional)

proxy.http.validate_tls = true -- specifies that the certificate of the proxy service is validated against the java key store (optional)

</pre>

h2. Richclient Settings

h1. Troubleshooting

h2. Logging

Each client may use a different logging framework. In the applet, Java Util Logging is used to save space of the executable while in the richclient, Logback provides a feature rich logging framework. Both are configured differently.

The logging configuration can be modified by a config file in the directory $HOME/.openecard (%HOME/.openecard for Microsoft Windows systems). The file must be named applet_log.properties for the applet and richclient_logback.xml for the richclient. Samples can be found at the end of this page.

After adding the config file, the log granularity of the packages and/ or classes must be configured. The syntax and possibilities of each logging framework are different from each other. The samples include an exemplary line for a package. For further details consult the documentation of the logging framework in use.

The following is a list of important packages to find errors. A complete list is available in the "JavaDoc":https://dev.openecard.org/projects/open-ecard/apidocs/index.html.

* @org.openecard.transport.paos@

* @org.openecard.ifd.scio@

* @org.openecard.sal@

* @org.openecard.sal.protocol.eac@

h2. Error Messages

h2. Reporting Problems