Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: added pathValidator utility method #1126

Merged
merged 4 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/contentstack-bootstrap/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@contentstack/cli-cm-bootstrap",
"description": "Bootstrap contentstack apps",
"version": "1.6.0",
"version": "1.6.1",
"author": "Contentstack",
"bugs": "https://github.com/contentstack/cli/issues",
"scripts": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const inquirer = require('inquirer');
import { cliux } from '@contentstack/cli-utilities';

import messageHandler from '../messages';
import { pathValidator } from '@contentstack/cli-utilities';

/**
* @description Inquire starter app
Expand Down Expand Up @@ -58,7 +59,8 @@ export async function inquireCloneDirectory(): Promise<string> {
message: messageHandler.parse('CLI_BOOTSTRAP_APP_COPY_SOURCE_CODE_DESTINATION_ENQUIRY'),
},
]);
selectedCustomPath = path.resolve(selectedCustomPath.path);
pathValidator.validatePath(selectedCustomPath.path);
selectedCustomPath = path.normalize(selectedCustomPath.path);
return selectedCustomPath;
}

Expand Down
1 change: 1 addition & 0 deletions packages/contentstack-bootstrap/src/bootstrap/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ const envFileHandler = async (
customHost = region.cma && region.cma.substring('8');
}
const production = environmentVariables.environment === 'production' ? true : false;
// Note: clonedDirectory is already sanitised.
switch (appConfigKey) {
case 'reactjs':
case 'reactjs-starter':
Expand Down
2 changes: 1 addition & 1 deletion packages/contentstack-bulk-publish/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@contentstack/cli-cm-bulk-publish",
"description": "Contentstack CLI plugin for bulk publish actions",
"version": "1.3.13",
"version": "1.3.14",
"author": "Contentstack",
"bugs": "https://github.com/contentstack/cli/issues",
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions packages/contentstack-bulk-publish/src/util/store.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ const fs = require('fs');
const path = require('path');
const config = require('../config/index.js');
const chalk = require('chalk');
const { pathValidator } = require('@contentstack/cli-utilities');

function save(key, data) {
let bulkPublish = config ? config : {};
Expand Down Expand Up @@ -49,6 +50,7 @@ function get(key, filePath) {

function updateMissing(key, flags) {
let savedConfig;
pathValidator.validatePath(flags.config);
savedConfig = get(key, path.resolve(flags.config));
Object.keys(savedConfig).forEach((element) => {
if (flags[element] === undefined) {
Expand Down
2 changes: 1 addition & 1 deletion packages/contentstack-clone/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@contentstack/cli-cm-clone",
"description": "Contentstack stack clone plugin",
"version": "1.6.0",
"version": "1.6.1",
"author": "Contentstack",
"bugs": "https://github.com/rohitmishra209/cli-cm-clone/issues",
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions packages/contentstack-clone/src/lib/util/log.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ var winston = require('winston');
var path = require('path');
var mkdirp = require('mkdirp');
var slice = Array.prototype.slice;
const { pathValidator } = require('@contentstack/cli-utilities');

function returnString(args) {
var returnStr = '';
Expand Down Expand Up @@ -41,6 +42,7 @@ var myCustomLevels = {
};

function init(_logPath, logfileName) {
pathValidator.validatePath(logfileName);
var logsDir = path.resolve(_logPath, 'logs', 'import');
// Create dir if doesn't already exist
mkdirp.sync(logsDir);
Expand Down
2 changes: 1 addition & 1 deletion packages/contentstack-migrate-rte/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@contentstack/cli-cm-migrate-rte",
"description": "Contentstack CLI plugin to migrate HTML RTE to JSON RTE",
"version": "1.4.13",
"version": "1.4.14",
"author": "contentstack",
"bugs": "https://github.com/contentstack/cli/issues",
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions packages/contentstack-migrate-rte/src/lib/util/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const {
isPlainObject,
} = require('lodash');
const Validator = require('jsonschema').Validator;
const { pathValidator } = require('@contentstack/cli-utilities');
const configSchema = require('./config_schema.json');
const { JSDOM } = require('jsdom');
const collapseWithSpace = require('collapse-whitespace');
Expand Down Expand Up @@ -88,6 +89,7 @@ async function getConfig(flags) {
let config;
if (flags['config-path']) {
const configPath = flags['config-path'];
pathValidator.validatePath(configPath);
config = require(nodePath.resolve(configPath));
} else {
config = {
Expand Down
2 changes: 1 addition & 1 deletion packages/contentstack-migration/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@contentstack/cli-migration",
"version": "1.3.14",
"version": "1.3.15",
"author": "@contentstack",
"bugs": "https://github.com/contentstack/cli/issues",
"dependencies": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const Listr = require('listr');
const { resolve, extname } = require('path');
const { Command } = require('@contentstack/cli-command');
const { waterfall } = require('async');
const { pathValidator } = require('@contentstack/cli-utilities');
const { Parser } = require('../../../modules');
const { ActionList } = require('../../../actions');
const fs = require('fs');
Expand Down Expand Up @@ -129,14 +130,14 @@ class MigrationCommand extends Command {
}

async execSingleFile(filePath, mapInstance) {
// Resolved absolute path
const resolvedMigrationPath = resolve(filePath);
// User provided migration function
const migrationFunc = require(resolvedMigrationPath);

const parser = new Parser();

try {
pathValidator.validatePath(filePath);
// Resolved absolute path
const resolvedMigrationPath = resolve(filePath);
// User provided migration function
const migrationFunc = require(resolvedMigrationPath);

const parser = new Parser();
const migrationParser = await parser.getMigrationParser(migrationFunc);
if (migrationParser.hasErrors) {
errorHelper(migrationParser.hasErrors);
Expand Down
1 change: 1 addition & 0 deletions packages/contentstack-utilities/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export { default as CLIError } from './cli-error';
export { default as messageHandler } from './message-handler';
export { default as authHandler } from './auth-handler';
export { default as configHandler } from './config-handler';
export { default as pathValidator } from './path-validator';
export {
default as managementSDKClient,
managementSDKInitiator,
Expand Down
10 changes: 10 additions & 0 deletions packages/contentstack-utilities/src/path-validator.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
class PathValidator {
validatePath(userInput) {
if (!/^[^.]+$/.test(userInput)) {
throw 'The path contains illegal character such as `.`. Please use absolute paths.';
}
return true;
}
}

export default new PathValidator();
Loading