feat(core): Add license support to n8n (#4566)

* add sdk * add license manager * type fix * add basic func * store to db * update default * activate license * add sharing flag * fix setup * clear license * update conosle log to info * refactor * use npm dependency * update error logs * add simple test * add license tests * update tests * update pnpm package * fix error handling types * Update packages/cli/src/config/schema.ts Co-authored-by: Cornelius Suermann <cornelius@n8n.io> * make feature enum * add warning * update sdk * Update packages/cli/src/config/schema.ts Co-authored-by: Cornelius Suermann <cornelius@n8n.io> Co-authored-by: Cornelius Suermann <cornelius@n8n.io>
2025-12-18 02:21:13 +00:00 · 2022-11-21 15:41:24 +01:00
parent a9bdc0bbfe
commit 30e5d3d04c
9 changed files with 328 additions and 2 deletions
--- a/packages/cli/src/License.ts
+++ b/packages/cli/src/License.ts
@@ -0,0 +1,121 @@
+import { LicenseManager, TLicenseContainerStr } from '@n8n_io/license-sdk';
+import { ILogger } from 'n8n-workflow';
+import { getLogger } from './Logger';
+import config from '@/config';
+import * as Db from '@/Db';
+import { LICENSE_FEATURES, SETTINGS_LICENSE_CERT_KEY } from './constants';
+
+async function loadCertStr(): Promise<TLicenseContainerStr> {
+	const databaseSettings = await Db.collections.Settings.findOne({
+		where: {
+			key: SETTINGS_LICENSE_CERT_KEY,
+		},
+	});
+
+	return databaseSettings?.value ?? '';
+}
+
+async function saveCertStr(value: TLicenseContainerStr): Promise<void> {
+	await Db.collections.Settings.upsert(
+		{
+			key: SETTINGS_LICENSE_CERT_KEY,
+			value,
+			loadOnStartup: false,
+		},
+		['key'],
+	);
+}
+
+export class License {
+	private logger: ILogger;
+
+	private manager: LicenseManager | undefined;
+
+	constructor() {
+		this.logger = getLogger();
+	}
+
+	async init(instanceId: string, version: string) {
+		if (this.manager) {
+			return;
+		}
+
+		const server = config.getEnv('license.serverUrl');
+		const autoRenewEnabled = config.getEnv('license.autoRenewEnabled');
+		const autoRenewOffset = config.getEnv('license.autoRenewOffset');
+
+		try {
+			this.manager = new LicenseManager({
+				server,
+				tenantId: 1,
+				productIdentifier: `n8n-${version}`,
+				autoRenewEnabled,
+				autoRenewOffset,
+				logger: this.logger,
+				loadCertStr,
+				saveCertStr,
+				deviceFingerprint: () => instanceId,
+			});
+
+			await this.manager.initialize();
+		} catch (e: unknown) {
+			if (e instanceof Error) {
+				this.logger.error('Could not initialize license manager sdk', e);
+			}
+		}
+	}
+
+	async activate(activationKey: string): Promise<void> {
+		if (!this.manager) {
+			return;
+		}
+
+		if (this.manager.isValid()) {
+			return;
+		}
+
+		try {
+			await this.manager.activate(activationKey);
+		} catch (e) {
+			if (e instanceof Error) {
+				this.logger.error('Could not activate license', e);
+			}
+		}
+	}
+
+	async renew() {
+		if (!this.manager) {
+			return;
+		}
+
+		try {
+			await this.manager.renew();
+		} catch (e) {
+			if (e instanceof Error) {
+				this.logger.error('Could not renew license', e);
+			}
+		}
+	}
+
+	isFeatureEnabled(feature: string): boolean {
+		if (!this.manager) {
+			return false;
+		}
+
+		return this.manager.hasFeatureEnabled(feature);
+	}
+
+	isSharingEnabled() {
+		return this.isFeatureEnabled(LICENSE_FEATURES.SHARING);
+	}
+}
+
+let licenseInstance: License | undefined;
+
+export function getLicense(): License {
+	if (licenseInstance === undefined) {
+		licenseInstance = new License();
+	}
+
+	return licenseInstance;
+}