Apache TSIK is a client and server toolkit for creating secure XML applications.

Source layout

TSIK source is divided into three main categories.

1. Core functionality
2. Plug-ins
3. Add-ons

Core functionality

This is the main TSIK body of source. The core functionality includes APIs for sending and receiving secure XML messages. The following functionality is implemented. More information can be found in each package.

• XML encryption {@link org.apache.tsik.xmlenc}
• XML signature {@link org.apache.tsik.xmlsig}
• Web Services policies {@link org.apache.tsik.wsp}
• WS-Trust {@link org.apache.tsik.wst}
• WS-Security {@link org.apache.tsik.wss}
• WS-MetadataExchange {@link org.apache.tsik.wsx}

The core also includes utilities used throughout the code, for example

• Loggers, schema mappers {@link org.apache.tsik.common}
• Datatypes {@link org.apache.tsik.datatypes}
• XPath processing {@link org.apache.tsik.xpath}
• DOM traversing and creation {@link org.apache.tsik.domutil}
• PKI utilities {@link org.apache.tsik.crl}, {@link org.apache.tsik.verifier}

Plug-ins (org.apache.tsik.plugin.*)

The plug-ins include implementations that conform to the base interfaces of the core functionalities. Currently, the SOAP engine is abstracted into a TSIK plug-in. An Apache Axis based SOAP plugin is planned.

In the future, other parts of TSIK may be converted into plug-ins.

Add-ons (org.apache.tsik.addon.*)

The TSIK add-ons represent optional TSIK functionality. The {@link org.apache.tsik.addon.messaging} plug-ins implements a hierarchy for XML based messaging.

Prerequisites

• TSIK compiles and executes in JDK 1.3 and up. You will need ant 1.5 or higher to build TSIK.
• To properly use most of the APIs in TSIK, you need to have a JCE provider installed. If you use JDK version less than J2SE 1.4, you need to install JCE and JSSE manually.
• TSIK works with Xerces and Crimson XML parsers.

File structure

• The build.xml file is the main ant build file.
• The src directory contains all source code (build with ant build).
• The reports directory contains the unit test report files (run tests with ant test).
• The test directory contains unit test for all the packages described above. You can see a great many TSIK use cases in this code.
• The api directory contains the javadoc API output (create with ant api).
• Finally, the lib directory contains the built tsik.jar, and tsik_test.jar contains all the compiled tests. See the build TSIK version by java -jar tsik.jar.