"Fossies" - the Fresh Open Source Software Archive

Member "open-ecard-1.4.5/README.md" (7 Sep 2020, 3227 Bytes) of package /linux/privat/open-ecard-1.4.5.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "README.md": 2.1.1_vs_2.1.2.

About Open eCard

In the context of the Open eCard Project, industrial as well as academic experts have decided to work together on providing an open source and cross platform implementation of the eCard-API-Framework (BSI-TR-03112), through which arbitrary applications can utilize authentication and signatures with arbitrary chip cards.

The artifacts of the project consist of modularized, and to some extent extensible, libraries as well as client implementations such as a Desktop application (richclient), an Android app and a Java Applet.

Build Instructions

Detailed build instructions can be found in the INSTALL.md file bundled with this source package.

Quick Start

The simplified build instructions are as follows:

$ git clone git://github.com/ecsec/open-ecard.git
$ cd open-ecard
$ mvn clean install

In case you received a preassembled source bundle, the build instructions are as follows:

$ tar xaf open-ecard-${version}.tar.xz
$ cd open-ecard-$version
$ mvn clean install

Finally, you can run the Open eCard App from command line:

$ ./packager/richclient-packager/target/open-ecard/bin/open-ecard

Packaging

Native packages which are based on a modular runtime image can be built with the new jpackage tool which is part of JDK-14. Native packages for the Open eCard App can be built by downloading JDK-14, referencing it as toolchain and by specifying the following user properties:

$ mvn clean install -Ddesktop-package -Djlink-jpackager.package-type=<type>

Thereby, the following package types are available:

You have to make sure the required packaging tools are installed. In case of Windows, msi and exe packages are built. For this purpose, two tools are required:

Native packages for Mac OS can be signed by using the following property (by default, unsigned packages will be created):

$ mvn clean install -Ddesktop-package -Djlink-jpackager.package-type={dmg, pkg} -Dmac.os.sign.package=true

More information about the required JDK versions and the setup of the toolchain, can be found in the INSTALL.md file.

License

The Open eCard App uses a Dual Licensing model. The software is always distributed under the GNU General Public License v3 (GPLv3). Additionally the software can be licensed in an individual agreement between the licenser and the licensee.

Contributing

New developers can find information on how to participate under https://dev.openecard.org/projects/open-ecard/wiki/Developer_Guide.

Contributions can only be accepted when the contributor has signed the contribution agreement (https://dev.openecard.org/documents/35). The agreement basically states, that the contributed work can, additionally to the GPLv3, be made available to others in an individual agreement as defined in the previous section. For further details refer to the agreement.