spec-3nweb-server 1.8.5 → 1.8.7

package/ts-code/asmail/asmail-app.ts

@@ -0,0 +1,91 @@
+/*
+ Copyright (C) 2015 - 2017, 2020, 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 { Express } from 'express';
+import { AppWithWSs } from '../lib-server/web-sockets/app';
+import { DeliverySessions } from './resources/delivery-sessions';
+import { makeSessionFactory } from './resources/sessions';
+import { makeRecipients } from './resources/recipients';
+import { MidAuthorizer } from '../lib-server/routes/sessions/mid-auth';
+import { ErrLogger, makeErrHandler } from '../lib-server/middleware/error-handler';
+import { makeApp as makeConfApp } from './config';
+import { makeApp as makeDeliveryApp } from './delivery';
+import { makeApp as makeRetrievalApp } from './retrieval';
+import { ASMailRootRoute } from '../lib-common/service-api/asmail/root-route';
+
+const PATHS = {
+	delivery: '/delivery/',
+	retrieval: '/retrieval/',
+	config: '/config/'
+};
+
+function setupStaticEntryRoute(app: Express): void {
+	
+	app.route('/')
+	.get((req, res) => {
+		let path = req.originalUrl;
+		if (path[path.length-1] !== '/') {
+			path = path+'/';
+		}
+		const json: ASMailRootRoute = {
+			delivery: path+PATHS.delivery.substring(1),
+			retrieval: path+PATHS.retrieval.substring(1),
+			config: path+PATHS.config.substring(1)
+		};
+		// the following implicitly sets content type application/json
+		res.status(200).json(json);
+	});
+	
+}
+
+export function makeASMailApp(
+	rootFolder: string, domain: string, midAuthorizer: MidAuthorizer,
+	errLogger?: ErrLogger
+): AppWithWSs {
+	
+	const app = new AppWithWSs();
+	const mailDeliverySessions = DeliverySessions.make(5*60);
+	const recipientsSessions = makeSessionFactory(10*60);
+	const userSettingSessions = makeSessionFactory(10*60);
+	const recipients = makeRecipients(rootFolder);
+	
+	setupStaticEntryRoute(app.http);
+	
+	app.http.use(PATHS.delivery,
+		makeDeliveryApp(
+			domain, mailDeliverySessions, recipients.delivery, midAuthorizer
+		)
+	);
+	
+	app.use(PATHS.retrieval,
+		makeRetrievalApp(
+			domain, recipientsSessions, recipients.retrieval, midAuthorizer
+		)
+	);
+	
+	app.http.use(PATHS.config,
+		makeConfApp(
+			domain, userSettingSessions, recipients.config, midAuthorizer
+		)
+	);
+	
+	app.http.use(makeErrHandler(errLogger));
+	
+	return app;
+}
+
+Object.freeze(exports);

package/ts-code/asmail/config.ts

@@ -0,0 +1,96 @@
+/*
+ Copyright (C) 2015 - 2016, 2024 - 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 * as express from 'express';
+import { json as parseJSON, emptyBody } from '../lib-server/middleware/body-parsers';
+import { SessionsFactory } from './resources/sessions';
+import { ASMailServiceConfig } from './resources/recipients';
+import { MidAuthorizer } from '../lib-server/routes/sessions/mid-auth';
+import { closeSession } from '../lib-server/routes/sessions/close';
+import { getParam } from './routes/config/param-getter';
+import { setParam } from './routes/config/param-setter';
+import * as api from '../lib-common/service-api/asmail/config';
+import { addMailerIdLoginRoutes } from '../lib-server/mid-access';
+
+export function makeApp(
+	domain: string, sessions: SessionsFactory, recipients: ASMailServiceConfig,
+	midAuthorizer: MidAuthorizer
+): express.Express {
+
+	const app = express();
+	app.disable('etag');
+
+	// Login
+	addMailerIdLoginRoutes(
+		app, domain, '/'+api.midLogin.URL_PART,
+		sessions, recipients.exists, midAuthorizer
+	);
+
+	// *** Require authorized session for everything below ***
+	app.use(sessions.ensureAuthorizedSession());
+
+	app.post('/'+api.closeSession.URL_END,
+		emptyBody(),
+		closeSession()
+	);
+
+	app.route('/'+api.p.initPubKey.URL_END)
+	.get(getParam(recipients.getPubKey))
+	.put(parseJSON('4kb', true),
+		setParam(recipients.setPubKey)
+	);
+
+	app.route('/'+api.p.anonSenderPolicy.URL_END)
+	.get(getParam(recipients.getAnonSenderPolicy))
+	.put(parseJSON('40kb'),
+		setParam(recipients.setAnonSenderPolicy)
+	);
+
+	app.route('/'+api.p.anonSenderInvites.URL_END)
+	.get(getParam(recipients.getAnonSenderInvites))
+	.put(parseJSON('40kb'),
+		setParam(recipients.setAnonSenderInvites)
+	);
+
+	app.route('/'+api.p.authSenderPolicy.URL_END)
+	.get(getParam(recipients.getAuthSenderPolicy))
+	.put(parseJSON('4kb'),
+		setParam(recipients.setAuthSenderPolicy)
+	);
+
+	app.route('/'+api.p.authSenderInvites.URL_END)
+	.get(getParam(recipients.getAuthSenderInvites))
+	.put(parseJSON('40kb'),
+		setParam(recipients.setAuthSenderInvites)
+	);
+
+	app.route('/'+api.p.authSenderWhitelist.URL_END)
+	.get(getParam(recipients.getAuthSenderWhitelist))
+	.put(parseJSON('40kb'),
+		setParam(recipients.setAuthSenderWhitelist)
+	);
+
+	app.route('/'+api.p.authSenderBlacklist.URL_END)
+	.get(getParam(recipients.getAuthSenderBlacklist))
+	.put(parseJSON('40kb'),
+		setParam(recipients.setAuthSenderBlacklist)
+	);
+
+	return app;
+}
+
+Object.freeze(exports);

package/ts-code/asmail/delivery.ts

@@ -0,0 +1,94 @@
+/*
+ Copyright (C) 2015 - 2017, 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 * as express from 'express';
+import { json as parseJSON, emptyBody } from '../lib-server/middleware/body-parsers';
+import { SessionsFactory } from './resources/delivery-sessions';
+import { MsgDelivery } from './resources/recipients';
+import { startSession } from './routes/delivery/start-session';
+import { preFlight } from './routes/delivery/pre-flight';
+import { restartSession } from './routes/delivery/restart-session';
+import { IMidAuthorizer, authorize } from './routes/delivery/sender-authorization';
+import { getRecipientPubKey } from './routes/delivery/provide-recipient-pubkey';
+import { saveMetadata } from './routes/delivery/put-metadata';
+import { saveMsgObj } from './routes/delivery/put-obj';
+import { finalizeDelivery } from './routes/delivery/finalize-delivery';
+
+import * as api from '../lib-common/service-api/asmail/delivery';
+
+const MAX_CHUNK_SIZE = '0.5mb';
+
+export function makeApp(
+	domain: string, sessions: SessionsFactory, recipients: MsgDelivery,
+	midAuthorizer: IMidAuthorizer
+): express.Express {
+
+	const app = express();
+	app.disable('etag');
+
+	app.post('/'+api.sessionStart.URL_END,
+		sessions.checkSession(),
+		parseJSON('1kb'),
+		startSession(recipients.allowedMaxMsgSize, sessions.generate)
+	);
+
+	app.post('/'+api.preFlight.URL_END,
+		sessions.checkSession(),
+		parseJSON('1kb'),
+		preFlight(recipients.allowedMaxMsgSize)
+	);
+
+	app.post('/'+api.sessionRestart.URL_END,
+		sessions.checkSession(),
+		parseJSON('1kb'),
+		restartSession(
+			sessions.generate, sessions.getSessionForMsg,
+			recipients.incompleteMsgDeliveryParams, MAX_CHUNK_SIZE
+		)
+	);
+
+	app.post('/'+api.authSender.URL_END,
+		sessions.ensureOpenedSession(),
+		parseJSON('4kb'),
+		authorize(domain, midAuthorizer)
+	);
+
+	// *** Require authorized session for everything below ***
+	app.use(sessions.ensureAuthorizedSession());
+
+	app.get('/'+api.initPubKey.URL_END,
+		getRecipientPubKey(recipients.getPubKey)
+	);
+
+	app.put('/'+api.msgMeta.URL_END,
+		parseJSON('16kb'),
+		saveMetadata(recipients.setMsgStorage, MAX_CHUNK_SIZE)
+	);
+
+	app.put('/'+api.msgObj.EXPRESS_URL_END,
+		saveMsgObj(recipients.saveObj, MAX_CHUNK_SIZE)
+	);
+
+	app.post('/'+api.completion.URL_END,
+		emptyBody(),
+		finalizeDelivery(recipients.finalizeDelivery)
+	);
+
+	return app;
+}
+
+Object.freeze(exports);

package/ts-code/asmail/resources/delivery-sessions.ts

@@ -0,0 +1,118 @@
+/*
+ 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 module constructs memory-backed sessions factories.
+ */
+
+import { InMemorySessions } from '../../lib-server/resources/mem-backed-sessions-factory';
+import { Request as Req, Factory, Session, GenerateSession as GenSession, wrapFactory } from '../../lib-server/resources/sessions';
+
+export interface SessionParams {
+	recipient: string;
+	sender: string|undefined;
+	invite: string|undefined;
+	maxMsgLength: number;
+	currentMsgLength: number;
+	msgId: string;
+}
+
+export type Request = Req<SessionParams>;
+export type GenerateSession = GenSession<SessionParams>;
+export type GetSessionForMsg = (recipient: string, msgId: string) =>
+	Promise<Session<SessionParams>|undefined>;
+
+export interface SessionsFactory extends Factory<SessionParams> {
+	getSessionForMsg: GetSessionForMsg;
+}
+
+export class DeliverySessions extends InMemorySessions<SessionParams>
+		implements SessionsFactory {
+
+	/**
+	 * Keys of this map identify messages, and format is 'recipient:msgId'.
+	 * Values are respective session ids.
+	 */
+	private msgToSessionMap = new Map<string, string>();
+
+	private constructor(timeoutSecs: number) {
+		super(timeoutSecs, sessionId => this.makeSessionParams(sessionId));
+		Object.seal(this);
+	}
+
+	private makeSessionParams(sessionId: string): SessionParams {
+		const factory = this;
+		let msgId: string = (undefined as any);
+		const sParams: SessionParams = {
+			recipient: (undefined as any),
+			currentMsgLength: 0,
+			maxMsgLength: (undefined as any),
+			invite: undefined,
+			sender: undefined,
+			get msgId(): string {
+				return msgId;
+			},
+			set msgId(id: string) {
+				if (msgId) { throw new Error(`Message is is already set`); }
+				if (typeof sParams.recipient !== 'string') {
+					throw new Error(`Recipient should be set in session before setting message id`); }
+				msgId = id;
+				factory.msgToSessionMap.set(
+					`${sParams.recipient}:${msgId}`, sessionId);
+			}
+		};
+		return Object.seal(sParams);
+	}
+
+	protected async remove(s: Session<SessionParams>): Promise<void> {
+		await super.remove(s);
+		this.msgToSessionMap.delete(`${s.params.recipient}:${s.params.msgId}`);
+	}
+
+	async getSessionForMsg(
+		recipient: string, msgId: string
+	): Promise<Session<SessionParams>|undefined> {
+		const sessionId = this.msgToSessionMap.get(`${recipient}:${msgId}`);
+		if (sessionId) {
+			const session = await this.get(sessionId);
+			if (session) {
+				session.lastAccessedAt = Date.now();
+				return session;
+			} else {
+				console.warn(`Inconsistency in session factory state: session to msg mapping exists, while session doesn't exist.`);
+			}
+		}
+		return;
+	}
+
+	/**
+	 * This returns factory, that works properly in a single process application,
+	 * clearing up sessions that past given timeout.
+	 * @param timeout is a session timeout in seconds
+	 */
+	static make(timeout: number): SessionsFactory {
+		const factory = new DeliverySessions(timeout);
+		const wrap = wrapFactory(factory) as SessionsFactory;
+		wrap.getSessionForMsg = factory.getSessionForMsg.bind(factory);
+		return Object.freeze(wrap);
+	}
+
+}
+Object.freeze(DeliverySessions.prototype);
+Object.freeze(DeliverySessions);
+
+Object.freeze(exports);