nodebb-plugin-session-sharing 8.0.5 → 9.0.0

package/README.md

@@ -1,8 +1,8 @@
 # Session Sharing for NodeBB
 
 In a nutshell, this plugin allows you to share sessions between your application and NodeBB. You'll need to set a
-special cookie with a common domain, containing a JSON Web Token with user data. If sufficient, this plugin will
-handle the rest (user registration/login).
+special cookie with a common domain, containing a JSON Web Token (signed, or encrypted) with user data. If
+sufficient, this plugin will handle the rest (user registration/login).
 
 ## How is this related to SSO?
 
@@ -21,8 +21,8 @@ You can use this plugin and single sign-on plugins together, but they won't be s
 ## How does this work?
 
 This plugin checks incoming requests for a **shared cookie** that is saved by your application when a user
-logs in. This cookie contains in its value, a specially crafted signed token containing unique identifying
-information for that user.
+logs in. This cookie contains in its value, a specially crafted signed (JWS) or encrypted (JWE) token
+containing unique identifying information for that user.
 
 If the user can be found in NodeBB, that user will be logged in. If not, then a user is created, and that
 unique indentifier is saved for future reference.
@@ -36,10 +36,13 @@ to have a couple special attributes:
 * The `domain` should be set to the naked domain. That is, if your site is at `app.example.com`, and your
 forum is at `talk.example.com`, the cookie domain should be set to `example.com`.
 * The cookie name is up to you, and can be configured in this plugin's settings. *(Default: `token`)*
