Contents Previous Next Index

Chapter   2

Installation

This release is provided for the Solaris™ Operating System (OS) release 8, Red Hat Linux version 7.2, and for Microsoft Windows 2000 (with Service Pack 4) as compressed Zip archives.

Note – The Linux platform version of the toolkit is unsupported and has undergone only limited testing. The Linux platform version was tested only on the English language Red Hat Linux 7.2 and gcc version 2.96.

In the future, we will release new Linux platform versions of the toolkit, but we do not commit to doing so with the same frequency as, nor simultaneously with new Solaris or Microsoft Windows 2000 platform versions. We do not commit to making fully-supported Linux platform versions of the toolkit. In addition, we do not commit to addressing problems or bug reports submitted against the Linux platform version.

Note – Do not overlay a previous release with this release. Instead perform the installation into a new directory.

Prerequisites for Installing the Binary Release

  1. Install the Java 2 Standard Edition Software Developer’s Kit (SDK) from:

    2. http://java.sun.com/j2se/

    The supported SDK version is 1.4.1. If you are installing the SDK on the Solaris or Linux platform, make sure that all of the required patches are installed. To get more information, refer to the product documentation available at: 

    http://www.sun.com/solaris/java
  2. Install javax.comm. If you are not using the Development Kit to communicate with a card reader installed on a serial port, you can skip this step.

    3. The package javax.comm can be found in the Java Communications API 2.0. To obtain the package, please visit Sun’s web site at: 

    http://java.sun.com/products/javacomm

    Separate versions of the javax.comm API are available for the Solaris/SPARC, Microsoft Windows 2000, and Solaris/x86 platforms.

    Note – If you are using the Development Kit on the Linux platform, download the Solaris/x86 release of the javax.comm API and install only the jar files.

    Follow the instructions provided in the file Readme.html to install the package. Make sure that the comm.jar file is added to the CLASSPATH.

  3. Install the OpenCard Framework (OCF) Version 1.2.

    4. Download the zipped version of the OpenCard Framework Base package from the OCF web site: 

    http://www.opencard.org/index-downloads.html

    Unzip the package into a separate directory.

Installing the Development Kit Binaries

There are three steps to install the Development Kit binaries. Separate sections cover installation for the Solaris, Linux, and Microsoft Windows 2000 platforms.

triangle pointing down  Installing on the Solaris or Linux Platform

The Java Card Development Kit provides separate download files for the binary release for the Solaris and Linux platforms. For the exact names of the download files, see the Java Card Development Kit Release Notes for the Binary Release.

  1. Save the file in a convenient installation location of your choice: for example, in the directory /javacard.
  2. Navigate to the /javacard directory:

    3. % cd /javacard

  3. Unzip the file provided with the release with the unzip utility. 
    4. % unzip <Development_Kit_binary_distribution>.zip

    where Development_Kit_binary_distribution refers to the name of the bundle containing the binary release installation files for the Solaris or Linux platform.

    The installation creates a directory java_card_kit-2_2_1 under /javacard. The /javacard/java_card_kit-2_2_1 directory is now the root of the development kit installation.

  4. Follow the directions "Setting Environment Variables for the Solaris or Linux Platform” to set the environment variables required by the Development Kit.

    5. For a description of the files that are installed under java_card_kit-2_2_1, see "Files Installed for the Binary Release" .

triangle pointing down  Setting Environment Variables for the Solaris or Linux Platform

  1. Set the environment variable JC_HOME to the installation directory. For example (using csh), if you unzipped the release in the directory /javacard:
    2. setenv JC_HOME /javacard/java_card_kit-2_2_1

    Or, if you unzipped the installation into a different directory, define the environment variable JC_HOME accordingly.

  2. Set the environment variable JAVA_HOME to the directory where you installed your Java development tools. For example,
    3. setenv JAVA_HOME /usr/j2sdk1.4.1

    The following optional path setting will enable you to run the Development Kit tools from any directory. 

    setenv PATH .:$JC_HOME/bin:$PATH

We suggest you automate these environment settings. Create a csh script file (named, for example, javacard_env.cshrc) which includes the setenv statements: 

setenv JC_HOME /javacard/java_card_kit-2_2_1 
setenv JAVA_HOME /usr/j2sdk1.4.1 
setenv PATH .:$JC_HOME/bin:$JAVA_HOME/bin:$PATH:

