`;
+exports[`[component] InputForm Renders correctly to match the snapshot: Input: filepicker 1`] = `
+
+
+`;
+
exports[`[component] InputForm Renders correctly to match the snapshot: Input: number 1`] = `
+
+
+
+
+
+
+
+
+ Select or drag the file
+
+ event.target.checked,
[EpluginSettingType.editor]: (value: any) => value,
+ [EpluginSettingType.filepicker]: (value: any) => value,
default: (event: any) => event.target.value,
};
@@ -21,6 +22,8 @@ export const useForm = (fields) => {
}
}), {}));
+ const fieldRefs = useRef({});
+
const enhanceFields = Object.entries(formFields).reduce((accum, [fieldKey, {currentValue: value, ...restFieldState}]) => ({
...accum,
[fieldKey]: {
@@ -30,6 +33,8 @@ export const useForm = (fields) => {
value,
changed: !isEqual(restFieldState.initialValue, value),
error: fields[fieldKey]?.validate?.(value),
+ setInputRef: (reference) => {fieldRefs.current[fieldKey] = reference},
+ inputRef: fieldRefs.current[fieldKey],
onChange: (event) => {
const inputValue = getValueFromEvent(event, fields[fieldKey].type);
const currentValue = fields[fieldKey]?.transformChangedInputValue?.(inputValue) ?? inputValue;
diff --git a/public/components/common/form/index.test.tsx b/public/components/common/form/index.test.tsx
index c0697402a9..6c5ba70ac9 100644
--- a/public/components/common/form/index.test.tsx
+++ b/public/components/common/form/index.test.tsx
@@ -4,50 +4,52 @@ import { InputForm } from './index';
import { useForm } from './hooks';
jest.mock('../../../../../../node_modules/@elastic/eui/lib/services/accessibility', () => ({
- htmlIdGenerator: () => () => 'generated-id',
- useGeneratedHtmlId: () => () => 'generated-id',
+ htmlIdGenerator: () => () => 'generated-id',
+ useGeneratedHtmlId: () => () => 'generated-id',
}));
describe('[component] InputForm', () => {
- const optionsEditor = { editor: { language: 'json' } };
- const optionsSelect = { select: [{ text: 'Label1', value: 'value1' }, { text: 'Label2', value: 'value2' }] };
- const optionsSwitch = { switch: { values: { enabled: { label: 'Enabled', value: true }, disabled: { label: 'Disabled', value: false } } } };
- it.each`
+ const optionsEditor = { editor: { language: 'json' } };
+ const optionsFilepicker = { file: { type: 'image', extensions: ['.jpeg', '.jpg', '.png', '.svg'] } };
+ const optionsSelect = { select: [{ text: 'Label1', value: 'value1' }, { text: 'Label2', value: 'value2' }] };
+ const optionsSwitch = { switch: { values: { enabled: { label: 'Enabled', value: true }, disabled: { label: 'Disabled', value: false } } } };
+ it.each`
inputType | value | options
${'editor'} | ${'{}'} | ${optionsEditor}
+ ${'filepicker'} | ${'{}'} | ${optionsFilepicker}
${'number'} | ${4} | ${undefined}
${'select'} | ${'value1'} | ${optionsSelect}
${'switch'} | ${true} | ${optionsSwitch}
${'text'} | ${'test'} | ${undefined}
`('Renders correctly to match the snapshot: Input: $inputType', ({ inputType, value, options }) => {
- const wrapper = render(
- { }}
- options={options}
- />
- );
- expect(wrapper.container).toMatchSnapshot();
- });
+ const wrapper = render(
+ { }}
+ options={options}
+ />
+ );
+ expect(wrapper.container).toMatchSnapshot();
+ });
- it.each`
+ it.each`
inputType | initialValue | options | rest
- ${'number'} | ${4} | ${{number: {min: 5}}} | ${{ validate: (value) => value > 3 ? undefined : 'Vaidation error: value is lower than 5'}}
+ ${'number'} | ${4} | ${{ number: { min: 5 } }} | ${{ validate: (value) => value > 3 ? undefined : 'Vaidation error: value is lower than 5' }}
${'text'} | ${''} | ${undefined} | ${{ validate: (value) => value.length ? undefined : 'Validation error: string can not be empty' }}
${'text'} | ${'test spaces'} | ${undefined} | ${{ validate: (value) => value.length ? undefined : 'Validation error: string can not contain spaces' }}
`('Renders correctly to match the snapshot with validation errors. Input: $inputType', async ({ inputType, initialValue, options, rest }) => {
- const TestComponent = () => {
- const { fields: { [inputType]: field } } = useForm({ [inputType]: { initialValue, type: inputType, options, ...rest } });
- return (
-
<>
- {typeof preInput === 'function' ? preInput({value, error}) : preInput}
- {input}
- {typeof postInput === 'function' ? postInput({value, error}) : postInput}
+ {typeof header === 'function' ? header({value, error}) : header}
+
+ {typeof preInput === 'function' ? preInput({value, error}) : preInput}
+
+ {input}
+
+ {typeof postInput === 'function' ? postInput({value, error}) : postInput}
+
+ {typeof footer === 'function' ? footer({value, error}) : footer}
)
: input;
@@ -44,4 +61,5 @@ const Input = {
number: InputFormNumber,
select: InputFormSelect,
text: InputFormText,
+ filepicker: InputFormFilePicker
};
diff --git a/public/components/common/form/input_filepicker.tsx b/public/components/common/form/input_filepicker.tsx
new file mode 100644
index 0000000000..5a46828a47
--- /dev/null
+++ b/public/components/common/form/input_filepicker.tsx
@@ -0,0 +1,20 @@
+import React from 'react';
+import { EuiFilePicker } from '@elastic/eui';
+import { IInputFormType } from './types';
+
+export const InputFormFilePicker = ({onChange, options, setInputRef, key, ...rest} : IInputFormType) => (
+ onChange(
+ // File was added.
+ fileList?.[0]
+ // File was removed. We set the initial value, so the useForm hook will not detect any change. */
+ || rest.initialValue)}
+ display='default'
+ fullWidth
+ aria-label='Upload a file'
+ accept={options.file.extensions.join(',')}
+ ref={setInputRef}
+ />
+);
diff --git a/public/components/common/form/input_number.tsx b/public/components/common/form/input_number.tsx
index acc21002f4..f4db8e2a0b 100644
--- a/public/components/common/form/input_number.tsx
+++ b/public/components/common/form/input_number.tsx
@@ -3,12 +3,13 @@ import { EuiFieldNumber } from '@elastic/eui';
import { IInputFormType } from './types';
export const InputFormNumber = ({ options, value, onChange }: IInputFormType) => {
+ const { integer, ...rest } = options?.number || {};
return (
= ({
title,
+ currentConfiguration,
description,
documentationLink,
items
@@ -122,10 +128,23 @@ export const Category: React.FunctionComponent = ({
)}
}
- description={getPluginSettingDescription(item)} >
+ description={item.description} >
(
+
+
+ )
+ }
+ : {}
+ )}
/>
)
@@ -135,3 +154,61 @@ export const Category: React.FunctionComponent = ({
)
};
+
+const InputFormFilePickerPreInput = ({image, field}: {image: string, field: any}) => {
+ const dispatch = useDispatch();
+
+ return (
+ <>
+
+
+ 
+
+
+ {
+ try{
+ const response = await WzRequest.genericReq('DELETE', `/utils/configuration/files/${field.key}`);
+ dispatch(updateAppConfig(response.data.data.updatedConfiguration));
+
+ // Show the toasts if necessary
+ const { requiresRunningHealthCheck, requiresReloadingBrowserTab, requiresRestartingPluginPlatform } = response.data.data;
+ requiresRunningHealthCheck && toastRequiresRunningHealthcheck();
+ requiresReloadingBrowserTab&& toastRequiresReloadingBrowserTab();
+ requiresRestartingPluginPlatform && toastRequiresRestartingPluginPlatform();
+ toastSuccessUpdateConfiguration();
+ }catch(error){
+ const options = {
+ context: `${InputFormFilePickerPreInput.name}.confirmDeleteFile`,
+ level: UI_LOGGER_LEVELS.ERROR,
+ severity: UI_ERROR_SEVERITIES.BUSINESS,
+ store: true,
+ error: {
+ error: error,
+ message: error.message || error,
+ title: error.name || error,
+ },
+ };
+ getErrorOrchestrator().handleError(options);
+ }
+ }}
+ modalProps={{ buttonColor: 'danger' }}
+ iconType="trash"
+ color="danger"
+ aria-label="Delete file"
+ />
+
+
+
+ );
+};
diff --git a/public/components/settings/configuration/components/categories/components/show-toasts.tsx b/public/components/settings/configuration/components/categories/components/show-toasts.tsx
new file mode 100644
index 0000000000..b53e56e092
--- /dev/null
+++ b/public/components/settings/configuration/components/categories/components/show-toasts.tsx
@@ -0,0 +1,51 @@
+import React from 'react';
+import {
+ EuiButton,
+ EuiFlexGroup,
+ EuiFlexItem,
+} from '@elastic/eui';
+import { PLUGIN_PLATFORM_NAME } from '../../../../../../../common/constants';
+import { getToasts } from '../../../../../../kibana-services';
+
+export const toastRequiresReloadingBrowserTab = () => {
+ getToasts().add({
+ color: 'success',
+ title: 'Reload the page to apply the changes',
+ text:
+
+ window.location.reload()} size="s">Reload page
+
+
+ });
+};
+
+export const toastRequiresRunningHealthcheck = () => {
+ const toast = getToasts().add({
+ color: 'warning',
+ title: 'Run a health check to apply the changes.',
+ toastLifeTimeMs: 5000,
+ text:
+
+
+ {
+ getToasts().remove(toast);
+ window.location.href = '#/health-check';
+ }} size="s">Execute health check
+
+
+ });
+};
+
+export const toastRequiresRestartingPluginPlatform = () => {
+ getToasts().add({
+ color: 'warning',
+ title: `Restart ${PLUGIN_PLATFORM_NAME} to apply the changes`,
+ });
+};
+
+export const toastSuccessUpdateConfiguration = () => {
+ getToasts().add({
+ color: 'success',
+ title: 'The configuration has been successfully updated',
+ });
+};
\ No newline at end of file
diff --git a/public/components/settings/configuration/configuration.tsx b/public/components/settings/configuration/configuration.tsx
index b8ccba3f2b..5fceb25b35 100644
--- a/public/components/settings/configuration/configuration.tsx
+++ b/public/components/settings/configuration/configuration.tsx
@@ -29,15 +29,17 @@ import {
import store from '../../../redux/store'
import { updateSelectedSettingsSection } from '../../../redux/actions/appStateActions';
import { withUserAuthorizationPrompt, withErrorBoundary, withReduxProvider } from '../../common/hocs';
-import { PLUGIN_PLATFORM_NAME, PLUGIN_SETTINGS, PLUGIN_SETTINGS_CATEGORIES, UI_LOGGER_LEVELS, WAZUH_ROLE_ADMINISTRATOR_NAME } from '../../../../common/constants';
+import { EpluginSettingType, PLUGIN_SETTINGS, PLUGIN_SETTINGS_CATEGORIES, UI_LOGGER_LEVELS, WAZUH_ROLE_ADMINISTRATOR_NAME } from '../../../../common/constants';
import { compose } from 'redux';
-import { getSettingsDefaultList, groupSettingsByCategory, getCategorySettingByTitle } from '../../../../common/services/settings';
+import { getPluginSettingDescription, getSettingsDefaultList, groupSettingsByCategory, getCategorySettingByTitle } from '../../../../common/services/settings';
import { Category } from './components/categories/components';
import { WzRequest } from '../../../react-services';
import { UIErrorLog, UIErrorSeverity, UILogLevel, UI_ERROR_SEVERITIES } from '../../../react-services/error-orchestrator/types';
import { getErrorOrchestrator } from '../../../react-services/common-services';
import { getToasts } from '../../../kibana-services';
import { updateAppConfig } from '../../../redux/actions/appConfigActions';
+import path from 'path';
+import { toastRequiresReloadingBrowserTab, toastRequiresRestartingPluginPlatform, toastRequiresRunningHealthcheck, toastSuccessUpdateConfiguration } from './components/categories/components/show-toasts';
export type ISetting = {
key: string
@@ -103,7 +105,7 @@ const WzConfigurationSettingsProvider = (props) => {
type: PLUGIN_SETTINGS[fieldKey].type,
options: PLUGIN_SETTINGS[fieldKey]?.options,
title: PLUGIN_SETTINGS[fieldKey]?.title,
- description: PLUGIN_SETTINGS[fieldKey]?.description
+ description: getPluginSettingDescription(PLUGIN_SETTINGS[fieldKey]),
}));
// https://github.com/elastic/eui/blob/aa4cfd7b7c34c2d724405a3ecffde7fe6cf3b50f/src/components/search_bar/query/query.ts#L138-L163
@@ -120,23 +122,48 @@ const WzConfigurationSettingsProvider = (props) => {
setLoading(true);
try {
const settingsToUpdate = Object.entries(changed).reduce((accum, [pluginSettingKey, currentValue]) => {
- if(PLUGIN_SETTINGS[pluginSettingKey].isConfigurableFromFile){
+ if(PLUGIN_SETTINGS[pluginSettingKey].isConfigurableFromFile && PLUGIN_SETTINGS[pluginSettingKey].type === EpluginSettingType.filepicker){
+ accum.fileUpload = {
+ ...accum.fileUpload,
+ [pluginSettingKey]: {
+ file: currentValue,
+ extension: path.extname(currentValue.name)
+ }
+ }
+ }else if(PLUGIN_SETTINGS[pluginSettingKey].isConfigurableFromFile){
accum.saveOnConfigurationFile = {
...accum.saveOnConfigurationFile,
[pluginSettingKey]: currentValue
}
};
return accum;
- }, {saveOnConfigurationFile: {}});
+ }, {saveOnConfigurationFile: {}, fileUpload: {}});
const requests = [];
+ // Update the settings that doesn't upload a file
if(Object.keys(settingsToUpdate.saveOnConfigurationFile).length){
requests.push(WzRequest.genericReq(
'PUT', '/utils/configuration',
settingsToUpdate.saveOnConfigurationFile
));
};
+
+ // Update the settings that uploads a file
+ if(Object.keys(settingsToUpdate.fileUpload).length){
+ requests.push(...Object.entries(settingsToUpdate.fileUpload)
+ .map(([pluginSettingKey, {file, extension}]) => {
+ // Create the form data
+ const formData = new FormData();
+ formData.append('file', file);
+ return WzRequest.genericReq(
+ 'PUT', `/utils/configuration/files/${pluginSettingKey}`,
+ formData,
+ {overwriteHeaders: {'content-type': 'multipart/form-data'}}
+ )
+ }));
+ };
+
const responses = await Promise.all(requests);
// Show the toasts if necessary
@@ -154,8 +181,26 @@ const WzConfigurationSettingsProvider = (props) => {
},{})
}));
+ // Remove the selected files on the file picker inputs
+ if(Object.keys(settingsToUpdate.fileUpload).length){
+ Object.keys(settingsToUpdate.fileUpload).forEach(settingKey => {
+ try{
+ fields[settingKey].inputRef.removeFiles(
+ // This method uses some methods of a DOM event.
+ // Because we want to remove the files when the configuration is saved,
+ // there is no event, so we create a object that contains the
+ // methods used to remove the files. Of this way, we can skip the errors
+ // due to missing methods.
+ // This workaround is based in @elastic/eui v29.3.2
+ // https://github.com/elastic/eui/blob/v29.3.2/src/components/form/file_picker/file_picker.tsx#L107-L108
+ {stopPropagation: () => {}, preventDefault: () => {}}
+ );
+ }catch(error){ };
+ });
+ };
+
// Show the success toast
- successToast();
+ toastSuccessUpdateConfiguration();
// Reset the form changed configuration
doChanges();
@@ -178,6 +223,31 @@ const WzConfigurationSettingsProvider = (props) => {
};
};
+ const onCancel = () => {
+ const updatedSettingsUseFilePicker = Object.entries(changed).reduce((accum, [pluginSettingKey]) => {
+ if(PLUGIN_SETTINGS[pluginSettingKey].isConfigurableFromFile && PLUGIN_SETTINGS[pluginSettingKey].type === EpluginSettingType.filepicker){
+ accum.push(pluginSettingKey);
+ };
+ return accum;
+ }, []);
+
+ updatedSettingsUseFilePicker.forEach(settingKey => {
+ try{
+ fields[settingKey].inputRef.removeFiles(
+ // This method uses some methods of a DOM event.
+ // Because we want to remove the files when the configuration is saved,
+ // there is no event, so we create a object that contains the
+ // methods used to remove the files. Of this way, we can skip the errors
+ // due to missing methods.
+ // This workaround is based in @elastic/eui v29.3.2
+ // https://github.com/elastic/eui/blob/v29.3.2/src/components/form/file_picker/file_picker.tsx#L107-L108
+ {stopPropagation: () => {}, preventDefault: () => {}}
+ );
+ }catch(error){ };
+ });
+ undoChanges();
+ };
+
return (
@@ -203,6 +273,7 @@ const WzConfigurationSettingsProvider = (props) => {
description={description}
documentationLink={documentationLink}
items={settings}
+ currentConfiguration={currentConfiguration}
/>
)
}
@@ -213,7 +284,7 @@ const WzConfigurationSettingsProvider = (props) => {
-
- window.location.reload()} size="s">Reload page
-
-
- });
-};
-
-const toastRequiresRunningHealthcheck = () => {
- const toast = getToasts().add({
- color: 'warning',
- title: 'You must execute the health check for the changes to take effect',
- toastLifeTimeMs: 5000,
- text:
-
-
- {
- getToasts().remove(toast);
- window.location.href = '#/health-check';
- }} size="s">Execute health check
-
-
- });
-};
-
-const toastRequiresRestartingPluginPlatform = () => {
- getToasts().add({
- color: 'warning',
- title: `You must restart ${PLUGIN_PLATFORM_NAME} for the changes to take effect`,
- });
-};
-
-const successToast = () => {
- getToasts().add({
- color: 'success',
- title: 'The configuration has been successfully updated',
- });
-};
diff --git a/public/components/wz-menu/wz-menu.js b/public/components/wz-menu/wz-menu.js
index f1922c7057..17072a7684 100644
--- a/public/components/wz-menu/wz-menu.js
+++ b/public/components/wz-menu/wz-menu.js
@@ -894,7 +894,7 @@ export const WzMenu = withWindowSize(class WzMenu extends Component {
)}
- {/*this.state.hover === 'overview' */this.state.isOverviewPopoverOpen && (
+ {this.state.isOverviewPopoverOpen && (
this.setState({ menuOpened: false })}
>
@@ -912,10 +912,15 @@ export const WzMenu = withWindowSize(class WzMenu extends Component {
responsive={false}
style={{ paddingTop: 2 }}
>
-
- 
+
+
-
+
{this.state.menuOpened && (
} app logs or ErrorResponse
@@ -121,6 +127,99 @@ export class WazuhUtilsCtrl {
}
}
+ /**
+ * Upload a file
+ * @param {Object} context
+ * @param {Object} request
+ * @param {Object} response
+ * @returns {Object} Configuration File or ErrorResponse
+ */
+ uploadFile = this.routeDecoratorProtectedAdministratorRoleValidToken(
+ async (context: RequestHandlerContext, request: KibanaRequest, response: KibanaResponseFactory) => {
+ const { key } = request.params;
+ const { file: bufferFile } = request.body;
+ const pluginSetting = PLUGIN_SETTINGS[key];
+
+ // Check file extension
+ const fileExtension = getFileExtensionFromBuffer(bufferFile);
+
+ // Check if the extension is valid for the setting.
+ if(!pluginSetting.options.file.extensions.includes(`.${fileExtension}`)){
+ return response.badRequest({
+ body: `File extension is not valid for setting [${key}] setting. Allowed file extensions: ${pluginSetting.options.file.extensions.join(', ')}`
+ });
+ };
+
+ const fileNamePath = `${key}.${fileExtension}`;
+
+ // Create target directory
+ const targetDirectory = path.join(__dirname, '../../..', pluginSetting.options.file.store.relativePathFileSystem);
+ createDirectoryIfNotExists(targetDirectory);
+ // Get the files related to the setting and remove them
+ const files = glob.sync(path.join(targetDirectory, `${key}.*`));
+ files.forEach(fs.unlinkSync);
+
+ // Store the file in the target directory.
+ fs.writeFileSync(path.join(targetDirectory, fileNamePath), bufferFile);
+
+ // Update the setting in the configuration cache
+ const pluginSettingValue = pluginSetting.options.file.store.resolveStaticURL(fileNamePath);
+ await updateConfigurationFile.updateConfiguration({[key]: pluginSettingValue});
+
+ return response.ok({
+ body: {
+ data: {
+ requiresRunningHealthCheck: Boolean(pluginSetting.requiresRunningHealthCheck),
+ requiresReloadingBrowserTab: Boolean(pluginSetting.requiresReloadingBrowserTab),
+ requiresRestartingPluginPlatform: Boolean(pluginSetting.requiresRestartingPluginPlatform),
+ updatedConfiguration: {
+ [key]: pluginSettingValue
+ }
+ }
+ }
+ });
+ },
+ 3022
+ )
+
+ /**
+ * Upload a file
+ * @param {Object} context
+ * @param {Object} request
+ * @param {Object} response
+ * @returns {Object} Configuration File or ErrorResponse
+ */
+ deleteFile = this.routeDecoratorProtectedAdministratorRoleValidToken(
+ async (context: RequestHandlerContext, request: KibanaRequest, response: KibanaResponseFactory) => {
+ const { key } = request.params;
+ const pluginSetting = PLUGIN_SETTINGS[key];
+
+ // Get the files related to the setting and remove them
+ const targetDirectory = path.join(__dirname, '../../..', pluginSetting.options.file.store.relativePathFileSystem);
+ const files = glob.sync(path.join(targetDirectory,`${key}.*`));
+ files.forEach(fs.unlinkSync);
+
+ // Update the setting in the configuration cache
+ const pluginSettingValue = pluginSetting.defaultValue;
+ await updateConfigurationFile.updateConfiguration({[key]: pluginSettingValue});
+
+ return response.ok({
+ body: {
+ message: 'All files were removed and the configuration file was updated.',
+ data: {
+ requiresRunningHealthCheck: Boolean(pluginSetting.requiresRunningHealthCheck),
+ requiresReloadingBrowserTab: Boolean(pluginSetting.requiresReloadingBrowserTab),
+ requiresRestartingPluginPlatform: Boolean(pluginSetting.requiresRestartingPluginPlatform),
+ updatedConfiguration: {
+ [key]: pluginSettingValue
+ }
+ }
+ }
+ });
+ },
+ 3023
+ )
+
private routeDecoratorProtectedAdministratorRoleValidToken(routeHandler, errorCode: number){
return async (context, request, response) => {
try{
diff --git a/server/lib/filesystem.ts b/server/lib/filesystem.ts
index d4aeab1bd5..68fe41c878 100644
--- a/server/lib/filesystem.ts
+++ b/server/lib/filesystem.ts
@@ -4,7 +4,7 @@ import { WAZUH_DATA_ABSOLUTE_PATH } from '../../common/constants';
export const createDirectoryIfNotExists = (directory: string): void => {
if (!fs.existsSync(directory)) {
- fs.mkdirSync(directory);
+ fs.mkdirSync(directory, { recursive: true });
}
};
@@ -19,7 +19,7 @@ export const createDataDirectoryIfNotExists = (directory?: string) => {
? path.join(WAZUH_DATA_ABSOLUTE_PATH, directory)
: WAZUH_DATA_ABSOLUTE_PATH;
if (!fs.existsSync(absoluteRoute)) {
- fs.mkdirSync(absoluteRoute);
+ fs.mkdirSync(absoluteRoute, { recursive: true });
}
};
diff --git a/server/routes/wazuh-utils/fixtures/fixture_file.txt b/server/routes/wazuh-utils/fixtures/fixture_file.txt
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/server/routes/wazuh-utils/fixtures/fixture_image_big.png b/server/routes/wazuh-utils/fixtures/fixture_image_big.png
new file mode 100644
index 0000000000..9c574f937d
Binary files /dev/null and b/server/routes/wazuh-utils/fixtures/fixture_image_big.png differ
diff --git a/server/routes/wazuh-utils/fixtures/fixture_image_small.jpg b/server/routes/wazuh-utils/fixtures/fixture_image_small.jpg
new file mode 100644
index 0000000000..19c02a553b
Binary files /dev/null and b/server/routes/wazuh-utils/fixtures/fixture_image_small.jpg differ
diff --git a/server/routes/wazuh-utils/fixtures/fixture_image_small.png b/server/routes/wazuh-utils/fixtures/fixture_image_small.png
new file mode 100644
index 0000000000..ba9bc4dae9
Binary files /dev/null and b/server/routes/wazuh-utils/fixtures/fixture_image_small.png differ
diff --git a/server/routes/wazuh-utils/fixtures/fixture_image_small.svg b/server/routes/wazuh-utils/fixtures/fixture_image_small.svg
new file mode 100644
index 0000000000..f6d72ed8ce
--- /dev/null
+++ b/server/routes/wazuh-utils/fixtures/fixture_image_small.svg
@@ -0,0 +1,14 @@
+
+
+
diff --git a/server/routes/wazuh-utils/wazuh-utils.test.ts b/server/routes/wazuh-utils/wazuh-utils.test.ts
index f5dfc3cbca..ce0ed7d0a1 100644
--- a/server/routes/wazuh-utils/wazuh-utils.test.ts
+++ b/server/routes/wazuh-utils/wazuh-utils.test.ts
@@ -13,13 +13,13 @@ import {
WAZUH_DATA_ABSOLUTE_PATH,
WAZUH_DATA_CONFIG_APP_PATH,
WAZUH_DATA_CONFIG_DIRECTORY_PATH,
- WAZUH_DATA_DOWNLOADS_DIRECTORY_PATH,
- WAZUH_DATA_DOWNLOADS_REPORTS_DIRECTORY_PATH,
WAZUH_DATA_LOGS_DIRECTORY_PATH,
WAZUH_DATA_LOGS_RAW_PATH,
} from "../../../common/constants";
import { execSync } from 'child_process';
import fs from 'fs';
+import path from 'path';
+import glob from 'glob';
import moment from 'moment';
import { of } from 'rxjs';
@@ -187,7 +187,7 @@ hosts:
},
{
testTitle: 'Bad request, unknown setting',
- settings: { 'unknown.setting': 'test-alerts-groupA-*','logs.level': 'debug' },
+ settings: { 'unknown.setting': 'test-alerts-groupA-*', 'logs.level': 'debug' },
responseStatusCode: 400,
responseBodyMessage: '[request body.unknown.setting]: definition for this key is missing'
},
@@ -197,17 +197,17 @@ hosts:
responseStatusCode: 400,
responseBodyMessage: '[request body.cron.statistics.apis.0]: expected value of type [string] but got [number]'
}
- ])(`$testTitle: $settings. PUT /utils/configuration - $responseStatusCode`, async ({responseBodyMessage, responseStatusCode, settings}) => {
+ ])(`$testTitle: $settings. PUT /utils/configuration - $responseStatusCode`, async ({ responseBodyMessage, responseStatusCode, settings }) => {
const response = await supertest(innerServer.listener)
.put('/utils/configuration')
.send(settings)
.expect(responseStatusCode);
- responseStatusCode === 200 && expect(response.body.data.updatedConfiguration).toEqual(settings);
- responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBeDefined();
- responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBeDefined();
- responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBeDefined();
- responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration).toEqual(settings);
+ responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBeDefined();
+ responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBeDefined();
+ responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBeDefined();
+ responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
});
it.each`
@@ -422,18 +422,166 @@ hosts:
${'wazuh.monitoring.shards'} | ${-1} | ${400} | ${"[request body.wazuh.monitoring.shards]: Value should be greater or equal than 1."}
${'wazuh.monitoring.shards'} | ${1.2} | ${400} | ${"[request body.wazuh.monitoring.shards]: Number should be an integer."}
${'wazuh.monitoring.shards'} | ${'custom'} | ${400} | ${"[request body.wazuh.monitoring.shards]: expected value of type [number] but got [string]"}
- `(`$setting: $value - PUT /utils/configuration - $responseStatusCode`, async ({responseBodyMessage, responseStatusCode, setting, value}) => {
- const body = {[setting]: value};
+ `(`$setting: $value - PUT /utils/configuration - $responseStatusCode`, async ({ responseBodyMessage, responseStatusCode, setting, value }) => {
+ const body = { [setting]: value };
const response = await supertest(innerServer.listener)
.put('/utils/configuration')
.send(body)
.expect(responseStatusCode);
- responseStatusCode === 200 && expect(response.body.data.updatedConfiguration).toEqual(body);
- responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRunningHealthCheck));
- responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresReloadingBrowserTab));
- responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRestartingPluginPlatform));
- responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration).toEqual(body);
+ responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRunningHealthCheck));
+ responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresReloadingBrowserTab));
+ responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRestartingPluginPlatform));
+ responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
+ });
+});
+
+describe('[endpoint] PUT /utils/configuration/files/{key} - Upload file', () => {
+
+ const PUBLIC_CUSTOM_ASSETS_PATH = path.join(__dirname, '../../../', 'public/assets/custom');
+
+ beforeAll(() => {
+ // Remove /public/assets/custom directory.
+ execSync(`rm -rf ${PUBLIC_CUSTOM_ASSETS_PATH}`);
+
+ // Create the configuration file with custom content
+ const fileContent = `---
+pattern: test-alerts-*
+
+hosts:
+ - default:
+ url: https://localhost
+ port: 55000
+ username: wazuh-wui
+ password: wazuh-wui
+ run_as: false
+`;
+
+ fs.writeFileSync(WAZUH_DATA_CONFIG_APP_PATH, fileContent, 'utf8');
+ });
+
+ afterAll(() => {
+ // Remove /public/assets/custom directory.
+ execSync(`rm -rf ${PUBLIC_CUSTOM_ASSETS_PATH}`);
+
+ // Remove the configuration file
+ fs.unlinkSync(WAZUH_DATA_CONFIG_APP_PATH);
+ });
+
+ it.each`
+ setting | filename | responseStatusCode | responseBodyMessage
+ ${'customization.logo.unknown'} | ${'fixture_image_small.jpg'} | ${400} | ${'[request params.key]: types that failed validation:\n- [request params.key.0]: expected value to equal [customization.logo.app]\n- [request params.key.1]: expected value to equal [customization.logo.healthcheck]\n- [request params.key.2]: expected value to equal [customization.logo.reports]\n- [request params.key.3]: expected value to equal [customization.logo.sidebar]'}
+ ${'customization.logo.app'} | ${'fixture_image_small.jpg'} | ${200} | ${null}
+ ${'customization.logo.app'} | ${'fixture_image_small.png'} | ${200} | ${null}
+ ${'customization.logo.app'} | ${'fixture_image_small.svg'} | ${200} | ${null}
+ ${'customization.logo.app'} | ${'fixture_image_big.png'} | ${413} | ${'Payload content length greater than maximum allowed: 1048576'}
+ ${'customization.logo.healthcheck'} | ${'fixture_image_small.jpg'} | ${200} | ${null}
+ ${'customization.logo.healthcheck'} | ${'fixture_image_small.png'} | ${200} | ${null}
+ ${'customization.logo.healthcheck'} | ${'fixture_image_small.svg'} | ${200} | ${null}
+ ${'customization.logo.healthcheck'} | ${'fixture_image_big.png'} | ${413} | ${'Payload content length greater than maximum allowed: 1048576'}
+ ${'customization.logo.reports'} | ${'fixture_image_small.jpg'} | ${200} | ${null}
+ ${'customization.logo.reports'} | ${'fixture_image_small.png'} | ${200} | ${null}
+ ${'customization.logo.reports'} | ${'fixture_image_big.png'} | ${413} | ${'Payload content length greater than maximum allowed: 1048576'}
+ ${'customization.logo.reports'} | ${'fixture_image_small.svg'} | ${400} | ${"File extension is not valid for setting [customization.logo.reports] setting. Allowed file extensions: .jpeg, .jpg, .png"}
+ ${'customization.logo.sidebar'} | ${'fixture_image_small.jpg'} | ${200} | ${null}
+ ${'customization.logo.sidebar'} | ${'fixture_image_small.png'} | ${200} | ${null}
+ ${'customization.logo.sidebar'} | ${'fixture_image_small.svg'} | ${200} | ${null}
+ ${'customization.logo.sidebar'} | ${'fixture_image_big.png'} | ${413} | ${'Payload content length greater than maximum allowed: 1048576'}
+ `(`$setting: $filename - PUT /utils/configuration/files/{key} - $responseStatusCode`, async ({ responseBodyMessage, responseStatusCode, setting, filename }) => {
+ const filePath = path.join(__dirname, 'fixtures', filename);
+ const extension = path.extname(filename);
+
+ const response = await supertest(innerServer.listener)
+ .put(`/utils/configuration/files/${setting}`)
+ .attach('file', filePath)
+ .expect(responseStatusCode);
+
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration[setting]).toBeDefined();
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration[setting]).toMatch(`${setting}${extension}`);
+ responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRunningHealthCheck));
+ responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresReloadingBrowserTab));
+ responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRestartingPluginPlatform));
+ responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
+
+ // Check the file was created in the expected path of the file system.
+ if (response?.body?.data?.updatedConfiguration?.[setting]) {
+ const targetFilepath = path.join(__dirname, '../../../', PLUGIN_SETTINGS[setting].options.file.store.relativePathFileSystem, `${PLUGIN_SETTINGS[setting].options.file.store.filename}${extension}`);
+ const files = glob.sync(path.join(targetFilepath));
+ expect(files[0]).toBeDefined();
+ };
+ });
+});
+
+describe('[endpoint] DELETE /utils/configuration/files/{key} - Delete file', () => {
+
+ const PUBLIC_CUSTOM_ASSETS_PATH = path.join(__dirname, '../../../', 'public/assets/custom');
+
+ beforeAll(() => {
+ // Remove /public/assets/custom directory.
+ execSync(`rm -rf ${PUBLIC_CUSTOM_ASSETS_PATH}`);
+
+ // Create the configuration file with custom content
+ const fileContent = `---
+pattern: test-alerts-*
+
+hosts:
+ - default:
+ url: https://localhost
+ port: 55000
+ username: wazuh-wui
+ password: wazuh-wui
+ run_as: false
+`;
+
+ fs.writeFileSync(WAZUH_DATA_CONFIG_APP_PATH, fileContent, 'utf8');
+
+ createDirectoryIfNotExists(PUBLIC_CUSTOM_ASSETS_PATH);
+ });
+
+ afterAll(() => {
+ // Remove /public/assets/custom directory.
+ execSync(`rm -rf ${PUBLIC_CUSTOM_ASSETS_PATH}`);
+
+ // Remove the configuration file
+ fs.unlinkSync(WAZUH_DATA_CONFIG_APP_PATH);
+ });
+
+ it.each`
+ setting | expectedValue | responseStatusCode | responseBodyMessage
+ ${'customization.logo.unknown'} | ${''} | ${400} | ${'[request params.key]: types that failed validation:\n- [request params.key.0]: expected value to equal [customization.logo.app]\n- [request params.key.1]: expected value to equal [customization.logo.healthcheck]\n- [request params.key.2]: expected value to equal [customization.logo.reports]\n- [request params.key.3]: expected value to equal [customization.logo.sidebar]'}
+ ${'customization.logo.app'} | ${''} | ${200} | ${'All files were removed and the configuration file was updated.'}
+ ${'customization.logo.healthcheck'} | ${''} | ${200} | ${'All files were removed and the configuration file was updated.'}
+ ${'customization.logo.reports'} | ${''} | ${200} | ${'All files were removed and the configuration file was updated.'}
+ ${'customization.logo.sidebar'} | ${''} | ${200} | ${'All files were removed and the configuration file was updated.'}
+ `(`$setting - PUT /utils/configuration - $responseStatusCode`, async ({ responseBodyMessage, responseStatusCode, setting, expectedValue }) => {
+
+ // If the setting is defined in the plugin
+ if (PLUGIN_SETTINGS[setting]) {
+ // Create the directory where the asset was stored.
+ createDirectoryIfNotExists(path.join(__dirname, '../../../', PLUGIN_SETTINGS[setting].options.file.store.relativePathFileSystem));
+
+ // Create a empty file
+ fs.writeFileSync(path.join(__dirname, '../../../', PLUGIN_SETTINGS[setting].options.file.store.relativePathFileSystem, `${PLUGIN_SETTINGS[setting].options.file.store.filename}.jpg`), '', 'utf8');
+ };
+
+ const response = await supertest(innerServer.listener)
+ .delete(`/utils/configuration/files/${setting}`)
+ .expect(responseStatusCode);
+
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration[setting]).toBeDefined();
+ responseStatusCode === 200 && expect(response.body.data.updatedConfiguration[setting]).toMatch(expectedValue);
+ responseStatusCode === 200 && expect(response.body.data.requiresRunningHealthCheck).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRunningHealthCheck));
+ responseStatusCode === 200 && expect(response.body.data.requiresReloadingBrowserTab).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresReloadingBrowserTab));
+ responseStatusCode === 200 && expect(response.body.data.requiresRestartingPluginPlatform).toBe(Boolean(PLUGIN_SETTINGS[setting].requiresRestartingPluginPlatform));
+ responseBodyMessage && expect(response.body.message).toMatch(responseBodyMessage);
+
+ // Check the file was deleted from the expected path of the file system.
+ if (response?.body?.data?.updatedConfiguration?.[setting]) {
+ const targetFilepath = path.join(__dirname, '../../../', PLUGIN_SETTINGS[setting].options.file.store.relativePathFileSystem, `${PLUGIN_SETTINGS[setting].options.file.store.filename}.*`);
+ const files = glob.sync(path.join(targetFilepath));
+ expect(files).toHaveLength(0);
+ };
});
});
diff --git a/server/routes/wazuh-utils/wazuh-utils.ts b/server/routes/wazuh-utils/wazuh-utils.ts
index 1e4032fd0d..26ec791f90 100644
--- a/server/routes/wazuh-utils/wazuh-utils.ts
+++ b/server/routes/wazuh-utils/wazuh-utils.ts
@@ -12,7 +12,7 @@
import { WazuhUtilsCtrl } from '../../controllers';
import { IRouter } from 'kibana/server';
import { schema } from '@kbn/config-schema';
-import { PLUGIN_SETTINGS } from '../../../common/constants';
+import { CUSTOMIZATION_ENDPOINT_PAYLOAD_UPLOAD_CUSTOM_FILE_MAXIMUM_BYTES, EpluginSettingType, PLUGIN_SETTINGS } from '../../../common/constants';
export function WazuhUtilsRoutes(router: IRouter) {
const ctrl = new WazuhUtilsCtrl();
@@ -51,6 +51,48 @@ export function WazuhUtilsRoutes(router: IRouter) {
async (context, request, response) => ctrl.updateConfigurationFile(context, request, response)
);
+ const pluginSettingsTypeFilepicker = Object.entries(PLUGIN_SETTINGS)
+ .filter(([_, {type, isConfigurableFromFile}]) => type === EpluginSettingType.filepicker && isConfigurableFromFile);
+
+ const schemaPluginSettingsTypeFilepicker = schema.oneOf(pluginSettingsTypeFilepicker.map(([pluginSettingKey]) => schema.literal(pluginSettingKey)));
+
+ // Upload an asset
+ router.put(
+ {
+ path: '/utils/configuration/files/{key}',
+ validate: {
+ params: schema.object({
+ // key parameter should be a plugin setting of `filepicker` type
+ key: schemaPluginSettingsTypeFilepicker
+ }),
+ body: schema.object({
+ // file: buffer
+ file: schema.buffer(),
+ })
+ },
+ options: {
+ body: {
+ maxBytes: CUSTOMIZATION_ENDPOINT_PAYLOAD_UPLOAD_CUSTOM_FILE_MAXIMUM_BYTES,
+ },
+ }
+ },
+ async (context, request, response) => ctrl.uploadFile(context, request, response)
+ );
+
+ // Remove an asset
+ router.delete(
+ {
+ path: '/utils/configuration/files/{key}',
+ validate: {
+ params: schema.object({
+ // key parameter should be a plugin setting of `filepicker` type
+ key: schemaPluginSettingsTypeFilepicker
+ })
+ }
+ },
+ async (context, request, response) => ctrl.deleteFile(context, request, response)
+ );
+
// Returns Wazuh app logs
router.get(
{