Create and manage users on an OT network sensor

Microsoft Defender for IoT provides tools for managing on-premises user access in the OT network sensor, and the on-premises management console. Azure users are managed at the Azure subscription level using Azure RBAC.

This article describes how to manage on-premises users directly on an OT network sensor.

Default privileged users

By default, each OT network sensor is installed with the privileged cyberx, support, and cyberx_host users, which have access to advanced tools for troubleshooting and setup.

When setting up a sensor for the first time, sign in with one of these privileged users, create an initial user with an Admin role, and then create extra users for security analysts and read-only users.

For more information, see Install OT monitoring software on OT sensors and Default privileged on-premises users.

Add new OT sensor users

This procedure describes how to create new users for a specific OT network sensor.

Prerequisites: This procedure is available for the cyberx, support, and cyberx_host users, and any user with the Admin role.

To add a user:

  1. Sign in to the sensor console and select Users > + Add user.

  2. On the Create a user | Users page, enter the following details:

    Name Description
    User name Enter a meaningful username for the user.
    Email Enter the user's email address.
    First Name Enter the user's first name.
    Last Name Enter the user's last name.
    Role Select one of the following user roles: Admin, Security Analyst, or Read Only. For more information, see On-premises user roles.
    Password Select the user type, either Local or Active Directory User.

    For local users, enter a password for the user. Password requirements include:
    - At least eight characters
    - Both lowercase and uppercase alphabetic characters
    - At least one number
    - At least one symbol

    Local user passwords can only be modified by Admin users.

    Tip

    Integrating with Active Directory lets you associate groups of users with specific permission levels. If you want to create users using Active Directory, first configure Active Directory on the sensor and then return to this procedure.

  3. Select Save when you're done.

Your new user is added and is listed on the sensor Users page.

To edit a user, select the Edit icon for the user you want to edit, and change any values as needed.

To delete a user, select the Delete button for the user you want to delete.

Integrate OT sensor users with Active Directory

Configure an integration between your sensor and Active Directory to:

  • Allow Active Directory users to sign in to your sensor
  • Use Active Directory groups, with collective permissions assigned to all users in the group

For example, use Active Directory when you have a large number of users that you want to assign Read Only access to, and you want to manage those permissions at the group level.

For more information, see Active Directory support on sensors and on-premises management consoles.

Prerequisites: This procedure is available for the cyberx and support users, and any user with the Admin role.

To integrate with Active Directory:

  1. Sign in to your OT sensor and select System Settings > Integrations > Active Directory.

  2. Toggle on the Active Directory Integration Enabled option.

  3. Enter the following values for your Active Directory server:

    Name Description
    Domain Controller FQDN The fully qualified domain name (FQDN), exactly as it appears on your LDAP server. For example, enter host1.subdomain.contoso.com.

    If you encounter an issue with the integration using the FQDN, check your DNS configuration. You can also enter the explicit IP of the LDAP server instead of the FQDN when setting up the integration.
    Domain Controller Port The port where your LDAP is configured.
    Primary Domain The domain name, such as subdomain.contoso.com, and then select the connection type for your LDAP configuration.

    Supported connection types include: LDAPS/NTLMv3 (recommended), LDAP/NTLMv3, or LDAP/SASL-MD5
    Active Directory Groups Select + Add to add an Active Directory group to each permission level listed, as needed.

    When you enter a group name, make sure that you enter the group name exactly as it's defined in your Active Directory configuration on the LDAP server. You'll use these group names when adding new sensor users with Active Directory.

    Supported permission levels include Read-only, Security Analyst, Admin, and Trusted Domains.

    Important

    When entering LDAP parameters:

    • Define values exactly as they appear in Active Directory, except for the case.
    • User lowercase characters only, even if the configuration in Active Directory uses uppercase.
    • LDAP and LDAPS can't be configured for the same domain. However, you can configure each in different domains and then use them at the same time.
  4. To add another Active Directory server, select + Add Server at the top of the page and define those server values.

  5. When you've added all your Active Directory servers, select Save.

    For example:

    Screenshot of the active directory integration configuration on the sensor.

Change a sensor user's password

This procedure describes how Admin users can change local user passwords. Admin users can change passwords for themselves or for other Security Analyst or Read Only users. Privileged users can change their own passwords, and the passwords for Admin users.

Tip

If you need to recover access to a privileged user account, see Recover privileged access to a sensor.

Prerequisites: This procedure is available only for the cyberx, support, or cyberx_host users, or for users with the Admin role.

