$Id$

IMPORTANT INFORMATION REGARDING IP RIGHTS AND AUTHORIZATIONS
IS CONTAINED IN THE NOTICE.TXT FILE THAT END USERS MUST READ
PRIOR TO USE.




Welcome to TSIK
---------------

Apache TSIK is an XML/SOAP security library/toolkit that implements
several of the WS-* standards as defined by both OASIS and W3C. Please
see the javadocs API for more information.

Apache TSIK is currently in incubation with the Apache Software
Foundation. More information can be found on

   http://incubator.apache.org/tsik/

On the same page is a link to the roadmap, which describes thoughts
on future TSIK development.

   http://incubator.apache.org/tsik/roadmap.html


Parts
-----

TSIK can be built either as a monolithic jar (default), or as follows:


+---------------------------------------------+
|               TSIK core              	      |
+---------------------------------------------+
+--------------+ +-------------+ +------------+
|  Messaging   | | SOAP engine | |  etc...    |
+--------------+ +-------------+ +------------+

The parts that build into separate JARs will abstract out functionality
that originally existed in TSIK. This parts may already exist within other
Apache projects, or they may be made available for future inclusion in
a common code area.


Philosophy
----------

* Simplicity

Apache TSIK is developed with simplicity of use in mind. Originally
developed by VeriSign, TSIK is based on a philosophy that
most application security errors occur when existing APIs are so
complex that it becomes easy to use them incorrectly. TSIK
therefore strives for simple APIs that cover main use cases.

* Few dependencies

Apache TSIK has very few dependencies on other projects. It used
the log4j logging sub system and that is it.

TSIK compiles out of the box with JDK 1.3 and higher into a single
jar, tsik.jar. The log4j jar file is included in the source
distribution.

Apache TSIK comes with its own set of XML/SOAP utility classes to
create and parse XML.

* Interop driven

Apache TSIK will be developed primarily by interop. If a toolkit
manages to interoperate via everyday scenarios (such are typically
the scenarios at interop events), then it is a useful toolkit.

Usability
---------

Before landing at Apache, TSIK had been in development for over four
years, oftem by the same people who co-authored many of the underlying
specifications. TSIK is today used in several commercial products and
considered quite stable.


Installation
------------

* Get the source
  Probably done since you're reading this :)

* Set up ant.
  Make sure you can run JUnit tasks. This should be fairly straight-
  forward. (You can use the junit.jar in ./resources if you don't have
  junit set up.)

* Set up your Java JCE provider.
  If you don't have a JCE provider that provides RSA encryption and
  signing, you need to install one. See e.g., http://www.bouncycastle.org/

* Build the library, test it, and generate javadoc APIs with

  $ ant build test api

* That's it.


Installation (binary distribution)
----------------------------------

There is no binary distribution since Apache TSIK is still in incubation.