import type { ICredentialsDb } from '@n8n/db'; import { CredentialsRepository } from '@n8n/db'; import { Command } from '@n8n/decorators'; import { Container } from '@n8n/di'; import fs from 'fs'; import { Credentials } from 'n8n-core'; import { UserError } from 'n8n-workflow'; import path from 'path'; import z from 'zod'; import { CredentialDescriptionsService } from '@/credentials/credential-descriptions.service'; import type { ICredentialsDecryptedDb } from '@/interfaces'; import { BaseCommand } from '../base-command'; import '../../zod-alias-support'; const flagsSchema = z.object({ all: z.boolean().describe('Export all credentials').optional(), backup: z .boolean() .describe( 'Sets --all --pretty --separate for simple backups. Only --output has to be set additionally.', ) .optional(), id: z.string().describe('The ID of the credential to export').optional(), projectId: z.string().describe('Export all credentials in the specified project').optional(), output: z .string() .alias('o') .describe('Output file name or directory if using separate files') .optional(), pretty: z.boolean().describe('Format the output in an easier to read fashion').optional(), separate: z .boolean() .describe( 'Exports one file per credential (useful for versioning). Must inform a directory via --output.', ) .optional(), decrypted: z .boolean() .describe( 'Exports data decrypted / in plain text. ALL SENSITIVE INFORMATION WILL BE VISIBLE IN THE FILES. Use to migrate from a installation to another that have a different secret key (in the config file).', ) .optional(), }); @Command({ name: 'export:credentials', description: 'Export credentials', examples: [ '--all', '--projectId=Ox8O54VQrmBrb4qL', '--id=5 --output=file.json', '--all --output=backups/latest.json', '--backup --output=backups/latest/', '--all --decrypted --output=backups/decrypted.json', ], flagsSchema, }) export class ExportCredentialsCommand extends BaseCommand> { // eslint-disable-next-line complexity async run() { const { flags } = this; if (flags.backup) { flags.all = true; flags.pretty = true; flags.separate = true; } const selectorCount = [flags.all, flags.id, flags.projectId].filter(Boolean).length; if (selectorCount === 0) { this.logger.info('One of "--all", "--id", or "--projectId" has to be set!'); return; } if (selectorCount > 1) { this.logger.info('Use exactly one of "--all", "--id", or "--projectId".'); return; } if (flags.separate) { try { if (!flags.output) { this.logger.info( 'You must inform an output directory via --output when using --separate', ); return; } if (fs.existsSync(flags.output)) { if (!fs.lstatSync(flags.output).isDirectory()) { this.logger.info('The parameter --output must be a directory'); return; } } else { fs.mkdirSync(flags.output, { recursive: true }); } } catch (e) { this.logger.error( 'Aborting execution as a filesystem error has been encountered while creating the output directory. See log messages for details.', ); this.logger.error('\nFILESYSTEM ERROR'); if (e instanceof Error) { this.logger.info('===================================='); this.logger.error(e.message); this.logger.error(e.stack!); } return; } } else if (flags.output) { if (fs.existsSync(flags.output)) { if (fs.lstatSync(flags.output).isDirectory()) { this.logger.info('The parameter --output must be a writeable file'); return; } } } const credentials: ICredentialsDb[] = await Container.get(CredentialsRepository).find({ where: this.getWhereFilter(flags), relations: ['shared.project'], }); await Container.get(CredentialDescriptionsService).stripIfDisabled(credentials); if (flags.decrypted) { for (let i = 0; i < credentials.length; i++) { const { name, type, data } = credentials[i]; const id = credentials[i].id; const credential = new Credentials({ id, name }, type, data); const plainData = await credential.getData(); (credentials[i] as ICredentialsDecryptedDb).data = plainData; } } if (credentials.length === 0) { throw new UserError('No credentials found with specified filters'); } if (flags.separate) { let fileContents: string; let i: number; for (i = 0; i < credentials.length; i++) { fileContents = JSON.stringify(credentials[i], null, flags.pretty ? 2 : undefined); const filename = `${ (flags.output!.endsWith(path.sep) ? flags.output : flags.output + path.sep) + credentials[i].id }.json`; fs.writeFileSync(filename, fileContents); } this.logger.info(`Successfully exported ${i} credentials.`); } else { const fileContents = JSON.stringify(credentials, null, flags.pretty ? 2 : undefined); if (flags.output) { fs.writeFileSync(flags.output, fileContents); this.logger.info(`Successfully exported ${credentials.length} credentials.`); } else { this.logger.info(fileContents); } } } async catch(error: Error) { this.logger.error('Error exporting credentials. See log messages for details.'); this.logger.error(error.message); } private getWhereFilter(flags: z.infer) { if (flags.id) { return { id: flags.id }; } if (flags.projectId) { return { shared: { projectId: flags.projectId } }; } return {}; } }