@prosopo/provider-mock 2.8.45 → 2.8.96

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prosopo/provider-mock",
-	"version": "2.8.45",
+	"version": "2.8.96",
 	"author": "PROSOPO LIMITED <info@prosopo.io>",
 	"license": "Apache-2.0",
 	"type": "module",
@@ -26,20 +26,21 @@
 		"bundle": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.config.ts --mode $NODE_ENV"
 	},
 	"dependencies": {
-		"@prosopo/api-express-router": "3.0.47",
-		"@prosopo/common": "3.1.28",
-		"@prosopo/database": "3.6.6",
-		"@prosopo/dotenv": "3.0.33",
-		"@prosopo/locale": "3.1.28",
-		"@prosopo/provider": "3.15.0",
-		"@prosopo/types": "3.8.0",
-		"@prosopo/types-database": "4.1.5",
+		"@prosopo/api-express-router": "3.1.17",
+		"@prosopo/common": "3.1.38",
+		"@prosopo/logger": "1.0.2",
+		"@prosopo/database": "3.13.7",
+		"@prosopo/dotenv": "3.0.43",
+		"@prosopo/locale": "3.2.4",
+		"@prosopo/provider": "4.7.1",
+		"@prosopo/types": "4.3.0",
+		"@prosopo/types-database": "4.8.0",
 		"cors": "2.8.5",
 		"express": "4.21.2",
 		"mongoose": "8.13.0"
 	},
 	"devDependencies": {
-		"@prosopo/config": "3.3.0",
+		"@prosopo/config": "3.3.1",
 		"@types/node": "22.10.2",
 		"@vitest/coverage-v8": "3.2.4",
 		"concurrently": "9.0.1",
@@ -53,7 +54,8 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+ssh://git@github.com/prosopo/provider.git"
+		"url": "git+https://github.com/prosopo/captcha.git",
+		"directory": "demos/provider-mock"
 	},
 	"bugs": {
 		"url": "https://github.com/prosopo/captcha/issues"

package/src/api.ts

@@ -0,0 +1,117 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { ProsopoApiError } from "@prosopo/common";
+import { getLogger } from "@prosopo/logger";
+import { getJA4 } from "@prosopo/provider";
+import {
+	ClientApiPaths,
+	VerifySolutionBody,
+	decodeProcaptchaOutput,
+} from "@prosopo/types";
+import type { VerifySolutionBodyTypeOutput } from "@prosopo/types";
+import express, { type Router } from "express";
+import { JA4Database } from "./db.js";
+
+/**
+ * Returns a router connected to the database which can interact with the Proposo protocol
+ *
+ * @return {Router} - A middleware router that can interact with the Prosopo protocol
+ */
+export function prosopoRouter(): Router {
+	const router = express.Router();
+	const db = new JA4Database(
+		process.env.MONGO_URL || "mongodb://localhost:27017",
+		process.env.MONGO_DBNAME || "client",
+		process.env.MONGO_AUTH_SOURCE || "admin",
+	);
+
+	/**
+	 * Verifies a user's solution as being approved or not
+	 *
+	 * @param {string} userAccount - Dapp User id
+	 * @param {string} commitmentId - The captcha solution to look up
+	 */
+	router.post(
+		ClientApiPaths.VerifyImageCaptchaSolutionDapp,
+		async (req, res, next) => {
+			let body: VerifySolutionBodyTypeOutput;
+			try {
+				body = VerifySolutionBody.parse(req.body);
+			} catch (err) {
+				return next(
+					new ProsopoApiError("CAPTCHA.PARSE_ERROR", {
+						context: { error: err, code: 400 },
+						logLevel: "info",
+					}),
+				);
+			}
+			try {
+				const { token } = body;
+				const { user, dapp, commitmentId } = decodeProcaptchaOutput(token);
+				const testCommitmentId = "0x123456789test";
+				const testAccount = "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY";
+				const testDapp = "5C4hrfjw9DjXZTzV3MwzrrAr9P1MJhSrvWGWqi1eSuyUpnhM";
+				let statusMessage = "API.USER_NOT_VERIFIED";
+				let approved = false;
+				if (
+					(user && user === testAccount) ||
+					(commitmentId && commitmentId === testCommitmentId) ||
+					(dapp && dapp === testDapp)
+				) {
+					approved = true;
+					statusMessage = "API.USER_VERIFIED";
+					return res.json({
+						status: req.t(statusMessage),
+						verified: approved,
+						commitmentId: testCommitmentId,
+					});
+				}
+
+				return res.json({
+					status: req.t(statusMessage),
+					verified: false,
+				});
+			} catch (err) {
+				return next(
+					new ProsopoApiError("API.UNKNOWN", {
+						context: { error: err, code: 500 },
+					}),
+				);
+			}
+		},
+	);
+
+	router.get("/test", async (req, res) => {
+		try {
+			const logger = getLogger("info", import.meta.url);
+			const ja4PlusFingerprint = await getJA4(req.headers, logger);
+			await db.connect();
+			await db.addOrUpdateJA4Record({
+				ja4_fingerprint: ja4PlusFingerprint.ja4PlusFingerprint,
+				user_agent_string: req.headers["user-agent"] || "",
+			});
+			await db.close();
+			return res.json({
+				ja4: ja4PlusFingerprint.ja4PlusFingerprint,
+				ua: req.headers["user-agent"],
+			});
+		} catch (e) {
+			console.error("Error parsing ClientHello:", e);
+			return res.status(500).send("Error parsing ClientHello.");
+		}
+	});
+
+	return router;
+}

package/src/db.ts

@@ -0,0 +1,141 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { ProsopoDBError } from "@prosopo/common";
+import { MongoDatabase } from "@prosopo/database";
+import type { Logger } from "@prosopo/logger";
+import type { Tables } from "@prosopo/types-database";
+import type mongoose from "mongoose";
+import { Schema } from "mongoose";
+
+enum TableNames {
+	ja4 = "ja4",
+}
+
+type JA4Data = {
+	application?: string;
+	library?: string;
+	device?: string;
+	os?: string;
+	user_agent_string: string;
+	certificate_authority?: string;
+	observation_count?: number;
+	verified?: boolean;
+	notes?: string;
+	ja4_fingerprint: string;
+	ja4_fingerprint_string?: string;
+	ja4s_fingerprint?: string;
+	ja4h_fingerprint?: string;
+	ja4x_fingerprint?: string;
+	ja4t_fingerprint?: string;
+	ja4ts_fingerprint?: string;
+	ja4tscan_fingerprint?: string;
+};
+
+type JA4Record = JA4Data & mongoose.Document;
+
+const JA4Schema = new Schema({
+	application: String,
+	library: String,
+	device: String,
+	os: String,
+	user_agent_string: String,
+	certificate_authority: String,
+	observation_count: { type: Number, default: 1 },
+	verified: { type: Boolean, default: false },
+	notes: { type: String, default: "" },
+	ja4_fingerprint: { type: String, required: true },
+	ja4_fingerprint_string: String,
+	ja4s_fingerprint: String,
+	ja4h_fingerprint: String,
+	ja4x_fingerprint: String,
+	ja4t_fingerprint: String,
+	ja4ts_fingerprint: String,
+	ja4tscan_fingerprint: String,
+});
+
+JA4Schema.index({ ja4_fingerprint: 1, user_agent_string: 1 }, { unique: true });
+
+const DATA_TABLES = [
+	{
+		collectionName: TableNames.ja4,
+		modelName: TableNames.ja4,
+		schema: JA4Schema,
+	},
+];
+
+export class JA4Database extends MongoDatabase {
+	tables: Tables<TableNames>;
+
+	constructor(
+		url: string,
+		dbname?: string,
+		authSource?: string,
+		logger?: Logger,
+	) {
+		super(url, dbname, authSource, logger);
+		this.tables = {} as Tables<TableNames>;
+	}
+
+	override async connect(): Promise<void> {
+		await super.connect();
+		DATA_TABLES.map(({ collectionName, modelName, schema }) => {
+			if (this.connection) {
+				this.tables[collectionName] = this.connection.model(modelName, schema);
+			}
+		});
+	}
+
+	getTables(): Tables<TableNames> {
+		if (!this.tables) {
+			throw new ProsopoDBError("DATABASE.TABLES_UNDEFINED", {
+				context: { failedFuncName: this.getTables.name },
+				logger: this.logger,
+			});
+		}
+		return this.tables;
+	}
+
+	async getJA4Records(): Promise<JA4Record[]> {
+		return this.tables.ja4.find<JA4Record>({});
+	}
+
+	async getJA4RecordByFingerprintAndUserAgent(
+		ja4Fingerprint: string,
+		userAgentString: string,
+	): Promise<JA4Record | null> {
+		return this.tables.ja4.findOne<JA4Record>({
+			ja4_fingerprint: ja4Fingerprint,
+			user_agent_string: userAgentString,
+		});
+	}
+
+	// add a ja4 record or update an existing one if the user agent string and ja4 fingerprint match, incrementing the observation count
+
+	async addOrUpdateJA4Record(ja4Record: JA4Data): Promise<JA4Record | null> {
+		const existingRecord = await this.getJA4RecordByFingerprintAndUserAgent(
+			ja4Record.ja4_fingerprint,
+			ja4Record.user_agent_string ? ja4Record.user_agent_string : "",
+		);
+		if (existingRecord) {
+			existingRecord.observation_count =
+				(existingRecord.observation_count || 0) + 1;
+			await existingRecord.save();
+			return existingRecord;
+		}
+		const newRecord = new this.tables.ja4(ja4Record);
+		await newRecord.save();
+		return newRecord;
+	}
+}

package/src/start.ts

@@ -0,0 +1,43 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { handleErrors } from "@prosopo/api-express-router";
+import { i18nMiddleware } from "@prosopo/locale";
+import { LogLevel, getLogger } from "@prosopo/logger";
+import cors from "cors";
+import express from "express";
+import { prosopoRouter } from "./api.js";
+const logger = getLogger(LogLevel.enum.info, "prosopo:provider-mock:start.ts");
+
+async function startApi() {
+	const apiApp = express();
+	const apiPort = "9229";
+
+	apiApp.use(cors());
+	apiApp.use(express.json());
+	apiApp.use(await i18nMiddleware({}));
+	apiApp.use(prosopoRouter());
+	apiApp.use(handleErrors);
+
+	apiApp.listen(apiPort, () => {
+		logger.info(() => ({
+			msg: `Prosopo app listening at http://localhost:${apiPort}`,
+		}));
+	});
+}
+
+startApi().catch((error) => {
+	logger.error(() => ({ err: error, msg: "Failed to start API" }));
+	process.exit(1);
+});

package/tsconfig.cjs.json

@@ -0,0 +1,41 @@
+{
+	"extends": "../../tsconfig.cjs.json",
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"module": "NodeNext"
+	},
+	"include": ["src", "src/**/*.json"],
+	"references": [
+		{
+			"path": "../../dev/config/tsconfig.cjs.json"
+		},
+		{
+			"path": "../../packages/api-express-router"
+		},
+		{
+			"path": "../../packages/common"
+		},
+		{
+			"path": "../../packages/logger"
+		},
+		{
+			"path": "../../packages/provider"
+		},
+		{
+			"path": "../../packages/types"
+		},
+		{
+			"path": "../../packages/database"
+		},
+		{
+			"path": "../../packages/dotenv"
+		},
+		{
+			"path": "../../packages/locale"
+		},
+		{
+			"path": "../../packages/types-database"
+		}
+	]
+}

package/tsconfig.json

@@ -0,0 +1,47 @@
+{
+	"extends": "../../tsconfig.esm.json",
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"module": "NodeNext"
+	},
+	"include": [
+		"src",
+		"src/**/*.json",
+		"src/**/*.ts",
+		"src/**/*.tsx",
+		"src/**/*.d.ts"
+	],
+	"references": [
+		{
+			"path": "../../dev/config/tsconfig.json"
+		},
+		{
+			"path": "../../packages/api-express-router"
+		},
+		{
+			"path": "../../packages/common"
+		},
+		{
+			"path": "../../packages/logger"
+		},
+		{
+			"path": "../../packages/provider"
+		},
+		{
+			"path": "../../packages/types"
+		},
+		{
+			"path": "../../packages/database"
+		},
+		{
+			"path": "../../packages/dotenv"
+		},
+		{
+			"path": "../../packages/locale"
+		},
+		{
+			"path": "../../packages/types-database"
+		}
+	]
+}