SMB

Learn how to configure an SMB Connection for Infisical.

The SMB Connection allows Infisical to connect to Windows servers using the SMB (Server Message Block) protocol for remote management operations such as password rotation.

Prerequisites

You will need the following information to establish an SMB connection:

• Host - The hostname or IP address of the Windows server
• Port - The SMB port (default is 445)
• Username - A Windows administrator account with permissions to manage local accounts
• Password - The password for the administrator account
• Domain (optional) - The Windows domain name for domain-joined servers

Windows Server Requirements

• SMB3 Support - This connection uses SMB3 with encryption enabled for secure communication with Windows servers.
• Firewall Configuration - The server must be accessible from Infisical or from the Infisical Gateway if using it.

Open firewall on Windows Defender for SMB connection

Run the following PowerShell command as Administrator on the Windows server to allow inbound SMB connections:

New-NetFirewallRule -DisplayName "Allow SMB Inbound" -Direction Inbound -Protocol TCP -LocalPort 445 -Action Allow

To verify the rule was created:

Get-NetFirewallRule -DisplayName "Allow SMB Inbound"

Setup SMB Connection in Infisical

Infisical UI

1. Navigate to App Connections

   Navigate to the App Connections page in your organization.

   
2. Select SMB Connection

   Click the + Add Connection button and select SMB from the available options.

   
3. Fill out the SMB Connection Modal

   Complete the SMB Connection form by entering:

   • A descriptive name for the connection

   • An optional description for future reference

   • The Windows server host (hostname or IP address)

   • The SMB port (default is 445)

   • The domain name (optional, for domain-joined servers)

   • The administrator username

   • The administrator password

     
4. Connection Created

   After clicking Create, your SMB Connection is established and ready to use with your Infisical project.

   

API

To create an SMB Connection, make an API request to the Create SMB Connection API endpoint.

Sample request

Request

curl --request POST \
    --url https://app.infisical.com/api/v1/app-connections/smb \
    --header 'Content-Type: application/json' \
    --data '{
        "name": "my-windows-connection",
        "method": "credentials",
        "credentials": {
            "host": "192.168.1.100",
            "port": 445,
            "username": "Administrator",
            "password": "your-admin-password",
            "domain": "MYDOMAIN"
        }
    }'

Sample response

Response

{
    "appConnection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-windows-connection",
        "version": 1,
        "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "app": "smb",
        "method": "credentials",
        "credentials": {
            "host": "192.168.1.100",
            "port": 445,
            "username": "Administrator",
            "domain": "MYDOMAIN"
        }
    }
}