spec-3nweb-server 1.8.5 → 1.8.6

package/ts-code/lib-common/ipc/ws-ipc.ts

@@ -0,0 +1,117 @@
+/*
+ Copyright (C) 2017 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import { RawDuplex, EventfulServer, makeEventfulServer,
+	SubscribingClient, makeSubscribingClient, Envelope, Observer,
+	MultiObserverWrap }
+	from './generic-ipc';
+import * as WebSocket from 'ws';
+
+export { RequestEnvelope, RequestHandler, EventfulServer, makeEventfulServer,
+	SubscribingClient }
+	from './generic-ipc';
+
+export interface WSException extends web3n.RuntimeException {
+	type: 'websocket',
+	socketSlow?: true
+}
+
+const MAX_TXT_BUFFER = 64*1024;
+
+/**
+ * This creates a json communication point on a given web socket.
+ * Point may have many listeners, allowing for single parsing of incoming
+ * messages.
+ * @param ws 
+ */
+export function makeJsonCommPoint(ws: WebSocket): RawDuplex<Envelope> {
+	
+	const observers = new MultiObserverWrap<Envelope>();
+
+	ws.on('message', onTxtMessage(ws, observers));
+	ws.on('close', onClose(observers));
+	ws.on('error', onError(ws, observers));
+
+	const commPoint: RawDuplex<Envelope> = {
+		subscribe: obs => observers.add(obs),
+		postMessage(env: Envelope): void {
+			if ((ws as any).bufferedAmount > MAX_TXT_BUFFER) {
+				const exc: WSException = {
+					runtimeException: true,
+					type: 'websocket',
+					socketSlow: true
+				};
+				throw exc;
+			}
+			ws.send(JSON.stringify(env));
+		}
+	};
+	return commPoint;
+}
+
+/**
+ * This generates an on-message callback for text messages in a web socket.
+ * @param ws 
+ * @param observers 
+ */
+function onTxtMessage(ws: WebSocket, observers: MultiObserverWrap<Envelope>):
+		(data: any) => void {
+	return (data: any): void => {
+		if (typeof data !== 'string') { return; }
+		if (observers.done) { return; }
+		
+		let env: Envelope;
+		try {
+			env = JSON.parse(data);
+		} catch (err) {
+			ws.close();
+			observers.error(err);
+			return;
+		}
+
+		observers.next(env);
+	};
+}
+
+/**
+ * This generates an on-close callback for a web socket.
+ * @param observers 
+ */
+function onClose(observers: MultiObserverWrap<any>): () => void {
+	return () => observers.complete();
+}
+
+/**
+ * This generates an on-error callback for a web socket.
+ * @param ws 
+ * @param observers 
+ */
+function onError(ws: WebSocket, observers: MultiObserverWrap<any>):
+		((err: any) => void) {
+	return (err?: any): void => {
+		observers.error(err);
+		ws.close();
+	};
+}
+
+export function makeSubscriber(ws: WebSocket, ipcChannel: string|undefined):
+		SubscribingClient {
+	const comm = makeJsonCommPoint(ws);
+	return makeSubscribingClient(ipcChannel, comm);
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/json-equal.ts

@@ -0,0 +1,55 @@
+/*
+ Copyright (C) 2015 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * This module provides hex encoding of binary array into a string.
+ */
+
+export function deepEqual(a: any, b: any): boolean {
+	
+	const t = typeof a;
+	
+	if (t !== typeof b) { return false; }
+	
+	if (t !== 'object') {
+		return (a === b);
+	}
+	
+	if (a === b) { return true; }
+	if ((a === null) || (b === null)) { return false; }
+		
+	if (Array.isArray(a)) {
+		if (!Array.isArray(b)) { return false; }
+		const aArr = <Array<any>> a;
+		const bArr = <Array<any>> b;
+		if (aArr.length !== bArr.length) { return false; }
+		for (let i=0; i<aArr.length; i+=1) {
+			if (!deepEqual(aArr[i], bArr[i])) { return false; }
+		}
+	} else {
+		const keys = Object.keys(a);
+		if (keys.length !== Object.keys(b).length) { return false; }
+		for (let i=0; i<keys.length; i+=1) {
+			const key = keys[i];
+			if (!deepEqual(a[key], b[key])) { return false; }
+		}
+	}
+	
+	return true;
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/json-utils.ts

@@ -0,0 +1,130 @@
+/*
+ Copyright (C) 2016 - 2018 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+
+/**
+ * This function creates a copy of json entity with a caveat that Buffer and
+ * byte arrays are shared between original and a copy.
+ * @param orig is an object, which copy is created. Buffer and byte arrays
+ * passed through like primitives.
+ * @param excludeTopFields is an optional list of fields to exclude from copy.
+ */
+export function copy<T>(orig: T, excludeTopFields?: string[]): T {
+	const origType = typeof orig;
+	if (origType !== 'object') {
+		return ((origType !== 'function') ? orig : (undefined as any));
+	}
+	if (orig === null) { return (null as any); }
+	if (Buffer.isBuffer(orig)) { return (orig as any); }
+	if (ArrayBuffer.isView(orig)) { return (orig as any); }
+	if (Array.isArray(orig)) {
+		const arr: any[] = orig;
+		const c: any[] = [];
+		for (let i=0; i < arr.length; i+=1) {
+			c[i] = copy(arr[i]);
+		}
+		return (c as any);
+	} else {
+		const c = ({} as T);
+		const fields = Object.keys(orig!);
+		if (excludeTopFields) {
+			for (const f of fields) {
+				if (excludeTopFields.includes(f)) { continue; }
+				c[f] = copy<any>(orig![f]);
+			}
+		} else {
+			for (const f of fields) {
+				c[f] = copy<any>(orig![f]);
+			}
+		}
+		return c;
+	}
+}
+
+export function deepEqual(a: any, b: any): boolean {
+	
+	const t = typeof a;
+	
+	if (t !== typeof b) { return false; }
+	
+	if (t !== 'object') {
+		return (a === b);
+	}
+	
+	if (a === b) { return true; }
+	if ((a === null) || (b === null)) { return false; }
+		
+	if (Array.isArray(a)) {
+		if (!Array.isArray(b)) { return false; }
+		const aArr = <Array<any>> a;
+		const bArr = <Array<any>> b;
+		if (aArr.length !== bArr.length) { return false; }
+		for (let i=0; i<aArr.length; i+=1) {
+			if (!deepEqual(aArr[i], bArr[i])) { return false; }
+		}
+	} else {
+		const keys = Object.keys(a);
+		if (keys.length !== Object.keys(b).length) { return false; }
+		for (let i=0; i<keys.length; i+=1) {
+			const key = keys[i];
+			if (!deepEqual(a[key], b[key])) { return false; }
+		}
+	}
+	
+	return true;
+}
+
+export function* deepFind(a: any, predicate: (val: any) => boolean):
+		IterableIterator<{ pos: string[]; val: any; }> {
+	if ((typeof a !== 'object') || !a) {
+		if (predicate(a)) {
+			yield { pos: [], val: a };
+		}
+		return;
+	}
+
+	for (const field in a) {
+		const val = a[field];
+		if (predicate(val)) {
+			yield { pos: [ field ], val };
+		} else {
+			for (const inner of deepFind(val, predicate)) {
+				inner.pos.unshift(field);
+				yield inner;
+			}
+		}
+	}
+}
+
+/**
+ * This function applies given changes to object.
+ * @param json is an object that is being changed
+ * @param changes is a set of changes to apply to an object. Undefined value in
+ * in a fields means that respective field should be deleted from an object.
+ */
+export function applyChangesToJSON<T>(json: T, changes: Partial<T>): void {
+	for (const f of Object.keys(changes)) {
+		const newValue = changes[f as keyof T];
+		if (newValue === undefined) {
+			delete json[f];
+		} else {
+			json[f] = newValue;
+		}
+	}
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/jwkeys.ts

@@ -0,0 +1,246 @@
+/*
+ Copyright (C) 2015 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * This module defines json form of keys and signed objects.
+ */
+
+import { utf8, base64 } from "./buffer-utils";
+
+export interface JsonKeyShort {
+	/**
+	 * This is a base64 representation of key's bytes.
+	 */
+	k: string;
+	/**
+	 * This is key's id.
+	 */
+	kid: string;
+}
+
+export interface JsonKey extends JsonKeyShort {
+	/**
+	 * This field is indicates application's use of this key, for example,
+	 * "private-mail-key". Notice that it has noting to do with crypto 
+	 * primitives, and everything to do with how key should be used by
+	 *  applications, that should check this field, so as to guard against
+	 *  miss-use of key material. Such strictness makes key reuse (bad security
+	 *  design) difficult. 
+	 */
+	use: string;
+	/**
+	 * This field indicates which crypto-box high level function should be used
+	 * with this key, for example, "NaCl-xsp-box". Notice that, unlike initial
+	 * JWK standard, alg is not for naming crypto primitive, because you,
+	 * developer, should use complete functionality, like that provided by NaCl,
+	 * and you should not be dealing with crypto primitives. Crypto primitives
+	 * are for libs, that should be written by cryptographers. If cryptographer
+	 * gives you only primitives, it is the same as car dealer giving you parts
+	 * for the car instead of an actual car. Your would call dealer's bullshit,
+	 * and you must call cryptographer's one as well. They, cryptographer, in a
+	 * 2nd decade of the 21st centure have no excuse to give us, developers,
+	 * incomplete libs with mere crypto primitives, which hurt, when assembled
+	 * incorrectly.
+	 */
+	alg: string;
+}
+
+export function isLikeJsonKey(jkey: JsonKey): boolean {
+	return (('object' === typeof jkey) && !!jkey &&
+		('string' === typeof jkey.alg) && !!jkey.alg &&
+		('string' === typeof jkey.kid) && !!jkey.kid &&
+		('string' === typeof jkey.k) && !!jkey.k &&
+		('string' === typeof jkey.kid && !!jkey.kid));
+}
+
+export interface Key {
+	/**
+	 * This is key's bytes.
+	 */
+	k: Uint8Array;
+	/**
+	 * This is key's id.
+	 */
+	kid: string;
+	/**
+	 * This field is indicates application's use of this key, for example,
+	 * "private-mail-key". Notice that it has noting to do with crypto 
+	 * primitives, and everything to do with how key should be used by
+	 *  applications, that should check this field, so as to guard against
+	 *  miss-use of key material. Such strictness makes key reuse (bad security
+	 *  design) difficult. 
+	 */
+	use: string;
+	/**
+	 * This field indicates which crypto-box high level function should be used
+	 * with this key, for example, "NaCl-xsp-box". Notice that, unlike initial
+	 * JWK standard, alg is not for naming crypto primitive, because you,
+	 * developer, should use complete functionality, like that provided by NaCl,
+	 * and you should not be dealing with crypto primitives. Crypto primitives
+	 * are for libs, that should be written by cryptographers. If cryptographer
+	 * gives you only primitives, it is the same as car dealer giving you parts
+	 * for the car instead of an actual car. Your would call dealer's bullshit,
+	 * and you must call cryptographer's one as well. They, cryptographer, in a
+	 * 2nd decade of the 21st centure have no excuse to give us, developers,
+	 * incomplete libs with mere crypto primitives, which hurt, when assembled
+	 * incorrectly.
+	 */
+	alg: string;
+}
+
+export interface SignedLoad {
+	/**
+	 * This is an id of a key that did the signature.
+	 */
+	alg: string;
+	/**
+	 * This is a function, used to make signature.
+	 */
+	kid: string;
+	/**
+	 * This is signature bytes, packed into base64 string.
+	 */
+	sig: string;
+	/**
+	 * This is bytes (packed into base64 string), on which signature was done.
+	 */
+	load: string;
+}
+
+export function isLikeSignedLoad(load: SignedLoad): boolean {
+	return (('object' === typeof load) && !!load &&
+			('string' === typeof load.alg) && !!load.alg &&
+			('string' === typeof load.kid) && !!load.kid &&
+			('string' === typeof load.sig) && !!load.sig &&
+			('string' === typeof load.load && !!load.load));
+}
+
+export interface KeyCert {
+	cert: {
+		publicKey: JsonKey;
+		principal: { address: string };
+	};
+	issuer: string;
+	issuedAt: number;
+	expiresAt: number;
+}
+
+export function isLikeKeyCert(cert: KeyCert): boolean {
+	return (('object' === typeof cert) && !!cert &&
+			('number' === typeof cert.expiresAt) &&
+			('number' === typeof cert.issuedAt) &&
+			(cert.expiresAt > cert.issuedAt) &&
+			('string' === typeof cert.issuer) && !!cert.issuer &&
+			('object' === typeof cert.cert) && !!cert.cert &&
+			('object' === typeof cert.cert.principal) &&
+			!!cert.cert.principal &&
+			('string' === typeof cert.cert.principal.address) &&
+			!!cert.cert.principal.address &&
+			isLikeJsonKey(cert.cert.publicKey));
+}
+
+export function isLikeSignedKeyCert(load: SignedLoad): boolean {
+	if (!isLikeSignedLoad(load)) { return false; }
+	try {
+		return isLikeKeyCert(JSON.parse(utf8.open(base64.open(load.load))));
+	} catch (e) {
+		return false;
+	}
+}
+
+export function keyFromJson(key: JsonKey,
+		use: string, alg: string, klen: number): Key {
+	if (key.use === use) {
+		if (key.alg === alg) {
+			const bytes = base64.open(key.k);
+			if (bytes.length !== klen) { throw new Error(
+					"Key "+key.kid+" has a wrong number of bytes"); }
+			return {
+				use: key.use,
+				alg: key.alg,
+				kid: key.kid,
+				k: bytes
+			};
+		} else {
+			throw new Error("Key "+key.kid+
+					", should be used with unsupported algorithm '"+
+					key.alg+"'");
+		}
+	} else {
+		throw new Error("Key "+key.kid+" has incorrect use '"+key.use+
+				"', instead of '"+use+"'");
+	}
+}
+
+export function keyToJson(key: Key): JsonKey {
+	return {
+		use: key.use,
+		alg: key.alg,
+		kid: key.kid,
+		k: base64.pack(key.k)
+	}
+}
+
+export function getKeyCert(signedCert: SignedLoad): KeyCert {
+	return JSON.parse(utf8.open(base64.open(signedCert.load)));
+}
+
+export function getPubKey(signedCert: SignedLoad): JsonKey {
+	return getKeyCert(signedCert).cert.publicKey;
+}
+
+export function getPrincipalAddress(signedCert: SignedLoad): string {
+	return getKeyCert(signedCert).cert.principal.address;
+}
+
+export module use {
+	
+	export const MID_PKLOGIN = 'login-pub-key';
+	
+}
+Object.freeze(use);
+
+export interface MailerIdAssertionLoad {
+	user: string;
+	rpDomain: string;
+	sessionId: string;
+	issuedAt: number;
+	expiresAt: number;
+}
+
+export function isLikeMailerIdAssertion(
+		assertLoad: MailerIdAssertionLoad): boolean {
+	return (('object' === typeof assertLoad) && !!assertLoad &&
+		('string' === typeof assertLoad.user) && !!assertLoad.user &&
+		('string' === typeof assertLoad.rpDomain) && !!assertLoad.rpDomain &&
+		('string' === typeof assertLoad.sessionId) && !!assertLoad.sessionId &&
+		('number' === typeof assertLoad.expiresAt) &&
+		('number' === typeof assertLoad.issuedAt) &&
+		(assertLoad.expiresAt > assertLoad.issuedAt));
+}
+
+export function isLikeSignedMailerIdAssertion(load: SignedLoad): boolean {
+	if (!isLikeSignedLoad(load)) { return false; }
+	try {
+		return isLikeMailerIdAssertion(
+			JSON.parse(utf8.open(base64.open(load.load))));
+	} catch (e) {
+		return false;
+	}
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/map-of-sets.ts

@@ -0,0 +1,60 @@
+/*
+ Copyright (C) 2017 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+export class MapOfSets<TKey, TValue> {
+	
+	private map = new Map<TKey, Set<TValue>>();
+
+	constructor() {
+		Object.freeze(this);
+	}
+
+	get(key: TKey): Set<TValue> | undefined {
+		return this.map.get(key);
+	}
+
+	add(key: TKey, value: TValue): void {
+		let set = this.map.get(key);
+		if (set === undefined) {
+			set = new Set<TValue>();
+			this.map.set(key, set);
+		}
+		set.add(value);
+	}
+
+	remove(key: TKey, value: TValue): void {
+		const set = this.map.get(key);
+		if (set === undefined) { return; }
+		set.delete(value);
+		if (set.size === 0) {
+			this.map.delete(key);
+		}
+	}
+
+	removeAll(key: TKey): void {
+		this.map.delete(key);
+	}
+
+	clear(): void {
+		this.map.clear();
+	}
+
+}
+Object.freeze(MapOfSets.prototype);
+Object.freeze(MapOfSets);
+
+Object.freeze(exports);