Ant Task Descriptions

1. Enter the following example code to run APDUTool to send APDUs in APDU script file test.scr to cref and to check if all APDUs were sent correctly.

   Also checks that the response returned from the card was 9000.

   <target name="APDUToolTarget" >
           <apdutool
               scriptFile="${samples.helloworld.script}"
               outEEFile="${samples.eeprom}/outEEFile"
               CrefExe="${jcardkit_home}/bin/cref.exe">
           </apdutool>
   </target>
   

2. Enter the following example code to run the APDUTool to install the APDU script in test.scr file to cref and check if the APDU commands were processed successfully:

   Note:

   Classpath in this example is referenced by the classpath refid.

   <target name="APDUToolTarget" > 
     <apdutool 
         scriptFile="${samples.helloworld.script}" 
         outEEFile="${samples.eeprom}/outEEFile" 
         CheckDownloadFailure="true" 
         CrefExe="${jcardkit_home}/bin/cref.exe"> 
         <classpath refid="classpath"/> 
     </apdutool>
   </target>
   

3. Enter the following example code to run APDUTool to install the APDU script in test.scr file to cref, which is initialized using a stored EEPROM image from the file inEEFile:

   Note:

   Also check if the APDU commands were sent correctly. Classpath used in this example is referenced by the classpath refid.

   <target name="APDUToolTarget" > 
     <apdutool 
         scriptFile="${samples.helloworld.script}" 
         outEEFile="${samples.eeprom}/outEEFile" 
         inEEFile="${samples.eeprom}/inEEFile" 
         CheckDownloadFailure="true" 
         CrefExe="${jcardkit_home}/bin/cref.exe"> 
         <classpath refid="classpath"/> 
     </apdutool>
   </target>
   

1. Enter the following example code to run CapDump to dump the contents of the test.cap file:

   <target name="CapDumpTarget" > 
     <capdump 
         CapFile="${samples.output}/test.cap" 
     </capdump>
   </target>
   

2. Enter the following example code to run CapDump to dump the contents of the test.cap file:

   Note:

   Classpath used in this example code is referenced by the classpath refid

   <target name="CapDumpTarget" > 
     <capdump 
         CapFile="${samples.output}/test.cap" 
         <classpath refid="classpath"/> 
     </capdump>
   </target>
   

1. Enter the following example code to run Capgen to generate the mathDemo.cap file from the mathDemo.jca file.

   <target name="CapgenTarget" > 
     <capgen 
         JCAFile="${sample.output}/mathDemo.jca" 
         outfile="${sample.output}/mathDemo.cap"> 
         </capgen>
   </target>
   

2. Enter the following example code to run Capgen to generate a mathDemo.cap file from the mathDemo.jca file.

   Note:

   Classpath used in this example is referenced by the classpath refid.

   <target name="CapgenTarget" > 
     <capgen 
         JCAFile="${sample.output}/mathDemo.jca" 
         outfile="${sample.output}/mathDemo.cap"> 
         <classpath refid="classpath"/> 
     </capgen>
   </target>
   

3. Enter the following example code to run Capgen as in the previous example, except no output file is specified.

   Note:

   Capgen generates out.cap in the directory in which the JVM software was invoked.

   <target name="CapgenTarget" > 
     <capgen 
         JCAFile="${sample.output}/mathDemo.jca"/> 
         <classpath refid="classpath"/> 
     </capgen>
   </target>
   

The AppletNameID parameters are specified as nested elements and use nested element AppletNameAID to specify names and AIDs of applets belonging to the package being converted. For details regarding AppletNameAID type, see AppletNameAID .

Execution of this task fails if any of the required elements are not supplied, if converter.jar or offcardverifier.jar are not in the classpath, or if Converter returns an error code.

1. Enter the following example code to run the Converter and generate helloworld.cap, helloworld.JCA and helloworld.EXP files:

   <target name="convert_HelloWorld.cap" > 
     <convert 
         JCA="true" 
         EXP="true" 
         CAP="true" 
         packagename="com.sun.javacard.samples.HelloWorld" 
         packageaid="0xa0:0x0:0x0:0x0:0x62:0x3:0x1:0xc:0x1" 
         majorminorversion="1.0" 
         classdir="${classroot}" 
         outputdirectory="${classroot}"> 
         <AppletNameAID 
             appletname="com.sun.javacard.samples.HelloWorld.HelloWorld" 
             aid="0xa0:0x0:0x0:0x0:0x62:0x3:0x1:0xc:0x1:0x1"/> 
         <exportpath refid="export"/> 
         <classpath refid="classpath"/> 
     </convert>
   </target>
   

