Documentation Index Compilation of Source Testing Binary Dist

Cryptix Development Team

JARs supplied

The binary distribution comes with a group of JAR archives. Each JAR is a major module within Cryptix. Here are some important ones (note that the names may not be precise):

• IJCE.jar is the International JCE. It is intended to stand alone as the support code for any Provider.
• SPT.jar is the all of the support code for the Cryptix provider. Effectively, it is needed for all crypto operations, in combination with a provider, below, and the IJCE above.
• ALG.jar includes all the symmetric key algorithms and message digests, as well their tests. It is a provider JAR (although to be entirely accurate, it needs SPT.jar to be complete as a provider).
• ELGAMAL.jar is the new ElGamal Public Key Algorithm.
• RSA.jar includes all the RSA code, as a separate provider.
• OLD.jar includes classes that provide the old Cryptix 2.2 API.

Still confused? Just remember to include IJCE.jar, SPT.jar and one or more algorithmic JARs.

Testing Algorithms by Hand

Here are some examples, all within the classes directory:

• To run a simple test that is standalone, and at least proves the testing method, do this:
  • Under Unix, enter

            CLASSPATH=.:SPT_0-0-8.jar
    	export CLASSPATH
    	java cryptix.test.TestBR
          

  • Under NT or Windows 95 (from a command prompt), enter

    	; Caveat for NT/95 users: this batch script is untested.
    	call ..\util\setpwd .
    	set CLASSPATH=.;%PWD%\SPT_0-0-8.jar
            java cryptix.test.TestBR
          

  Note that the script will generate: "Warning: failed to load the Cryptix.properties file." which can safely be ignored.

  Also, in both cases, the version numbers will differ from release to release.

  You should see lots of output:

      Start tests...
  
      Binary dump of a BigRegister [64-bit]...
      Byte #:|........|........|........|........|........|........|........|........|
  	 8: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
  
      {big snip}
      Done tests...
      ===========================================================================
      Number of passes:   8
      Number of failures: 0
      Expected passes:    8
      

  If none of the above works, then jump down to the next section and try the auto scripts.

• Once the above works, test the IJCE by doing:

  	CLASSPATH=.:$PWD/IJCE_0-0-10.jar:SPT_0-0-8.jar:ALG_0-0-8.jar
  	export CLASSPATH
  	java cryptix.test.TestIJCE
      

  or, for NT/95,

  	set CLASSPATH=.;%PWD%\IJCE_0-0-10.jar;%PWD%\SPT_0-0-8.jar;%PWD%\ALG_0-0-10.jar
          java cryptix.test.TestIJCE
      

  Note that many systems, including NT/95, will need the full path name set, as per the first example. Above, the properties file ijce-lib/IJCE.Properties is only loaded by absolute path.
• Now try out the different tests by examining the JARs (try unzip -l SPT.jar for example).

  For each of the algorithmic JARs, add the extra JAR to the CLASSPATH:

  	CLASSPATH=.:$PWD/IJCE_0-0-10.jar:SPT_0-0-8.jar:ALG_0-0-8.jar
  	export CLASSPATH
  	java cryptix.test.TestDES
      

  Or, for the full test of ElGamal, you will need four different JARs:

  	CLASSPATH=.:$PWD/IJCE_0-0-10.jar:SPT_0-0-8.jar:ALG_0-0-8.jar:ELGAMAL_0-0-1.jar
  	export CLASSPATH
  	java cryptix.test.TestElGamal
      

  The ElGamal test will take a while: 95 seconds on a P100. ElGamal is new, so please try it out and post any failures.

Repeating the Distribution Tests

In order to repeat the entire distribution tests, run the scripts in ../auto:

     ../auto/testjar.sh

     ; this script is untested, and unwritten as of the current dist.
     ..\auto\testjar

Note that the ../auto/testjar_err scripts include all of the tests that failed during distribution, so they are unlikely to work later on (there should be none in there, this is more a tool to assist the distribution process).

If some of the Tests Fail...

In theory, the tests supplied, and especially those run by ../auto/testjar.sh are working and tested at distribution point. Any failures indicate that there is a portability bug. Please mail the team clear details on what platform and Java virtual machine you are using, and the output of the tests.

If none of the tests work, including the ../auto/testjar.sh tests, then suspect a setup problem with your Java installation.