Web File Repository

category: Utilities
provider: Open Source
sectionorder:
- Connect
- Collect
commonfields:
  id: Web File Repository
  version: -1
configuration:
- display: Incident type
  name: incidentType
  type: 13
  required: false
  section: Collect
- defaultvalue: "true"
  display: Long running instance
  name: longRunning
  type: 8
  required: false
  section: Connect
- display: Port mapping (<port> or <host port>:<docker port>)
  name: longRunningPort
  required: true
  type: 0
  additionalinfo: "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."
  section: Connect
- display: User ID for Read/Write
  displaypassword: Password
  name: rwCredentials
  type: 9
  required: false
  section: Connect
- display: User ID for Read-Only
  displaypassword: Password
  name: roCredentials
  type: 9
  required: false
  section: Connect
- additionalinfo: Some of the browsers such as Chrome may not support Digest-sha256.
  display: Authentication Method
  name: authenticationMethod
  options:
  - Basic
  - Digest-md5
  - Digest-sha256
  type: 15
  required: false
  section: Connect
- additionalinfo: Authentication is not required for read access
  defaultvalue: "true"
  display: Public Read Access
  name: publicReadAccess
  type: 8
  required: false
  section: Connect
- additionalinfo: '"mime-type  extension [extension]*" for each line, wild-card file extensions are supported.'
  display: MIME Types for file extensions
  name: mimeTypes
  type: 12
  required: false
  section: Collect
- additionalinfo: Set true to merge the specified types with the default settings, false to replace them
  defaultvalue: "true"
  display: Merge with Default MIME Types
  name: mergeMimeTypes
  type: 8
  required: false
  section: Collect
- additionalinfo: List of extensions to set "attachment" to Content-Disposition
  display: Attachment extensions
  name: attachmentExtensions
  type: 0
  required: false
  section: Collect
- defaultvalue: read/write
  display: Storage Protection
  name: storageProtection
  options:
  - read/write
  - read-only
  - sandbox
  required: true
  type: 15
  section: Collect
- defaultvalue: 100MB
  display: The maximum repository size
  name: maxStorageSize
  type: 0
  required: false
  section: Collect
- defaultvalue: 1GB
  display: The maximum sandbox repository size
  name: maxSandboxSize
  type: 0
  required: false
  section: Collect
description: |-
  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.
display: Web File Repository
name: Web File Repository
script:
  commands:
  - arguments: []
    description: Get the service status.
    name: wfr-status
    outputs:
    - contextPath: WebFileRepository.Status.StorageUsage
      description: The current storage usage in bytes.
      type: number
    - contextPath: WebFileRepository.Status.SandboxUsage
      description: The current sandbox usage in bytes.
      type: number
    - contextPath: WebFileRepository.Status.StorageProtection
      description: The storage protection mode.
      type: string
    - contextPath: WebFileRepository.Status.IntercommunicationIP
      description: The IP address of the service to which the internal client connects.
      type: string
    - contextPath: WebFileRepository.Status.IntercommunicationPort
      description: The port number of the service to which the internal client connects.
      type: number
    - contextPath: WebFileRepository.Status.ExternaIP
      description: The external IP address of the service.
    - contextPath: WebFileRepository.Status.ExternalPort
      description: The external port number of the service.
    - contextPath: WebFileRepository.Status.ServerIP
      description: The IP address of the service.
      type: string
    - contextPath: WebFileRepository.Status.ServerPort
      description: The port number of the service.
      type: number
  - arguments: []
    description: Remove all the files from the repository.
    name: wfr-cleanup
  - arguments:
    - description: The entry ID of the file.
      name: entry_id
      required: true
    - description: The name of the file.
      name: file_name
    - auto: PREDEFINED
      defaultValue: "false"
      description: Set to true to extract files to archive files, otherwise false.
      name: extract_archive
      predefined:
      - "true"
      - "false"
    - defaultValue: /
      description: The directory path where to upload.
      name: upload_directory
    description: Upload files to the repository.
    name: wfr-upload-file
  - arguments:
    - name: file_name
      required: true
      description: The name of the file.
    - name: data
      description: Input data to create the file.
    - name: encoding
      auto: PREDEFINED
      predefined:
      - utf-8
      - base64
      description: Encoding type of the input data. Default is utf-8.
      defaultValue: utf-8
    - name: extract_archive
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      description: Set to true to extract files to archive files, otherwise false.
      defaultValue: "false"
    - name: upload_directory
      description: The directory path where to upload.
      defaultValue: /
    description: Upload a file from data to the repository.
    name: wfr-upload-as-file
  - arguments:
    - description: The entry ID list of files.
      isArray: true
      name: entry_ids
      required: true
    - auto: PREDEFINED
      defaultValue: "false"
      description: Set to true to extract files to archive files, otherwise false.
      name: extract_archive
      predefined:
      - "true"
      - "false"
    - defaultValue: /
      description: The directory path where to upload.
      name: upload_directory
    description: Upload files to the repository.
    name: wfr-upload-files
  - arguments:
    - defaultValue: /
      description: The directory path where to list files.
      name: directory
    - auto: PREDEFINED
      defaultValue: "false"
      description: Set to true to list subdirectories recursively, otherwise false.
      name: recursive
      predefined:
      - "true"
      - "false"
    description: List files in the repository.
    name: wfr-list-files
    outputs:
    - contextPath: WebFileRepository.Files.Name
      description: The file name.
      type: string
    - contextPath: WebFileRepository.Files.Path
      description: The file path.
      type: string
    - contextPath: WebFileRepository.Files.Size
      description: The file size in bytes.
      type: number
    - contextPath: WebFileRepository.Files.LastModified
      description: The last modified time.
      type: date
  - arguments:
    - description: The list of the file paths.
      isArray: true
      name: paths
      required: true
    description: Remove files from the repository.
    name: wfr-remove-files
  - arguments:
    - description: The file path.
      name: path
      required: true
    - description: The name to give the file to save.
      name: save_as
    description: Download a file from the repository.
    name: wfr-download-file
  - arguments:
    - name: path
      required: true
      description: The file path.
    - name: encoding
      auto: PREDEFINED
      predefined:
      - utf-8
      - base64
      description: Encoding type to convert the file data when setting to the context.
        Default is utf-8.
      defaultValue: utf-8
    outputs:
    - contextPath: WebFileRepository.Files.Name
      description: The file name.
      type: string
    - contextPath: WebFileRepository.Files.Path
      description: The file path.
      type: string
    - contextPath: WebFileRepository.Files.Size
      description: The file size in bytes.
      type: number
    - contextPath: WebFileRepository.Files.Data
      description: The file data encoded in the encoding.
      type: string
    - contextPath: WebFileRepository.Files.Encoding
      description: The encoding name.
      type: string
    description: Retrieve the file data from the repository into the context.
    name: wfr-download-as-text
  - arguments:
    - description: The name to give the archive-file to save.
      name: save_as
    description: Download a file to which all the files are archived.
    name: wfr-archive-zip
  - arguments: []
    description: Reset the repository data.
    name: wfr-reset
  dockerimage: demisto/bottle:1.0.0.10133006
  longRunning: true
  longRunningPort: true
  resetContext: true
  script: ''
  subtype: python3
  type: python
fromversion: 6.0.0
tests:
- No tests (auto formatted)
triggers:
  - conditions:
      - name: engine
        operator: not_exists
      - name: isEngineGroup
        operator: not_exists
    effects:
      - name: longRunningPort
        action:
          hidden: true
          required: false