[Redesign add page] Agent register wizard handle properly special characters in password

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to the Wazuh app project will be documented in this file.
 
 - Support for Wazuh 4.7.0
 - Added `status detail` column in the agents table. [#5680](https:/wazuh/wazuh-kibana-app/pull/5680)
+- Added agent register wizard handle properly special characters in password [5738](https:/wazuh/wazuh-kibana-app/pull/5738)
 
 ### Changed
 

docker/images/wzd-dev.Dockerfile

@@ -0,0 +1,24 @@
+# Usage: docker build --build-arg NODE_VERSION=16.20.0 --build-arg WAZUH_DASHBOARD_VERSION=4.6.0 -t quay.io/wazuh/osd-dev:4.6.0 -f wzd-dev.Dockerfile .
+
+ARG NODE_VERSION
+FROM node:${NODE_VERSION} AS base
+ARG WAZUH_DASHBOARD_VERSION
+USER node
+RUN git clone --depth 1 --branch ${WAZUH_DASHBOARD_VERSION} https:/wazuh/wazuh-dashboard.git /home/node/kbn
+RUN chown node.node /home/node/kbn
+
+WORKDIR /home/node/kbn
+RUN yarn osd bootstrap --production
+
+
+WORKDIR /home/node/kbn/plugins
+RUN git clone --depth 1 --branch ${WAZUH_DASHBOARD_VERSION} https:/wazuh/wazuh-security-dashboards-plugin.git
+WORKDIR /home/node/kbn/plugins/wazuh-security-dashboards-plugin
+RUN yarn install
+
+RUN mkdir -p /home/node/kbn/data/wazuh/config
+
+FROM node:${NODE_VERSION}
+USER node
+COPY --chown=node:node --from=base /home/node/kbn /home/node/kbn
+WORKDIR /home/node/kbn

docker/osd-dev/dev.sh

@@ -9,6 +9,8 @@ os_versions=(
  '2.4.0'
  '2.4.1'
  '2.6.0'
+ '2.8.0'
+ '2.9.0'
 )
 
 osd_versions=(
@@ -20,6 +22,8 @@ osd_versions=(
  '2.4.0'
  '2.4.1'
  '2.6.0'
+ '4.6.0'
+ '4.7.0'
 )
 
 usage() {
@@ -71,9 +75,16 @@ export OSD_VERSION=$2
 export OSD_PORT=${PORT:-5601}
 export IMPOSTER_PORT=8081
 export SRC=$3
-export OSD_MAJOR=$(echo $OSD_VERSION | cut -d. -f1).x
+export OSD_MAJOR_NUMBER=$(echo $OSD_VERSION | cut -d. -f1)
 export COMPOSE_PROJECT_NAME=os-dev-${OSD_VERSION//./}
 
+if [[ "$OSD_MAJOR_NUMBER" -ge 2 ]];
+then
+ export OSD_MAJOR="2.x"
+else
+ export OSD_MAJOR="1.x"
+fi
+
 profile="standard"
 export WAZUH_DASHBOARD_CONF=./config/${OSD_MAJOR}/osd/opensearch_dashboards.yml
 export SEC_CONFIG_FILE=./config/${OSD_MAJOR}/os/config.yml

plugins/main/public/controllers/agent/components/agents-preview.scss

@@ -57,7 +57,7 @@
  position: absolute;
  top: 0;
  width: 100%;
- height: 100%;
+ height: 90%;
  display: flex;
  flex-direction: column;
  justify-content: center;

plugins/main/public/controllers/register-agent/components/command-output/command-output.tsx

@@ -9,6 +9,7 @@ import {
 } from '@elastic/eui';
 import React, { Fragment, useEffect, useState } from 'react';
 import { tOperatingSystem } from '../../core/config/os-commands-definitions';
+import { osdfucatePasswordInCommand } from '../../services/wazuh-password-service';
 
 interface ICommandSectionProps {
  commandText: string;
@@ -20,13 +21,6 @@ interface ICommandSectionProps {
 
 export default function CommandOutput(props: ICommandSectionProps) {
  const { commandText, showCommand, onCopy, os, password } = props;
- const getHighlightCodeLanguage = (os: 'WINDOWS' | string) => {
- if (os.toLowerCase() === 'windows') {
- return 'powershell';
- } else {
- return 'bash';
- }
- };
  const [havePassword, setHavePassword] = useState(false);
  const [showPassword, setShowPassword] = useState(false);
 
@@ -45,27 +39,23 @@ export default function CommandOutput(props: ICommandSectionProps) {
  setHavePassword(false);
  setCommandToShow(commandText);
  }
- }, [password, commandText, showPassword])
+
+ }, [password, commandText, showPassword]);
 
  const osdfucatePassword = (password: string) => {
- if(!password) return;
- if(!commandText) return;
+ if (!password) return;
+ if (!commandText) return;
 
- if(showPassword){
+ if (showPassword) {
  setCommandToShow(commandText);
- }else{
- // search password in commandText and replace with * for every character
- const findPassword = commandText.search(password);
- if (findPassword > -1) {
- let command = commandText;
- setCommandToShow(command.replace(/WAZUH_REGISTRATION_PASSWORD='([^']+)'/,`WAZUH_REGISTRATION_PASSWORD='${'*'.repeat(password.length)}'`));
- }
+ } else {
+ setCommandToShow(osdfucatePasswordInCommand(password, commandText, os));
  }
- }
-
+ };
+ 
  const onChangeShowPassword = (event: EuiSwitchEvent) => {
  setShowPassword(event.target.checked);
- }
+ };
 
  return (
  <Fragment>
@@ -76,7 +66,7 @@ export default function CommandOutput(props: ICommandSectionProps) {
  style={{
  zIndex: '100',
  }}
- language={getHighlightCodeLanguage(os || '')}
+ language='tsx'
  >
  {showCommand ? commandToShow : ''}
  </EuiCodeBlock>
@@ -96,7 +86,13 @@ export default function CommandOutput(props: ICommandSectionProps) {
  )}
  </div>
  <EuiSpacer size='s' />
- {showCommand && havePassword ? <EuiSwitch checked={showPassword} label='Show password' onChange={onChangeShowPassword}/> : null}
+ {showCommand && havePassword ? (
+ <EuiSwitch
+ checked={showPassword}
+ label='Show password'
+ onChange={onChangeShowPassword}
+ />
+ ) : null}
  </EuiText>
  </Fragment>
  );

plugins/main/public/controllers/register-agent/containers/register-agent/register-agent.tsx

@@ -30,6 +30,8 @@ import {
  validateServerAddress,
  validateAgentName,
 } from '../../utils/validations';
+import { getPasswordWithScapedSpecialCharacters } from '../../services/wazuh-password-service';
+
 
 interface IRegisterAgentProps {
  getWazuhVersion: () => Promise<string>;
@@ -127,6 +129,7 @@ export const RegisterAgent = withReduxProvider(
  configuration['enrollment.password'] ||
  authInfo['authd.pass'] ||
  '';
+ //wazuhPassword = getPasswordWithScapedSpecialCharacters(wazuhPassword);
  }
  const groups = await getGroups();
  setNeedsPassword(needsPassword);

plugins/main/public/controllers/register-agent/containers/steps/steps.tsx

@@ -114,7 +114,7 @@ export const Steps = ({
  ) {
  selectOS(registerAgentFormValues.operatingSystem as tOperatingSystem);
  }
- setOptionalParams({ ...registerAgentFormValues.optionalParams });
+ setOptionalParams({ ...registerAgentFormValues.optionalParams }, registerAgentFormValues.operatingSystem as tOperatingSystem);
  setInstallCommandWasCopied(false);
  setStartCommandWasCopied(false);
  }, [registerAgentFormValues]);

plugins/main/public/controllers/register-agent/core/config/os-commands-definitions.ts

@@ -6,6 +6,7 @@ import {
  getMacosStartCommand, 
  getWindowsInstallCommand, 
  getWindowsStartCommand } from '../../services/register-agent-os-commands-services';
+import { scapeSpecialCharsForLinux, scapeSpecialCharsForMacOS, scapeSpecialCharsForWindows } from '../../services/wazuh-password-service';
 import { IOSDefinition, tOptionalParams } from '../register-commands/types';
 
 // Defined OS combinations
@@ -149,21 +150,21 @@ export const osCommandsDefinitions = [
 export const optionalParamsDefinitions: tOptionalParams<tOptionalParameters> = {
  serverAddress: {
  property: 'WAZUH_MANAGER',
- getParamCommand: props => {
+ getParamCommand: (props,selectedOS) => {
  const { property, value } = props;
  return value !== '' ? `${property}='${value}'` : '';
  },
  },
  agentName: {
  property: 'WAZUH_AGENT_NAME',
- getParamCommand: props => {
+ getParamCommand: (props,selectedOS) => {
  const { property, value } = props;
  return value !== '' ? `${property}='${value}'` : '';
  },
  },
  agentGroups: {
  property: 'WAZUH_AGENT_GROUP',
- getParamCommand: props => {
+ getParamCommand: (props,selectedOS) => {
  const { property, value } = props;
  let parsedValue = value;
  if (Array.isArray(value)) {
@@ -174,16 +175,34 @@ export const optionalParamsDefinitions: tOptionalParams<tOptionalParameters> = {
  },
  protocol: {
  property: 'WAZUH_PROTOCOL',
- getParamCommand: props => {
+ getParamCommand: (props,selectedOS) => {
  const { property, value } = props;
  return value !== '' ? `${property}='${value}'` : '';
  },
  },
  wazuhPassword: {
  property: 'WAZUH_REGISTRATION_PASSWORD',
- getParamCommand: props => {
+ getParamCommand: (props,selectedOS) => {
  const { property, value } = props;
- return value !== '' ? `${property}='${value}'` : '';
+ if(!value){
+ return '';
+ }
+ if(selectedOS){
+ let osName = selectedOS.name.toLocaleLowerCase();
+ switch(osName){
+ case "linux":
+ return `${property}=$'${scapeSpecialCharsForLinux(value)}'`;
+ case "macos":
+ return `${property}='${scapeSpecialCharsForMacOS(value)}'`;
+ case "windows":
+ return `${property}='${scapeSpecialCharsForWindows(value)}'`;
+ default:
+ return `${property}=$'${value}'`;
+ }
+
+ }
+
+ return value !== '' ? `${property}=$'${value}'` : '';
  },
  },
 };

plugins/main/public/controllers/register-agent/core/register-commands/command-generator/command-generator.ts

@@ -59,9 +59,9 @@ export class CommandGenerator<OS extends IOperationSystem, Params extends string
  * @param props - The optional parameters to select
  * @returns The selected optional parameters
  */
- addOptionalParams(props: IOptionalParameters<Params>): void {
+ addOptionalParams(props: IOptionalParameters<Params>, selectedOS?: OS): void {
  // Get all the optional parameters based on the given parameters
- this.optionals = this.optionalsManager.getAllOptionalParams(props);
+ this.optionals = this.optionalsManager.getAllOptionalParams(props, selectedOS);
  }
 
  /**

plugins/main/public/controllers/register-agent/core/register-commands/optional-parameters-manager/optional-parameters-manager.ts

@@ -1,5 +1,6 @@
+import { tOperatingSystem } from '../../config/os-commands-definitions';
 import { NoOptionalParamFoundException } from '../exceptions';
-import { IOptionalParamInput, IOptionalParameters, IOptionalParametersManager, tOptionalParams } from '../types';
+import { IOperationSystem, IOptionalParamInput, IOptionalParameters, IOptionalParametersManager, tOptionalParams } from '../types';
 
 export class OptionalParametersManager<Params extends string> implements IOptionalParametersManager<Params> {
  constructor(private optionalParamsConfig: tOptionalParams<Params>) {}
@@ -10,7 +11,7 @@ export class OptionalParametersManager<Params extends string> implements IOption
  * @returns The command string for the given optional parameter.
  * @throws NoOptionalParamFoundException if the given optional parameter name is not found in the configuration.
  */
- getOptionalParam(props: IOptionalParamInput<Params>) {
+ getOptionalParam(props: IOptionalParamInput<Params>, selectedOS?: IOperationSystem) {
  const { value, name } = props;
  if (!this.optionalParamsConfig[name]) {
  throw new NoOptionalParamFoundException(name);
@@ -19,7 +20,8 @@ export class OptionalParametersManager<Params extends string> implements IOption
  value,
  property: this.optionalParamsConfig[name].property,
  name
- });
+ },
+ selectedOS);
  }
 
  /**
@@ -28,7 +30,7 @@ export class OptionalParametersManager<Params extends string> implements IOption
  * @returns An object containing the command strings for all optional parameters with non-empty values.
  * @throws NoOptionalParamFoundException if any of the given optional parameter names is not found in the configuration.
  */
- getAllOptionalParams(paramsValues: IOptionalParameters<Params>){
+ getAllOptionalParams(paramsValues: IOptionalParameters<Params>, selectedOS: IOperationSystem){
  // get keys for only the optional params with values !== ''
  const optionalParams = Object.keys(paramsValues).filter(key => paramsValues[key as keyof typeof paramsValues] !== '') as Array<keyof typeof paramsValues>;
  const resolvedOptionalParams: any = {};
@@ -42,7 +44,7 @@ export class OptionalParametersManager<Params extends string> implements IOption
  name: param as Params,
  value: paramsValues[param] as string,
  property: paramDef.property
- }) as string;
+ }, selectedOS) as string;
  }
  return resolvedOptionalParams;
  }

plugins/main/public/controllers/register-agent/core/register-commands/types.ts

@@ -1,5 +1,8 @@
 /////////////////////////////////////////////////////////
 /// Domain
+
+import { tOperatingSystem } from "../../hooks/use-register-agent-commands.test";
+
 /////////////////////////////////////////////////////////
 export interface IOperationSystem {
  name: string;
@@ -51,7 +54,7 @@ export type tOptionalParamsCommandProps<T extends string> = IOptionalParamProps
 };
 export interface IOptionsParamConfig<T extends string> {
  property: string;
- getParamCommand: (props: tOptionalParamsCommandProps<T>) => string;
+ getParamCommand: (props: tOptionalParamsCommandProps<T>, selectedOS?: IOperationSystem) => string;
 }
 
 export type tOptionalParams<T extends string> = {
@@ -64,7 +67,7 @@ export interface IOptionalParamInput<T extends string> {
 }
 export interface IOptionalParametersManager<T extends string> {
  getOptionalParam(props: IOptionalParamInput<T>): string;
- getAllOptionalParams(paramsValues: IOptionalParameters<T>): object;
+ getAllOptionalParams(paramsValues: IOptionalParameters<T>, selectedOs?: IOperationSystem): object;
 }
 
 ///////////////////////////////////////////////////////////////////
@@ -79,7 +82,7 @@ export interface ICommandGenerator<OS extends IOperationSystem, Params extends s
 
 export interface ICommandGeneratorMethods<T extends string> {
  selectOS(params: IOperationSystem): void;
- addOptionalParams(props: IOptionalParameters<T>): void;
+ addOptionalParams(props: IOptionalParameters<T>, osSelected?: IOperationSystem): void;
  getInstallCommand(): string;
  getStartCommand(): string;
  getUrlPackage(): string;

plugins/main/public/controllers/register-agent/hooks/use-register-agent-commands.ts

@@ -15,7 +15,7 @@ interface IUseRegisterCommandsProps<OS extends IOperationSystem, Params extends
 
 interface IUseRegisterCommandsOutput<OS extends IOperationSystem, Params extends string> {
  selectOS: (params: OS) => void;
- setOptionalParams: (params: IOptionalParameters<Params>) => void;
+ setOptionalParams: (params: IOptionalParameters<Params>, selectedOS?: OS) => void;
  installCommand: string;
  startCommand: string;
  optionalParamsParsed: IOptionalParameters<Params> | {};
@@ -62,7 +62,7 @@ export function useRegisterAgentCommands<OS extends IOperationSystem, Params ext
  }
  if (optionalParamsValues) {
  commandGenerator.addOptionalParams(
- optionalParamsValues as IOptionalParameters<Params>,
+ optionalParamsValues as IOptionalParameters<Params>, osSelected
  );
  }
  const installCommand = commandGenerator.getInstallCommand();
@@ -93,8 +93,8 @@ export function useRegisterAgentCommands<OS extends IOperationSystem, Params ext
  * @param {IOptionalParameters} params - The optional parameters to be set.
  * @returns {void}
  */
- const setOptionalParams = (params: IOptionalParameters<Params>): void => {
- commandGenerator.addOptionalParams(params);
+ const setOptionalParams = (params: IOptionalParameters<Params>, selectedOS?: OS): void => {
+ commandGenerator.addOptionalParams(params,selectedOS);
  setOptionalParamsValues(params);
  setOptionalParamsParsed(commandGenerator.getOptionalParamsCommands());
  };