From de77762e51f55241cfdf957c8f9966f193bd2ee8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Iv=C3=A1n=20Ovejero?= <ivov.src@gmail.com>
Date: Thu, 1 Jun 2023 11:22:29 +0200
Subject: [PATCH] refactor: Add deprecation notice for basic auth and JWT auth
 (#6349)

---
 packages/cli/src/commands/BaseCommand.ts | 14 +++++++++++++-
 packages/cli/src/config/schema.ts        | 24 ++++++++++++------------
 packages/cli/src/constants.ts            |  3 +++
 3 files changed, 28 insertions(+), 13 deletions(-)

diff --git a/packages/cli/src/commands/BaseCommand.ts b/packages/cli/src/commands/BaseCommand.ts
index b8d8c5a322..15b8cb0bc2 100644
--- a/packages/cli/src/commands/BaseCommand.ts
+++ b/packages/cli/src/commands/BaseCommand.ts
@@ -9,7 +9,7 @@ import { getLogger } from '@/Logger';
 import config from '@/config';
 import * as Db from '@/Db';
 import * as CrashJournal from '@/CrashJournal';
-import { inTest } from '@/constants';
+import { USER_MANAGEMENT_DOCS_URL, inTest } from '@/constants';
 import { CredentialTypes } from '@/CredentialTypes';
 import { CredentialsOverwrites } from '@/CredentialsOverwrites';
 import { initErrorHandling } from '@/ErrorReporting';
@@ -83,6 +83,18 @@ export abstract class BaseCommand extends Command {
 			);
 		}
 
+		if (process.env.N8N_BASIC_AUTH_ACTIVE === 'true') {
+			LoggerProxy.warn(
+				`Basic auth has been deprecated and will be removed in a future version of n8n. For authentication, please consider User Management. To learn more: ${USER_MANAGEMENT_DOCS_URL}`,
+			);
+		}
+
+		if (process.env.N8N_JWT_AUTH_ACTIVE === 'true') {
+			LoggerProxy.warn(
+				`JWT auth has been deprecated and will be removed in a future version of n8n. For authentication, please consider User Management. To learn more: ${USER_MANAGEMENT_DOCS_URL}`,
+			);
+		}
+
 		this.instanceId = this.userSettings.instanceId ?? '';
 		await Container.get(PostHogClient).init(this.instanceId);
 		await Container.get(InternalHooks).init(this.instanceId);
diff --git a/packages/cli/src/config/schema.ts b/packages/cli/src/config/schema.ts
index 402f7353a7..cc323ac338 100644
--- a/packages/cli/src/config/schema.ts
+++ b/packages/cli/src/config/schema.ts
@@ -499,25 +499,25 @@ export const schema = {
 				format: 'Boolean',
 				default: false,
 				env: 'N8N_BASIC_AUTH_ACTIVE',
-				doc: 'If basic auth should be activated for editor and REST-API',
+				doc: '[DEPRECATED] If basic auth should be activated for editor and REST-API',
 			},
 			user: {
 				format: String,
 				default: '',
 				env: 'N8N_BASIC_AUTH_USER',
-				doc: 'The name of the basic auth user',
+				doc: '[DEPRECATED] The name of the basic auth user',
 			},
 			password: {
 				format: String,
 				default: '',
 				env: 'N8N_BASIC_AUTH_PASSWORD',
-				doc: 'The password of the basic auth user',
+				doc: '[DEPRECATED] The password of the basic auth user',
 			},
 			hash: {
 				format: 'Boolean',
 				default: false,
 				env: 'N8N_BASIC_AUTH_HASH',
-				doc: 'If password for basic auth is hashed',
+				doc: '[DEPRECATED] If password for basic auth is hashed',
 			},
 		},
 		jwtAuth: {
@@ -525,49 +525,49 @@ export const schema = {
 				format: 'Boolean',
 				default: false,
 				env: 'N8N_JWT_AUTH_ACTIVE',
-				doc: 'If JWT auth should be activated for editor and REST-API',
+				doc: '[DEPRECATED] If JWT auth should be activated for editor and REST-API',
 			},
 			jwtHeader: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_AUTH_HEADER',
-				doc: 'The request header containing a signed JWT',
+				doc: '[DEPRECATED] The request header containing a signed JWT',
 			},
 			jwtHeaderValuePrefix: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_AUTH_HEADER_VALUE_PREFIX',
-				doc: 'The request header value prefix to strip (optional)',
+				doc: '[DEPRECATED] The request header value prefix to strip (optional)',
 			},
 			jwksUri: {
 				format: String,
 				default: '',
 				env: 'N8N_JWKS_URI',
-				doc: 'The URI to fetch JWK Set for JWT authentication',
+				doc: '[DEPRECATED] The URI to fetch JWK Set for JWT authentication',
 			},
 			jwtIssuer: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_ISSUER',
-				doc: 'JWT issuer to expect (optional)',
+				doc: '[DEPRECATED] JWT issuer to expect (optional)',
 			},
 			jwtNamespace: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_NAMESPACE',
-				doc: 'JWT namespace to expect (optional)',
+				doc: '[DEPRECATED] JWT namespace to expect (optional)',
 			},
 			jwtAllowedTenantKey: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_ALLOWED_TENANT_KEY',
-				doc: 'JWT tenant key name to inspect within JWT namespace (optional)',
+				doc: '[DEPRECATED] JWT tenant key name to inspect within JWT namespace (optional)',
 			},
 			jwtAllowedTenant: {
 				format: String,
 				default: '',
 				env: 'N8N_JWT_ALLOWED_TENANT',
-				doc: 'JWT tenant to allow (optional)',
+				doc: '[DEPRECATED] JWT tenant to allow (optional)',
 			},
 		},
 	},
diff --git a/packages/cli/src/constants.ts b/packages/cli/src/constants.ts
index 049f103cc9..4bdfbfe2e2 100644
--- a/packages/cli/src/constants.ts
+++ b/packages/cli/src/constants.ts
@@ -87,3 +87,6 @@ export const enum LICENSE_QUOTAS {
 }
 
 export const CREDENTIAL_BLANKING_VALUE = '__n8n_BLANK_VALUE_e5362baf-c777-4d57-a609-6eaf1f9e87f6';
+
+export const USER_MANAGEMENT_DOCS_URL =
+	'https://docs.n8n.io/hosting/authentication/user-management-self-hosted';