2. Enter the following example code to run the Converter with the converter options specified in thehelloworld.cfg file instead of being specified in the target itself.

   Note:

   This example also shows how a classpath can be specified for a target and how a directory can be set in which the Java VM is invoked for the converter task.

   <target name="convert_HelloWorld" > 
     <convert 
         dir="${samples}" 
         Configfile="${samples.configDir}/helloworld.cfg"> 
         <classpath> 
             <pathelement path="${samples}"/> 
             <fileset dir="${lib}"> 
                 <include name="**/converter.jar"/> 
                 <include name="**/offcardverifier.jar"/> 
             </fileset> 
         </classpath> 
     </convert>
   </target> 
   

Execution of this task fails if any of the required elements are not supplied, if apdutool.jar, apduio.jar and scriptgen.jar are not in the classpath, or if APDUTool, Scriptgen or cref fail to execute.

1. Enter the following example code to install helloworld.cap file in cref:

   Note:

   By default it is checked if the APDU commands were sent correctly. Classpath used in the above example is referenced by the classpath refid.

   <target name="Deploy_Hello_world_CAP" > 
     <deploycap 
         CAPFile="${samples.output}/helloworld.cap" 
         outEEFile="${samples.eeprom}/outEEFile" 
         CrefExe="{JAVACARD_HOME}/bin/cref"> 
         <classpath refid="classpath"/> 
     </deploycap>
   </target> 
   

2. Enter the following example code to install helloworld.cap file in cref, which in this case is initialized with EEFile:

   Note:

   The cref output EEPROM image is also saved in the same EEFile. By default it is checked if the APDU commands were sent correctly. This example shows that the resulting EEPROM image can be stored in the same EEPROM image file that was used to initialize cref.

   <target name="Deploy_Hello_world_CAP" > 
     <deploycap 
         CAPFile="${samples.output}/helloworld.cap" 
         outEEFile="${samples.eeprom}/EEFile" 
         inEEFile="${samples.eeprom}/EEFile" 
         CrefExe="{JAVACARD_HOME}/bin/cref"> 
         <classpath refid="classpath"/> 
     </deploycap>
   </target> 
   

Execution of this task fails if any of the required elements are not supplied, if converter.jar is not in the classpath, or if Exp2Text returns an error code.

1. Enter the following example code to run Exp2Text and generate text file from the export file of package HelloWorld:

   Note:

   This example assumes that converter.jar is already in classpath.

   <target name="Exp2TextTarget" > 
     <Exp2Text 
         packagename="com.sun.javacard.samples.HelloWorld" 
         classdir="${classroot}" 
         outputdir="${classroot}"> 
     </Exp2Text>
   </target>
   

2. Enter the following example code to run Exp2Text and generate text file from the export file of package HelloWorld:

   Note:

   Classdir and the root outputdir are both assumed to be the directory where the Java VM was invoked. Classpath used in this example is referenced by the classpath refid.

   <target name="Exp2TextTarget" > 
     <Exp2Text 
         packagename="com.sun.javacard.samples.HelloWorld"> 
         <classpath refid="classpath"/> 
     </Exp2Text>
   </target>
   

The JCAInputFile parameters are specified as nested elements and use nested element JCAInputFile to specify names of input JCA files for Maskgen. Input JCA files are required to create a Mask file. The reason a standard FileSet to specify JCA file names is not used here is that Maskgen supports input file names that starts with an "@" symbol to specify an input file that contains a list of names of input JCA files. A file name that starts with "@" is not supported by any of the standard Ant types. See the description for JCAInputFile for details.

Execution of this task fails if any of the required elements are not supplied, if converter.jar is not in the classpath or if Maskgen returns an error code.

1. Enter the following example code to run Maskgen to generate mask.c file from input JCA files specified in files mask1.in and mask2.in:

   <target name="MasgenTarget" > 
     <maskgen  
         generator="cref"  
         configfile="${maskDir}/mask.cfg" 
         outfile="${crefDir}/common/mask.c" > 
         <jcainputfile inputfile="@${maskDir}/mask1.in" / > 
         <jcainputfile inputfile="@${maskDir}/mask2.in" / > 
     </maskgen >
   </target >
   

