Precondition
JCShell
Command
Command
Command-Description
Parameter
n) is numbering
n) is numbering
Param-Description
n) is corresponding numbering
n) is corresponding numbering
Required / Optional
?
List of CardManager-Commands or help to those commands are available only when CardManager has been activated (prompt is cm>).
e.g. "help /mode"
usage: > {0|1|2|3} [-|[+]file]
2) -
3) file
4) +file
2) close log file
3) create log file
4) append to log file
2-4) Optional
usage: /applet [nickname [--reuse|-r]]
2) --reuse|-r
2) Reuse another logical channel for a currenlty active plugin instance with the same nickname.
Waiting for card with timeout only with given param.
Uses only the reader selected with term-command.
usage: /atr [[-t|time num[s|ms]]]
examples:
/atr --> no wait for card insertion
/atr time 10 --> waits max. 10 sec. for card insertion
/atr time 50ms --> waits max. 50 millisec. for card insertion
set before
Required: set variable "bugz-classpath" with the path to bugz and JRE before:
/set-var bugz-classpath "c:/Projekte/ibm/nJCOP/lib/bugz.jar;c:/jdk1.4.2_04/lib/tools.jar"
usage: /cap-clear [-p|--package package-name] CAP-file
2) CAP-file
2) CAP filename
usage: /cap-info [-p|--package package-name] CAP-file
e.g. /cap-info "C:/Projecte/testen/bin/showBug/javacard/showBug.cap"
2) CAP-file
Wrong package name results in "Incomplete CAP file, missing mandatory component: Header.cap at com.ibm.jc.CapFile.loadCode(CapFile.java:444)" 2) CAP-filename
usage: /cap-inst-auth [-e|--delegation][-l|--cm-lock][-t|--terminate][-d|--default][-c|--pin-change][-s|--security-domain][-b|--sd-dap] [-m|--mandated-dap][-p|--package package-name][-i|--instaid AID][-u|--params parameters][-n|--tokenpin PIN][-f|--target CAP-file] applet-AID CAP-file tokenspec
Possible token definitions are:
"pkcs11:<dllname>" | "windows" | "<PKCS#12-file>" | "<PKCS#8-file>" | "<hex-signature>".
2) -l|--cm-lock
3) -t|--terminate
4) -d|--default
5) -c|--pin-change
6) -s|--security-domain
7) -b|--sd-dap
8) -m|--mandated-dap
9) -p|--package package-name
10) -i|--instaid AID
11) -u|--params parameters
12) -n|--tokenpin PIN
13) -f|--target CAP-file
14) applet-AID
15) CAP-file
16) tokenspec
2) Card Manager lock permission.
3) Card terminate permission.
4) Implicit selectable (default) applet.
5) PIN change permission.
6) A Security Domain.
7) Security Domain with DAP verification.
8) Security Domain with mandated DAP verification.
9) Specify the Java package name to search for in the CAP-file. If this option isn't set, the first package found will be authorized for delegated installation (package-name --> Java package name).
10) Specify the desired instance AID (applet AID is default). AID --> Instance AID.
11) Application and/or system specific install parameters in TLV format. Tags:
0xC9 - application specific parameters
0xEF - system specific parametes:
0xC6 - non volatile code space limit
0xC7 - volatile data space limit
0xC8 - non volatile data space limit
(parameters --> Install parameters (TLV format)).
12) Specify the PIN to open the token. Only used if token is PIN protected (PIN --> PIN to open the token referenced by tokenspec).
13) If the CAP-file to be authorized shall not be modified this option can be used to specify the location and name of the target CAP-file (CAP-file --> File name of the authorized CAP-file).
14) AID of the applet in the package to be installed.
15) CAP filename
16) Specify the token holding the private key to be used for signature generation. The string "windows" means to search your Windows system (CAPI) for a private key. You can also pass the signature directly.
usage: /cap-load-auth [-p|--package package-name][-i|--tokenpin PIN][-s|--sdaid AID][-l|--params parameters][-t|--target CAP-file] CAP-file tokenspec
Possible token definitions are:
"pkcs11:<dllname>" | "windows" | "<PKCS#12-file>" | "<PKCS#8-file>" | "<hex-signature>".
2) -i|--tokenpin PIN
3) -s|--sdaid AID
4) -l|--params parameters
5) -t|--target CAP-file
6) CAP-file
7) tokenspec
2) Specify the PIN to open the token. Only used if token is PIN protected (PIN --> PIN to open the token referenced by tokenspec).
3) Specify the AID of the Security Domain to be associated with the package and it's applications (Card Manager is default) (AID --> AID of Security Domain).
4) Load parameters (parameters --> Load parameters in raw (TLV) format).
5) If the CAP-file to be authorized shall not be modified this option can be used to specify the location and name of the target CAP-file (CAP-file --> File name of the authorized CAP-file).
6) CAP filename
7) Specify the token holding the private key to be used for signature generation. The string "windows" means to search your Windows system (CAPI) for a private key. You can also pass the signature directly.
usage: /cap-sign [-d|--debug][-p|--package package-name][-i|--tokenpin PIN][-t|--target CAP-file][-a|--algorithm VOP201|GP211] CAP-file AID tokenspec
2) -p|--package package-name
3) -i|--tokenpin PIN
4) -t|--target CAP-file
5) -a|--algorithm VOP201|GP211
6) CAP-file
7) AID
8) tokenspec
2) Specify the Java package name to search for in the CAP-file. If this option isn't set, the first package found will be signed (package-name --> Java package name).
3) Specify the PIN to open the token. Only used if token is PIN protected (PIN --> PIN to open the token referenced by tokenspec).
4) If the CAP-file to be signed shall not be modified this option can be used to specify the location and name of the target (signed) CAP-file (CAP-file --> File name of the signed CAP-file).
5) Defines whether the DAP generation algorithm defined in VOP 2.0.1' or the one defined in Global Platform 2.1.1 is to be used. The default value is VOP201 (VOP201|GP211 --> DAP generation algorithm).
6) CAP filename
7) AID of Security Domain to verify this signature.
8) Specify the token holding the key to be used for signature generation. In case of PK DAP possible token definitions are: "pkcs11:<dllname>" | "windows" | "<PKCS#12-file>" | "<PKCS#8-file>" | "<hex-signature>". For symetric DAP the tokenspec must be the 16 byte DES key (as HEX string) to be used for DAP generation. The string "windows" means to search the Windows system (CAPI) for a private key. You can also pass the signature directly.
Uses only the reader selected with term-command.
usage: /card [-t|time num[s|ms]][-c|card-manager class-name][-a|card-manager-aid aid][-v|--verbose]
Optionally:
- wait for insertion,
- define a card manager AID and/or a specific Card Manager implementation.
The default Card Manager AID is 0xA000000003000000 and the default implementation behaves in accordance with Global Plaform 2.1.1 (VOP 2.0.1').
This command implicitely registers the Card Manager plugin referencing the desired Card Manager implementation with the JCShell under the nickname "cm".
examples:
/card -a a000000003000000 -c com.ibm.jc.CardManager --> selects the default Card Manager and reset card with timeout: 0 (ms)
/card -t 10ms --> selects the default Card Manager and reset card with timeout: 10 (ms)
2) -c|card-manager class-name
3) -a|card-manager-aid aid
4) -v|--verbose
2) Defines which off-card Card Manager implementation to use.
class-name --> Class which implements the Card Manager (subclassed com.ibm.jc.CardManager).
3) Desired Card Manager AID to be used. aid --> Card Manager AID
4) Print some FCI information.
usage: /channel [<0-3>]
ISO 7816-4/Global Platform MANAGE CHANNEL command. Either opens the next available supplementary logical channel or closes the current logical channel.
Upon opening a channel the new channel becomes the current channel.
Upon closing a supplementary channel the default channel (zero) becomes the current channel.
If no channel parameter is provided, this command only lists the logical channels currently open. The channel with the "*" is the one currently active within the JCShell.
usage: /clear-vars
(see also: /list-vars or /set-var)
usage: /dialog [-V|--split-value][-c|--choice][-s|--sound sound][-l|--loop][title [text [label..]*
examples:
/dialog Title Message Yes No Cancel
--> Display a Dialog with 3 buttons "Yes", "No" and "Cancel"
--> If a button has the name "Cancel" and will be selected then NULL is returned otherwise the name of the selected button.
2) -c|--choice
3) -s|--sound sound
4) -l|--loop
5) title
6) text
7) label
2) Display a list of choices instead of many buttons
3) Play some sounds while dialog is showing
4) Play sound in a loop
5) Dialog heading
6) message text
7) Text of button or choice
usage: /echo[-0|1|2|3] args..
2) args..
2) This content will be echoed!
usage: /error args..
usage: /exec [[-a|--async][-s|--silent][-l|--label label][-k|--kill][command [argument..]*
2) -s|--silent
3) -l|--label label
4) -k|--kill
5) command
6) argument..
2) Suppress process output
3) Attach this label to identify process
4) Kill process - pass label as command name. Omitted command kills all processes.
5) Command. Omitted command/args kills or lists all processes.
6) List of arguments to pass on to process.
usage: /expr args..
examples:
X=$(/expr ${X} + 1) --> increment internal variable "X"
usage: /glob pattern..
usage: identify [-q]
usage: /list-vars [[pattern|!pattern]..]
(see also: /clear-vars or /set-var)
Either opens the next available supplementary logical channel or closes the current logical channel.
Upon opening a channel the new channel becomes the current channel. Upon closing a supplementary channel the default channel (zero) becomes the current channel.
usage: /manage-channel open|close
close --> closes the current logical channel
usage: /mode [trace=on|off|num][echo=on|off][verbose=on|off][debug=on|off]
2) echo=on|off
3) verbose=on|off
4) debug=on|off
2) Echo command lines
3) Turn verbose mode on/off
4) Turn debug mode on/off
usage: /printf [-0|1|2|3] format args..
%x %X : format argument as lowercase/uppercase hexadecimal number
%d %u : format argument as decimal number (signed/unsigned)
%s : format argument as a string
%Ns : N is a decimal number or '*', specifies padding width. * reads padding from respetive argument list
%.Ms : M is a decimal number or '*', specifies maximum item length. * reads max length from respetive argument list
%N.Ms : truncate string to M chars and pad to length N
%-Ns : string is left aligned, padding to the right
%+Ns : string is right aligned, padding to the left (default if +/- is missing)
%|Ns : string is centered, padding on both sides
%0Ns : pad with zero characters
%[C]Ns : pad with C character, C can be any character
\[rnt] : replace with carriage return, line feed, and tab
With param: Introduce an applet to the shell.
The meaning of "applet" is a JCShellPlugin - a class with additional JCShell commands.
usage: /register [name aid [plugin] ]
2) aid
3) plugin
2) AID data (syntax see :send)
3) A fully qualified class name specifying a class implementing com.ibm.jc.tools.JCShellPlugin interface. If omitted com.ibm.jc.tools.OPAppletPlugin is used. The class com.ibm.jc.tools.
Some commands also set a return value. This command is for development purposes only.
usage: /remote [-0|1|2|3] command...
nJCOP simulation command list (some commands depends on configuration):
- exit
- terminate HAL
- clear-checkpoints
- clear-checkpoints(ifdef CFG_checkpoints)
- imon
- call monitor (insertion of imonitor-commands at ccg-monitor-console)
This is the monitor command list(get more information with "help command-name"):
exit quit ? help echo print disassemble stop step continue dump break until next finish log-level statistics reset enter-gdb trace fabstate
- tricerror
- get last tric error
- stats:{start:
|stop} - dump api stats
- unfuse
- reverting card state to unfused
examples:
/remote imon
--> open the communication with HAL imonitor; prompts with "jcop>" in Eclipse-Console
--> see following IMON session:
JCOP imonitor session example
2) command...
2) List of commands can be retrieved from halio.c
2) Required
This class is used to generate native system input events for the purposes of test automation, self-running demos, and other applications where control of the mouse and keyboard is needed. The primary purpose of Robot is to facilitate automated testing of Java platform implementations.
Using the class to generate input events differs from posting events to the AWT event queue or AWT components in that the events are generated in the platform's native input queue. For example, Robot.mouseMove will actually move the mouse cursor instead of just generating mouse move events.
Note that some platforms require special privileges or extensions to access low-level input control. If the current platform configuration does not allow input control, an AWTException will be thrown when trying to construct Robot objects. For example, X-Window systems will throw the exception if the XTEST 2.2 standard extension is not supported (or not enabled) by the X server.
usage: /robot click <x> <y>
usage: /robot type [<strings>]+ (emacs-like syntax: C-x2 M-TAB RET...)
usage: /robot getcolor <x> <y> [<var>]
usage: /robot getscreen <x> <y> <w> <h> [<var>]
usage: /robot waitscreen <x> <y> <w> <h> <hash> <timeout (ms)>
2) type [<strings>]+
3) getcolor <x> <y> [<var>]
4) getscreen <x> <y> <w> <h> [<var>]
5) waitscreen <x> <y> <w> <h> <hash> <timeout (ms)>
2) type keys. Possible keynames are all number and digits, special characters and predefined:
"RET", "ESC", "SPC", "TAB", "DEL", "LEFT", "RIGHT", "DOWN", "UP", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12"
You may use the following modifiers:
"S-" --> shift
"A-" --> alt
"M-" --> alt
"C-" --> cntrl
3) getcolor read the pixel color at the given x-y-position. If "var" was specified save the color-value in the given variable otherwise print out.
4) getscreen get screen hash. Compute CCITT-CRC for RGB values of specified screen rectangle. If "var" was specified save the value in the given variable otherwise print out.
5) waitscreen wait (poll 1/10 sec) for specified screen hash (HEX-chars) at the specified screen rectangle. Wait time is given timeout (default 100 ms).
usage: /r-echo args..
If the target channel is already open the assigned applet plugin, if any, is reused.
If the select FCI returned by the applet includes a remote object reference and there is no applet plugin selected or the current applet plugin is the Card Manager plugin, then it is automatically switched to the JCRMI plugin.
usage: /select AID [<0-3>]
examples:
/select |TESTA.01 --> selects applet with AID 0x54455354412E3031
APDU is: 00 A4 04 00 08 54 45 53 54 41 2E 30 31 00
2) <0-3>
Prefixing the AID with "|" converts the given ASCII-String into HEX-Code.
2) Target logical channel (current channel is default).
usage: /send [-r|--raw][nad=NAD][-t|--timeout num] apdu [pattern..]
examples:
"/send 0102|ab|03 04|cd" ==> 01 02 61 62 03 04 63 64
"/send 01#(|ab|#{FE FF})" ==> 01 05 61 62 02 FE FF
2) nad=NAD
3) -t|--timeout num
4) apdu
5) pattern..
3) max time to wait for response data in raw mode (time unit is device-dependent)
4) The APDU data to send. Data syntax: HEX[|CHARS[|HEX...]] (see also Data Considerations)
5) Description of expected responses. Each argument is pattern describing response as sequence of hexdigits with embedded wild cards (*,?,[..]). A leading ! char means NOT. Arguments '&' and '|' are interpreted as the respective logical operators. The response is ok if it matches the pattern and the logical expression.
The CLA byte of any APDU header sent to the card is automatically modified to reflect the logical channel number as defined in ISO 7816-4. Modification only takes place if the original CLA byte indicates channel zero, otherwise the given channel info is maintained.
By default the logical channel number is zero.
usage: /set-channel [{0|1|2|3}]
usage: /set-var [-d|--def][-g|--global][-q|--quote] varname [expr..]
(see also: /list-vars or /clear-vars)
examples:
- /set-var VAR1 xyz
- create global variable "VAR1" with value "xyz"
- /set-var VAR1
- purge global variable "VAR1"
- /set-var n1 10
- create global variable "n1" with value "10"
- /set-var n2 2
- create global variable "n2" with value "2"
- /set-var n1 $(/expr ${n1} + ( ${n2} * 5 ) )
- set global variable "n1" to new value "20"
- /set-var b1 true
- create global variable "b1" with value "true"
- /set-var b2 $(/expr ( ${n1} >= 20 ) && ${b1} )
- create global variable "b2" with value "true"
- NUMS[*]=1 2 3
- create global variable "NUMS" with space separated value list "1 2 3"
- NUMS[#]=3 4 5
- appends global variable "NUMS" with values "3 4 5" to "1 2 3 3 4 5"
2) -d|--def
3) -g|--global
4) -q|--quote
5) expr..
2) Update/create variable in defining scope. If var not defined use local scope.
3) Update/create variable in global scope
4) Do not evaluate arguments as expression. If multiple arguments create an array.
5) Shell expression
2-5) Optional
usage: /sleep time[s|ms]
Select Card-Terminal or Simulation.
usage: /terminal [-p|--pop] [term[|term_param]]
Create an instance of the specified terminal. The terminal specifier is first checked against the definitions in the system and personal setup files. The referred setup value or the supplied specifier is evaluated as listed below:
- null, ""
- A null reference or an empty string refer to the default terminal.
The default terminal is defined in the system or personal terminal
properties file.
If no properties-entry found for "DEFAULT.TERMINAL" try auto detect of card+terminal. Without any additional param it opens a PCSCJCTerminal and searches for existing readers. Returns first reader with inserted card or first reader in reader-list.
- DLL:API
- A NativeJCTerminal
is instanciated. DLL refers to the DLLs to used and API is the number of
the API to be used with this DLL.
examples:
/term "pcsc:4 --> opens a NativeJCTerminal (using jct.dll)
/term "winscard:4 --> opens a NativeJCTerminal (using jct.dll)
- NICKNAME
- If the specifier does not contain a dot (`.') then a Java class named
com.ibm.jc.terminal.NICKNAMEJCTerminal is instanciated. This
instance must be a subclass of JCTerminal.
examples:
/term "PCSC" --> opens a PCSCJCTerminal(using jpcsc.dll)
/term "PCSC|SCM Microsystems Inc. SDI010 Contactless Reader 0" --> opens a PCSCJCTerminal(using jpcsc.dll) to the designated reader
/term Remote --> opens a RemoteJCTerminal (using a socket connection at localhost:8050 to the Generic-Simulation - must be started before)
/term Remote|2233 --> opens a RemoteJCTerminal (try to connect Simulation at localhost:2233)
/term Remote|2233 --> opens a RemoteJCTerminal (try to connect Simulation at localhost:2233)
/term Remote|myHost:2233 --> opens a RemoteJCTerminal (try to connect Simulation at myHost:2233)
/term "MyTerm" --> try to open a MyTermJCTerminal(using ???.dll);
You have to ensure the implementation of this specified class (better use -->"CLASSQUAL").
- CLASSQUAL
- If none of the above cases matches then the specifier is treated as a fully qulified class name. This class is instanciated and must be a subclass of JCTerminal.
2) term[|term_param]
2) Specify either the name of a terminal or
a name plus some terminal parameter.
The parameter must be separated by a `|' character.
usage: /test-suite [[--details][{--test-suite ...|--summary ...|--start-gui|--stop-gui|--open-folder ...|--enlist-test ...|--close-folder|-- test-start ...|--test-passed|--test-not-run|--test-failed ...|--test-not-applicable ...}]]
Test suite must be used with multiple calls like:
/test-suite --test-suite "My special Tests" "c:/temp/mylog.txt"
/test-suite --open-folder "Folder short name" "Folder full name" c:/Projekte/ibm/offcard/tests
/test-suite --start-gui
/test-suite ......
/test-suite --stop-gui
2) --test-suite short-text [logfile]
3) --summary infomsg
4) --start-gui
5) --stop-gui
6) --open-folder short-text long-text scriptname
7) --enlist-test short-text long-text scriptname funcname
8) --close-folder
9) --test-start scriptname funcname [logfile]
10) --test-passed
11) --test-not-run
12) --test-failed [errmsg]
13) --test-not-applicable scriptname funcname [infomsg]
2) Announce a new test suite (short-text --> Short descriptive text; logfile --> Log file receiving output of test scripts)
3) Display test summary and update log file (if set) (infomsg --> Information message)
4) Start up GUI for set up test suite.
5) Stop displaying GUI.
6) Open a new test folder and enlist (short-text --> Short descriptive text; long-text --> Long descriptive text; scriptname --> File name of test script)
7) Enlist test in current test folder (short-text --> Short descriptive text; long-text --> Long descriptive text; scriptname --> File name of test script; funcname --> Name of test function)
8) Close current test folder.
9) Test has been started (scriptname --> File name of test script; funcname --> Name of test function; logfile --> Log file receiving output of test scripts)
10) Started test has been completed and passed.
11) Revert state of test to
12) Started test failed(errmsg --> Error message)
13) Test not applicable (scriptname --> File name of test script; funcname --> Name of test function; infomsg --> Information message)