README.md: add build instructions

We do not have any build instructions in our README.md file yet. Let's add some information about the basic steps that are needed to build the applets. Related: OS#6069
build-system: import build system from HelloSTK2
2023-09-06 11:55:39 +02:00 · 2023-09-06 11:09:44 +02:00
14 changed files with 9338 additions and 136 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1 +1,5 @@
+.vscode
+
+ant-javacard.jar
+gp.jar
 build/
--- a/.gitmodules
+++ b/.gitmodules
@ -0,0 +1,3 @@
+[submodule "oracle_javacard_sdks"]
+	path = oracle_javacard_sdks
+	url = https://github.com/martinpaljak/oracle_javacard_sdks.git
--- a/README.md
+++ b/README.md
@ -5,3 +5,89 @@ the tools from the <http://git.osmocom.org/sim/sim-tools/> repository.

 For more information see
 <https://osmocom.org/projects/cellular-infrastructure/wiki/Shadysimpy>
+
+
+# Build requirements
+
+Install a JAVA compiler and ANT:
+```
+$ sudo apt-get install default-jdk ant
+```
+
+Download the Javacard SDKs into the (empty) directory oracle_javacard_sdks
+```
+$ git submodule update --init --recursive
+```
+
+There is also another component "ant-javacard.jar", which is automatically downloaded during the build process.
+
+# Building CAP files
+
+The build process is started by calling ANT
+```
+$ ant
+Buildfile: /home/owner/work/git_master/hello-stk/build.xml
+
+dist:
+      [get] Getting: https://github.com/martinpaljak/ant-javacard/releases/latest/download/ant-javacard.jar
+      [get] To: /home/owner/work/git_master/hello-stk/ant-javacard.jar
+      [get] https://github.com/martinpaljak/ant-javacard/releases/latest/download/ant-javacard.jar moved to https://github.com/martinpaljak/ant-javacard/releases/download/v23.08.29/ant-javacard.jar
+      [get] https://github.com/martinpaljak/ant-javacard/releases/download/v23.08.29/ant-javacard.jar moved to https://objects.githubusercontent.com/github-production-release-asset-2e65be/28853876/2cb87380-f21f-45e7-894e-54ca5a3513d0?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20230906%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230906T085907Z&X-Amz-Expires=300&X-Amz-Signature=d16ac3b8e6a53831e85ec8315daa51b90f0ccfc09dcfd55d76bd8ff416a0651c&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=28853876&response-content-disposition=attachment%3B%20filename%3Dant-javacard.jar&response-content-type=application%2Foctet-stream
+      [cap] INFO: using JavaCard 3.0.5 SDK in /home/owner/work/git_master/hello-stk/oracle_javacard_sdks/jc305u3_kit with JDK 11
+      [cap] INFO: targeting JavaCard 2.2.1 SDK in /home/owner/work/git_master/hello-stk/oracle_javacard_sdks/jc221_kit
+      [cap] INFO: Setting package name to org.toorcamp.HelloSTK
+      [cap] Building CAP with 1 applet from package org.toorcamp.HelloSTK (AID: D07002CA44)
+      [cap] org.toorcamp.HelloSTK.HelloSTK D07002CA44900101
+  [compile] Compiling files from /home/owner/work/git_master/hello-stk/hello-stk
+  [compile] Compiling 1 source file to /home/owner/work/git_master/hello-stk/build/classes
+  [compile] /home/owner/work/git_master/hello-stk/hello-stk/src/org/toorcamp/HelloSTK/HelloSTK.java
+  [convert] [ INFO: ] Converter [v3.0.5]
+  [convert] [ INFO: ]     Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
+  [convert]     
+  [convert]     
+  [convert] [ INFO: ] conversion completed with 0 errors and 0 warnings.
+   [verify] Verification passed
+      [cap] CAP saved to /home/owner/work/git_master/hello-stk/build/HelloSTK.cap
+      [cap] INFO: using JavaCard 3.0.5 SDK in /home/owner/work/git_master/hello-stk/oracle_javacard_sdks/jc305u3_kit with JDK 11
+      [cap] INFO: targeting JavaCard 2.2.1 SDK in /home/owner/work/git_master/hello-stk/oracle_javacard_sdks/jc221_kit
+      [cap] INFO: Setting package name to org.osmocom.IMSIChange
+      [cap] Building CAP with 1 applet from package org.osmocom.IMSIChange (AID: D07002CA44)
+      [cap] org.osmocom.IMSIChange.IMSIChange D07002CA44900102
+  [compile] Compiling files from /home/owner/work/git_master/hello-stk/imsi-change
+  [compile] Compiling 3 source files to /home/owner/work/git_master/hello-stk/build/classes
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/Bytes.java
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/MobileIdentity.java
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:83: warning: [cast] redundant cast to byte
+  [compile] 			proHdlr.appendTLV((byte)(TAG_DEFAULT_TEXT), (byte)4, prefillVal, (short)0,
+  [compile] 			                  ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:134: warning: [cast] redundant cast to short
+  [compile] 		gsmFile.select((short) SIMView.FID_DF_GSM);
+  [compile] 		               ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:135: warning: [cast] redundant cast to short
+  [compile] 		gsmFile.select((short) SIMView.FID_EF_IMSI);
+  [compile] 		               ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:145: warning: [cast] redundant cast to short
+  [compile] 		gsmFile.select((short) SIMView.FID_DF_GSM);
+  [compile] 		               ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:146: warning: [cast] redundant cast to short
+  [compile] 		gsmFile.select((short) SIMView.FID_EF_IMSI);
+  [compile] 		               ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/IMSIChange.java:173: warning: [cast] redundant cast to byte
+  [compile] 		proHdlr.init((byte)PRO_CMD_REFRESH, SIM_REFRESH_SIM_INIT_FULL_FILE_CHANGE, DEV_ID_ME);
+  [compile] 		             ^
+  [compile] /home/owner/work/git_master/hello-stk/imsi-change/src/org/osmocom/IMSIChange/MobileIdentity.java:41: warning: [cast] redundant cast to byte
+  [compile] 			byte nibble = bcd[(byte)nibble_i >> 1];
+  [compile] 			                  ^
+  [compile] 7 warnings
+  [convert] [ INFO: ] Converter [v3.0.5]
+  [convert] [ INFO: ]     Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
+  [convert]     
+  [convert]     
+  [convert] [ INFO: ] conversion completed with 0 errors and 0 warnings.
+   [verify] Verification passed
+      [cap] CAP saved to /home/owner/work/git_master/hello-stk/build/ImsiChange.cap
+
+BUILD SUCCESSFUL
+Total time: 7 seconds
+```
--- a/build.xml
+++ b/build.xml
@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="HelloSTK" default="dist" basedir=".">
+  <description>Builds the project.</description>
+  <target name="dist" description="generate the distribution">
+    <tstamp/>
+    <get src="https://github.com/martinpaljak/ant-javacard/releases/latest/download/ant-javacard.jar" dest="." skipexisting="true"/>
+    <!-- Create the distribution directory -->
+    <taskdef name="javacard" classname="pro.javacard.ant.JavaCard" classpath="ant-javacard.jar"/>
+    <javacard>
+      <cap targetsdk="oracle_javacard_sdks/jc221_kit" jckit="oracle_javacard_sdks/jc305u3_kit" output="build/HelloSTK.cap" sources="hello-stk" classes="build/classes" version="1.0">
+        <applet class="org.toorcamp.HelloSTK.HelloSTK" aid="d0:70:02:CA:44:90:01:01"/>
+        <import exps="exp" jar="lib/sim.jar"/>
+      </cap>
+      <cap targetsdk="oracle_javacard_sdks/jc221_kit" jckit="oracle_javacard_sdks/jc305u3_kit" output="build/ImsiChange.cap" sources="imsi-change" excludes="src/**/Test*.java" classes="build/classes" version="1.0">
+        <applet class="org.osmocom.IMSIChange.IMSIChange" aid="d0:70:02:CA:44:90:01:02"/>
+        <import exps="exp" jar="lib/sim.jar"/>
+      </cap>
+    </javacard>
+  </target>
+  <target name="clean" description="clean up">
+    <!-- Delete the built applet -->
+    <delete dir="HelloSTK.cap"/>
+  </target>
+</project>
--- a/exp/sim/access/javacard/access.exp
+++ b/exp/sim/access/javacard/access.exp
--- a/exp/sim/access/javacard/access_exp.tex
+++ b/exp/sim/access/javacard/access_exp.tex
--- a/exp/sim/toolkit/javacard/toolkit.exp
+++ b/exp/sim/toolkit/javacard/toolkit.exp
--- a/exp/sim/toolkit/javacard/toolkit_exp.tex
+++ b/exp/sim/toolkit/javacard/toolkit_exp.tex
--- a/hello-stk/Makefile
+++ b/hello-stk/Makefile
@ -1,12 +0,0 @@
-SIMTOOLS_DIR    = ../../sim-tools
-
-APPLET_AID      = 0xd0:0x70:0x02:0xca:0x44:0x90:0x01:0x01
-APPLET_NAME     = org.toorcamp.HelloSTK.HelloSTK
-PACKAGE_AID     = 0xd0:0x70:0x02:0xCA:0x44:0x90:0x01
-PACKAGE_NAME    = org.toorcamp.HelloSTK
-PACKAGE_VERSION = 1.0
-
-SOURCES = \
-	src/org/toorcamp/HelloSTK/HelloSTK.java
-
-include $(SIMTOOLS_DIR)/javacard/makefiles/applet-project.mk
--- a/imsi-change/Makefile
+++ b/imsi-change/Makefile
@ -1,71 +0,0 @@
-SIMTOOLS_DIR    = ../../sim-tools
-
-APPLET_AID      = 0xd0:0x70:0x02:0xca:0x44:0x90:0x01:0x01
-APPLET_NAME     = org.osmocom.IMSIChange.IMSIChange
-PACKAGE_AID     = 0xd0:0x70:0x02:0xCA:0x44:0x90:0x01
-PACKAGE_NAME    = org.osmocom.IMSIChange
-PACKAGE_VERSION = 1.0
-
-SOURCES = \
-	  src/org/osmocom/IMSIChange/Bytes.java \
-	  src/org/osmocom/IMSIChange/MobileIdentity.java \
-	  src/org/osmocom/IMSIChange/IMSIChange.java \
-	  $(NULL)
-
-CAP_FILE = build/javacard/org/osmocom/IMSIChange/javacard/IMSIChange.cap
-
-include ./applet-project.mk
-
-.PHONY: flash
-flash: classes
-	$(eval MODULE_AID   := $(shell echo $(APPLET_AID) | sed 's/0x//g' | sed 's/\://g'))
-	$(eval INSTANCE_AID := $(shell echo $(APPLET_AID) | sed 's/0x//g' | sed 's/\://g'))
-	. $$PWD/.sim-keys && $(SIMTOOLS_DIR)/bin/shadysim \
-		--pcsc \
-		-l $(CAP_FILE) \
-		-i $(CAP_FILE) \
-		--enable-sim-toolkit \
-		--access-domain=00 \
-		--module-aid $(MODULE_AID) \
-		--instance-aid $(INSTANCE_AID) \
-		--nonvolatile-memory-required 0100 \
-		--volatile-memory-for-install 0100 \
-		--max-menu-entry-text 21 \
-		--max-menu-entries 01 \
-		--kic "$$KIC1" \
-		--kid "$$KID1"
-
-.PHONY: remove
-remove:
-	. $$PWD/.sim-keys && $(SIMTOOLS_DIR)/bin/shadysim \
-		--pcsc \
-		-d "$$(echo $(PACKAGE_AID) | sed 's/0x//g' | sed 's/\://g')" \
-		--kic "$$KIC1" \
-		--kid "$$KID1"
-
-.PHONY: list
-list:
-	. $$PWD/.sim-keys && $(SIMTOOLS_DIR)/bin/shadysim \
-		--pcsc \
-		--list-applets \
-		--kic "$$KIC1" \
-		--kid "$$KID1"
-
-.PHONY: delete
-delete: remove
-
-.PHONY: reflash
-reflash:
-	$(MAKE) remove
-	$(MAKE) flash
-
-.PHONY: test
-test:
-	mkdir -p ./test/classes
-	javac -target 1.1 -source 1.3 -classpath test/classes -g -d ./test/classes src/org/osmocom/IMSIChange/Bytes.java
-	javac -target 1.1 -source 1.3 -classpath test/classes -g -d ./test/classes src/org/osmocom/IMSIChange/MobileIdentity.java
-	javac -target 1.1 -source 1.3 -classpath test/classes -g -d ./test/classes src/org/osmocom/IMSIChange/Test.java
-	java -classpath test/classes org.osmocom.IMSIChange.Test
-
-.PHONY: check
-check: test
--- a/imsi-change/applet-project.mk
+++ b/imsi-change/applet-project.mk
@ -1,51 +0,0 @@
-BUILD_DIR           = ./build
-BUILD_CLASSES_DIR   = $(BUILD_DIR)/classes
-BUILD_JAVACARD_DIR  = $(BUILD_DIR)/javacard
-JAVACARD_SDK_DIR    ?= $(SIMTOOLS_DIR)/javacard
-JAVACARD_EXPORT_DIR ?= $(JAVACARD_SDK_DIR)/api21_export_files
-ifdef COMSPEC
-	CLASSPATH	    = $(JAVACARD_SDK_DIR)/lib/api21.jar;$(JAVACARD_SDK_DIR)/lib/sim.jar
-else
-	CLASSPATH           = $(JAVACARD_SDK_DIR)/lib/api21.jar:$(JAVACARD_SDK_DIR)/lib/sim.jar
-endif
-JFLAGS              = -target 1.1 -source 1.3 -g -d $(BUILD_CLASSES_DIR) -classpath "$(BUILD_CLASSES_DIR):$(CLASSPATH)"
-JAVA                ?= java
-JC                  ?= javac
-
-.SUFFIXES: .java .class
-.java.class:
-	@mkdir -p $(BUILD_CLASSES_DIR)
-	@mkdir -p $(BUILD_JAVACARD_DIR)
-	$(JC) $(JFLAGS) $*.java
-
-.PHONY: jar
-jar: classes
-	$(JAVA) -jar $(JAVACARD_SDK_DIR)/bin/converter.jar  \
-		-d $(BUILD_JAVACARD_DIR)                    \
-		-classdir $(BUILD_CLASSES_DIR)              \
-		-exportpath $(JAVACARD_EXPORT_DIR)          \
-		-applet $(APPLET_AID) $(APPLET_NAME)        \
-		$(PACKAGE_NAME) $(PACKAGE_AID) $(PACKAGE_VERSION)
-
-default: jar
-
-classes: $(SOURCES:.java=.class)
-
-clean:
-	$(RM) -rf $(BUILD_DIR)
-
-install:
-	$(eval CAP_FILE     := $(shell find $(BUILD_JAVACARD_DIR) -name *.cap))
-	$(eval MODULE_AID   := $(shell echo $(APPLET_AID) | sed 's/0x//g' | sed 's/\://g'))
-	$(eval INSTANCE_AID := $(shell echo $(APPLET_AID) | sed 's/0x//g' | sed 's/\://g'))
-	$(SIMTOOLS_DIR)/bin/shadysim                  \
-		$(SHADYSIM_OPTIONS)                \
-		-l $(CAP_FILE)                     \
-		-i $(CAP_FILE)                     \
-		--enable-sim-toolkit               \
-		--module-aid $(MODULE_AID)         \
-		--instance-aid $(INSTANCE_AID)     \
-		--nonvolatile-memory-required 0100 \
-		--volatile-memory-for-install 0100 \
-		--max-menu-entry-text 10           \
-		--max-menu-entries 01
--- a/imsi-change/src/org/osmocom/IMSIChange/Test.java
+++ b/imsi-change/src/org/osmocom/IMSIChange/Test.java
@ -1,7 +1,7 @@
 /* Copyright 2020 sysmocom s.f.m.c. GmbH
 * SPDX-License-Identifier: Apache-2.0 */
-package org.osmocom.IMSIChange;
-import org.osmocom.IMSIChange.*;
+package org.osmocom.IMSIPseudo;
+import org.osmocom.IMSIPseudo.*;

 public class Test {
 	private static byte nibble2hex(byte nibble)
--- a/lib/sim.jar
+++ b/lib/sim.jar
--- a/1
+++ b/1
@ -0,0 +1 @@
+Subproject commit e305a1a0b9bf6b9a8b0c91a9aad8d73537e7ff1b
				`@ -0,0 +1 @@`
				`Subproject commit e305a1a0b9bf6b9a8b0c91a9aad8d73537e7ff1b`