Skip to main content

Cyware Orchestrate

pfSense

App Vendor: pfSense

Connector Category: Network Security

Connector Version: 1.1.0

API Version: 1.0.0

About App

pfSense makes it easy for administrators to use a terminal or edit config files, prepare custom reports on traffic and threats, seek robust searches with powerful log forensics, and much more. The pfSense app allows security teams to integrate with the pfSense enterprise application to block and unblock IP addresses, thereby assisting in threat management and load balancing.

The pfSense app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Unblock IP address

This action unblocks an IP address.

Block IP address

This action blocks an IP address.

Generic Action

This is a generic action to perform any additional use case on the pfSense application.

Configuration parameters

The following configuration parameters are required for the pfSense app to communicate with the pfSense enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required / Optional

Comments

Hostname

Enter the Hostname.

Example:

"pfsense.stegnophora.in"

Text

Required

Username

Enter the Username.

Text

Required

Port

Enter the Port number.

Text

Required

SSH Key

Enter the SSH Key.

Text

Required

SSH Phrase

Enter the SSH Phrase.

Text

Required

Action: Unblock IP address

This action unblocks an IP address in the pfSense app.

Action Input parameters

Parameter

Description

Field Type

Required / Optional

Comments

IP address

Enter the IP address that needs to be blocked.

Example:

"1.1.1.1"

Text

Required

Interface

Enter the interface on which the IP address needs to be blocked.

Example:

"eth0"

Text

Optional

Example Request
[
    {
        "ip": "1.1.1.1"
    }
]
Action: Block IP Address

This action blocks an IP address in the pfSense app.

Action Input parameters

Parameter

Description

Field Type

Required / Optional

Comments

IP address

Enter the IP address that needs to be blocked.

Example:

"1.1.1.1"

Text

Required

Interface

Enter the interface on which the IP address needs to be blocked.

Example:

"eth0"

Text

Optional

Example Request
[
    {
        "ip": "1.1.1.1"
    }
]
Action: Generic Action

This is a generic action to perform any additional use case on the pfSense application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Command

Enter the command to perform on the pfSense application.

Example:

"pfctl -t blacklist -T add"

Text

Optional

Example Request

[
   {
      "command":"pfctl -t blacklist -T add"
   }
]