Merge pull request #9 from sentclose/sortable

added tests for sortable

Author: joernheinemann

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentclose/sentc",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "End-to-end encryption sdk",
   "repository": {
     "type": "git",
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "idb": "^6.1.4",
-    "sentc_wasm": "0.8.0"
+    "sentc_wasm": "0.9.0"
   },
   "devDependencies": {
     "@joernheinemann/eslint-config-typescript": "1.0.0",

package.json

@@ -100,6 +100,11 @@ export interface GroupOutDataHmacKeys {
 	key_data: string
 }
 
+export interface GroupOutDataSortableKeys {
+	group_key_id: string,
+	key_data: string
+}
+
 export interface GroupData
 {
 	group_id: string,
@@ -116,6 +121,7 @@ export interface GroupData
 	access_by_group_as_member?: string,
 	is_connected_group: boolean,
 	hmac_keys: string[],
+	sortable_keys: string[],
 	last_check_time: number,
 }
 

src/Enities.ts

@@ -16,7 +16,7 @@ import {
 	GroupKeyRotationOut,
 	GroupList,
 	GroupOutDataHmacKeys,
-	GroupOutDataKeys,
+	GroupOutDataKeys, GroupOutDataSortableKeys,
 	GroupUserListItem,
 	HttpMethod,
 	KeyRotationInput,
@@ -33,7 +33,9 @@ import {
 	group_create_child_group,
 	group_create_connected_group,
 	group_decrypt_hmac_key,
-	group_decrypt_key, group_extract_group_data,
+	group_decrypt_key,
+	group_decrypt_sortable_key,
+	group_extract_group_data,
 	group_extract_group_key,
 	group_extract_group_keys,
 	group_finish_key_rotation,
@@ -48,7 +50,11 @@ import {
 	group_prepare_update_rank,
 	prepare_create_searchable,
 	prepare_create_searchable_light,
-	prepare_search
+	prepare_search,
+	sortable_encrypt_number,
+	sortable_encrypt_raw_number,
+	sortable_encrypt_raw_string,
+	sortable_encrypt_string
 } from "sentc_wasm";
 import {Sentc} from "./Sentc";
 import {AbstractSymCrypto} from "./crypto/AbstractSymCrypto";
@@ -175,6 +181,7 @@ export async function getGroup(
 		access_by_parent_group,
 		is_connected_group: out.get_is_connected_group(),
 		hmac_keys: [],
+		sortable_keys: [],
 		last_check_time: Date.now()
 	};
 
@@ -212,6 +219,12 @@ export async function getGroup(
 	const decrypted_hmac_keys = await group_obj.decryptHmacKeys(hmac_keys);
 	group_obj.data.hmac_keys = decrypted_hmac_keys;
 	group_data.hmac_keys = decrypted_hmac_keys;
+
+	const sortable_keys = out.get_sortable_keys();
+
+	const decrypted_sortable_keys = await group_obj.decryptSortableKeys(sortable_keys);
+	group_obj.data.sortable_keys = decrypted_sortable_keys;
+	group_data.sortable_keys = decrypted_sortable_keys;
 
 	await Promise.all([
 		//store the group data
@@ -1127,6 +1140,24 @@ export class Group extends AbstractSymCrypto
 		return keys;
 	}
 
+	public async decryptSortableKeys(fetchedKeys: GroupOutDataSortableKeys[])
+	{
+		const keys = [];
+
+		for (let i = 0; i < fetchedKeys.length; i++) {
+			const fetched_key = fetchedKeys[i];
+
+			// eslint-disable-next-line no-await-in-loop
+			const group_key = await this.getSymKeyById(fetched_key.group_key_id);
+
+			const decrypted_key = group_decrypt_sortable_key(group_key, fetched_key.key_data);
+
+			keys.push(decrypted_key);
+		}
+
+		return keys;
+	}
+
 	private prepareKeys(page = 0): [string, boolean]
 	{
 		return prepareKeys(this.data.keys, page);
@@ -1223,6 +1254,11 @@ export class Group extends AbstractSymCrypto
 		return this.data.hmac_keys[0];
 	}
 
+	getNewestSortableKey(): string
+	{
+		return this.data.sortable_keys[0];
+	}
+
 	//__________________________________________________________________________________________________________________
 
 	/**
@@ -1559,6 +1595,44 @@ export class Group extends AbstractSymCrypto
 		return handle_server_response(res);
 	}
 
+	//__________________________________________________________________________________________________________________
+	//sortable
+
+	public encryptSortableRawNumber(number: number)
+	{
+		const key = this.getNewestSortableKey();
+
+		return sortable_encrypt_raw_number(key, BigInt(number));
+	}
+
+	public encryptSortableNumber(number: number)
+	{
+		const key = this.getNewestSortableKey();
+
+		const out = sortable_encrypt_number(key, BigInt(number));
+
+		return [out.get_number(), out.get_alg(), out.get_key_id()];
+	}
+
+	public encryptSortableRawString(data: string)
+	{
+		const key = this.getNewestSortableKey();
+
+		return sortable_encrypt_raw_string(key, data);
+	}
+
+	public encryptSortableString(data: string)
+	{
+		const key = this.getNewestSortableKey();
+
+		const out = sortable_encrypt_string(key, data);
+
+		return [out.get_number(), out.get_alg(), out.get_key_id()];
+	}
+
+	//__________________________________________________________________________________________________________________
+	//content
+
 	public async fetchContent(data: {last_fetched_item?: ListContentItem, cat_id?: string, limit?: CONTENT_FETCH_LIMIT}): Promise<ListContentItem[]>
 	{
 		const {limit, cat_id, last_fetched_item} = data;

src/Group.ts

@@ -17,6 +17,8 @@
 	<script src="user/userTests.js"></script>
 	<script src="group/groupTest.js"></script>
 	<script src="group/groupTest2.js"></script>
+	<script src="sortable/sortableTest.js"></script>
+	<script src="sortable/sortableTest2.js"></script>
 	<script src="file/fileTest.js"></script>
 
 	<script>

tests/integration/index.html

@@ -0,0 +1,121 @@
+describe("Sortable tests", () => {
+	const username0 = "test0";
+	const username1 = "test1";
+
+	const pw = "12345";
+
+	/** @type User */
+	let user0, user1;
+
+	/** @type Group */
+	let group, group_for_user_1;
+
+	const sentc = window.Sentc.default;
+
+	before(async () => {
+		await sentc.init({
+			app_token: "5zMb6zs3dEM62n+FxjBilFPp+j9e7YUFA+7pi6Hi",
+			base_url: "http://127.0.0.1:3002"
+		});
+
+		await sentc.register(username0, pw);
+
+		user0 = await sentc.login(username0, pw);
+
+		await sentc.register(username1, pw);
+
+		user1 = await sentc.login(username1, pw);
+	});
+
+	it("should create a group", async function() {
+		const group_id = await user0.createGroup();
+
+		group = await user0.getGroup(group_id);
+
+		chai.assert.equal(group.data.group_id, group_id);
+	});
+
+	it("should invite the 2nd user in this group", async function() {
+		await group.inviteAuto(user1.user_data.user_id);
+
+		group_for_user_1 = await user1.getGroup(group.data.group_id);
+	});
+
+	let a, b, c;
+	
+	it("should encrypt a number", function() {
+		a = group.encryptSortableRawNumber(262);
+		b = group.encryptSortableRawNumber(263);
+		c = group.encryptSortableRawNumber(65321);
+
+		chai.assert.equal((a < b), true);
+		chai.assert.equal((b < c), true);
+	});
+
+	it("should get the same numbers as result back", function() {
+		const a1 = group_for_user_1.encryptSortableRawNumber(262);
+		const b1 = group_for_user_1.encryptSortableRawNumber(263);
+		const c1 = group_for_user_1.encryptSortableRawNumber(65321);
+
+		chai.assert.equal((a1 < b1), true);
+		chai.assert.equal((b1 < c1), true);
+
+		chai.assert.equal(a, a1);
+		chai.assert.equal(b, b1);
+		chai.assert.equal(c, c1);
+	});
+
+	const str_values = ["a", "az", "azzz", "b", "ba", "baaa", "o", "oe", "z", "zaaa"];
+	const encrypted_values = [];
+
+	it("should encrypt a string", function() {
+		for (let i = 0; i < str_values.length; i++) {
+			const v = str_values[i];
+
+			encrypted_values.push(group.encryptSortableRawString(v));
+		}
+
+		//check the number
+		let past_item = BigInt(0);
+
+		for (let i = 0; i < encrypted_values.length; i++) {
+			const item = encrypted_values[i];
+
+			chai.assert.equal(past_item < item, true);
+			past_item = item;
+		}
+	});
+
+	it("should encrypt the same values", function() {
+		const new_values = [];
+
+		for (let i = 0; i < str_values.length; i++) {
+			const v = str_values[i];
+
+			new_values.push(group_for_user_1.encryptSortableRawString(v));
+		}
+
+		//check the number
+		let past_item = BigInt(0);
+
+		for (let i = 0; i < new_values.length; i++) {
+			const item = new_values[i];
+			const check_item = encrypted_values[i];
+
+			chai.assert.equal(past_item < item, true);
+
+			chai.assert.equal(check_item, item);
+
+			past_item = item;
+		}
+	});
+
+	after(async () => {
+		//clean up
+
+		await group.deleteGroup();
+
+		await user0.deleteUser(pw);
+		await user1.deleteUser(pw);
+	});
+});

tests/integration/sortable/sortableTest.js

@@ -0,0 +1,27 @@
+describe("Sortable test 2", () => {
+	const sentc = window.Sentc.default;
+
+	before(async () => {
+		await sentc.init({
+			app_token: "5zMb6zs3dEM62n+FxjBilFPp+j9e7YUFA+7pi6Hi",
+			base_url: "http://127.0.0.1:3002"
+		});
+	});
+
+	it("should generate the same numbers with same key", function() {
+		//dummy group
+		const group = new window.Sentc.Group({
+			sortable_keys: [`{"Ope16":{"key":"5kGPKgLQKmuZeOWQyJ7vOg==","key_id":"1876b629-5795-471f-9704-0cac52eaf9a1"}}`]
+		}, "", "", null);
+
+		const a = group.encryptSortableRawNumber(262);
+		const b = group.encryptSortableRawNumber(263);
+		const c = group.encryptSortableRawNumber(65321);
+
+		// eslint-disable-next-line no-console
+		console.log(`a: ${a}, b: ${b}, c: ${c}`);
+
+		chai.assert.equal((a < b), true);
+		chai.assert.equal((b < c), true);
+	});
+});