-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: support wrong order fields for KeyDescription
- Loading branch information
1 parent
5145f19
commit ef4e3ee
Showing
5 changed files
with
304 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| export * from "./key_description"; | ||
| export * from "./key_description"; | ||
| export * from "./nonstandard"; | ||
| export * from "./attestation"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import { AsnProp, AsnPropTypes, AsnArray, AsnType, AsnTypeTypes, OctetString } from "@peculiar/asn1-schema"; | ||
| import { AuthorizationList, SecurityLevel, Version } from "./key_description"; | ||
|
|
||
| /** | ||
| * This file contains classes to handle non-standard key descriptions and authorizations. | ||
| * | ||
| * Due to an issue with the asn1-schema library, referenced at https://github.com/PeculiarVentures/asn1-schema/issues/98#issuecomment-1764345351, | ||
| * the standard key description does not allow for a non-strict order of fields in the `softwareEnforced` and `teeEnforced` attributes. | ||
| * | ||
| * To address this and provide greater flexibility, the `NonStandardKeyDescription` and | ||
| * `NonStandardAuthorizationList` classes were created, allowing for the use of non-standard authorizations and a flexible field order. | ||
| * | ||
| * The purpose of these modifications is to ensure compatibility with specific requirements and standards, as well as to offer | ||
| * more convenient tools for working with key descriptions and authorizations. | ||
| * | ||
| * Please refer to the documentation and class comments before using or modifying them. | ||
| */ | ||
|
|
||
| /** | ||
| * Represents a non-standard authorization for NonStandardAuthorizationList. It uses the same | ||
| * structure as AuthorizationList, but it is a CHOICE instead of a SEQUENCE, that allows for | ||
| * non-strict ordering of fields. | ||
| */ | ||
| @AsnType({ type: AsnTypeTypes.Choice }) | ||
| export class NonStandardAuthorization extends AuthorizationList { } | ||
|
|
||
| /** | ||
| * Represents a list of non-standard authorizations. | ||
| * ```asn | ||
| * NonStandardAuthorizationList ::= SEQUENCE OF NonStandardAuthorization | ||
| * ``` | ||
| */ | ||
| @AsnType({ type: AsnTypeTypes.Sequence, itemType: NonStandardAuthorization }) | ||
| export class NonStandardAuthorizationList extends AsnArray<NonStandardAuthorization> { | ||
| constructor(items?: NonStandardAuthorization[]) { | ||
| super(items); | ||
|
|
||
| // Set the prototype explicitly. | ||
| Object.setPrototypeOf(this, NonStandardAuthorizationList.prototype); | ||
| } | ||
|
|
||
| /** | ||
| * Finds the first authorization that contains the specified key. | ||
| * @param key The key to search for. | ||
| * @returns The first authorization that contains the specified key, or `undefined` if not found. | ||
| */ | ||
| findProperty<K extends keyof AuthorizationList>(key: K): AuthorizationList[K] | undefined { | ||
| const prop = this.find((o => key in o)); | ||
| if (prop) { | ||
| return prop[key]; | ||
| } | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The AuthorizationList class allows for non-strict ordering of fields in the | ||
| * softwareEnforced and teeEnforced fields. | ||
| * | ||
| * This behavior is due to an issue with the asn1-schema library, which is | ||
| * documented here: https://github.com/PeculiarVentures/asn1-schema/issues/98#issuecomment-1764345351 | ||
| * | ||
| * ```asn | ||
| * KeyDescription ::= SEQUENCE { | ||
| * attestationVersion INTEGER, # versions 1, 2, 3, 4, 100, and 200 | ||
| * attestationSecurityLevel SecurityLevel, | ||
| * keymasterVersion INTEGER, | ||
| * keymasterSecurityLevel SecurityLevel, | ||
| * attestationChallenge OCTET_STRING, | ||
| * uniqueId OCTET_STRING, | ||
| * softwareEnforced NonStandardAuthorizationList, | ||
| * teeEnforced NonStandardAuthorizationList, | ||
| * } | ||
| * ``` | ||
| */ | ||
| export class NonStandardKeyDescription { | ||
| @AsnProp({ type: AsnPropTypes.Integer }) | ||
| public attestationVersion: Version = Version.KM4; | ||
|
|
||
| @AsnProp({ type: AsnPropTypes.Enumerated }) | ||
| public attestationSecurityLevel: SecurityLevel = SecurityLevel.software; | ||
|
|
||
| @AsnProp({ type: AsnPropTypes.Integer }) | ||
| public keymasterVersion = 0; | ||
|
|
||
| @AsnProp({ type: AsnPropTypes.Enumerated }) | ||
| public keymasterSecurityLevel: SecurityLevel = SecurityLevel.software; | ||
|
|
||
| @AsnProp({ type: OctetString }) | ||
| public attestationChallenge = new OctetString(); | ||
|
|
||
| @AsnProp({ type: OctetString }) | ||
| public uniqueId = new OctetString(); | ||
|
|
||
| @AsnProp({ type: NonStandardAuthorizationList }) | ||
| public softwareEnforced = new NonStandardAuthorizationList(); | ||
|
|
||
| @AsnProp({ type: NonStandardAuthorizationList }) | ||
| public teeEnforced = new NonStandardAuthorizationList(); | ||
|
|
||
| public constructor(params: Partial<NonStandardKeyDescription> = {}) { | ||
| Object.assign(this, params); | ||
| } | ||
| } |
Oops, something went wrong.