mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: Add deprecation notice for basic auth and JWT auth (#6349)

Browse source
This commit is contained in:
Iván Ovejero 2023-06-01 11:22:29 +02:00 committed by GitHub
parent f7708c9159
commit de77762e51
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
packages/cli/src/commands/BaseCommand.ts
View file

@ -9,7 +9,7 @@ import { getLogger } from '@/Logger';
import config from '@/config'; import config from '@/config';
import * as Db from '@/Db'; import * as Db from '@/Db';
import * as CrashJournal from '@/CrashJournal'; import * as CrashJournal from '@/CrashJournal';
import { inTest } from '@/constants'; import { USER_MANAGEMENT_DOCS_URL, inTest } from '@/constants';
import { CredentialTypes } from '@/CredentialTypes'; import { CredentialTypes } from '@/CredentialTypes';
import { CredentialsOverwrites } from '@/CredentialsOverwrites'; import { CredentialsOverwrites } from '@/CredentialsOverwrites';
import { initErrorHandling } from '@/ErrorReporting'; 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 ?? ''; this.instanceId = this.userSettings.instanceId ?? '';
await Container.get(PostHogClient).init(this.instanceId); await Container.get(PostHogClient).init(this.instanceId);
await Container.get(InternalHooks).init(this.instanceId); await Container.get(InternalHooks).init(this.instanceId);

24
packages/cli/src/config/schema.ts
View file

@ -499,25 +499,25 @@ export const schema = {
format: 'Boolean', format: 'Boolean',
default: false, default: false,
env: 'N8N_BASIC_AUTH_ACTIVE', 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: { user: {
format: String, format: String,
default: '', default: '',
env: 'N8N_BASIC_AUTH_USER', env: 'N8N_BASIC_AUTH_USER',
doc: 'The name of the basic auth user', doc: '[DEPRECATED] The name of the basic auth user',
}, },
password: { password: {
format: String, format: String,
default: '', default: '',
env: 'N8N_BASIC_AUTH_PASSWORD', env: 'N8N_BASIC_AUTH_PASSWORD',
doc: 'The password of the basic auth user', doc: '[DEPRECATED] The password of the basic auth user',
}, },
hash: { hash: {
format: 'Boolean', format: 'Boolean',
default: false, default: false,
env: 'N8N_BASIC_AUTH_HASH', env: 'N8N_BASIC_AUTH_HASH',
doc: 'If password for basic auth is hashed', doc: '[DEPRECATED] If password for basic auth is hashed',
}, },
}, },
jwtAuth: { jwtAuth: {
@ -525,49 +525,49 @@ export const schema = {
format: 'Boolean', format: 'Boolean',
default: false, default: false,
env: 'N8N_JWT_AUTH_ACTIVE', 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: { jwtHeader: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_AUTH_HEADER', env: 'N8N_JWT_AUTH_HEADER',
doc: 'The request header containing a signed JWT', doc: '[DEPRECATED] The request header containing a signed JWT',
}, },
jwtHeaderValuePrefix: { jwtHeaderValuePrefix: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_AUTH_HEADER_VALUE_PREFIX', 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: { jwksUri: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWKS_URI', 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: { jwtIssuer: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_ISSUER', env: 'N8N_JWT_ISSUER',
doc: 'JWT issuer to expect (optional)', doc: '[DEPRECATED] JWT issuer to expect (optional)',
}, },
jwtNamespace: { jwtNamespace: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_NAMESPACE', env: 'N8N_JWT_NAMESPACE',
doc: 'JWT namespace to expect (optional)', doc: '[DEPRECATED] JWT namespace to expect (optional)',
}, },
jwtAllowedTenantKey: { jwtAllowedTenantKey: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_ALLOWED_TENANT_KEY', 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: { jwtAllowedTenant: {
format: String, format: String,
default: '', default: '',
env: 'N8N_JWT_ALLOWED_TENANT', env: 'N8N_JWT_ALLOWED_TENANT',
doc: 'JWT tenant to allow (optional)', doc: '[DEPRECATED] JWT tenant to allow (optional)',
}, },
}, },
}, },

3
packages/cli/src/constants.ts
View file

@ -87,3 +87,6 @@ export const enum LICENSE_QUOTAS {
} }
export const CREDENTIAL_BLANKING_VALUE = '__n8n_BLANK_VALUE_e5362baf-c777-4d57-a609-6eaf1f9e87f6'; 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';