2. Enter the following example code to run Maskgen to generate mask.c file from input JCA files specified in files api.in and installer and helloworld JCA files:

   <target name="MasgenTarget" > 
     <maskgen  
         generator="cref"  
         configfile="${maskDir}/mask.cfg" 
         outfile="${crefDir}/common/mask.c" > 
         <jcainputfile inputfile="@${maskDir}/api.in" / > 
         <jcainputfile inputfile="${jcaDir}/installer.jca" / > 
         <jcainputfile inputfile="${jcaDir}/helloworld.jca" / > 
     </maskgen >
   </target >
   

3. Enter the following example code to run Maskgen without specifying an output file and classpath.

   Note:

   Maskgen generates the file a.out in the directory in which Java VM was invoked.

   <target name="MasgenTarget" > 
     <maskgen  
         generator="cref"  
         configfile="${maskDir}/mask.cfg" 
         outfile="${crefDir}/common/mask.c" > 
         <jcainputfile inputfile="@${maskDir}/api.in" / > 
         <jcainputfile inputfile="${jcaDir}/installer.jca" / > 
         <jcainputfile inputfile="${jcaDir}/helloworld.jca" / > 
         <classpath refid="classpath"/> 
     </maskgen >
   </target >
   

Execution of this task fails if any of the required elements are not supplied, if scriptgen.jar is not in the classpath or if Scriptgen returns an error code.

1. Enter the following example code to run Scriptgen and generate script file helloWorld.scr from helloWorld.cap file.

   Note:

   Classpath used in this example is referenced by the classpath refid.

   <target name="ScriptgenTarget" > 
     <scriptgen  
         noBeginEnd="true" 
         noBanner="true" 
         CapFile="${samples.helloworld.output}/HelloWorld.cap"  
         outFile="${samples.helloworld.script}/helloWorld.scr" > 
         <classpath refid="classpath" /> 
     </scriptgen >
   </target >
   

The ExportFiles are parameters specified as nested elements that use nested element ExportFiles to specify group of export files for packages imported by the package whose CAP file is being verified and the export file corresponding to the CAP being verified. For details regarding ExportFiles type see ExportFiles.

Execution of this task fails if any of the required elements are not supplied, if offcardverifier.jar is not in the classpath, or if Verifier returns an error code.

1. Enter the following example code to run the Java Card platform off-card verifier and verify the HelloWorld.cap file.

   <target name="VerifyCapTarget" > 
     <verifycap  
         CapFile="${samples.helloworld.output}/HelloWorld.cap" > 
         <exportfiles file="${samples.helloworld.output}/HelloWorld.exp" /> 
         <exportfiles file="${api_exports}/javacard/framework/javacard/framework.exp" /> 
         <exportfiles file="${api_exports}/java/lang/javacard/lang.exp" /> 
         <classpath refid="classpath"/> 
     </verifycap>
   </target> 
   

The ExportFiles are parameters specified as nested elements that use nested element ExportFiles to specify the EXP file being verified. For details regarding ExportFiles type see ExportFiles. VerifiyExp requires that only one input EXP file be specified. This tasks throws an error if more than one EXP files are specified.

Execution of this task fails if no EXP file is specified or if more than one EXP file is specified, if offcardverifier.jar is not in the classpath, or if Verifier returns an error code.

1. Enter the following example code to run the Java Card platform off-card verifier to verify HelloWorld.exp file:

   <target name="VerifyExpTarget" > 
     <verifyExp  
         <exportfiles file="${samples.helloworld.output}/HelloWorld.exp" /> 
         <classpath refid="classpath"/> 
     </verifyExp>
   </target> 
   

The ExportFiles are parameters specified as nested elements that use nested element ExportFiles to specify the EXP files being verified. For details regarding ExportFiles type see ExportFiles. VerifyExp requires that exactly two input EXP files are specified: it throws an error if that is not the case.

Execution of this task fails if no EXP file is specified or if less or more than two EXP files are specified, if offcardverifier.jar is not in the classpath, or if Verifier returns an error code.

1. Enter the following example code to run the Java Card platform off-card verifier to verify binary compatibility between two versions of HelloWorld.exp file.

   <target name="VerifyExpTarget" > 
     <verifyExp  
         <exportfiles file="${samples.helloworld.output}/HelloWorld.exp" /> 
         <exportfiles file="${samples.helloworld.output.new}/HelloWorld.exp" /> 
         <classpath refid="classpath"/> 
     </verifyExp>
   </target>