Run the script file from the command prompt before running the Development Kit tools, samples, and demonstrations (refer to Chapter 3, "Development Kit Samples and Demonstrations”): 

% source javacard_env.cshrc

triangle pointing down  Installing on the Microsoft Windows 2000 Platform

The Java Card Development Kit provides a separate download file for the binary release for the Microsoft Windows 2000 platform. For the exact name of the download file, see the Java Card Development Kit Release Notes for the Binary Release.

  1. Save the zip file in a convenient installation location of your choice. For example, the root of the C: drive.
  2. Unzip the file provided with the release with the Winzip utility (available from http://www.winzip.com).
    3. C:\> winzip32 <Development_Kit_binary_distribution>.zip

    where Development_Kit_binary_distribution refers to the name of the bundle containing the installation files for the Microsoft Windows 2000 platform.

    In the Winzip dialog, choose Select All and Extract from the Actions menu. Enter C:\ into the Extract To field to unzip the contents of the zip file into that directory. (For more information, refer to the Winzip documentation.)

    The java_card_kit-2_2_1 directory is the root of the Development Kit installation.

  3. Follow the directions below to set the Microsoft Windows 2000 platform environment variables required by the Development Kit.

    4. For a description of the files that are installed under java_card_kit-2_2_1, see "Files Installed for the Binary Release" .

triangle pointing down  Setting Environment Variables for Microsoft Windows 2000 Platform

  1. Set the environment variable JC_HOME to the installation directory. For example, if you unzipped the release in the root directory of the C: volume:
    2. set JC_HOME=c:\java_card_kit-2_2_1

    Or, if you unzipped the installation into a different directory, define the environment variable JC_HOME accordingly.

  2. Set the environment variable JAVA_HOME to the directory where you installed your Java development tools. For example,
    3. set JAVA_HOME=c:\j2sdk1.4.1

    The following optional path setting will enable you to run the Development Kit tools from any directory. 

    set PATH=%JC_HOME%\bin;%JAVA_HOME%\bin;%PATH%

We suggest you automate these environment settings. Create a batch file (named, for example, javacard_env.bat) which includes the set statements: 

@echo off 
set JC_HOME=C:\java_card_kit-2_2_1 
set JAVA_HOME=c:\j2sdk1.4.1 
set PATH=.;%JC_HOME%\bin;%JAVA_HOME%\bin;%PATH%

Run the batch file from the command prompt before running the Development Kit tools, samples, and demonstrations (refer to Chapter 3, "Development Kit Samples and Demonstrations”):

triangle pointing down  Copying OpenCard Framework Files

For Solaris, Linux, and Microsoft Windows 2000 Platforms:

To run the Java Card RMI demos, you must copy certain OpenCard Framework (OCF) jar files into the lib subdirectory of your JC_HOME directory.

  1. Navigate to the directory <ocf_download_home>/OCF1.2/lib/ (on the Solaris and Linux platform) or <ocf_download_home>\OCF1.2\lib\ (on the Microsoft Windows 2000 platform) of the OCF installation. In this path, <ocf_download_home> represents the directory where OpenCard Framework files were unzipped.
  2. Copy the files base-core.jar and base-opt.jar from this directory into the $JC_HOME/lib (Solaris or Linux platform) or %JC_HOME%\lib (Microsoft Windows 2000 platform) directory.

Files Installed for the Binary Release

TABLE 1 describes the files and directories that the binary installation procedure installs under java_card_kit-2_2_1.

Note – If you are using the Microsoft Windows 2000 platform, substitute the \ character for / in the paths.

TABLE 1  –  Directories and Files Installed for the Binary Release
Directory/File
Description
api_export_files
Contains the export files for version 2.2.1 of the Java Card API packages.
bin
Contains all shell scripts or batch files for running the tools (such as the apdutool, capdump, converter and so forth), and the cref binary executable.
doc/en
The api, devnotes, and guides subdirectories contain the English-language guides for this release:
  • api—contains the HTML files for the Java Card specification produced by the Javadoc™ tool.
  • devnotes—contains the Application Programming Notes for the Java Card™ Platform, Version 2.2.1 in PDF format. The html subdirectory contains the same manual in HTML format.
  • guides—contains this document: the Development Kit User’s Guide for the Java Card™ Platform, Version 2.2.1, in PDF format, and an html directory containing the document in HTML format.
  • j2me-docs.css—cascading style sheet used by the release note HTML files.
lib
Contains all Java jar files required for the tools:
  • apdutool.jar and apduio.jar—used by apdutool
  • api.jar (with cryptography extensions)—needed to write Java Card technology-based applets (“Java Card applets”) and libraries
  • capdump.jar—needed to produce an ASCII representation of a CAP file
  • converter.jar—needed to process Java class files and Java Card export files
  • javacardframework.jar—used by the Java RMIC compiler for generating stubs for Java Card RMI applications
  • jcclientsamples.jar—contains the client part of the Java Card RMI samples
  • jcrmiclientframework.jar—contains the classes of the Java Card RMI Client API
  • jcwde.jar (with cryptography extensions)—used by Java Card WDE
  • installer.jar—contains the installer applet
  • offcardverifier.jar—needed to evaluate CAP and export files in a desktop environment
  • scriptgen.jar—needed to convert a package in a CAP file into a script file containing a sequence of APDUs
samples
Contains sample applets and demonstration programs. For more information on the contents of this directory, see "Sample Programs and Demonstrations".
COPYRIGHT_dom
(COPYRIGHT_dom.txt on Microsoft Windows 2000) Contains the copyright notice for the product.
LICENSE.html
Contains the text of the license agreement.
RELEASENOTES.html
Contains important information about this release.

Sample Programs and Demonstrations

All samples are contained in the samples directory under JC_HOME. TABLE 2 describes the contents of the directory.

TABLE 2  –  Directory Structure for Sample Programs and Demonstrations
Directory/File
Description
classes
Contains pre-built sample classes.
build_samples or
build_samples.bat
A script or batch file to automate building samples.
src
Contains the sources for the sample applets that belong to the packages com.sun.javacard.samples.*.
src/demo
Contains all of the files needed to run the Java Card demonstration programs. For more information on the contents of the demo directory, see "Directories and Files in the demo Directory".
src/com/sun/javacard/samples
Contains the source code for the sample applets.
src_client
Contains sample card acceptance device (CAD) client programs for the Photo Card, Java Card RMI, and secure Java Card RMI demos.

 

Contents Previous Next Index Development Kit User's Guide for the Binary Release with Cryptography Extensions
Java Card Platform, Version 2.2.1

 

Copyright © 2003 Sun Microsystems, Inc. All rights reserved.