Server Message Block (SMB) Deprecated

Deprecated. Use the Server Message Block (SMB) v2 integration instead.

Details

ID	`Server Message Block (SMB)`
Provider	Microsoft
Category	Utilities
From Version	5.0.0
Docker Image	`demisto/smb:1.0.0.7685`
Supported Modules	Agentix Cloud Runtime Security Cloud Posture Security XSIAM EDR Cortex Cloud

README

Use the SMB integration to upload and download files from an SMB protocol.

The integration will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. Otherwise, the integration will automatically fall back to use SMB1 protocol.

Configure SMB on Cortex XSOAR

If you did not configure the Server IP / Hostname, Server NetBIOS (AD) Name, or Domain parameters, you can configure them later on as command arguments. In that case, the test command in the instance configuration will return an error.

Navigate to Settings > Integrations > Servers & Services.
Search for SMB.
Click Add instance to create and configure a new integration instance.
- Name: a textual name for the integration instance.
- Server IP / Hostname
- Port
- Server NetBIOS (AD) Name
- Domain
- Username
- Use system proxy settings
Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR 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.

Download a file: smb-download
Upload a file: smb-upload

1. Download a file

Downloads a file from an SMB server.

Base Command

smb-download

Input

Argument Name	Description	Required
hostname	Server IP address or hostname, for example, 1.2.3.4.	Optional
nbname	Name of the server NetBIOS (AD).	Optional
domain	The host domain.	Optional
file_path	The path to the file, starting from the share	Required
download_and_attach	If "yes", the file is downloaded and attached. If "no", only the output is attached. Default is "yes".	Optional

Command Example

!smb-download file_path=/Shared/test.txt

Context Output

playground - war room 2018-11-21 16-34-35

War Room Output

2. Upload a file

Uploads a file to an SMB server.

Base Command

smb-upload

Input

Argument Name	Description	Required
hostname	Server IP address or hostname, for example, 1.2.3.4.	Optional
nbname	Name of the server NetBIOS (AD).	Optional
domain	The host domain.	Optional
file-path	The path to the file, starting from the share, for example: Share/Folder/File.	Required
entryID	The entry ID to the file to send to the share.	Optional
content	The content of the file to send to the share	Optional

Troubleshooting

The following error might be due to an incorrect file path, or a permissions issue.

playground - war room 2018-11-21 16-35-18

Configuration parameters

hostname — Server IP / Hostname (e.g. 1.2.3.4)
port — Port (required)
nbname — Server NetBIOS (AD) Name
domain — Domain
credentials — Username (required)
proxy — Use system proxy settings

Commands (2)

smb-download Deprecated
Downloads a file from the SMB server.
smb-upload Deprecated
Uploads a file to the SMB server.

Source

SMB.py SMB.yml SMB_description.md

Download History Raw

category: Utilities
provider: Microsoft
commonfields:
  id: Server Message Block (SMB)
  version: -1
configuration:
- display: Server IP / Hostname (e.g. 1.2.3.4)
  name: hostname
  type: 0
  required: false
- defaultvalue: '445'
  display: Port
  name: port
  required: true
  type: 0
- display: Server NetBIOS (AD) Name
  name: nbname
  type: 0
  required: false
- display: Domain
  name: domain
  type: 0
  required: false
- display: Username
  name: credentials
  required: true
  type: 9
- defaultvalue: 'false'
  display: Use system proxy settings
  name: proxy
  type: 8
  required: false
description: Deprecated. Use the Server Message Block (SMB) v2 integration instead.
display: Server Message Block (SMB) (Deprecated)
name: Server Message Block (SMB)
deprecated: true
script:
  commands:
  - arguments:
    - name: hostname
      description: 'Server IP address / hostname, for example: 1.2.3.4.'
    - name: nbname
      description: Server NetBIOS (AD) name.
    - name: domain
      description: The host domain
    - name: file_path
      required: true
      default: true
      description: 'The path to the file, starting from the share, for example: Share/Folder/File.'
    - name: download_and_attach
      auto: PREDEFINED
      predefined:
      - "yes"
      - "no"
      description: 'If "yes", the file is downloaded and attached. If "no", only the output is attached. Default is yes".'
      defaultValue: "yes"
    outputs:
    - contextPath: File.Size
      description: File size.
      type: number
    - contextPath: File.SHA1
      description: SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: SHA256 hash of the file.
      type: string
    - contextPath: File.Name
      description: File name.
      type: string
    - contextPath: File.SSDeep
      description: SSDeep hash of the file.
      type: string
    - contextPath: File.EntryID
      description: File entry ID.
      type: string
    - contextPath: File.Info
      description: Information about the file.
      type: string
    - contextPath: File.Type
      description: File type.
      type: string
    - contextPath: File.MD5
      description: MD5 hash of the file.
      type: string
    deprecated: true
    description: Downloads a file from the SMB server.
    name: smb-download
  - arguments:
    - name: hostname
      description: 'Server IP address / hostname, for example: 1.2.3.4.'
    - name: nbname
      description: Server NetBIOS (AD) name.
    - name: domain
      description: The host domain
    - name: file_path
      required: true
      description: 'The path to the file, starting from the share, for example: Share/Folder/File.'
    - name: entryID
      description: EntryID of the file to send to the share.
    - name: content
      description: File content to send to the share. Ignored if EntryID argument is specified.
    deprecated: true
    description: Uploads a file to the SMB server.
    name: smb-upload
  dockerimage: demisto/smb:1.0.0.7685
  runonce: false
  script: '-'
  type: python
  subtype: python2
tests:
- SMB test
fromversion: 5.0.0