To change a user's password on a sensor:

  1. Sign into the sensor and select Users.

  2. On the sensor's Users page, locate the user whose password needs to be changed.

  3. At the right of that user row, select the options (...) menu > Edit to open the user pane.

  4. In the user pane on the right, in the Change password area, enter and confirm the new password. If you're changing your own password, you'll also need to enter your current password.

    Password requirements include:

    • At least eight characters
    • Both lowercase and uppercase alphabetic characters
    • At least one number
    • At least one symbol
  5. Select Save when you're done.

Recover privileged access to a sensor

This procedure descries how to recover privileged access to a sensor, for the cyberx, support, or cyberx_host users. For more information, see Default privileged on-premises users.

Prerequisites: This procedure is available only for the cyberx, support, or cyberx_host users.

To recover privileged access to a sensor:

  1. Start signing in to the OT network sensor. On the sign-in screen, select the Reset link. For example:

    Screenshot of the sensor sign-in screen with the Reset password link.

  2. In the Reset password dialog, from the Choose user menu, select the user whose password you're recovering, either Cyberx, Support, or CyberX_host.

  3. Copy the unique identifier code that's shown in the Reset password identifier to the clipboard. For example:

    Screenshot of the Reset password dialog on the OT sensor.

  4. Go the Defender for IoT Sites and sensors page in the Azure portal. You may want to open the Azure portal in a new browser tab or window, keeping your sensor tab open.

    In your Azure portal settings > Directories + subscriptions, make sure that you've selected the subscription where your sensor was onboarded to Defender for IoT.

  5. On the Sites and sensors page, locate the sensor that you're working with, and select the options menu (...) on the right > Recover my password. For example:

    Screenshot of the Recover my password option on the Sites and sensors page.

  6. In the Recover dialog that opens, enter the unique identifier that you've copied to the clipboard from your sensor and select Recover. A password_recovery.zip file is automatically downloaded.

    All files downloaded from the Azure portal are signed by root of trust so that your machines use signed assets only.

  7. Back on the sensor tab, on the Password recovery screen, select Select file. Navigate to and upload the password_recovery.zip file you'd downloaded earlier from the Azure portal.

    Note

    If an error message appears, indicating that the file is invalid, you may have had an incorrect subscription selected in your Azure portal settings.

    Return to Azure, and select the settings icon in the top toolbar. On the Directories + subscriptions page, make sure that you've selected the subscription where your sensor was onboarded to Defender for IoT. Then repeat the steps in Azure to download the password_recovery.zip file and upload it on the sensor again.

  8. Select Next. A system-generated password for your sensor appears for you to use for the selected user. Make sure to write down the password as it won't be shown again.

  9. Select Next again to sign into your sensor with the new password.

Define maximum number of failed sign-ins

Use the OT sensor's CLI access to define the number of maximum failed sign-ins before an OT sensor will prevent the user from signing in again from the same IP address.

For more information, see Defender for IoT CLI users and access.

Prerequisites: This procedure is available for the cyberx user only.

  1. Sign into your OT sensor via SSH and run:

    nano /var/cyberx/components/xsense-web/cyberx_web/settings.py
    
  2. In the settings.py file, set the "MAX_FAILED_LOGINS" value to the maximum number of failed sign ins you want to define. Make sure that you consider the number of concurrent users in your system.

  3. Exit the file and run sudo monit restart all to apply your changes.

Control user session timeouts

By default, on-premises users are signed out of their sessions after 30 minutes of inactivity. Admin users can use the local CLI access to either turn this feature on or off, or to adjust the inactivity thresholds. For more information, see Defender for IoT CLI users and access.

Note

Any changes made to user session timeouts are reset to defaults when you update the OT monitoring software.

Prerequisites: This procedure is available for the cyberx, support, and cyberx_host users only.

To control sensor user session timeouts:

  1. Sign in to your sensor via a terminal and run:

    sudo nano /var/cyberx/properties/authentication.properties
    

    The following output appears:

    infinity_session_expiration=true
    session_expiration_default_seconds=0
    session_expiration_admin_seconds=1800
    session_expiration_security_analyst_seconds=1800
    session_expiration_read_only_users_seconds=1800
    certifcate_validation=false
    crl_timeout_secounds=3
    crl_retries=1
    cm_auth_token=
    
    
  2. Do one of the following:

    • To turn off user session timeouts entirely, change infinity_session_expiration=true to infinity_session_expiration=false. Change it back to turn it back on again.

    • To adjust an inactivity timeout period, adjust one of the following values to the required time, in seconds:

      • session_expiration_default_seconds for all users
      • session_expiration_admin_seconds for Admin users only
      • session_expiration_security_analyst_seconds for Security Analyst users only
      • session_expiration_read_only_users_seconds for Read Only users only

Next steps

For more information, see: