Managing the HID RADIUS Authentication Agent

The HID RADIUS Authentication Agent enables OTP (including SMS OTP), static password authentication (including LDAP) and push-based authentication with the HID Approve™ mobile application over the Remote Authentication Dial-In User Service (RADIUS) protocol. This allows integrations using RADIUS protocol, such as VPN agents.

The HID RADIUS Authentication Agent receives a RADIUS authentication request and translates it into an authentication call to the HID Authentication Service public API.

The HID RADIUS Authentication Agent communicates with the HID Authentication Service using the OpenID and SCIM APIs.

The communication between the HID RADIUS Authentication Agent and the HID Authentication Service is secured using SSL.

Install the HID RADIUS Authentication Agent

To use the HID RADIUS Authentication Agent, it must be installed on your local machine.

Prerequisites: Make sure the following requirements and values are set:
  • The agent supports the following server editions:

    • Microsoft® Windows® Server 2016
    • Microsoft Windows Server 2019
    • Microsoft Windows 10 (32 and 64-bit)
  • Onboard a tenant in the HID Authentication Service and create users and authenticators (password, OTP, push, etc..). For further information, see Managing Users Groups and Roles and Enabling User Authentication.

Important:  

Make sure port 1812 is configured in the inbound rules on the Microsoft Windows server where the HID RADIUS Authentication Agent is installed.

  1. Download the HID RADIUS Authentication Agent setup file from the HID Global Customer Portal.

  2. Run the .exe as an administrator, and click Next in the Welcome screen.

  3. Accept the License Agreement terms and click Next.

  4. If necessary, change the Installation Folder and Log Folder and then click Install.

  5. Click Finish to complete the installation.

The HID RADIUS Authentication Agent is now available in the system tray:

Configure the HID RADIUS Authentication Agent

The agent's settings are organized into the following sections:

  1. In the System Tray, right-click on the HID RADIUS Authentication Agent and select Settings.

  2. In the Authentication Service section, define the settings for your HID Authentication Service system:

    Property Description

    Authentication Service URL

    Enter the URL of the HID Authentication Service platform for which authentication is requested.

    For example, auth-us.api.hidglobal.com

    Tenant

    Enter your tenant identifier.

    A tenant is uniquely identified by an alpha numeric value with the prefix t, and is automatically generated by the HID Authentication Service when onboarding an organization.

    For example, t134fg778a367208536160

    ClientID

    Enter your identifier of the OIDC Client ID as defined in the HID Authentication Service.

    A ClientID is a unique user in your tenant, specially configured (with a group, a role and a set of registration data) to be authorized through OpenID.

    For example, 70832624314759130520949533907619412406458927584

    ClientID Password

    Enter the OIDC Client ID password.

    Number of Threads

    Enter the number of threads supported for RADIUS authentication requests.

  3. In the Authentication Policies section, define the first and second level authentication policies

    Property Description

    Authentication Policy

    Select the required first factor authentication policy from the drop-down list or enter the name of a own custom authentication policy.

    An authentication policy defines the authentication factors (MFA) settings, such as password lengths or constraints, One-Time Password synchronization protocols, and push notification signature details.

    There are two types of policies:

    • For static authentication, select a specific authentication policy:

      • Standard Password

      • AD or Azure AD Password

      • One Time Password with HID Approve app

      • One Time Password

      • Mobile Push Based Logon

    • To allow authentication with any of the polices, select Dynamic Authentication

    For example, select Standard Password for static password authentication.

    Enable Second Authentication factor

    Select True if you want to enable the second factor authentication, or else select False.

    Second factor authentication Policy

    Select the required second factor authentication policy from the drop-down list or enter the name of a own custom authentication policy.

    Second factor authentication is a security system that requires two separate, distinct forms of identification in order to access a protected resource. The first factor could be a password and the second factor commonly includes a text with a code sent to your smartphone, or biometrics using your fingerprint, face, or retina.

    For example, select Out of Band OTP via SMS for the delivery of an OTP via SMS to the user's mobile device.

    Activation code for second factor

    If the second factor authentication policy is AT_OOBEML or AT_OOBSMS, enter the Activation Code.

    This code is sent to the HID Authentication Service API to trigger the delivery of the OTP via SMS or email.

    Note:  
  4. In the RADIUS Settings section, add or edit multiple gateways for the RADIUS clients:

    The Number of Configured Gateways is indicted in the agent's configuration interface.

    1. Select the RADIUS Settings node to access the gateway configuration tool.

    2. Either click Add to define a new gateway or select an existing one to edit it.

    Property Description

    Gateway Name

    Enter an identifiable name for the gateway

    Host/IP/Subnet

    Enter the RADIUS client's hostname or IP address (v4 or v6)

    This can either be a single entry or a range of hostnames/addresses

    Secret

    Enter your RADIUS shared secret

    Challenge Timeout

    Enter the duration for the session timeout in seconds

    The default value is 0 (that is, a timeout is not applied)

    It is recommended setting a timeout between 30 and 180 seconds

    There are no constraints (minimum or maximum duration)

    Click SUBMIT to apply your changes.

    Note: Authentication requests will be sent through a PAP, CHAP or MS-CHAPv2 channel:
    • All the authentication policies are supported through PAP channel.

    • The AD/Azure AD password (AT_LDAP) and Mobile Push Based Logon authentication policies are not supported through CHAP and MS-CHAPv2 channel.

    • For dynamic authentication (CHAP, MS-CHAPv2), due to limitations in these protocols, AD/Azure AD password (AT_LDAP) and Mobile Push Based Logon authentication are not supported.

  5. In the Logging section, define your logging requirements:

    Property Description

    Logging Level

    Select the type/severity of the logging level from the drop-down list

    The available levels are:

    • OFF

    • FATAL

    • ERROR

    • WARN

    • INFO

    • DEBUG

    • TRACE

    • ALL

    It is recommended setting the level to ERROR for regular operations in a production environment

    Log Path

    Set the folder path where the logs should be stored

    By default, this is C:\ProgramData\HID Global\HIDRADIUSAgent\logs

  6. Click OK.

  7. In the System Tray, right-click on the HID RADIUS Authentication Agent and select Start.

HID RADIUS Send After Support

A Send After profile defines a set of attribute values to be returned in the response for a successful authentication request.

The Send After attribute/value pairs can be sent back to the service provider. For example, to provide additional information about the user and the last successful authentication, the following information can be sent:

  • User_Full_Name = John Doe

  • Last_Successful_Access = 01/01/2023

Note:
  • Send After attributes are supported for PAP channel.

  • Send After attributes are not supported for Mobile Push Based Logon authentication.

To configure Send After profiles on your tenant, contact HID Global Technical Support.

Configure VPN or Client Tools

The configuration required for VPN/client tool integration with the HID RADIUS Authentication Agent varies according to the VPN software you are deploying.

As a guideline, the following parameters are required:

  • RADIUS Server: - enter the IP of the server

  • RADIUS Port - enter the 1812 as the port

  • RADIUS Secret Key - enter the shared secret configured in the agent's settings

  • User Name - enter a username for the configured tenant

  • Password - enter the tenant user's password

  • Request Type - enter Authentication Request as the type