Begin adding Android Keystore ASN.1 schema

1 files changed, 146 insertions, 0 deletions

diff --git a/packages/server/src/helpers/asn1Schemas/KeyDescription.ts b/packages/server/src/helpers/asn1Schemas/KeyDescription.ts
new file mode 100644
index 0000000..23b0a39
--- /dev/null
+++ b/packages/server/src/helpers/asn1Schemas/KeyDescription.ts
@@ -0,0 +1,146 @@
+import {
+  AsnProp,
+  AsnPropTypes,
+  AsnArray,
+  AsnType,
+  AsnTypeTypes,
+  OctetString,
+} from '@peculiar/asn1-schema';
+
+/**
+ * From https://source.android.com/security/keystore/attestation#schema:
+ */
+
+/**
+ * ```
+ * KM2 value is 1. KM3 value is 2. KM4 value is 3.
+ * ```
+ */
+enum AttestationVersion {
+  KM2 = 1,
+  KM3 = 2,
+  KM4 = 3,
+}
+
+/**
+ * ```
+ * SecurityLevel ::= ENUMERATED {
+ *   Software                   (0),
+ *   TrustedEnvironment         (1),
+ *   StrongBox                  (2),
+ * }
+ * ```
+ */
+enum SecurityLevel {
+  Software = 0,
+  TrustedEnvironment = 1,
+  StrongBox = 2,
+}
+
+/**
+ * ```
+ * VerifiedBootState ::= ENUMERATED {
+ *   Verified                   (0),
+ *   SelfSigned                 (1),
+ *   Unverified                 (2),
+ *   Failed                     (3),
+ * }
+ * ```
+ */
+enum VerifiedBootState {
+  Verified = 0,
+  SelfSigned = 1,
+  Unverified = 2,
+  Failed = 3,
+}
+
+/**
+ * ```
+ * AuthorizationList ::= SEQUENCE {
+ *   purpose                     [1] EXPLICIT SET OF INTEGER OPTIONAL,
+ *   algorithm                   [2] EXPLICIT INTEGER OPTIONAL,
+ *   keySize                     [3] EXPLICIT INTEGER OPTIONAL.
+ *   digest                      [5] EXPLICIT SET OF INTEGER OPTIONAL,
+ *   padding                     [6] EXPLICIT SET OF INTEGER OPTIONAL,
+ *   ecCurve                     [10] EXPLICIT INTEGER OPTIONAL,
+ *   rsaPublicExponent           [200] EXPLICIT INTEGER OPTIONAL,
+ *   rollbackResistance          [303] EXPLICIT NULL OPTIONAL, # KM4
+ *   activeDateTime              [400] EXPLICIT INTEGER OPTIONAL
+ *   originationExpireDateTime   [401] EXPLICIT INTEGER OPTIONAL
+ *   usageExpireDateTime         [402] EXPLICIT INTEGER OPTIONAL
+ *   noAuthRequired              [503] EXPLICIT NULL OPTIONAL,
+ *   userAuthType                [504] EXPLICIT INTEGER OPTIONAL,
+ *   authTimeout                 [505] EXPLICIT INTEGER OPTIONAL,
+ *   allowWhileOnBody            [506] EXPLICIT NULL OPTIONAL,
+ *   trustedUserPresenceRequired [507] EXPLICIT NULL OPTIONAL, # KM4
+ *   trustedConfirmationRequired [508] EXPLICIT NULL OPTIONAL, # KM4
+ *   unlockedDeviceRequired      [509] EXPLICIT NULL OPTIONAL, # KM4
+ *   allApplications             [600] EXPLICIT NULL OPTIONAL,
+ *   applicationId               [601] EXPLICIT OCTET_STRING OPTIONAL,
+ *   creationDateTime            [701] EXPLICIT INTEGER OPTIONAL,
+ *   origin                      [702] EXPLICIT INTEGER OPTIONAL,
+ *   rollbackResistant           [703] EXPLICIT NULL OPTIONAL, # KM2 and KM3 only.
+ *   rootOfTrust                 [704] EXPLICIT RootOfTrust OPTIONAL,
+ *   osVersion                   [705] EXPLICIT INTEGER OPTIONAL,
+ *   osPatchLevel                [706] EXPLICIT INTEGER OPTIONAL,
+ *   attestationApplicationId    [709] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdBrand          [710] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdDevice         [711] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdProduct        [712] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdSerial         [713] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdImei           [714] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdMeid           [715] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdManufacturer   [716] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   attestationIdModel          [717] EXPLICIT OCTET_STRING OPTIONAL, # KM3
+ *   vendorPatchLevel            [718] EXPLICIT INTEGER OPTIONAL, # KM4
+ *   bootPatchLevel              [719] EXPLICIT INTEGER OPTIONAL, # KM4
+ * }
+ * ```
+ */
+class AuthorizationList {}
+
+/**
+ * ```
+ * RootOfTrust ::= SEQUENCE {
+ *   verifiedBootKey            OCTET_STRING,
+ *   deviceLocked               BOOLEAN,
+ *   verifiedBootState          VerifiedBootState,
+ *   verifiedBootHash           OCTET_STRING, # KM4
+ * }
+ * ```
+ */
+class RootOfTrust {}
+
+/**
+ * ```
+ * KeyDescription ::= SEQUENCE {
+ *   attestationVersion         INTEGER, # KM2 value is 1. KM3 value is 2. KM4 value is 3.
+ *   attestationSecurityLevel   SecurityLevel,
+ *   keymasterVersion           INTEGER,
+ *   keymasterSecurityLevel     SecurityLevel,
+ *   attestationChallenge       OCTET_STRING,
+ *   uniqueId                   OCTET_STRING,
+ *   softwareEnforced           AuthorizationList,
+ *   teeEnforced                AuthorizationList,
+ * }
+ * ```
+ */
+export default class KeyDescription {
+  @AsnProp({ type: AsnPropTypes.Integer })
+  public attestationVersion = AttestationVersion.KM2;
+
+  @AsnProp({ type: AsnPropTypes.Enumerated })
+  public attestationSecurityLevel = SecurityLevel.Software;
+
+  @AsnProp({ type: AsnPropTypes.Integer })
+  public keymasterVersion = AttestationVersion.KM2;
+
+  @AsnProp({ type: AsnPropTypes.Enumerated })
+  public keymasterSecurityLevel = SecurityLevel.Software;
+
+  @AsnProp({ type: OctetString })
+  public attestationChallenge = new OctetString();
+
+  @AsnProp({ type: OctetString })
+  public uniqueId = new OctetString();
+}