PICS/DSig Standard Library

PICS/DSig Standard Library in Java -- Documentation

Installation

To install the PICS/DSig Standard Library:

1. Download the source code (US Version / Non-US Version)

2. Uncompress the file in a directory on your local machine, let's call it installdir. You should now have the following directory structure:

   installdir/bin -- contains a Win32 version of an ECC (elliptic curve algorithm) reference implementation (eccw3c.dll)
   installdir/classes -- contains ZIP file(s) with all of the Java classes.
   installdir/demo -- contains sample PICS and DSig label files.
   installdir/javadocs -- contains the javadocs for the library.
   installdir/src -- contains all of the source files for the library
   installdir/COPYRIGHT.html -- contains copyright information on this reference code.
   installdir/dsigapi.html -- contains an overview of the DSig implementation and API.
   installdir/History -- contains thre revision history of the DSig portion of the code.
   installdir/Readme -- contains a information relevant to running the DSig portion of the code.
   

3. Add the following three zip files to your Java CLASSPATH:
   installdir/classes/dsig.zip;
   installdir/classes/jsafe_rsa.zip;
   installdir/jce1_1/lib/jce.zip;
   

4. If you have a Win32 machine, and would like to use ECDSS (Elliptic Curve Algorithm with Digital Signature Standard), you need to add the following directory to your PATH variable: installdir\bin

5. You should now be ready to go!

DSigDemo

The PICSParser

java w3c.pics.parser.PICSParser

The exact command will differ slightly if you are using a Java VM other than the JDK.

There is one command-line flag that PICSParser recognizes: -debug . If it is present, then extra debugging information will be printed out when using the process command.

The PICSParser offers the following commands:

• help : displays this help information
• testsuite URLfile profile: Checks each URL in URLfile against profile, requesting labels from a label bureau as specified in profile. Currently not checking for embedded labels even if profile specifies that.
• filter htmlfile profile: filters the HTML in htmlfile according to the labels in its header and the profile in profile
• find labels filename: parses the HTML file filename, looking for labels in its header.
• parse dsiglabel filename: parses the label(s) contained in the file filename and outputs in Dsig-ready canonicalized form
• parse label filename: parses the label(s) contained in the file filename
• parse profile filename: parses the profile contained in the file filename
• parse service filename: parses the service contained in the file filename
• process labelfile profile: Runs the label(s) from labelfile against the profile in profile
• quit : quits the program

The process command will indicate which labels passed the profile and which did not. If the -debug flag was used to run the program, it will also display a list of the policy clause types, in order, to show which clause caused the label to be passed/blocked.

Running a parser stand-alone

java w3c.pics.parser.parserClass filename

where parserClass is one of the three parser class names: LabelParser, ServiceParser, or ProfileParser.

Custom use of parsers

It should be known that partial parsing of input can be accomplished with these parsers. The top-level production of the grammar for a particular parser need not be the method called to begin parsing. Parsing can start from any production in the parser. (For more on grammar files, see below). For example, you can call a method in the LabelParser so that you can just input an extension clause, and parse just that information.

Modifying the grammars

Each production in the grammar corresponds to a method in the javacc generated .java file. Thus, if you want to start parsing from a specific production in a grammar, call the parser with that method.

JJDoc is a tool that is included with JavaCC. It produces HTML files for JavaCC grammar files:

• LabelParser
• ServiceParser
• ProfileParser
• DSigParser

Reporting Bugs