Custom branding: PDF reports

[AlexRuiz7]

Description

As described in #4392, we need to add the ability to white-label the reports generated by the App.

Pre-conditions

• Custom branding: assets upload #4434

Tasks

• (1) Use of custom logo in reports
• (2) Customizable email and website information in reports #3892
• (3) Use of custom copyright mark in reports

Custom logo

Definitions

• wazuh_logo: Wazuh's original logo, as seen in the image.
• custom_logo: user chosen logo. By default, this logo will be a copy of wazuh_logo.

Strategy

These 2 logos will live in the app's space simultaneously (the paths are yet to be defined). The app will always use the custom_logo. The following states and mutations are allowed:

• (S) initial: custom_logo = wazuh_logo
• (M) update: custom_logo overwritten with uploaded logo
• (M) delete: custom_logo overwritten with wazuh_logo

Depends on: #4443

[Desvelao]

Proposal

Goal

The user should be able to customize the data displayed in the PDF reports related to:

• the header (in the example, the company's site and email)
• the footer (in the example, the Copyright)

Implementation

Add the new plugin's settings and use them if the custom branding is enabled.

We want to offer the users the possibility to add whatever they like in the header and the footer of the PDF reports, not only the website, the email and the copyright, as seen in the example.

New settings

Setting	Description	Configurable in file	Configurable in UI	Validation
customization.reports.header	Header text for PDF reports	Yes	Yes	Max: 3 lines. Max characters by line: 20
customization.reports.footer	Footer text for PDF reports	Yes	Yes	Max: 2 lines. Max characters by line: 30

Tasks

• Create the new plugin's settings.
• Adapt the PDF report generation to use these new settings.
• Test

[Desvelao]

I added the new settings and adapted the generation of PDF reports.

I think it will be interesting to support multiple lines. This requires changing the input type (and the input form in the Settings/Configuration view) and see how the data is stored in the configuration file. I found some problems when the values contain new lines.

Tasks

• Fix the current problems when new lines are used in the footer and header values.

[Desvelao]

Should we allow the users to use empty strings in these values?

In that case, anything will be displayed in the related sections of the PDF.

[Desvelao]

• Fixed a problem when using multiple lines in the value of the settings cutomization.reports.footer and customization.reports.header and saving the configuration from UI.

[Desvelao]

Enhancement suggestion

I was investigating the possibility to resize the custom logo in the PDF reports.

It is possible to use the fit property to fit the image to the defined size in the property. More information in https://pdfmake.github.io/docs/0.1/document-definition-object/images.

We could use it to avoid the custom image overlay the text of the report.

[Desvelao]

Update

• Added a character count limitation