@microsoft/ccf-app 5.0.0-dev17 → 5.0.0-dev18

package/converters.js

@@ -3,7 +3,8 @@
 /**
  * This module provides converters to and from `ArrayBuffer` objects.
  *
- * Converters are commonly used as {@linkcode kv.typedKv} arguments.
+ * Converters are commonly used as {@linkcode kv.typedKv} or
+ * {@linkcode kv.typedKvSet} arguments.
  * Another use case is {@linkcode crypto.wrapKey} to convert
  * PEM-encoded keys to `ArrayBuffer`.
  *

package/global.d.ts

@@ -32,6 +32,22 @@ export interface KvMap {
     forEach(callback: (value: ArrayBuffer, key: ArrayBuffer, kvmap: KvMap) => void): void;
     size: number;
 }
+/**
+ * A set in the Key Value Store.
+ *
+ * `KVSet` is modelled after JavaScript's `Set` object,
+ * except that keys must be of type `ArrayBuffer`
+ * and no guarantees on iteration order are provided.
+ */
+export interface KvSet {
+    has(key: ArrayBuffer): boolean;
+    getVersionOfPreviousWrite(key: ArrayBuffer): number | undefined;
+    add(key: ArrayBuffer): KvSet;
+    delete(key: ArrayBuffer): void;
+    clear(): void;
+    forEach(callback: (value: ArrayBuffer, kvset: KvSet) => void): void;
+    size: number;
+}
 /**
  * @inheritDoc CCF.kv
  */
@@ -107,7 +123,7 @@ export interface HistoricalState {
     /**
      * An object that provides access to the maps of the Key-Value Store
      * associated with the historic transaction.
-     * Fields are map names and values are {@linkcode KvMap} objects.
+     * Fields are map names and values are {@linkcode KvMap}  objects.
      */
     kv: KvMaps;
 }
@@ -592,29 +608,6 @@ export interface CCF {
      */
     enableMetricsLogging(enable: boolean): boolean;
 }
-export declare const openenclave: OpenEnclave;
-export interface EvidenceClaims {
-    claims: {
-        [name: string]: ArrayBuffer;
-    };
-    customClaims: {
-        [name: string]: ArrayBuffer;
-    };
-}
-export interface OpenEnclave {
-    /**
-     * Verifies Open Enclave evidence and returns the claims of the evidence.
-     *
-     * @param format The optional format id of the evidence to be verified as
-     *  a UUID of the form "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".
-     *  If this parameter is `undefined`, the evidence and endorsement
-     *  must either contain data with an attestation header holding a valid
-     *  format id, or be an Open Enclave report generated by the legacy API function
-     *  `oe_get_report()`. Otherwise, this parameter must be a valid format id, and
-     *  the evidence and endorsements data must not be wrapped with an attestation header.
-     */
-    verifyOpenEnclaveEvidence(format: string | undefined, evidence: ArrayBuffer, endorsements?: ArrayBuffer): EvidenceClaims;
-}
 export interface TcbVersion {
     boot_loader: number;
     tee: number;

package/global.js

@@ -20,6 +20,5 @@
 // in a .d.ts definition file.
 // This avoids polluting the global namespace.
 export const ccf = globalThis.ccf;
-export const openenclave = globalThis.openenclave;
 export const snp_attestation = globalThis
     .snp_attestation;

package/kv.d.ts

@@ -49,6 +49,18 @@ export declare class TypedKvMap<K, V> {
     forEach(callback: (value: V, key: K, table: TypedKvMap<K, V>) => void): void;
     get size(): number;
 }
+export declare class TypedKvSet<K> {
+    private kv;
+    private kt;
+    constructor(kv: KvMap, kt: DataConverter<K>);
+    has(key: K): boolean;
+    getVersionOfPreviousWrite(key: K): number | undefined;
+    add(key: K): TypedKvSet<K>;
+    delete(key: K): void;
+    clear(): void;
+    forEach(callback: (key: K, table: TypedKvSet<K>) => void): void;
+    get size(): number;
+}
 /**
  * Returns a typed view of a map in the Key-Value Store,
  * where keys and values are automatically converted
@@ -63,8 +75,21 @@ export declare class TypedKvMap<K, V> {
  * @param vt The converter to use for map values.
  */
 export declare function typedKv<K, V>(nameOrMap: string | KvMap, kt: DataConverter<K>, vt: DataConverter<V>): TypedKvMap<K, V>;
+/**
+ * Returns a typed view of a set in the Key-Value Store,
+ * where keys are automatically converted
+ * to and from ``ArrayBuffer`` based on the given key
+ * converter.
+ *
+ * See the {@linkcode converters} module for available converters.
+ *
+ * @param nameOrMap Either the map name in the Key-Value Store,
+ *    or a ``KvMap`` object.
+ * @param kt The converter to use for map keys.
+ */
+export declare function typedKvSet<K, V>(nameOrMap: string | KvMap, kt: DataConverter<K>): TypedKvSet<K>;
 /**
  * @inheritDoc global!CCF.kv
  */
 export declare const rawKv: import("./global.js").KvMaps;
-export { KvMap, KvMaps } from "./global";
+export { KvMap, KvSet, KvMaps } from "./global";

package/kv.js

@@ -74,6 +74,38 @@ export class TypedKvMap {
         return this.kv.size;
     }
 }
