spec-3nweb-server 1.8.4 → 1.8.6

package/ts-code/lib-common/service-api/mailer-id/provisioning.ts

@@ -0,0 +1,64 @@
+/*
+ Copyright (C) 2015, 2019 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 defines request interfaces for MailerId certificate provisioning.
+ */
+
+import { JsonKey, SignedLoad } from '../../jwkeys';
+
+export namespace certify {
+	
+	export const URL_END = 'certify';
+	
+	export interface Request {
+		pkey: JsonKey;
+		duration: number;
+	}
+
+	export interface Reply {
+		userCert: SignedLoad;
+		provCert: SignedLoad;
+	}
+
+	export const SC = {
+		cryptoVerifFail: 403,
+		malformed: 400,
+		ok: 200
+	};
+	Object.freeze(SC);
+	
+}
+Object.freeze(certify);
+
+export namespace serviceRoot {
+
+	export interface Reply {
+		"current-cert": SignedLoad;
+		"previous-certs": SignedLoad[];
+		provisioning: string;
+	}
+
+	export const SC = {
+		ok: 200
+	};
+	Object.freeze(SC);
+
+}
+Object.freeze(serviceRoot);
+
+Object.freeze(exports);

package/ts-code/lib-common/service-api/mailer-id/root-route.ts