-* The cookie value is a [JSON Web Token](https://jwt.io/). See below.
+* The cookie value is a [JSON Web Token](https://jwt.io/) — signed (JWS) or encrypted (JWE). See below.
 
 ### Generating the JSON Web Token
 
+The steps below describe the default **JWS** format; if you've switched the plugin to **JWE**, see
+[Token Format (JWS / JWE)](#token-format-jws--jwe) instead.
+
 A list of compatible libraries can be obtained on the main website for [JSON Web Tokens](https://jwt.io/).
 
 You'll be encoding a payload that looks something like this...
@@ -87,14 +90,66 @@ it can properly decode and verify the JWT signature.
 
 In which case, you can set the "Parent Key" setting in this plugin to `d`.
 
+### Token Format (JWS / JWE)
+
+By default the shared cookie is a **JWS** (signed) JWT. The **Token Format** setting in the admin panel
+allows switching to **JWE** (encrypted) JWTs, in which case the payload is confidential and only decryptable
+with the corresponding key, so its contents are not visible in the cookie.
+
+This setting controls the format of tokens *generated* by NodeBB (the `nbb_token` reverse cookie and the
+development debug token). **Incoming cookies are auto-detected by their structure** (a JWS has 3
+dot-separated segments, a JWE has 5), so *both* formats are accepted regardless of the setting. This allows
+a gradual migration: flip the setting, then switch your application over to issuing JWE cookies at your own
+pace — users with cookies in either format will continue to log in throughout the transition.
+
+Tokens are created and verified with [`jose`](https://github.com/panva/jose). When issuing JWE cookies from
+your application, use the following parameters:
+
+| Signing method | `alg` | `enc` | Key |
+| --- | --- | --- | --- |
+| HMAC | `dir` | `A256GCM` | HKDF-derived from your shared secret (see below) |
+| RSA | `RSA-OAEP-256` | `A256GCM` | The RSA **public** key |
+
+**HMAC key derivation** — JWE's `dir` key method requires the key to be exactly 32 bytes, so
+arbitrary-length shared secrets cannot be used directly. NodeBB derives the JWE key with HKDF-SHA256:
+
+```
+HKDF(
+	ikm:	<your shared secret>,
+	salt:	"nodebb-plugin-session-sharing",
+	info:	"A256GCM",
+	length:	32
+)
+```
+
+Your application must perform the same derivation before encrypting. JWS is unaffected — `HS256` signing
+uses the raw secret as-is, so existing JWS setups keep working unchanged.
+
+**RSA key direction** — note that JWE inverts the key direction of JWS: your application *encrypts* with the
+RSA **public** key, and NodeBB *decrypts* with the RSA **private** key. If you use JWE with the RSA signing
+method, make sure the **RSA Private Key** is configured in the admin settings — without it, encrypted cookies
+cannot be decrypted (a warning is logged at startup).
+
+The `nbb_token` reverse cookie follows the same Token Format setting. If your application reads the reverse
+token, it must be able to decrypt JWE when this setting is enabled.
+
 ## Security
 
-Please note that according to the JWT spec, the payload itself is ***not encrypted***, only *signed*. That is,
+Please note that according to the JWT spec, a JWS payload is ***not encrypted***, only *signed*. That is,
 the Base64 Url Encoded payload is appended to the header. It can be decoded trivially (as base64 is not meant
-to be cryptographically secure), so **do not put any private information in the payload**. The header and
-payload themselves are *signed* against the secret, and NodeBB will only allow a JWT through if it has not been
-tampered with. That is, NodeBB will only continue with a login if the signature can be independently generated
-by the received payload and the secret.
+to be cryptographically secure), so **do not put any private information in the payload** of a JWS token. The
+header and payload themselves are *signed* against the secret, and NodeBB will only allow a JWT through if it
+has not been tampered with. That is, NodeBB will only continue with a login if the signature can be
+independently generated by the received payload and the secret.
+
+**Mitigating payload exposure with JWE** — if the exposure above is a concern for your setup (for example,
+your payload includes an `email` or `groups` you'd rather not be visible in a cookie, or you cannot guarantee
+HTTPS end-to-end), switch the **Token Format** setting to JWE (see
+[Token Format (JWS / JWE)](#token-format-jws--jwe)). A JWE token *encrypts* the payload — with `A256GCM` in
+this plugin — so the identifying information is not visible in the cookie at all, and can only be decrypted by
+NodeBB with the corresponding key. Note that JWE protects the payload's *confidentiality*; the token is still
+only as trustworthy as the key or secret it was sealed with, and a stolen private key (or shared secret) can
+still mint valid tokens — the rest of this section applies to both formats.
 
 Use secure cookies transmitted via HTTPS if at all possible.
 

package/eslint.config.mjs

@@ -6,5 +6,13 @@ import publicConfig from 'eslint-config-nodebb/public';
 export default [
 	...publicConfig,
 	...serverConfig,
+	{
+		files: ['library.js', 'lib/**/*.js'],
+		languageOptions: {
+			globals: {
+				nodebb: 'readonly',
+			},
+		},
+	},
 ];
 

package/library.js

@@ -4,9 +4,10 @@ const winston = nodebb.require('winston');
 const nconf = nodebb.require('nconf');
 
 const util = require('util');
+const crypto = require('crypto');
 
 const _ = require('lodash');
-const jwt = require('jsonwebtoken');
+const { jwtVerify, jwtDecrypt, SignJWT, EncryptJWT } = require('jose');
 
 const meta = nodebb.require('./src/meta');
 const user = nodebb.require('./src/user');
@@ -47,6 +48,10 @@ const plugin = {
 		cookieName: 'token',
 		cookieDomain: undefined,
 		secret: '',
+		signingMethod: 'hmac',
+		tokenFormat: 'jws',
+		publicKey: '',
+		privateKey: '',
 		behaviour: 'trust',
 		adminRevalidate: 'off',
 		noRegistration: 'off',
@@ -136,8 +141,93 @@ plugin.getUser = async (remoteId) => {
 	return user.getUserFields(uid, ['username', 'userslug', 'picture']);
 };
 
+/*
+ * JWE with a symmetric key ("dir" key method) requires the key to be exactly
+ * the length of the content encryption key (32 bytes for A256GCM). Shared
+ * secrets are arbitrary-length, so derive a fixed-length key with HKDF.
+ * Apps issuing JWE cookies must perform the same derivation.
+ */
+const JWE_HKDF_SALT = 'nodebb-plugin-session-sharing';
+const JWE_HKDF_INFO = 'A256GCM';
+
+plugin.getJwsKey = (isPrivate) => {
+	if (plugin.settings.signingMethod === 'rsa') {
+		const pem = isPrivate ? plugin.settings.privateKey : plugin.settings.publicKey;
+		if (!pem) {
+			throw new Error(isPrivate ? 'No RSA private key configured' : 'No RSA public key configured');
+		}
+		// jose v6 expects a KeyObject, not a PEM string
+		return isPrivate ? crypto.createPrivateKey(pem) : crypto.createPublicKey(pem);
+	}
+	if (!plugin.settings.secret) {
+		throw new Error('No JWT secret configured');
+	}
+	return crypto.createSecretKey(plugin.settings.secret, 'utf8');
+};
+
+/*
+ * Note the key direction differs from JWS: JWE is encrypted with the public
+ * key and decrypted with the private key, so verifying an incoming JWE
+ * cookie requires the RSA private key.
+ */
+plugin.getJweKey = (isDecryption) => {
+	if (plugin.settings.signingMethod === 'rsa') {
+		return plugin.getJwsKey(isDecryption);
+	}
+	if (!plugin.settings.secret) {
+		throw new Error('No JWT secret configured');
+	}
+	// jose expects a Uint8Array (not a Node Buffer) for symmetric JWE keys
+	return new Uint8Array(crypto.hkdfSync('sha256', plugin.settings.secret, JWE_HKDF_SALT, JWE_HKDF_INFO, 32));
+};
+
+/*
+ * Verifies an incoming token, accepting both JWS (3 segments) and JWE
+ * (5 segments) so that installs can migrate between the two formats
+ * without a hard cutover. Key selection is driven by the configured
+ * signing method, not the token header.
+ */
+plugin.verifyToken = async (token) => {
+	if (typeof token !== 'string' || !token.length) {
+		throw new Error('payload-invalid');
+	}
+
+	const isJWE = token.split('.').length === 5;
+
+	try {
+		if (isJWE) {
+			const { payload } = await jwtDecrypt(token, plugin.getJweKey(true), {
+				algorithms: plugin.settings.signingMethod === 'rsa' ? ['RSA-OAEP-256'] : ['dir'],
+			});
+			return payload; // already JSON-parsed by jose
+		}
+
+		const { payload } = await jwtVerify(token, plugin.getJwsKey(false), {
+			algorithms: plugin.settings.signingMethod === 'rsa' ? ['RS256'] : ['HS256'],
+		});
+		return payload;
+	} catch (error) {
+		throw new Error('payload-invalid', { cause: error });
+	}
+};
+
+/* Creates a JWS or JWE token according to the configured token format */
+plugin.createToken = async (payload) => {
+	if (plugin.settings.tokenFormat === 'jwe') {
+		const encrypted = new EncryptJWT(payload).setProtectedHeader(
+			plugin.settings.signingMethod === 'rsa' ? { alg: 'RSA-OAEP-256', enc: 'A256GCM' } : { alg: 'dir', enc: 'A256GCM' }
+		);
+		return encrypted.encrypt(plugin.getJweKey(false));
+	}
+
+	const signed = new SignJWT(payload).setProtectedHeader({
+		alg: plugin.settings.signingMethod === 'rsa' ? 'RS256' : 'HS256',
+	});
+	return signed.sign(plugin.getJwsKey(true));
+};
+
 plugin.process = async (token) => {
-	const payload = await jwt.verify(token, plugin.settings.secret, { algorithms: ['HS256'] });
+	const payload = await plugin.verifyToken(token);
 	const userData = await plugin.normalizePayload(payload);
 	const [uid, isNewUser] = await plugin.findOrCreateUser(userData);
 	await plugin.updateUserProfile(uid, userData, isNewUser);
@@ -386,10 +476,15 @@ plugin.addMiddleware = async function ({ req, res }) {
 	const { hostWhitelist, guestRedirect, editOverride, loginOverride, registerOverride } = await meta.settings.get('session-sharing');
 
 	if (hostWhitelist) {
+		const hostHeader = req.headers.host;
+		if (!hostHeader) {
+			return;
+		}
+
 		const hosts = hostWhitelist.split(',') || [hostWhitelist];
 		let whitelisted = false;
 		for (const host of hosts) {
-			if (req.headers.host.includes(host)) {
+			if (hostHeader.includes(host)) {
 				whitelisted = true;
 				break;
 			}
@@ -521,13 +616,11 @@ plugin.addMiddleware = async function ({ req, res }) {
 };
 
 plugin.cleanup = async (data) => {
-	if (plugin.settings.cookieDomain) {
-		winston.verbose('[session-sharing] Clearing cookie');
-		data.res.clearCookie(plugin.settings.cookieName, {
-			domain: plugin.settings.cookieDomain,
-			path: '/',
-		});
-	}
+	winston.verbose('[session-sharing] Clearing cookie');
+	data.res.clearCookie(plugin.settings.cookieName, {
+		domain: plugin.settings.cookieDomain,
+		path: '/',
+	});
 
 	data.res.clearCookie('nbb_token', {
 		domain: plugin.settings.cookieDomain,
@@ -537,7 +630,7 @@ plugin.cleanup = async (data) => {
 	return true;
 };
 
-plugin.generate = function (req, res) {
+plugin.generate = async function (req, res) {
 	if (!plugin.ready) {
 		return res.sendStatus(404);
 	}
@@ -563,7 +656,7 @@ plugin.generate = function (req, res) {
 		payload = newPayload;
 	}
 
-	const token = jwt.sign(payload, plugin.settings.secret);
+	const token = await plugin.createToken(payload);
 	res.cookie(plugin.settings.cookieName, token, {
 		maxAge: 1000 * 60 * 60 * 24 * 21,
 		httpOnly: true,
@@ -590,10 +683,24 @@ plugin.reloadSettings = async (data) => {
 	}
 
 	const settings = await meta.settings.get('session-sharing');
-	if (!settings.hasOwnProperty('secret') || !settings.secret.length) {
+	const signingMethod = settings.signingMethod || 'hmac';
+	const tokenFormat = settings.tokenFormat || 'jws';
+	if (tokenFormat !== 'jws' && tokenFormat !== 'jwe') {
+		winston.error('[session-sharing] Invalid token format ("' + tokenFormat + '"), session sharing disabled.');
+		return;
+	}
+	if (signingMethod === 'rsa') {
+		if (!settings.publicKey || !settings.publicKey.length) {
+			winston.error('[session-sharing] RSA public key not found, session sharing disabled.');
+			return;
+		}
+	} else if (!settings.hasOwnProperty('secret') || !settings.secret.length) {
 		winston.error('[session-sharing] JWT Secret not found, session sharing disabled.');
 		return;
 	}
+	if (signingMethod === 'rsa' && (!settings.privateKey || !settings.privateKey.length)) {
+		winston.warn('[session-sharing] RSA private key not configured; JWE (encrypted) cookies cannot be decrypted and reverse tokens cannot be signed.');
+	}
 
 	// If "payload:parent" is found, but payloadParent is not, update the latter and delete the former
 	if (!settings.payloadParent && settings['payload:parent']) {
@@ -636,7 +743,7 @@ plugin.saveReverseToken = async ({ req, userData: data }) => {
 	const { res } = req;
 	const userData = await user.getUserFields(data.uid, ['uid', 'username', 'picture', 'reputation', 'postcount', 'banned']);
 	userData.groups = (await groups.getUserGroups([data.uid])).pop();
-	const token = jwt.sign(userData, plugin.settings.secret);
+	const token = await plugin.createToken(userData);
 
 	res.cookie('nbb_token', token, {
 		maxAge: meta.getSessionTTLSeconds() * 1000,

package/package-lock.json

@@ -1,17 +1,17 @@
 {
   "name": "nodebb-plugin-session-sharing",
-  "version": "8.0.5",
+  "version": "9.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "nodebb-plugin-session-sharing",
-      "version": "8.0.5",
+      "version": "9.0.0",
       "license": "MIT",
       "dependencies": {
         "@commitlint/cli": "^9.1.2",
         "async": "^3",
-        "jsonwebtoken": "^8.5.1",
+        "jose": "^6.0.0",
         "lint-staged": "^10.0.9",
         "lodash": "^4.17.14"
       },
@@ -749,11 +749,6 @@
         "node": ">=8"
       }
     },
-    "node_modules/buffer-equal-constant-time": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz",
-      "integrity": "sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA=="
-    },
     "node_modules/caller-callsite": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/caller-callsite/-/caller-callsite-2.0.0.tgz",
@@ -1162,14 +1157,6 @@
         "safer-buffer": "^2.1.0"
       }
     },
-    "node_modules/ecdsa-sig-formatter": {
-      "version": "1.0.11",
-      "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz",
-      "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==",
-      "dependencies": {
-        "safe-buffer": "^5.0.1"
-      }
-    },
     "node_modules/emoji-regex": {
       "version": "8.0.0",
       "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
@@ -2283,6 +2270,15 @@
       "integrity": "sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g==",
       "dev": true
     },
+    "node_modules/jose": {
+      "version": "6.2.12",
+      "resolved": "https://registry.npmjs.org/jose/-/jose-6.2.12.tgz",
+      "integrity": "sha512-9NiFmJEex0sy2Dk58j2UGBSHgUs2ypF9eZSu4L6vjOX3Dp96Sw1F3uL+H+D1sx02jZZdzUT0HgvCy59CuvXcWw==",
+      "license": "MIT",
+      "funding": {
+        "url": "https://github.com/sponsors/panva"
+      }
+    },
     "node_modules/js-tokens": {
       "version": "4.0.0",
       "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
@@ -2371,35 +2367,6 @@
         "node": "*"
       }
     },
-    "node_modules/jsonwebtoken": {
-      "version": "8.5.1",
-      "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-8.5.1.tgz",
-      "integrity": "sha512-XjwVfRS6jTMsqYs0EsuJ4LGxXV14zQybNd4L2r0UvbVnSF9Af8x7p5MzbJ90Ioz/9TI41/hTCvznF/loiSzn8w==",
-      "dependencies": {
-        "jws": "^3.2.2",
-        "lodash.includes": "^4.3.0",
-        "lodash.isboolean": "^3.0.3",
-        "lodash.isinteger": "^4.0.4",
-        "lodash.isnumber": "^3.0.3",
-        "lodash.isplainobject": "^4.0.6",
-        "lodash.isstring": "^4.0.1",
-        "lodash.once": "^4.0.0",
-        "ms": "^2.1.1",
-        "semver": "^5.6.0"
-      },
-      "engines": {
-        "node": ">=4",
-        "npm": ">=1.4.28"
-      }
-    },
-    "node_modules/jsonwebtoken/node_modules/semver": {
-      "version": "5.7.2",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz",
-      "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==",
-      "bin": {
-        "semver": "bin/semver"
-      }
-    },
     "node_modules/jsprim": {
       "version": "1.4.2",
       "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.2.tgz",
@@ -2415,25 +2382,6 @@
         "node": ">=0.6.0"
       }
     },
-    "node_modules/jwa": {
-      "version": "1.4.2",
-      "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.2.tgz",
-      "integrity": "sha512-eeH5JO+21J78qMvTIDdBXidBd6nG2kZjg5Ohz/1fpa28Z4CcsWUzJ1ZZyFq/3z3N17aZy+ZuBoHljASbL1WfOw==",
-      "dependencies": {
-        "buffer-equal-constant-time": "^1.0.1",
-        "ecdsa-sig-formatter": "1.0.11",
-        "safe-buffer": "^5.0.1"
-      }
-    },
-    "node_modules/jws": {
-      "version": "3.2.2",
-      "resolved": "https://registry.npmjs.org/jws/-/jws-3.2.2.tgz",
-      "integrity": "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==",
-      "dependencies": {
-        "jwa": "^1.4.1",
-        "safe-buffer": "^5.0.1"
-      }
-    },
     "node_modules/keyv": {
       "version": "4.5.4",
       "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz",
@@ -2622,41 +2570,6 @@
       "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
       "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
     },
-    "node_modules/lodash.includes": {
-      "version": "4.3.0",
-      "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz",
-      "integrity": "sha512-W3Bx6mdkRTGtlJISOvVD/lbqjTlPPUDTMnlXZFnVwi9NKJ6tiAk6LVdlhZMm17VZisqhKcgzpO5Wz91PCt5b0w=="
-    },
-    "node_modules/lodash.isboolean": {
-      "version": "3.0.3",
-      "resolved": "https://registry.npmjs.org/lodash.isboolean/-/lodash.isboolean-3.0.3.tgz",
-      "integrity": "sha512-Bz5mupy2SVbPHURB98VAcw+aHh4vRV5IPNhILUCsOzRmsTmSQ17jIuqopAentWoehktxGd9e/hbIXq980/1QJg=="
-    },
-    "node_modules/lodash.isinteger": {
-      "version": "4.0.4",
-      "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz",
-      "integrity": "sha512-DBwtEWN2caHQ9/imiNeEA5ys1JoRtRfY3d7V9wkqtbycnAmTvRRmbHKDV4a0EYc678/dia0jrte4tjYwVBaZUA=="
-    },
-    "node_modules/lodash.isnumber": {
-      "version": "3.0.3",
-      "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz",
-      "integrity": "sha512-QYqzpfwO3/CWf3XP+Z+tkQsfaLL/EnUlXWVkIk5FUPc4sBdTehEqZONuyRt2P67PXAk+NXmTBcc97zw9t1FQrw=="
-    },
-    "node_modules/lodash.isplainobject": {
-      "version": "4.0.6",
-      "resolved": "https://registry.npmjs.org/lodash.isplainobject/-/lodash.isplainobject-4.0.6.tgz",
-      "integrity": "sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA=="
-    },
-    "node_modules/lodash.isstring": {
-      "version": "4.0.1",
-      "resolved": "https://registry.npmjs.org/lodash.isstring/-/lodash.isstring-4.0.1.tgz",
-      "integrity": "sha512-0wJxfxH1wgO3GrbuP+dTTk7op+6L41QCXbGINEmD+ny/G/eCqGzxyCsh7159S+mgDDcoarnBw6PC1PS5+wUGgw=="
-    },
-    "node_modules/lodash.once": {
-      "version": "4.1.1",
-      "resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz",
-      "integrity": "sha512-Sb487aTOCr9drQVL8pIxOzVhafOjZN9UU54hiN8PU3uAiSV7lx1yYNpbNmex2PK6dSJoNTSJUUswT651yww3Mg=="
-    },
     "node_modules/log-symbols": {
       "version": "4.1.0",
       "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz",
@@ -2852,7 +2765,8 @@
     "node_modules/ms": {
       "version": "2.1.3",
       "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
-      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
+      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
+      "dev": true
     },
     "node_modules/natural-compare": {
       "version": "1.4.0",
@@ -3500,6 +3414,7 @@
       "version": "5.2.1",
       "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
       "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
+      "dev": true,
       "funding": [
         {
           "type": "github",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-session-sharing",
-  "version": "8.0.5",
+  "version": "9.0.0",
   "description": "Allows login sessions from your app to persist in NodeBB",
   "main": "library.js",
   "repository": {
@@ -41,7 +41,7 @@
   "dependencies": {
     "@commitlint/cli": "^9.1.2",
     "async": "^3",
-    "jsonwebtoken": "^8.5.1",
+    "jose": "^6.0.0",
     "lint-staged": "^10.0.9",
     "lodash": "^4.17.14"
   },

package/static/lib/admin.js

@@ -4,7 +4,10 @@ define('admin/plugins/session-sharing', ['settings'], function (Settings) {
 	const ACP = {};
 
 	ACP.init = function () {
-		Settings.load('session-sharing', $('.session-sharing-settings'));
+		// Settings.load is async: only toggle field visibility once the saved
+		// signingMethod value has been populated into the form.
+		Settings.load('session-sharing', $('.session-sharing-settings'), ACP.toggleSigningFields);
+		$('#signingMethod').on('change', ACP.toggleSigningFields);
 
 		$('#save').on('click', function () {
 			Settings.save('session-sharing', $('.session-sharing-settings'));
@@ -14,6 +17,19 @@ define('admin/plugins/session-sharing', ['settings'], function (Settings) {
 		$('#remote_search').on('keyup', ACP.findUserByRemoteId);
 	};
 
+	ACP.toggleSigningFields = function () {
+		const method = $('#signingMethod').val() || 'hmac';
+		if (method === 'rsa') {
+			$('#hmac-fields').hide();
+			$('#rsa-fields').show();
+			$('#rsa-sign-fields').show();
+		} else {
+			$('#hmac-fields').show();
+			$('#rsa-fields').hide();
+			$('#rsa-sign-fields').hide();
+		}
+	};
+
 	ACP.showUserId = function () {
 		if (ACP._searchDelay) {
 			clearTimeout(ACP._searchDelay);

package/static/templates/admin/plugins/session-sharing.tpl

@@ -25,6 +25,44 @@
 						</p>
 					</div>
 					<div class="mb-3">
+						<label class="form-label" for="hostWhitelist">Host Whitelist</label>
+						<input type="text" id="hostWhitelist" name="hostWhitelist" title="Host Whitelist" class="form-control" placeholder="localhost" />
+						<p class="form-text">
+							If set, session-sharing plugin works only on whitelisted domains. Separate with commas, for example: "localhost,test.domain.com".
+						</p>
+					</div>
+
+					<h5 class="fw-bold tracking-tight settings-header">Token Settings</h5>
+
+					<div class="mb-3">
+						<label class="form-label" for="signingMethod">Signing Method</label>
+						<select class="form-control" id="signingMethod" name="signingMethod">
+							<option value="hmac">HMAC (symmetric shared secret)</option>
+							<option value="rsa">RSA (asymmetric key pair)</option>
+						</select>
+						<p class="form-text">
+							HMAC uses a shared secret known to both parties. RSA uses an asymmetric key pair where only the
+							issuing server can sign, but any holder of the public key can verify.
+						</p>
+					</div>
+					<div class="mb-3">
+						<label class="form-label" for="tokenFormat">Token Format</label>
+						<select class="form-control" id="tokenFormat" name="tokenFormat">
+							<option value="jws">JWS (signed JWT)</option>
+							<option value="jwe">JWE (encrypted JWT)</option>
+						</select>
+						<p class="form-text">
+							JWS tokens are digitally signed: their payload is base64url-encoded and readable by anyone, but
+							tamper-proof. JWE tokens are encrypted: the payload is confidential and only decryptable with the
+							corresponding key. This setting controls the format of tokens <em>generated</em> by NodeBB (the
+							<code>nbb_token</code> reverse cookie and the development debug token).
+						</p>
+						<p class="form-text">
+							Incoming cookies are auto-detected, so <strong>both</strong> JWS and JWE tokens are accepted
+							regardless of this setting.
+						</p>
+					</div>
+					<div class="mb-3" id="hmac-fields">
 						<label class="form-label" for="secret">JWT Secret</label>
 						<input type="text" id="secret" name="secret" title="JWT Secret" class="form-control" />
 						<p class="form-text">
@@ -32,13 +70,20 @@
 							otherwise the JWT cannot be properly decoded.
 						</p>
 					</div>
-					<div class="mb-3">
-						<label class="form-label" for="hostWhitelist">Host Whitelist</label>
-						<input type="text" id="hostWhitelist" name="hostWhitelist" title="Host Whitelist" class="form-control" placeholder="localhost" />
+					<div class="mb-3" id="rsa-fields" style="display: none;">
+						<label class="form-label" for="publicKey">RSA Public Key</label>
+						<textarea id="publicKey" name="publicKey" title="RSA Public Key" class="form-control" rows="5" placeholder="-----BEGIN PUBLIC KEY-----&#10;...&#10;-----END PUBLIC KEY-----"></textarea>
 						<p class="form-text">
-							If set, session-sharing plugin works only on whitelisted domains. Separate with commas, for example: "localhost,test.domain.com".
+							The public key used to verify JWT signatures. This key is shared with clients so they can verify tokens.
 						</p>
 					</div>
+					<div class="mb-3" id="rsa-sign-fields" style="display: none;">
+						<label class="form-label" for="privateKey">RSA Private Key</label>
+						<textarea id="privateKey" name="privateKey" title="RSA Private Key" class="form-control" rows="5" placeholder="-----BEGIN PRIVATE KEY-----&#10;...&#10;-----END PRIVATE KEY-----"></textarea>
+						<p class="form-text">
+							The private key used to sign reverse tokens (if enabled), and to decrypt JWE (encrypted) cookies. Keep this secret — only the issuing server should have access to it.
+					</p>
+					</div>
 				</div>
 
 				<div class="mb-4">

package/test/index.js

@@ -6,6 +6,7 @@
 // Don't forget to add this plugin to `test_plugins` array in `config.json`
 
 const assert = require('assert');
+const crypto = require('crypto');
 const url = require('url');
 const util = require('util');
 const request = require('request-promise-native');
@@ -15,6 +16,17 @@ const db = nodebb.require('./test/mocks/databasemock');
 const nconf = nodebb.require('nconf');
 const meta = nodebb.require('./src/meta');
 
+/*
+ * meta.settings.setOne fires the `action:settings.set` hook without awaiting it,
+ * so the plugin's reloadSettings may still be running when setOne resolves.
+ * Awaiting reloadSettings directly keeps these tests deterministic.
+ * (Required lazily to avoid a circular dependency while mocha loads the suite.)
+ */
+const setSetting = async (key, value) => {
+	await meta.settings.setOne('session-sharing', key, value);
+	await require('../library').reloadSettings();
+};
+
 describe('nodebb-plugin-session-sharing', () => {
 	const userJar = request.jar();
 	const anonJar = request.jar();
@@ -30,7 +42,7 @@ describe('nodebb-plugin-session-sharing', () => {
 
 			assert.strictEqual(response.statusCode, 404);
 
-			await meta.settings.setOne('session-sharing', 'secret', 's3cr37c47');
+			await setSetting('secret', 's3cr37c47');
 		});
 
 		it('should generate a valid session when called', async () => {
@@ -76,12 +88,21 @@ describe('nodebb-plugin-session-sharing', () => {
 			});
 			assert.strictEqual(response.statusCode, 200);
 
+			// Core now initialises the guest session (CSRF token), so assert on the
+			// session contents: the guest must not have been logged in.
+			const getSession = util.promisify(db.sessionStore.get.bind(db.sessionStore));
 			const cookies = anonJar.getCookies(`${protocol}//${hostname}/`);
-			assert(cookies.every(cookie => cookie.key !== 'express.sid'));
+			const sidCookie = cookies.find(cookie => cookie.key === 'express.sid');
+			if (sidCookie) {
+				let sid = sidCookie.value.match(/s%3A([^.]+)/);
+				assert(sid && sid[1]);
+				const sessionObj = await getSession(sid[1]);
+				assert(!sessionObj || !sessionObj.passport || !sessionObj.passport.user);
+			}
 		});
 
 		it('should redirect a guest to a specified redirection target if configured', async () => {
-			await meta.settings.setOne('session-sharing', 'guestRedirect', 'https://example.org');
+			await setSetting('guestRedirect', 'https://example.org');
 			const response = await request(`${nconf.get('url')}`, {
 				resolveWithFullResponse: true,
 				jar: anonJar,
@@ -91,12 +112,12 @@ describe('nodebb-plugin-session-sharing', () => {
 
 			assert(response.statusCode, 302);
 			assert.strictEqual(response.headers.location, 'https://example.org');
-			await meta.settings.setOne('session-sharing', 'guestRedirect', '');
+			await setSetting('guestRedirect', '');
 		});
 
 		it('should maintain the login if behaviour is "revalidate"', async () => {
 			const getSession = util.promisify(db.sessionStore.get.bind(db.sessionStore));
-			await meta.settings.setOne('session-sharing', 'behaviour', 'revalidate');
+			await setSetting('behaviour', 'revalidate');
 
 			await request(`${nconf.get('url')}`, {
 				resolveWithFullResponse: true,
@@ -152,7 +173,7 @@ describe('nodebb-plugin-session-sharing', () => {
 
 	describe('login override', () => {
 		it('should redirect a guest to a specified login override if configured', async () => {
-			await meta.settings.setOne('session-sharing', 'loginOverride', 'https://example.org/login');
+			await setSetting('loginOverride', 'https://example.org/login');
 			const response = await request(`${nconf.get('url')}/login`, {
 				resolveWithFullResponse: true,
 				jar: anonJar,
@@ -167,7 +188,7 @@ describe('nodebb-plugin-session-sharing', () => {
 
 	describe('register override', () => {
 		it('should redirect a guest to a specified register override if configured', async () => {
-			await meta.settings.setOne('session-sharing', 'registerOverride', 'https://example.org/register');
+			await setSetting('registerOverride', 'https://example.org/register');
 			const response = await request(`${nconf.get('url')}/register`, {
 				resolveWithFullResponse: true,
 				jar: anonJar,
@@ -179,4 +200,93 @@ describe('nodebb-plugin-session-sharing', () => {
 			assert.strictEqual(response.headers.location, 'https://example.org/register');
 		});
 	});
+
+	describe('JWE token support', () => {
+		const getTokenCookie = (jar) => {
+			const cookies = jar.getCookies(`${protocol}//${hostname}/`);
+			return cookies.find(cookie => cookie.key === 'token');
+		};
+
+		const assertLoggedIn = async (jar) => {
+			const getSession = util.promisify(db.sessionStore.get.bind(db.sessionStore));
+			const response = await request(`${nconf.get('url')}`, {
+				resolveWithFullResponse: true,
+				jar,
+			});
+			assert.strictEqual(response.statusCode, 200);
+
+			const cookies = jar.getCookies(`${protocol}//${hostname}/`);
+			const sidCookie = cookies.find(cookie => cookie.key === 'express.sid');
+			assert(sidCookie);
+			const sid = sidCookie.value.match(/s%3A([^.]+)/)[1];
+			const sessionObj = await getSession(sid);
+
+			assert(sessionObj && sessionObj.passport && sessionObj.passport.user);
+			assert(parseInt(sessionObj.passport.user, 10) > 0);
+		};
+
+		it('should generate and accept an HMAC JWE token', async () => {
+			const jweJar = request.jar();
+			await setSetting('tokenFormat', 'jwe');
+
+			await request(`${nconf.get('url')}/debug/session`, { jar: jweJar });
+			const cookie = getTokenCookie(jweJar);
+			assert(cookie);
+			assert.strictEqual(cookie.value.split('.').length, 5);
+
+			await assertLoggedIn(jweJar);
+		});
+
+		it('should accept a JWS token even when tokenFormat is jwe (auto-detection)', async () => {
+			const jwsJar = request.jar();
+			await setSetting('tokenFormat', 'jws');
+
+			await request(`${nconf.get('url')}/debug/session`, { jar: jwsJar });
+			const cookie = getTokenCookie(jwsJar);
+			assert(cookie);
+			assert.strictEqual(cookie.value.split('.').length, 3);
+
+			await setSetting('tokenFormat', 'jwe');
+			await assertLoggedIn(jwsJar);
+		});
+
+		it('should generate and accept an RSA JWE token', async () => {
+			const { publicKey, privateKey } = crypto.generateKeyPairSync('rsa', { modulusLength: 2048 });
+			await setSetting('publicKey', publicKey.export({ type: 'spki', format: 'pem' }));
+			await setSetting('privateKey', privateKey.export({ type: 'pkcs8', format: 'pem' }));
+			await setSetting('signingMethod', 'rsa');
+			await setSetting('tokenFormat', 'jwe');
+
+			const rsaJar = request.jar();
+			await request(`${nconf.get('url')}/debug/session`, { jar: rsaJar });
+			const cookie = getTokenCookie(rsaJar);
+			assert(cookie);
+			assert.strictEqual(cookie.value.split('.').length, 5);
+
+			await assertLoggedIn(rsaJar);
+		});
+
+		it('should reject a JWE token decrypted with the wrong key', async () => {
+			const { EncryptJWT } = require('jose');
+			const wrongKey = new Uint8Array(crypto.hkdfSync('sha256', 'wrong-secret', 'nodebb-plugin-session-sharing', 'A256GCM', 32));
+			const token = await new EncryptJWT({ id: 99999, username: 'intruder' })
+				.setProtectedHeader({ alg: 'dir', enc: 'A256GCM' })
+				.encrypt(wrongKey);
+
+			const badJar = request.jar();
+			badJar.setCookie(`token=${token}`, `${protocol}//${hostname}/`);
+			const response = await request(`${nconf.get('url')}`, {
+				resolveWithFullResponse: true,
+				jar: badJar,
+				simple: false,
+			});
+
+			assert.strictEqual(response.statusCode, 500);
+		});
+
+		it('should restore default signing settings', async () => {
+			await setSetting('signingMethod', 'hmac');
+			await setSetting('tokenFormat', 'jws');
+		});
+	});
 });