Web File Repository

This Integration is part of the Web File Repository Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

Simple web server with a file uploading console to store small files. This is helpful to make your environment ready for testing purpose for your playbooks or automations to download files from a web server.

Configure Web File Repository in Cortex#

Parameter	Description	Required
Incident type		False
Long running instance		False
Port mapping (<port> or <host port>:<docker port>)	Runs the service on this port from within Cortex XSOAR. Requires a unique port for each long-running integration instance. Do not use the same port for multiple instances. Note: If you click the test button more than once, a failure may occur mistakenly indicating that the port is already in use. (For Cortex XSOAR 8 and Cortex XSIAM) If you do not enter a port, an unused port for Web File Repository will automatically be generated when the instance is saved. However, if using an engine, you must enter a port.	True
User ID for Read/Write		False
Password		False
User ID for Read-Only		False
Password		False
Authentication Method	Some of the browsers such as Chrome may not support Digest-sha256.	False
Public Read Access	Authentication is not requiured for read access	False
MIME Types for file extensions	"mime-type extension [extension]*" for each line, wild-card file extensions are supported.	False
Merge with Default MIME Types	Set true to merge the specified types with the default settings, false to replace them	False
Attachment extensions	List of extensions to set "attachment" to Content-Disposition	False
Storage Protection		True
The maximum repository size		False
The maximum sandbox repository size		False

How to Access the File Management UI#

Access the File Management UI by URL and Port (HTTP)#

In a web browser, go to http://<cortex-xsoar-server-address>:<listen_port>.

Access the File Management UI by Instance Name (HTTPS)#

To access the File Management UI by instance name, make sure Instance execute external is enabled.

In Cortex XSOAR 6.x:
1. Navigate to Settings > About > Troubleshooting.
2. In the Server Configuration section, verify that the instance.execute.external.<instance_name> key is set to true. If this key does not exist, click + Add Server Configuration and add the instance.execute.external.<instance_name> and set the value to true. See this documentation for further information.
In a web browser:
- For Cortex XSOAR 6.x: Go to https://<cortex-xsoar-address>/instance/execute/<instance_name>.
- For Cortex XSOAR 8 On-prem, Cortex XSOAR 8 Cloud, or Cortex XSIAM: Go to https://ext-<tenant>.crtx.<region>.paloaltonetworks.com/xsoar/instance/execute/<instance-name>.
- For Multi Tenant environments: Go to https://<cortex-xsoar-address>/acc_<account name>/instance/execute/<instance_name>.
  Note:
  For Cortex XSOAR 8 On-prem, you need to add the ext- FQDN DNS record to map the Cortex XSOAR DNS name to the external IP address.
  For example, ext-xsoar.mycompany.com.

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

wfr-status#

Get the service status

Base Command#

wfr-status

Input#

Argument Name	Description	Required

Context Output#

Path	Type	Description
WebFileRepository.Status.StorageUsage	number	The current storage usage in bytes
WebFileRepository.Status.SandboxUsage	number	The current sandbox usage in bytes
WebFileRepository.Status.StorageProtection	string	The storage protection mode
WebFileRepository.Status.IntercommunicationIP	string	The IP address of the service to which the internal client connects
WebFileRepository.Status.IntercommunicationPort	number	The port number of the service to which the internal client connects
WebFileRepository.Status.ExternaIP	unknown	The external IP address of the service
WebFileRepository.Status.ExternalPort	unknown	The external port number of the service
WebFileRepository.Status.ServerIP	string	The IP address of the service
WebFileRepository.Status.ServerPort	number	The port number of the service

wfr-cleanup#

Remove all the files from the repository

Base Command#

wfr-cleanup

Input#

Argument Name	Description	Required

Context Output#

There is no context output for this command.

wfr-upload-as-file#

Upload a file from data to the repository.

Base Command#

wfr-upload-as-file

Input#

Argument Name	Description	Required
file_name	The name of the file.	Required
data	Input data to create the file.	Optional
encoding	Encoding type of the input data. Default is utf-8.	Optional
extract_archive	Set to true to extract files to archive files, otherwise false. Possible values are: true, false. Default is false.	Optional
upload_directory	The directory path where to upload. Default is /.	Optional

Context Output#

There is no context output for this command.

wfr-upload-file#

Upload a file to the repository

Base Command#

wfr-upload-file

Input#

Argument Name	Description	Required
entry_id	The entry ID list of the file.	Required
file_name	The name of the file.	Optional
extract_archive	Set to true to extract files to archive files, otherwise false. Possible values are: true, false. Default is false.	Optional
upload_directory	The directory path where to upload. Default is /.	Optional

Context Output#

There is no context output for this command.

wfr-upload-files#

Upload files to the repository

Base Command#

wfr-upload-files

Input#

Argument Name	Description	Required
entry_ids	The entry ID list of files.	Required
extract_archive	Set to true to extract files to archive files, otherwise false. Possible values are: true, false. Default is false.	Optional
upload_directory	The directory path where to upload. Default is /.	Optional

Context Output#

There is no context output for this command.

wfr-list-files#

List files in the repository

Base Command#

wfr-list-files

Input#

Argument Name	Description	Required
directory	The directory path where to list files. Default is /.	Optional
recursive	Set to true to list subdirectories recursively, otherwise false. Possible values are: true, false. Default is false.	Optional

Context Output#

Path	Type	Description
WebFileRepository.Files.Name	string	The file name
WebFileRepository.Files.Path	string	The file path
WebFileRepository.Files.Size	number	The file size in bytes
WebFileRepository.Files.LastModified	date	The last modified time

wfr-remove-files#

Remove files from the repository

Base Command#

wfr-remove-files

Input#

Argument Name	Description	Required
paths	The list of the file paths.	Required

Context Output#

There is no context output for this command.

wfr-download-file#

Download a file from the repository

Base Command#

wfr-download-file

Input#

Argument Name	Description	Required
path	The file path.	Required
save_as	The name to give the file to save.	Optional

Context Output#

There is no context output for this command.

wfr-download-as-text#

Retrieve the file data from the repository into the context.

Base Command#

wfr-download-as-text

Input#

Argument Name	Description	Required
path	The file path.	Required
encoding	Encoding type to convert the file data when setting to the context. Default is utf-8.	Optional

Context Output#

Path	Type	Description
WebFileRepository.Files.Name	string	The file name
WebFileRepository.Files.Path	string	The file path
WebFileRepository.Files.Size	number	The file size in bytes
WebFileRepository.Files.Data	string	The file data encoded in the encoding
WebFileRepository.Files.Encoding	string	The encoding name

wfr-archive-zip#

Download a file to which all the files are archived

Base Command#

wfr-archive-zip

Input#

Argument Name	Description	Required
save_as	The name to give the archive-file to save.	Optional

Context Output#

There is no context output for this command.

wfr-reset#

Reset the repository data

Base Command#

wfr-reset

Input#

Argument Name	Description	Required

Context Output#

There is no context output for this command.