@@ -0,0 +1,25 @@
+/*
+ Copyright (C) 2025 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 { SignedLoad } from "../../jwkeys";
+
+
+export interface MailerIdRootRoute {
+	"current-cert": SignedLoad;
+	"previous-certs": SignedLoad[];
+	provisioning: string;
+}

package/ts-code/lib-common/service-api/pub-key-login.ts

@@ -0,0 +1,75 @@
+/*
+ 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 defines interfaces for public key login routes.
+ */
+
+export const ERR_SC = {
+	duplicate: 475,
+	malformed: 400
+};
+Object.freeze(ERR_SC);
+
+export namespace start {
+	
+	export const URL_END = 'start-login-exchange';
+
+	export interface Request {
+		userId: string;
+		kid?: string;
+	}
+
+	export interface Reply {
+		sessionId: string;
+		sessionKey: string;
+		serverPubKey: string;
+		keyDerivParams: any;
+	}
+
+	export interface RedirectReply {
+		redirect: string;
+	}
+
+	export const SC = {
+		unknownUser: 474,
+		redirect: 373,
+		ok: 200
+	};
+	Object.freeze(SC);
+
+}
+Object.freeze(start);
+
+export namespace complete {
+	
+	export const URL_END = 'complete-login-exchange';
+
+	export const SC = {
+		authFailed: 403,
+		ok: 200
+	};
+	Object.freeze(SC);
+	
+}
+Object.freeze(complete);
+
+export interface ErrorReply {
+	error: string;
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/service-api/web-socket-base.ts

@@ -0,0 +1,87 @@
+/*
+ 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 interface RequestEnvelope<T> {
+	type: 'request';
+	name: string;
+	count: number;
+	req: T;
+}
+
+export interface ReplyEnvelope<T> {
+	type: 'reply';
+	reqCount: number;
+	isInProgress?: boolean;
+	rep?: T;
+	err?: any;
+}
+
+export interface EventEnvelope<T> {
+	type: 'event';
+	eventChannel: string;
+	eventPayload: T;
+}
+
+export type Envelope = RequestEnvelope<any> | ReplyEnvelope<any> |
+	EventEnvelope<any>;
+
+export namespace events {
+
+	export const MISSED_EVENTS_CHANNEL = 'missed-events';
+
+	export const SUBSCRIBE_REQ_NAME = 'subscribe';
+	export const UNSUBSCRIBE_REQ_NAME = 'unsubscribe';
+
+	export function subscriptionRequest(act: 'subscribe'|'unsubscribe',
+			channel: string, reqCount: number): string {
+		const reply: RequestEnvelope<string> = {
+			type: 'request',
+			name: act,
+			count: reqCount,
+			req: channel
+		};
+		return JSON.stringify(reply);
+	}
+
+	export function subscriptionReply(reqCount: number, status: string): string {
+		const reply: ReplyEnvelope<string> = {
+			type: 'reply',
+			reqCount,
+			rep: status,
+		};
+		return JSON.stringify(reply);
+	}
+
+	export const SUBSCRIBE_SC = {
+		ok: 'ok',
+		unknownChannel: 'unknown-channel'
+	};
+	Object.freeze(SUBSCRIBE_SC);
+
+}
+Object.freeze(events);
+
+export function errorReplyTo(req: RequestEnvelope<any>, err: any): string {
+		const reply: ReplyEnvelope<any> = {
+		type: 'reply',
+		err,
+		reqCount: req.count
+	};
+	return JSON.stringify(reply);
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/session-encryptor.ts

@@ -0,0 +1,54 @@
+/*
+ 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 creates encryptor, which uses session key, established with PKL.
+ */
+
+import { secret_box as sbox } from 'ecma-nacl';
+import { utf8 } from './buffer-utils';
+
+export interface SessionEncryptor extends sbox.Encryptor, sbox.Decryptor {
+	openJSON(bytesWN: Uint8Array): any; 
+	packJSON(json: any): Uint8Array;
+}
+
+export function makeSessionEncryptor(key: Uint8Array, nextNonce: Uint8Array):
+		SessionEncryptor {
+	let encr = sbox.formatWN.makeEncryptor(key, nextNonce, 2);
+	let decr = sbox.formatWN.makeDecryptor(key);
+	return {
+		open: decr.open,
+		openJSON: (bytesWN: Uint8Array): any => {
+			return JSON.parse(utf8.open(decr.open(bytesWN)));
+		},
+		pack: encr.pack,
+		packJSON: (json: any): Uint8Array => {
+			return encr.pack(utf8.pack(JSON.stringify(json)));
+		},
+		getDelta: encr.getDelta,
+		destroy: (): void => {
+			if (!encr) { return; }
+			encr.destroy();
+			encr = (null as any);
+			decr.destroy();
+			decr = (null as any);
+		}
+	};
+}
+
+Object.freeze(exports);

package/ts-code/lib-common/time-window-cache.ts

@@ -0,0 +1,74 @@
+/*
+ Copyright (C) 2016 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 TimeWindowCache<TKey, TVal> {
+
+	private filling: Map<TKey, TVal> = new Map<TKey, TVal>();
+	private waiting: Map<TKey, TVal> = new Map<TKey, TVal>();
+	private interval: NodeJS.Timer|void;
+
+	constructor(periodMillis: number) {
+		this.interval = setInterval(
+			() => { this.dropAndRotate(); }, periodMillis);
+		this.interval.unref();
+		Object.seal(this);
+	}
+
+	private dropAndRotate(): void {
+		this.waiting.clear();
+		const b = this.waiting;
+		this.waiting = this.filling;
+		this.filling = b;
+	}
+
+	get(key: TKey): TVal | undefined {
+		let v = this.filling.get(key);
+		if (v !== undefined) { return v; }
+		v = this.waiting.get(key);
+		if (v !== undefined) {
+			this.filling.set(key, v);
+		}
+		return v
+	}
+
+	set(key: TKey, val: TVal): void {
+		this.filling.set(key, val);
+	}
+
+	delete(key: TKey): void {
+		this.filling.delete(key);
+		this.waiting.delete(key);
+	}
+
+	clear(): void {
+		this.filling.clear();
+		this.waiting.clear();
+	}
+
+	destroy() {
+		if (!this.interval) { return; }
+		clearInterval(this.interval);
+		this.interval = undefined;
+		this.filling = (undefined as any);
+		this.waiting = (undefined as any);
+	}
+
+}
+Object.freeze(TimeWindowCache.prototype);
+Object.freeze(TimeWindowCache);
+
+Object.freeze(exports);

package/ts-code/lib-common/transferable.d.ts

@@ -0,0 +1,30 @@
+/*
+ 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/>.
+*/
+
+/**
+ * This declaration space exists only for implementation code, hence, it is
+ * kept separately from definitions that are used by apps.
+ */
+declare namespace web3n.implementation {
+
+	type TransferableType = 'ByteSource' | 'ByteSink' | 'File' | 'FS' | 'SymLink';
+
+	interface Transferable {
+		$_transferrable_type_id_$: TransferableType;
+	}
+
+}

package/ts-code/lib-server/conf-util.ts

@@ -0,0 +1,35 @@
+/*
+ Copyright (C) 2015 - 2016 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/>.
+*/
+
+const mapAmountEndings = {
+		kb: 1 << 10,
+		mb: 1 << 20,
+		gb: 1 << 30
+};
+
+export function stringToNumOfBytes(size: string|number): number {
+	if ('number' === typeof size) { return (size as number); }
+	if ('string' !== typeof size) { throw new Error(
+			"Given argument 'size' must be either string, or number"); }
+	const parts = (size as string).match(/^(\d+(?:\.\d+)?) *(kb|mb|gb)$/);
+	if (parts === null) { throw new Error(`Bad size string is given: ${size}`); }
+	const n = parseFloat(parts[1]);
+	const type = parts[2];
+	return mapAmountEndings[type] * n;
+}
+
+Object.freeze(exports);

package/ts-code/lib-server/mid-access.ts

@@ -0,0 +1,45 @@
+/*
+ Copyright (C) 2024 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 { json as parseJSON } from './middleware/body-parsers';
+import { Factory as SessionsFactory, SessionParams } from './resources/sessions';
+import { startSession } from './routes/sessions/start';
+import { midLogin } from './routes/sessions/mid-auth';
+import { MidAuthorizer } from "./routes/sessions/mid-auth";
+import * as api from '../lib-common/service-api/mailer-id/login';
+import { Express } from 'express';
+
+export type AccountExists = (id: string) => Promise<boolean>;
+
+export function addMailerIdLoginRoutes(
+	app: Express, domain: string, urlPrefix: string,
+	sessions: SessionsFactory<SessionParams>,
+	accountExists: AccountExists, midAuthorizer: MidAuthorizer
+): void {
+
+	app.post(urlPrefix+api.startSession.URL_END,
+		sessions.checkSession(),
+		parseJSON('1kb'),
+		startSession(accountExists, sessions.generate)
+	);
+	app.post(urlPrefix+api.authSession.URL_END,
+		sessions.ensureOpenedSession(),
+		parseJSON('4kb'),
+		midLogin(domain, midAuthorizer)
+	);
+
+}