spec-3nweb-server 1.8.5 → 1.8.7

package/push-to-github.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+
+PROJ_NAME="spec-server"
+ITEMS_TO_PUSH="ts-code packing .gitignore LICENSE package.json package-lock.json postinstall.js README.md tsconfig.json"
+
+GITHUB_REPO="https://github.com/3nsoft/${PROJ_NAME}.git"
+DIST_DIR="dist"
+
+branch=$1
+if [ -z "$branch" ]
+then
+	branch="master"
+fi
+
+function is_clean_from_wip {
+	local status="$(git status -s)"
+	if [ -n "$status" ]
+	then
+		echo "There are uncommited changes:"
+		echo "$status"
+		return 1;
+	else
+		return 0;
+	fi
+}
+
+function is_branch {
+	local check_out=$(git $branch | grep '*' | grep "$branch")
+	if [ -n "$check_out" ]
+	then
+		return 0;
+	else
+		return 1;
+	fi
+}
+
+function rm_all_in_git_dir {
+	for entity in $(ls -a)
+	do
+		case $entity in
+			.) ;;
+			..) ;;
+			.git) continue ;;
+			*) rm -rf $entity ;;
+		esac
+	done
+}
+
+function cp_items_push {
+	local src=$1
+	for entity in $ITEMS_TO_PUSH
+	do
+		cp -r $src/$entity ./
+	done
+}
+
+function update_content_from {
+	local src=$1
+	rm_all_in_git_dir || return 1
+	cp_items_push $src || return 1
+}
+
+function pull_from_github_and_enter_repo {
+	if [ -d $PROJ_NAME ]
+	then
+		cd $PROJ_NAME
+		echo "Pulling current state from GitHub:"
+		git pull
+		if [ ! is_branch ]
+		then
+			git checkout $branch
+		fi
+	else
+		echo "Cloning repository from GitHub:"
+		git clone $GITHUB_REPO
+		cd $PROJ_NAME
+	fi
+}
+
+is_clean_from_wip || exit 1
+
+if [ ! is_branch ]
+then
+	echo "Current git branch is not $branch"
+	exit 1
+fi
+
+init_dir="$(pwd)"
+if [ ! -d $DIST_DIR ]
+then
+	mkdir $DIST_DIR
+fi
+cd $DIST_DIR
+
+echo
+pull_from_github_and_enter_repo
+
+update_content_from $init_dir
+
+git add .
+git commit
+git push
+
+cd $init_dir
+rm -rf $DIST_DIR/$PROJ_NAME

package/ts-code/3nstorage/3nstorage-app.ts

