|
To use Ganzúa you'll need a full implementation of the Java 2 Runtime Environment, Standard Edition (JRE) version 1.4 or higher with an implementation of the Java API for XML Processing (JAXP) version 1.2 or higher .
Ganzúa is a Java application and therefore platform-independent. It should run fine on any platform with a full implementation of the Java 2 Runtime Environment, Standard Edition (JRE) version 1.4 or higher with an implementation of the Java API for XML Processing (JAXP) version 1.2 or higher.
Ganzúa has been tested and is known to work on the following platforms:
If you are able to run Ganzúa successfully on some other platform, please contact me (see chapter 5) so it can be added to this section.
This section provides information on how to install Ganzúa in the different platforms it is known to work on. Feel free to skip the sections that do not deal with the platform you want to use.
In order to run Ganzúa, you'll need an implementation of the Java 2 Runtime Environment, Standard Edition (JRE) version 1.4 or higher. If you don't have one installed on your system, you'll need to get one of the implementations available for GNU/Linux. The one used to test Ganzúa was the implementation by Sun Microsystems, which can be found at http://java.sun.com , but you might want to get IBM's (http://www.ibm.com), Blackdown's (http://www.blackdown.org) or other. Preferably install a JRE for the Java 2 Platform, Standard Edition (J2SE) 5.0 or higher, this way you may avoid updating the JAXP included with the JRE.
Now you are ready to install Ganzúa. To do so follow these steps:
You should be able to run Ganzúa by invoking the command java -jar ganzua.jar from the directory Ganzúa was installed to.
Run Ganzúa and select Open from its File menu. Now select a cryptanalysis project from the examples found at the directory GANZÚA_HOME/examples/projects/en where GANZÚA_HOME stands for the directory Ganzúa was installed to.
If the project is opened successfully, congratulations, you may skip the rest of this chapter. But, if the project could not be opened and an error message was displayed asking you to update the version of the Java API for XML Processing (JAXP), quit the program and read the next section, which will guide you through this process.
If your implementation of the JRE does not include an implementation of the Java API for XML Processing (JAXP) version 1.2 or higher, you'll have to install one. The Xerces2 Java Parser (version 2.6 or higher) provides such implementation. To install it do the following:
You will not need findEndorsedDirs.jar or the Xerces2 archive any more, so you may delete them.
If you have any problem, contact me (see chapter 5) so it can be addressed in the documentation in the future.
Apple's implementation of the Java 2 Runtime Environment, Standard Edition (JRE) version 1.4.1 (or higher) is included in Mac OS X 10.3 (or higher), but downloading any update to the Java platform available through Software Update may improve Ganzúa's performance and make the installation process easier. To run Software Update choose it from the Apple Menu, or choose System Preferences from the Apple menu, then choose Software Update from the View menu, and click Update Now.
Now you are ready to install Ganzúa. To do so follow these steps:
That is it. Now you can run Ganzúa by double-clicking its icon.
Run Ganzúa and select Open from its File menu. Now select a cryptanalysis project from the examples found at the directory GANZÚA_HOME/examples/projects/en where GANZÚA_HOME stands for the directory Ganzúa was installed to.
If the project is opened successfully, congratulations, you may skip the rest of this chapter. But, if the project could not be opened and an error message was displayed asking you to update the version of the Java API for XML Processing (JAXP), quit the program and read the next section, which will guide you through this process.
If the JRE does not include an implementation of the Java API for XML Processing (JAXP) version 1.2 or higher, you'll have to install one, like the Xerces2 Java Parser. To install Xerces 2 you'll need to do the following:
You will not need findEndorsedDirs.jar or the Xerces2 archive any more, so you may delete them.
If you have any problem, contact me (see chapter 5) so it can be addressed in the documentation in the future.
In order to use Ganzúa, you'll need an implementation of the Java 2 Runtime Environment, Standard Edition (JRE) version 1.4 or higher. If you don't have one installed on your system, or all you have is the program named Microsoft Java Virtual Machine (which is not an implementation of the JRE), you'll need to get one of the implementations available for Windows. The one used to test Ganzúa was the implementation by Sun Microsystems, which can be found at http://java.sun.com , but you might want to get IBM's (http://www.ibm.com), or other. Preferably, install a JRE for the Java 2, Standard Edition (J2SE) 5.0 or higher, this way you may avoid updating the version of JAXP included with the JRE.
Now you are ready to install Ganzúa. To do so follow these steps:
You should be able to run Ganzúa by double clicking ganzua.jar or using the command java -jar ganzua.jar from the directory Ganzúa was installed to.
Run Ganzúa and select Open from its File menu. Now select a cryptanalysis project from the examples found at the directory GANZÚA_HOME/examples/projects/en where GANZÚA_HOME stands for the directory Ganzúa was installed to.
If the project is opened successfully, congratulations, you may skip the rest of this chapter. But, if the project could not be opened and an error message was displayed asking you to update the version of the Java API for XML Processing (JAXP), quit the program and read the next section, which will guide you through this process.
If your implementation of the JRE does not include an implementation of the Java API for XML Processing (JAXP) version 1.2 or higher you'll have to install one. The Xerces2 Java Parser (version 2.6 or higher) provides such implementation. To install it do the following:
You will not need findEndorsedDirs.jar or the Xerces2 archive any more, so you may delete them.
This section will explain how Ganzúa's files are organized, what they contain and how to customize your installation.
If you downloaded a binary package you should have the following files and directories (folders). In the case of the Mac OS X package, there must be an application package instead of ganzua.jar .
If you downloaded the source code package you should have the following files and directories:
To use Ganzúa you need the JAR files ganzua.jar and langFreq.jar, the schemata files they use and a default directory with language frequencies, the rest of the files are dispensable.
Ganzúa makes extensive use of XML (eXtensible Markup Language) files, they are used to save and load projects, language frequencies, and give instructions to the application langFreq.jar. XML files are similar to HTML files in that both are text files with markup tags. Ganzúa checks the structure of these files using W3C XML schemata (which are XML files themselves) that specify their build. This way, Ganzúa lets you access the data you have created and make new Ganzúa-compatible documents with any text editor, and if you use an XML editor that can use W3C XML schemata, you can validate the documents as you write them.
You can rename or move the schemata and frequencies directories if you want to put the schemata with some other W3C XML schema files or if you just don't like them where they are, but you'll have to tell the program about the changes by editing a couple of configuration files.
If you move or rename the schemata and/or language frequencies directories, you'll have to close all active Ganzúa programs and edit two configuration files to notify the program about the changes.
The configuration files are inside the JAR files, one inside ganzua.jar, the other in langFreq.jar, both are named config.properties and have the same structure. To edit these files do as you would to edit a text file in a ZIP archive (JAR files can be handled as ZIP files). If you know how to use the EMACS editor you can use it to open the JAR files and edit the config.properties files directly.
If you change the name of the schemata directory or move it,
you'll have to edit the line
#schemataDir =
/usr/local/share/ganzua/schemata/
Remove the # character at the beginning of the line
and change the path after the = character to the
full path of the directory where you put the schemata.
If you change the name of the language frequencies directory
or move it, you'll have to edit the line
#langFreqDir =
/usr/local/share/ganzua/frequencies/
Remove the # character at the beginning of the line
and change the path after the = character to the
full path of the directory where you put the language
frequencies.
Remember that this has to be done on both JAR files.
Since this is an open source program, the source code is available at Ganzúa's site (http://ganzua.sourceforge.net) for you to download, modify, redistribute, etc. as specified in the General Public License (GPL).
To compile the source code you'll need a compiler for the Java programming language version 1.4 or higher, and the Apache Ant build tool (http://ant.apache.org) version 1.5 or higher.
During the development of Ganzúa version 1.01, two compilers were used:
There are two Apache Ant buildfiles in Ganzúa's source code package. The first one is at the root of the package and can be used to generate the executable JARs and documentation. The second one can generate the bytecode and is in the src directory. For more information on these build files use the command ant -projecthelp in the directories where the files are located.
If you plan to run Ganzúa outside of a JAR package (as compiled by the buildfile in the src directory) you'll have to edit the file config.properties found in src/net/sourceforge/ganzua, as explained in section 2.4.2, even if you don't move the schemata or language frequencies directories. To run the program this way, you should use the command
from the src directory (Analyzer is the name of the class that contains Ganzúa's main program), or
if you want to use the language frequencies utility.
Jesús Adolfo García Pasquel 2004-10-04
