From b43405cdb052201de6ef66d44e473cb74c55d4b0 Mon Sep 17 00:00:00 2001 From: mcentner Date: Fri, 7 May 2010 14:54:05 +0000 Subject: Updated project documentation. git-svn-id: https://joinup.ec.europa.eu/svn/mocca/trunk@730 8a26b1a7-26f0-462f-b9ef-d0e30c41f5a4 --- BKUApplet/pom.xml | 1 + BKUAppletExt/pom.xml | 4 +- BKUCertificates/pom.xml | 1 + BKUCommonGUI/pom.xml | 5 +- BKUFonts/pom.xml | 19 +------ BKUFonts/src/site/apt/index.apt | 25 +++++++++ BKUGuiExt/pom.xml | 3 +- BKULocal/pom.xml | 3 +- BKUOnline/pom.xml | 3 +- BKUViewer/pom.xml | 2 +- STAL/pom.xml | 3 +- STALExt/pom.xml | 4 +- STALService/pom.xml | 2 +- STALXService/pom.xml | 3 +- bkucommon/pom.xml | 15 ++++++ bkucommon/src/site/apt/configuration.apt | 87 ++++++++++++++++++++++++++++++++ bkucommon/src/site/site.xml | 4 ++ pom.xml | 16 ++++++ smcc/pom.xml | 3 +- smccSTAL/pom.xml | 3 +- smccSTALExt/pom.xml | 3 +- src/site/site.xml | 2 + utils/pom.xml | 3 +- 23 files changed, 179 insertions(+), 35 deletions(-) create mode 100644 BKUFonts/src/site/apt/index.apt create mode 100644 bkucommon/src/site/apt/configuration.apt diff --git a/BKUApplet/pom.xml b/BKUApplet/pom.xml index 1c27294e..9a2d11f3 100644 --- a/BKUApplet/pom.xml +++ b/BKUApplet/pom.xml @@ -9,6 +9,7 @@ BKUApplet BKU Applet ${project.parent.version} + Java Applet used by MOCCA Online diff --git a/BKUAppletExt/pom.xml b/BKUAppletExt/pom.xml index c60864bc..770f977b 100644 --- a/BKUAppletExt/pom.xml +++ b/BKUAppletExt/pom.xml @@ -7,9 +7,9 @@ 4.0.0 at.gv.egiz BKUAppletExt - BKU Applet Extension + BKU Applet Ext ${project.parent.version} - + Card management extension for Java Applet used by MOCCA Online at.gv.egiz diff --git a/BKUCertificates/pom.xml b/BKUCertificates/pom.xml index 8227014f..17f0a4cf 100644 --- a/BKUCertificates/pom.xml +++ b/BKUCertificates/pom.xml @@ -14,6 +14,7 @@ 1.2 BKU Certificates + Trusted certificates for TLS/SSL authentication diff --git a/BKUCommonGUI/pom.xml b/BKUCommonGUI/pom.xml index ccb47235..3d3f1446 100644 --- a/BKUCommonGUI/pom.xml +++ b/BKUCommonGUI/pom.xml @@ -7,7 +7,7 @@ 4.0.0 at.gv.egiz BKUCommonGUI - BKU GUI + BKU Common GUI ${project.parent.version} @@ -22,7 +22,8 @@ compile - + Common GUI functionality + maven-compiler-plugin diff --git a/BKUFonts/pom.xml b/BKUFonts/pom.xml index abcb8339..592c5b38 100644 --- a/BKUFonts/pom.xml +++ b/BKUFonts/pom.xml @@ -16,26 +16,9 @@ | remains (not true for provided), see BKUViewer, BKULocal and | BKUOnline --> - This module is used in validator(s) and viewer and is a direct dependency of - - bkucommon (direct runtime dependency) - - BKUViewer (transitive runtime from bkucommon) - TextValidator depends on the fonts. (TextValidator should rather use a FontProvider) - - BKUOnline (transitive runtime from bkucommon/bkuviewer) - unpack-fonts to applet dir and include jar in WEB-INF/lib - - BKULocal (transitive runtime from bkucommon/bkuviewer) - - removed the BKUCommonGUI (runtime; propagate dependency to BKUApplet): - no real dependency: BKUCommonGUI contains SecureFontProvider interface only - (which does not state how fonts are loaded); implementations should depend no BKUFonts - (ResourceFontLoader in BKULocal depends on the fonts, however URLFontLoader in BKUApplet doesn't. - BKUOnline however depends on BKUFonts for providing the fonts as web-resource for the applet) + Fonts used by validators and viewers - at.gv.egiz.bku.text.TextValidator and xxx.LocalFontProvider load fonts from classpath, - resource name must be known, TODO: encapsulate resource loading (FontProvider constants?) - - at.gv.egiz.bku.online.applet.URLFontLoader loads (unpacked) font files from applet codebase, - resource names _must_ be known since applet has no BKUFonts dependency - diff --git a/BKUFonts/src/site/apt/index.apt b/BKUFonts/src/site/apt/index.apt new file mode 100644 index 00000000..6ed73926 --- /dev/null +++ b/BKUFonts/src/site/apt/index.apt @@ -0,0 +1,25 @@ + --- + About + --- + EGIZ + --- + 2010 + --- + +BKU Fonts + + This module provides fonts used in validator(s) and viewer and is a direct dependency of + + * bkucommon (direct runtime dependency) + + * BKUViewer (transitive runtime from bkucommon) + + TextValidator depends on the fonts. (TextValidator should rather use a FontProvider) + + * BKUOnline (transitive runtime from bkucommon/bkuviewer) + + unpack-fonts to applet dir and include jar in WEB-INF/lib + + * BKULocal (transitive runtime from bkucommon/bkuviewer) + + diff --git a/BKUGuiExt/pom.xml b/BKUGuiExt/pom.xml index 85f06b1e..d5d9b47b 100644 --- a/BKUGuiExt/pom.xml +++ b/BKUGuiExt/pom.xml @@ -8,7 +8,8 @@ at.gv.egiz BKUGuiExt ${project.parent.version} - BKU GUI Extension + BKU GUI Ext + Common BKU GUI functionality extension for card managment at.gv.egiz diff --git a/BKULocal/pom.xml b/BKULocal/pom.xml index 19e2633a..ef1d7900 100644 --- a/BKULocal/pom.xml +++ b/BKULocal/pom.xml @@ -11,7 +11,8 @@ BKU Local ${project.parent.version} - + MOCCA Local + maven-war-plugin diff --git a/BKUOnline/pom.xml b/BKUOnline/pom.xml index 20c6ff56..315e7cba 100644 --- a/BKUOnline/pom.xml +++ b/BKUOnline/pom.xml @@ -9,7 +9,7 @@ at.gv.egiz BKUOnline war - BKU Online + MOCCA Online ${parent.version} @@ -146,6 +146,7 @@ provided + MOCCA Online diff --git a/BKUViewer/pom.xml b/BKUViewer/pom.xml index 69367c54..203d3ca1 100644 --- a/BKUViewer/pom.xml +++ b/BKUViewer/pom.xml @@ -9,7 +9,7 @@ BKUViewer BKU Viewer ${project.parent.version} - + Validator for plain text and XHTML to-be signed content at.gv.egiz diff --git a/STAL/pom.xml b/STAL/pom.xml index c4851c3d..f923a073 100644 --- a/STAL/pom.xml +++ b/STAL/pom.xml @@ -12,7 +12,8 @@ ${parent.version} - + Security Token Access Layer + maven-compiler-plugin diff --git a/STALExt/pom.xml b/STALExt/pom.xml index 0d4dcc4c..376ba450 100644 --- a/STALExt/pom.xml +++ b/STALExt/pom.xml @@ -7,9 +7,9 @@ 4.0.0 at.gv.egiz STALExt - STAL Extension + STAL Ext ${project.parent.version} - + STAL extensions for card management at.gv.egiz diff --git a/STALService/pom.xml b/STALService/pom.xml index 2f1e3ed4..c25d955f 100644 --- a/STALService/pom.xml +++ b/STALService/pom.xml @@ -10,7 +10,7 @@ STALService STAL Service ${project.parent.version} - + STAL webservice interface at.gv.egiz diff --git a/STALXService/pom.xml b/STALXService/pom.xml index d4cb3e15..c71b3f75 100644 --- a/STALXService/pom.xml +++ b/STALXService/pom.xml @@ -7,8 +7,9 @@ 4.0.0 at.gv.egiz STALXService - STAL-X Service + STAL Ext Service ${project.parent.version} + STAL extension webservice interface STALService diff --git a/bkucommon/pom.xml b/bkucommon/pom.xml index 1dbc8078..467e1ca9 100644 --- a/bkucommon/pom.xml +++ b/bkucommon/pom.xml @@ -135,4 +135,19 @@ compile + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.7 + + ${project.name} API ${project.version} + ${project.name} API ${project.version} + ${project.name} Test API ${project.version} + ${project.name} Test API ${project.version} + + + + \ No newline at end of file diff --git a/bkucommon/src/site/apt/configuration.apt b/bkucommon/src/site/apt/configuration.apt new file mode 100644 index 00000000..cf1d384d --- /dev/null +++ b/bkucommon/src/site/apt/configuration.apt @@ -0,0 +1,87 @@ + --- + Configuration + --- + EGIZ + --- + 2010 + --- + +MOCCA Configuration + + Since MOCCA version 1.3 {{{http://commons.apache.org/configuration/}commons-configuration}} is used for the main configuration of MOCCA. + + The configuration is build by the {{{./apidocs/at/gv/egiz/bku/spring/ConfigurationFactoryBean.html} ConfigurationFactoryBean}} class. It creates a composite configuration using a default configuration read from {{{./apidocs/constant-values.html#at.gv.egiz.bku.spring.ConfigurationFactoryBean.DEFAULT_CONFIG}ConfigurationFactoryBean.DEFAULT_CONFIG}} and an (optional) resource specified by {{{./apidocs/at/gv/egiz/bku/spring/ConfigurationFactoryBean.html#setConfigurationResource(org.springframework.core.io.Resource)}setConfigurationResource(org.springframework.core.io.Resource)}}. The later {{{http://static.springsource.org/spring/docs/2.5.5/reference/resources.html}resource}} is usually injected via a {{{http://static.springsource.org/spring/docs/2.5.5/reference/beans.html}spring application context}}. See the configuration sections of MOCCA Online / MOCCA Local on how the configuration resource is constructed in their respective application contexts and on how to provide your own configuration file. + +* Common Configuration Options + + A typical configuraton file looks like the following: + ++------------------+ + + + true + + 50 + + true + + ./certStore + ./trustStore + + ++------------------+ + +** Supported Configuration Parameters + + [<<>>] Allows to controll if MOCCA should register the Java {{{http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#ProviderArch}Cryptographic Service Providers}}. + + NOTE: MOCCA will only work if the required security providers are registered. If this is set to <<>>, the security providers must be registered by some other means (e.g. {{{http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#ProviderInstalling}registered staticaly}}). + + Default: <<>> + + [<<>>] + + [<<>>] Sets the number of consequtive requests allowed to be recieved from the {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/Bindings.en.html#http.ablauf.schritte}DataURL}} server. + This allows to prevent from infinite request loops caused by erroneous server implementations. + + Default: <<<50>>> + + [<<>>] Controls if to-be signed data is validated for conformity with the {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/viewerformat/ViewerFormat.en.html}standardised viewer format}} auf the Austrian Citizen Card spezification. + + Default: <<>> + + [<<>>] + + The following two configuration elements must provide an URL which resolves to a directory in the filesystem. It may either be an absolute URL or a relative URL, which is resolved using the URL of the configuration file. + + [<<>>] Specifies the URL of a certificate store directory. This directory must contain all certificates required to build a valid certification chain up to an anchor of trust (e.g. a certificate also contained in the trust store directory). Certificate filenames are hashed. To add new certificates to the certificate store directory create a sub-directory named <<>> and put the certificates into this directory. They will then be added to the certificate store upon startup of MOCCA. + + Default: <<>> + + [<<>>] Specifies the URL of a trust store directory. This directory must contain all certificates considered as a root of trust. + + NOTE: Any certificate in the trust store directory must also be present in the certificate store directory! + + Default: <<>> + + [<<>>] Options: <<>> (default) or <<>> + + [] + + NOTE: Do not enable the following two options in production environments! + + [<<>>] May be set to <<>> disable verification of the server host name given in the server's certificate. + + Default: <<>> + + [<<>>] May be set to <<>> to disable all TSL/SSL related checks. + + Default: <<>> + + [<<>>] May be specified to set the product name given by the <<>> and <<>> HTTP headers as specified by {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/bindings.en.html#http}HTTP binding}}. + + [<<>>] May be specified to set the product version given by the <<>> and <<>> HTTP headers as specified by {{{http://www.buergerkarte.at/konzept/securitylayer/spezifikation/aktuell/bindings/bindings.en.html#http}HTTP binding}}. + + [<<>>] May be specified to set the <<>> HTTP header. + + \ No newline at end of file diff --git a/bkucommon/src/site/site.xml b/bkucommon/src/site/site.xml index 7500b6cc..a1937bc3 100644 --- a/bkucommon/src/site/site.xml +++ b/bkucommon/src/site/site.xml @@ -30,6 +30,10 @@ under the License. + + + + diff --git a/pom.xml b/pom.xml index d5b8f6fe..4197a375 100644 --- a/pom.xml +++ b/pom.xml @@ -34,6 +34,7 @@ smccSTALExt BKUFonts + 2007 mcentner @@ -55,6 +56,13 @@ E-Government Innovation Center (EGIZ) http://www.egiz.gv.at + + + Apache 2 + LICENSE.txt + manually + + @@ -180,11 +188,18 @@ org.apache.maven.plugins maven-project-info-reports-plugin 2.1.2 + + true + false + index summary + license + dependencies + dependency-management @@ -334,4 +349,5 @@ scp://egovlabs.gv.at/var/lib/gforge/chroot/home/groups/mocca/htdocs + \ No newline at end of file diff --git a/smcc/pom.xml b/smcc/pom.xml index efda2522..c0d59481 100644 --- a/smcc/pom.xml +++ b/smcc/pom.xml @@ -10,7 +10,8 @@ smcc jar ${project.parent.version} - + Smart card communication + maven-compiler-plugin diff --git a/smccSTAL/pom.xml b/smccSTAL/pom.xml index 5864e122..73fd2581 100644 --- a/smccSTAL/pom.xml +++ b/smccSTAL/pom.xml @@ -9,7 +9,8 @@ smccSTAL smcc STAL ${project.parent.version} - + STAL implementation for smart cards using smcc + maven-compiler-plugin diff --git a/smccSTALExt/pom.xml b/smccSTALExt/pom.xml index 2411ba8e..deeaeb0d 100644 --- a/smccSTALExt/pom.xml +++ b/smccSTALExt/pom.xml @@ -8,7 +8,8 @@ at.gv.egiz smccSTALExt ${project.parent.version} - smcc STAL Extension + smcc STAL Ext + STAL Ext implementation for smart cards using smcc at.gv.egiz diff --git a/src/site/site.xml b/src/site/site.xml index e43bec96..4f0ea09d 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -27,6 +27,8 @@ under the License. http://mocca.egovlabs.gv.at/ + + diff --git a/utils/pom.xml b/utils/pom.xml index 69e4f6d7..68e47055 100644 --- a/utils/pom.xml +++ b/utils/pom.xml @@ -7,9 +7,10 @@ 4.0.0 at.gv.egiz utils - BKU Utils + Utils jar ${parent.version} + Utilities org.slf4j -- cgit v1.2.3