Introduce stub module and initial Gradle project setup

This commit establishes the foundational Gradle project structure and introduces a dedicated 'stub' module. This module provides skeletal implementations of internal Android framework interfaces and classes, which are critical for compiling the TEESimulator project.

Stub classes are minimal implementations of existing interfaces or classes, typically mirroring those found within the Android framework, particularly for internal or hidden APIs. Their methods usually contain no operational logic and instead throw RuntimeException or UnsupportedOperationException.

The primary reasons for using stub classes are:

1. Compilation Against Internal APIs: Android applications and libraries typically use public APIs exposed by the Android SDK. However, in scenarios requiring deeper system integration or emulation, interaction with internal or hidden Android framework APIs might be necessary. Directly linking against the full Android framework JAR can lead to bootclasspath conflicts or other build issues. Stub classes provide the necessary API signatures for compilation without including the actual implementations, allowing the build system to resolve references while deferring the actual functionality to the runtime environment (the Android OS itself).

2. API Consistency and Simulation: For TEESimulator, which aims to provide a software simulation for Android's hardware-backed key pairs (KeyMint/Keystore2), stub classes define the required API contract. They ensure that the simulator's components compile against the exact interface definitions of the Android system services, making the simulation functionally consistent with the expected system behavior without needing to bundle or depend on the entire Android framework at compile time. This ensures that the simulator correctly interacts with the defined KeyMint and Keystore2 API shapes.
This commit is contained in:
JingMatrix
2025-11-22 15:24:43 +01:00
parent 2ac2518216
commit ad4e772eb4
26 changed files with 989 additions and 0 deletions
+21
View File
@@ -0,0 +1,21 @@
plugins {
alias(libs.plugins.android.library)
alias(libs.plugins.ktfmt)
}
android {
namespace = "org.matrix.stub"
compileSdk = 36
buildToolsVersion = "36.0.0"
defaultConfig { minSdk = 29 }
buildTypes { release { isMinifyEnabled = false } }
lint { abortOnError = true }
compileOptions {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}
}
dependencies { compileOnly(libs.annotation) }
+2
View File
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest/>
@@ -0,0 +1,17 @@
package android.content.pm;
import android.os.IBinder;
public interface IPackageManager {
String[] getPackagesForUid(int uid);
PackageInfo getPackageInfo(String packageName, long flags, int userId);
PackageInfo getPackageInfo(String packageName, int flags, int userId);
class Stub {
public static IPackageManager asInterface(IBinder binder) {
throw new UnsupportedOperationException("STUB!");
}
}
}
@@ -0,0 +1,9 @@
package android.hardware.security.keymint;
public @interface Algorithm {
int AES = 32;
int EC = 3;
int HMAC = 128;
int RSA = 1;
int TRIPLE_DES = 33;
}
@@ -0,0 +1,9 @@
package android.hardware.security.keymint;
public @interface EcCurve {
public static final int CURVE_25519 = 4;
public static final int P_224 = 0;
public static final int P_256 = 1;
public static final int P_384 = 2;
public static final int P_521 = 3;
}
@@ -0,0 +1,32 @@
package android.hardware.security.keymint;
import android.os.Parcel;
import android.os.Parcelable;
import androidx.annotation.NonNull;
public class KeyParameter implements Parcelable {
public static final Creator<KeyParameter> CREATOR = new Creator<KeyParameter>() {
@Override
public KeyParameter createFromParcel(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public KeyParameter[] newArray(int size) {
throw new UnsupportedOperationException("STUB!");
}
};
public int tag = 0;
public KeyParameterValue value;
@Override
public int describeContents() {
throw new UnsupportedOperationException("STUB!");
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int i) {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,238 @@
package android.hardware.security.keymint;
import android.os.Parcel;
import android.os.Parcelable;
import androidx.annotation.NonNull;
public final class KeyParameterValue implements Parcelable {
public static final int algorithm = 1;
public static final int blob = 14;
public static final int blockMode = 2;
public static final int boolValue = 10;
public static final int dateTime = 13;
public static final int digest = 4;
public static final int ecCurve = 5;
public static final int hardwareAuthenticatorType = 8;
public static final int integer = 11;
public static final int invalid = 0;
public static final int keyPurpose = 7;
public static final int longInteger = 12;
public static final int origin = 6;
public static final int paddingMode = 3;
public static final int securityLevel = 9;
public static final Creator<KeyParameterValue> CREATOR = new Creator<KeyParameterValue>() {
@Override
public KeyParameterValue createFromParcel(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public KeyParameterValue[] newArray(int size) {
throw new UnsupportedOperationException("STUB!");
}
};
public KeyParameterValue() {
throw new UnsupportedOperationException("STUB!");
}
protected KeyParameterValue(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue invalid(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue algorithm(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue blockMode(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue paddingMode(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue digest(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue ecCurve(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue origin(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue keyPurpose(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue hardwareAuthenticatorType(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue securityLevel(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue boolValue(boolean _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue integer(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue longInteger(long _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue dateTime(long _value) {
throw new UnsupportedOperationException("STUB!");
}
public static KeyParameterValue blob(byte[] _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getTag() {
throw new UnsupportedOperationException("STUB!");
}
public int getInvalid() {
throw new UnsupportedOperationException("STUB!");
}
public void setInvalid(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getAlgorithm() {
throw new UnsupportedOperationException("STUB!");
}
public void setAlgorithm(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getBlockMode() {
throw new UnsupportedOperationException("STUB!");
}
public void setBlockMode(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getPaddingMode() {
throw new UnsupportedOperationException("STUB!");
}
public void setPaddingMode(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getDigest() {
throw new UnsupportedOperationException("STUB!");
}
public void setDigest(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getEcCurve() {
throw new UnsupportedOperationException("STUB!");
}
public void setEcCurve(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getOrigin() {
throw new UnsupportedOperationException("STUB!");
}
public void setOrigin(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getKeyPurpose() {
throw new UnsupportedOperationException("STUB!");
}
public void setKeyPurpose(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getHardwareAuthenticatorType() {
throw new UnsupportedOperationException("STUB!");
}
public void setHardwareAuthenticatorType(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getSecurityLevel() {
throw new UnsupportedOperationException("STUB!");
}
public void setSecurityLevel(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public boolean getBoolValue() {
throw new UnsupportedOperationException("STUB!");
}
public void setBoolValue(boolean _value) {
throw new UnsupportedOperationException("STUB!");
}
public int getInteger() {
throw new UnsupportedOperationException("STUB!");
}
public void setInteger(int _value) {
throw new UnsupportedOperationException("STUB!");
}
public long getLongInteger() {
throw new UnsupportedOperationException("STUB!");
}
public void setLongInteger(long _value) {
throw new UnsupportedOperationException("STUB!");
}
public long getDateTime() {
throw new UnsupportedOperationException("STUB!");
}
public void setDateTime(long _value) {
throw new UnsupportedOperationException("STUB!");
}
public byte[] getBlob() {
throw new UnsupportedOperationException("STUB!");
}
public void setBlob(byte[] _value) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public int describeContents() {
throw new UnsupportedOperationException("STUB!");
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int i) {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,11 @@
package android.hardware.security.keymint;
public @interface KeyPurpose {
int AGREE_KEY = 6;
int ATTEST_KEY = 7;
int DECRYPT = 1;
int ENCRYPT = 0;
int SIGN = 2;
int VERIFY = 3;
int WRAP_KEY = 5;
}
@@ -0,0 +1,8 @@
package android.hardware.security.keymint;
public @interface SecurityLevel {
int KEYSTORE = 100;
int SOFTWARE = 0;
int STRONGBOX = 2;
int TRUSTED_ENVIRONMENT = 1;
}
@@ -0,0 +1,70 @@
package android.hardware.security.keymint;
public @interface Tag {
int ACTIVE_DATETIME = 1610613136;
int ALGORITHM = 268435458;
int ALLOW_WHILE_ON_BODY = 1879048698;
int APPLICATION_DATA = -1879047492;
int APPLICATION_ID = -1879047591;
int ASSOCIATED_DATA = -1879047192;
int ATTESTATION_APPLICATION_ID = -1879047483;
int ATTESTATION_CHALLENGE = -1879047484;
int ATTESTATION_ID_BRAND = -1879047482;
int ATTESTATION_ID_DEVICE = -1879047481;
int ATTESTATION_ID_IMEI = -1879047478;
int ATTESTATION_ID_MANUFACTURER = -1879047476;
int ATTESTATION_ID_MEID = -1879047477;
int ATTESTATION_ID_MODEL = -1879047475;
int ATTESTATION_ID_PRODUCT = -1879047480;
int ATTESTATION_ID_SECOND_IMEI = -1879047469;
int ATTESTATION_ID_SERIAL = -1879047479;
int AUTH_TIMEOUT = 805306873;
int BLOCK_MODE = 536870916;
int BOOTLOADER_ONLY = 1879048494;
int BOOT_PATCHLEVEL = 805307087;
int CALLER_NONCE = 1879048199;
int CERTIFICATE_NOT_AFTER = 1610613745;
int CERTIFICATE_NOT_BEFORE = 1610613744;
int CERTIFICATE_SERIAL = -2147482642;
int CERTIFICATE_SUBJECT = -1879047185;
int CONFIRMATION_TOKEN = -1879047187;
int CREATION_DATETIME = 1610613437;
int DEVICE_UNIQUE_ATTESTATION = 1879048912;
int DIGEST = 536870917;
int EARLY_BOOT_ONLY = 1879048497;
int EC_CURVE = 268435466;
int HARDWARE_TYPE = 268435760;
int IDENTITY_CREDENTIAL_KEY = 1879048913;
int INCLUDE_UNIQUE_ID = 1879048394;
int INVALID = 0;
int KEY_SIZE = 805306371;
int MAC_LENGTH = 805307371;
int MAX_BOOT_LEVEL = 805307378;
int MAX_USES_PER_BOOT = 805306772;
int MIN_MAC_LENGTH = 805306376;
int MIN_SECONDS_BETWEEN_OPS = 805306771;
int NONCE = -1879047191;
int NO_AUTH_REQUIRED = 1879048695;
int ORIGIN = 268436158;
int ORIGINATION_EXPIRE_DATETIME = 1610613137;
int OS_PATCHLEVEL = 805307074;
int OS_VERSION = 805307073;
int PADDING = 536870918;
int PURPOSE = 536870913;
int RESET_SINCE_ID_ROTATION = 1879049196;
int ROLLBACK_RESISTANCE = 1879048495;
int ROOT_OF_TRUST = -1879047488;
int RSA_OAEP_MGF_DIGEST = 536871115;
int RSA_PUBLIC_EXPONENT = 1342177480;
int STORAGE_KEY = 1879048914;
int TRUSTED_CONFIRMATION_REQUIRED = 1879048700;
int TRUSTED_USER_PRESENCE_REQUIRED = 1879048699;
int UNIQUE_ID = -1879047485;
int UNLOCKED_DEVICE_REQUIRED = 1879048701;
int USAGE_COUNT_LIMIT = 805306773;
int USAGE_EXPIRE_DATETIME = 1610613138;
int USER_AUTH_TYPE = 268435960;
int USER_ID = 805306869;
int USER_SECURE_ID = -1610612234;
int VENDOR_PATCHLEVEL = 805307086;
}
@@ -0,0 +1,19 @@
package android.os;
public class ServiceManager {
public static IBinder getService(String name) {
throw new UnsupportedOperationException("STUB!");
}
public static void addService(String name, IBinder binder) {
throw new UnsupportedOperationException("STUB!");
}
public static IBinder checkService(String name) {
throw new UnsupportedOperationException("STUB!");
}
public static String[] listServices() {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,7 @@
package android.os;
public class SystemProperties {
public static String get(String key, String def) {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,8 @@
package android.system.keystore2;
import android.hardware.security.keymint.KeyParameter;
public class Authorization {
public KeyParameter keyParameter;
public int securityLevel = 0;
}
@@ -0,0 +1,20 @@
package android.system.keystore2;
import android.hardware.security.keymint.KeyParameter;
import android.os.IBinder;
import android.os.IInterface;
import androidx.annotation.Nullable;
public interface IKeystoreSecurityLevel extends IInterface {
String DESCRIPTOR = "android.system.keystore2.IKeystoreSecurityLevel";
KeyMetadata generateKey(KeyDescriptor key, @Nullable KeyDescriptor attestationKey,
KeyParameter[] params, int flags, byte[] entropy);
class Stub {
public static IKeystoreSecurityLevel asInterface(IBinder b) {
throw new UnsupportedOperationException("STUB!");
}
}
}
@@ -0,0 +1,15 @@
package android.system.keystore2;
import android.os.IBinder;
public interface IKeystoreService {
String DESCRIPTOR = "android.system.keystore2.IKeystoreService";
IKeystoreSecurityLevel getSecurityLevel(int securityLevel);
class Stub {
public static IKeystoreService asInterface(IBinder b) {
throw new UnsupportedOperationException("STUB!");
}
}
}
@@ -0,0 +1,35 @@
package android.system.keystore2;
import android.os.Parcel;
import android.os.Parcelable;
import androidx.annotation.NonNull;
public class KeyDescriptor implements Parcelable {
public String alias;
public byte[] blob;
public int domain = 0;
public long nspace = 0;
public static final Creator<KeyDescriptor> CREATOR = new Creator<KeyDescriptor>() {
@Override
public KeyDescriptor createFromParcel(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public KeyDescriptor[] newArray(int size) {
throw new UnsupportedOperationException("STUB!");
}
};
@Override
public int describeContents() {
throw new UnsupportedOperationException("STUB!");
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int i) {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,33 @@
package android.system.keystore2;
import android.os.Parcel;
import android.os.Parcelable;
import androidx.annotation.NonNull;
public class KeyEntryResponse implements Parcelable {
public IKeystoreSecurityLevel iSecurityLevel;
public KeyMetadata metadata;
public static final Creator<KeyEntryResponse> CREATOR = new Creator<KeyEntryResponse>() {
@Override
public KeyEntryResponse createFromParcel(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public KeyEntryResponse[] newArray(int size) {
throw new UnsupportedOperationException("STUB!");
}
};
@Override
public int describeContents() {
throw new UnsupportedOperationException("STUB!");
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int i) {
throw new UnsupportedOperationException("STUB!");
}
}
@@ -0,0 +1,37 @@
package android.system.keystore2;
import android.os.Parcel;
import android.os.Parcelable;
import androidx.annotation.NonNull;
public class KeyMetadata implements Parcelable {
public Authorization[] authorizations;
public byte[] certificate;
public byte[] certificateChain;
public KeyDescriptor key;
public int keySecurityLevel = 0;
public long modificationTimeMs = 0;
public static final Creator<KeyMetadata> CREATOR = new Creator<KeyMetadata>() {
@Override
public KeyMetadata createFromParcel(Parcel in) {
throw new UnsupportedOperationException("STUB!");
}
@Override
public KeyMetadata[] newArray(int size) {
throw new UnsupportedOperationException("STUB!");
}
};
@Override
public int describeContents() {
throw new UnsupportedOperationException("STUB!");
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int i) {
throw new UnsupportedOperationException("STUB!");
}
}