+export class TypedKvSet {
+    constructor(kv, kt) {
+        this.kv = kv;
+        this.kt = kt;
+    }
+    has(key) {
+        return this.kv.has(this.kt.encode(key));
+    }
+    getVersionOfPreviousWrite(key) {
+        return this.kv.getVersionOfPreviousWrite(this.kt.encode(key));
+    }
+    add(key) {
+        this.kv.set(this.kt.encode(key), new ArrayBuffer(8));
+        return this;
+    }
+    delete(key) {
+        this.kv.delete(this.kt.encode(key));
+    }
+    clear() {
+        this.kv.clear();
+    }
+    forEach(callback) {
+        let kt = this.kt;
+        let typedSet = this;
+        this.kv.forEach(function (raw_v, raw_k, table) {
+            callback(kt.decode(raw_k), typedSet);
+        });
+    }
+    get size() {
+        return this.kv.size;
+    }
+}
 /**
  * Returns a typed view of a map in the Key-Value Store,
  * where keys and values are automatically converted
@@ -91,6 +123,22 @@ export function typedKv(nameOrMap, kt, vt) {
     const kvMap = typeof nameOrMap === "string" ? ccf.kv[nameOrMap] : nameOrMap;
     return new TypedKvMap(kvMap, kt, vt);
 }
+/**
+ * Returns a typed view of a set in the Key-Value Store,
+ * where keys are automatically converted
+ * to and from ``ArrayBuffer`` based on the given key
+ * converter.
+ *
+ * See the {@linkcode converters} module for available converters.
+ *
+ * @param nameOrMap Either the map name in the Key-Value Store,
+ *    or a ``KvMap`` object.
+ * @param kt The converter to use for map keys.
+ */
+export function typedKvSet(nameOrMap, kt) {
+    const kvMap = typeof nameOrMap === "string" ? ccf.kv[nameOrMap] : nameOrMap;
+    return new TypedKvSet(kvMap, kt);
+}
 /**
  * @inheritDoc global!CCF.kv
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/ccf-app",
-  "version": "5.0.0-dev17",
+  "version": "5.0.0-dev18",
   "description": "CCF app support package",
   "main": "index.js",
   "files": [

package/polyfill.js

@@ -524,12 +524,6 @@ class CCFPolyfill {
     }
 }
 globalThis.ccf = new CCFPolyfill();
-class OpenEnclavePolyfill {
-    verifyOpenEnclaveEvidence(format, evidence, endorsements) {
-        throw new Error("Method not implemented.");
-    }
-}
-globalThis.openenclave = new OpenEnclavePolyfill();
 class SnpAttestationPolyfill {
     verifySnpAttestation(evidence, endorsements, uvm_endorsements, endorsed_tcb) {
         throw new Error("Method not implemented.");

package/openenclave.d.ts

@@ -1,5 +0,0 @@
-/**
- * @inheritDoc global!OpenEnclave.verifyOpenEnclaveEvidence
- */
-export declare const verifyOpenEnclaveEvidence: (format: string | undefined, evidence: ArrayBuffer, endorsements?: ArrayBuffer | undefined) => import("./global").EvidenceClaims;
-export { EvidenceClaims } from "./global";

package/openenclave.js

@@ -1,12 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the Apache 2.0 License.
-/**
- * The `openenclave` module provides access to Open Enclave functionality.
- *
- * @module
- */
-import { openenclave } from "./global";
-/**
- * @inheritDoc global!OpenEnclave.verifyOpenEnclaveEvidence
- */
-export const verifyOpenEnclaveEvidence = openenclave.verifyOpenEnclaveEvidence;