@@ -0,0 +1,99 @@
+/*
+ Copyright (C) 2015 - 2016, 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 { makeFactory as makeUsersFactory, Factory as UsersFactory } from './resources/users';
+import { makeSessionFactory, SessionsFactory } from './resources/sessions';
+import { MidAuthorizer } from '../lib-server/routes/sessions/mid-auth';
+import { ErrLogger, makeErrHandler } from '../lib-server/middleware/error-handler';
+import { AppWithWSs } from '../lib-server/web-sockets/app';
+import { makeOwnerStorageApp, makeOwnerStorageForLocker } from './owner';
+import { makeSharedStorageApp } from './shared';
+import { StorageRootRoute } from '../lib-common/service-api/3nstorage/root-route';
+
+const PATHS = {
+	owner: '/owner/',
+	shared: '/shared/'
+};
+
+function setupStaticStorageEntryRoute(app: Express): void {
+
+	app.route('/')
+	.get((req, res) => {
+		let path = req.originalUrl;
+		if (path[path.length-1] !== '/') {
+			path = path+'/';
+		}
+		const json: StorageRootRoute = {
+			owner: path+PATHS.owner.substring(1),
+			shared: path+PATHS.shared.substring(1)
+		};
+		// the following implicitly sets content type application/json
+		res.status(200).json(json);
+	});
+
+}
+
+export function makeStorageApp(
+	dataFolder: string, domain: string, midAuthorizer: MidAuthorizer,
+	errLogger?: ErrLogger
+): AppWithWSs {
+
+	const app = new AppWithWSs();
+	const ownersSessions = makeSessionFactory(20*60);
+	const sharingSessions = makeSessionFactory(20*60);
+	const users = makeUsersFactory(dataFolder);
+
+	setupStaticStorageEntryRoute(app.http);
+
+	app.use(PATHS.owner,
+		makeOwnerStorageApp(domain, ownersSessions, users, midAuthorizer)
+	);
+
+	app.http.use(PATHS.shared,
+		makeSharedStorageApp(sharingSessions, users)
+	);
+
+	app.http.use(makeErrHandler(errLogger));
+
+	return app;
+}
+
+export function makeStorageAppForLocker(
+	users: UsersFactory,
+	ownersSessions: SessionsFactory, sharingSessions: SessionsFactory,
+	errLogger?: ErrLogger
+): AppWithWSs {
+
+	const app = new AppWithWSs();
+
+	setupStaticStorageEntryRoute(app.http);
+
+	app.use(PATHS.owner,
+		makeOwnerStorageForLocker(ownersSessions, users)
+	);
+
+	app.http.use(PATHS.shared,
+		makeSharedStorageApp(sharingSessions, users)
+	);
+
+	app.http.use(makeErrHandler(errLogger));
+
+	return app;
+}
+
+Object.freeze(exports);

package/ts-code/3nstorage/owner.ts

@@ -0,0 +1,178 @@
+/*
+ Copyright (C) 2015 - 2017, 2022, 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/>.
+*/
+
+/**
+ * This module gives a function that creates a mountable, or app.use()-able,
+ * express 3NStorage owners' application.
+ */
+
+import { Express } from 'express';
+import { json as parseJSON, emptyBody } from '../lib-server/middleware/body-parsers';
+import { UserSockets, AppWithWSs } from '../lib-server/web-sockets/app';
+import { ServerEvents } from '../lib-server/web-sockets/server-events';
+import { SessionsFactory } from './resources/sessions';
+import { Factory as UsersFactory } from './resources/users';
+import { MidAuthorizer } from '../lib-server/routes/sessions/mid-auth';
+import { closeSession } from '../lib-server/routes/sessions/close';
+import { sessionParams } from './routes/owner/session-params';
+import { getParam } from './routes/owner/param-getter';
+import { setParam } from './routes/owner/param-setter';
+import { cancelTransaction } from './routes/owner/cancel-trans';
+import { saveCurrentObj } from './routes/owner/put-current-obj';
+import { getCurrentObj } from './routes/owner/get-current-obj';
+import { getArchivedObjVersion } from './routes/owner/get-archived-obj-ver';
+import { deleteArchivedObjVer, deleteCurrentObjVer } from './routes/owner/delete-obj';
+import { archiveCurrentObjVersion } from './routes/owner/archive-obj-version';
+import { getObjStatus } from './routes/owner/get-obj-status';
+import * as api from '../lib-common/service-api/3nstorage/owner';
+import { addMailerIdLoginRoutes } from '../lib-server/mid-access';
+import { addPKLLoginRoutes } from '../lib-server/pkl-access';
+import { calcNaClBoxSharedKey } from '../lib-server/resources/server-key-for-pkl-challenge';
+
+const WS_PING_PERIOD_MILLIS = 2*60*1000;
+
+export function makeOwnerStorageApp(
+	domain: string, sessions: SessionsFactory, users: UsersFactory, midAuthorizer: MidAuthorizer
+): AppWithWSs {
+
+	const app = new AppWithWSs();
+
+	setHttpPart(app.http, domain, sessions, users, midAuthorizer);
+	setWSPart(app, sessions, users);
+
+	return app;
+}
+
+export function makeOwnerStorageForLocker(sessions: SessionsFactory, users: UsersFactory): AppWithWSs {
+
+	const app = new AppWithWSs();
+
+	// XXX WIP
+
+	// const setupLoginRoutes: SetupLoginRoutes = (
+	// 	app, urlPrefix
+	// ) => addPKLLoginRoutes(
+	// 	app, urlPrefix, getUserParamsAndKey, sessions, calcNaClBoxSharedKey
+	// );
+
+	// setHttpPart(app.http, setupLoginRoutes, sessions, users);
+	setWSPart(app, sessions, users);
+
+	return app;
+}
+
+function setWSPart(app: AppWithWSs, sessions: SessionsFactory, users: UsersFactory): void {
+	const sockets = new UserSockets(sessions.ensureAuthorizedSessionForSocketStart(), WS_PING_PERIOD_MILLIS);
+	
+	const storageEvents = new ServerEvents(
+		undefined, api.events.all, sockets.socketGetter
+	);
+	
+	// give events ipc to both ends
+	sockets.addSocketIPC(storageEvents);
+	users.setStorageEventsSink(storageEvents.eventsSink);
+
+	app.addWS(api.wsEventChannel.URL_END, sockets);
+}
+
+const MAX_CHUNK_SIZE = '0.5mb';
+
+function setHttpPart(
+	app: Express, domain: string, sessions: SessionsFactory, users: UsersFactory, midAuthorizer: MidAuthorizer
+): void {
+
+	app.disable('etag');
+
+	// Login
+	addMailerIdLoginRoutes(app, domain, '/'+api.midLogin.URL_PART, sessions, users.exists, midAuthorizer);
+
+	// *** Require authorized session for everything below ***
+	app.use(sessions.ensureAuthorizedSession());
+
+	app.post('/'+api.closeSession.URL_END,
+		emptyBody(),
+		closeSession()
+	);
+
+	// Session params
+	app.get('/'+api.sessionParams.URL_END,
+		sessionParams(MAX_CHUNK_SIZE)
+	);
+
+	// Key derivation params
+	app.route('/'+api.keyDerivParams.URL_END)
+	.get(getParam(users.getKeyDerivParams))
+	.put(parseJSON('1kb'),
+		setParam(users.setKeyDerivParams)
+	);
+
+	// Transaction canceling
+	app.post('/'+api.cancelTransaction.EXPRESS_URL_END,
+		emptyBody(),
+		cancelTransaction(false, users.cancelTransaction)
+	);
+	app.post('/'+api.cancelRootTransaction.EXPRESS_URL_END,
+		emptyBody(),
+		cancelTransaction(true, users.cancelTransaction)
+	);
+
+	// Getting and updating current root object
+	app.route('/'+api.currentRootObj.EXPRESS_URL_END)
+	.get(getCurrentObj(true, users.getCurrentRootObj))
+	.put(saveCurrentObj(true, users.saveNewRootVersion, MAX_CHUNK_SIZE));
+
+	// Getting, updating and removing current non-root objects
+	app.route('/'+api.currentObj.EXPRESS_URL_END)
+	.get(getCurrentObj(false, users.getCurrentObj))
+	.delete(deleteCurrentObjVer(users.deleteCurrentObjVersion))
+	.put(saveCurrentObj(false, users.saveNewObjVersion, MAX_CHUNK_SIZE));
+
+	// Getting root archived versions
+	app.route('/'+api.archivedRootVersion.EXPRESS_URL_END)
+	.get(getArchivedObjVersion(true, users.getArchivedRootVersion));
+
+	// Getting non-root object archived versions
+	app.route('/'+api.archivedObjVersion.EXPRESS_URL_END)
+	.get(getArchivedObjVersion(false, users.getArchivedObjVersion));
+
+	// Archive root's current version
+	app.route('/'+api.archiveRoot.EXPRESS_URL_END)
+	.post(emptyBody(),
+		archiveCurrentObjVersion(true, users.archiveObjVersion)
+	)
+	.delete(deleteArchivedObjVer(true, users.deleteArchivedObjVersion));
+
+	// Archive non-root object's current version
+	app.route('/'+api.archiveObj.EXPRESS_URL_END)
+	.post(emptyBody(),
+		archiveCurrentObjVersion(false, users.archiveObjVersion)
+	)
+	.delete(deleteArchivedObjVer(false, users.deleteArchivedObjVersion));
+
+	// Getting root object status
+	app.get('/'+api.rootStatus.EXPRESS_URL_END,
+		getObjStatus(true, users.getObjStatus)
+	);
+
+	// Getting object status
+	app.get('/'+api.objStatus.EXPRESS_URL_END,
+		getObjStatus(false, users.getObjStatus)
+	);
+
+}
+
+Object.freeze(exports);

package/ts-code/3nstorage/resources/sessions.ts

@@ -0,0 +1,37 @@
+/*
+ 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 { InMemorySessions } from '../../lib-server/resources/mem-backed-sessions-factory';
+import { Request as Req, SessionParams, Factory } from '../../lib-server/resources/sessions';
+
+export type SessionsFactory = Factory<SessionParams>;
+export type Request = Req<SessionParams>;
+
+function makeSessionParams(): SessionParams {
+	return { userId: (undefined as any) };
+}
+
+/**
+ * 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
+ */
+export function makeSessionFactory(timeout: number): SessionsFactory {
+	return InMemorySessions.factory<SessionParams>(timeout, makeSessionParams);
+}
+
+Object.freeze(exports);