UTM: How Does SonicWALL SSO Agent Software Work? (SW5946)

  • Title

    UTM: How Does SonicWALL SSO Agent Software Work?
  • Resolution

    Article Applies To:

    Affected SonicWALL Security Appliance Platforms:

    Gen5: NSA E7500, NSA E6500, NSA E5500, NSA 5000, NSA 4500, NSA 3500, NSA 2400, NSA 240
    Gen5 TZ Series: TZ 100, TZ 100 Wireless, TZ 200, TZ 200 W, TZ 210, TZ 210 Wireless,
    Gen4: PRO series: PRO 5060, PRO 4100, PRO 4060,PRO 3060, PRO 2040, PRO 1260
    Gen4: TZ series: TZ 190, TZ 190 W, TZ 180, TZ 180 W.

    Firmware/Software Version: SonicOS Enhanced 4.0 or higher.
    Services: Single Sign-On



    The SonicWALL SSO Agent can be installed on any workstation with a Windows domain that can communicate with clients and the SonicWALL security appliance directly using the IP address or using a path, such as VPN.

    For installation instructions for the SonicWALL SSO Agent, refer to the KBID 5948: SonicOS: Installing the SonicWALL SSO Agent Software. and KBID 5949: Configuring the SonicWALL SSO Agent Software.

    The SonicWALL SSO Agent only communicates with clients and the SonicWALL security appliance. SonicWALL SSO Agent uses a shared key for encryption of messages between the SSO Agent and the SonicWALL security appliance. The shared key is generated in the SSO Agent and the key entered in the SonicWALL security appliance during SSO configuration must match the SSO Agent-generated key exactly.


    The SonicWALL security appliance queries the SonicWALL SSO Agent over the default port 2258. The SSO Agent then communicates between the client and the SonicWALL security appliance to determine the client’s user ID. The SonicWALL SSO Agent is polled, at a rate that is configurable by the administrator, by the SonicWALL security appliance to continually confirm a user’s login status.

    Please Note: SonicWALL SSO agent tries to identify the logged in user by querying the workstations using NETAPI or WMI protocols. NETAPI and WMI require "file & print sharing" enabled on the end workstations.


    The SonicWALL SSO Agent sends log event messages to the Windows Event Log based on administrator-selected logging levels.

    The SonicWALL security appliance also logs SSO Agent-specific events in its event log. The following is a list of SSO Agent-specific log event messages from the SonicWALL security appliance:

    • User login denied - not allowed by policy rule: The user has been identified and does not belong to any user groups allowed by the policy blocking the user’s traffic.

    • User login denied - not found locally: The user has not been found locally, and Allow only users listed locally is selected in the SonicWALL security appliance.
    • User login denied - SSO Agent agent timeout: Attempts to contact the SonicWALL SSO Agent have timed out.
    • User login denied - SSO Agent configuration error: The SSO Agent is not properly configured to allow access for this user.
    • User login denied - SSO Agent communication problem: There is a problem communicating with the workstation running the SonicWALL SSO Agent.
    • User login denied - SSO Agent agent name resolution failed: The SonicWALL SSO Agent is unable to resolve the user name.
    • SSO Agent returned user name too long: The user name is too long.
    • SSO Agent returned domain name too long: The domain name is too long.

    Note: The notes field of log messages specific to the SSO Agent will contain the text , authentication by SSO Agent.

    Source: SonicOS Enhanced 5.0: Single Sign-on Feature Module

Feedback submitted.

Did this article help?

[Select Rating]

Thank you for your rating!


Request or Create a KB Article »

SonicWALL NSA Series
4500, 3500, 2400, 240
SonicWALL E-Class NSA Series
E7500, E6500, E5500
SonicWALL TZ Series
210W, 210, 200W, 200, 100W, 100
SonicWALL PRO Series
5060, 4100, 4060, 3060, 2040, 1260
TZ Series
190W, 190, 180W, 180

Technical Solutions

Article History:
Created on: 1/2/2009
Last Update on: 9/3/2014