Enable Active Directory Domain Services (ADDS) LDAP authentication for NFS volumes

When you create an NFS volume, you have the option to enable the LDAP with extended groups feature (the LDAP option) for the volume. This feature enables Active Directory LDAP users and extended groups (up to 1024 groups) to access files and directories in the volume. You can use the LDAP with extended groups feature with both NFSv4.1 and NFSv3 volumes.

Azure NetApp Files supports fetching of extended groups from the LDAP name service rather than from the RPC header. Azure NetApp Files interacts with LDAP by querying for attributes such as usernames, numeric IDs, groups, and group memberships for NFS protocol operations.

When it’s determined that LDAP will be used for operations such as name lookup and fetching extended groups, the following process occurs:

  1. Azure NetApp Files uses an LDAP client configuration to make a connection attempt to the ADDS/AADDS LDAP server that is specified in the Azure NetApp Files AD configuration.
  2. If the TCP connection over the defined ADDS/AADDS LDAP service port is successful, then the Azure NetApp Files LDAP client attempts to “bind” (sign in) to the ADDS/AADDS LDAP server (domain controller) by using the defined credentials in the LDAP client configuration.
  3. If the bind is successful, then the Azure NetApp Files LDAP client uses the RFC 2307bis LDAP schema to make an LDAP search query to the ADDS/AADDS LDAP server (domain controller). The following information is passed to the server in the query:
    • Base/user DN (to narrow search scope)
    • Search scope type (subtree)
    • Object class (user, posixAccount for users, and posixGroup for groups)
    • UID or username
    • Requested attributes (uid, uidNumber, gidNumber for users, or gidNumber for groups)
  4. If the user or group isn’t found, the request fails, and access is denied.
  5. If the request is successful, then user and group attributes are cached for future use. This operation improves the performance of subsequent LDAP queries associated with the cached user or group attributes. It also reduces the load on the ADDS/AADDS LDAP server.

Considerations

  • You can enable the LDAP with extended groups feature only during volume creation. This feature cannot be retroactively enabled on existing volumes.

  • LDAP with extended groups is supported only with Active Directory Domain Services (ADDS) or Azure Active Directory Domain services (AADDS). OpenLDAP or other third-party LDAP directory services are not supported.

  • LDAP over TLS must not be enabled if you are using Azure Active Directory Domain Services (AADDS).

  • You cannot modify the LDAP option setting (enabled or disabled) after you have created the volume.

  • The following table describes the Time to Live (TTL) settings for the LDAP cache. You need to wait until the cache is refreshed before trying to access a file or directory through a client. Otherwise, an access or permission denied message appears on the client.

    Cache Default Timeout
    Group membership list 24-hour TTL
    Unix groups 24-hour TTL, 1-minute negative TTL
    Unix users 24-hour TTL, 1-minute negative TTL

    Caches have a specific timeout period called Time to Live. After the timeout period, entries age out so that stale entries do not linger. The negative TTL value is where a lookup that has failed resides to help avoid performance issues due to LDAP queries for objects that might not exist.

  • The Allow local NFS users with LDAP option in Active Directory connections intends to provide occasional and temporary access to local users. When this option is enabled, user authentication and lookup from the LDAP server stop working, and the number of group memberships that Azure NetApp Files will support will be limited to 16. As such, you should keep this option disabled on Active Directory connections, except for the occasion when a local user needs to access LDAP-enabled volumes. In that case, you should disable this option as soon as local user access is no longer required for the volume. See Allow local NFS users with LDAP to access a dual-protocol volume about managing local user access.

Steps

  1. LDAP volumes require an Active Directory configuration for LDAP server settings. Follow instructions in Requirements for Active Directory connections and Create an Active Directory connection to configure Active Directory connections on the Azure portal.

    Note

    Ensure that you have configured the Active Directory connection settings. A machine account will be created in the organizational unit (OU) that is specified in the Active Directory connection settings. The settings are used by the LDAP client to authenticate with your Active Directory.

  2. Ensure that the Active Directory LDAP server is up and running on the Active Directory.

  3. LDAP NFS users need to have certain POSIX attributes on the LDAP server. Set the attributes for LDAP users and LDAP groups as follows:

    • Required attributes for LDAP users:
      uid: Alice,
      uidNumber: 139,
      gidNumber: 555,
      objectClass: user, posixAccount
    • Required attributes for LDAP groups:
      objectClass: group, posixGroup,
      gidNumber: 555

    The values specified for objectClass are separate entries. For example, in Multi-valued String Editor, objectClass would have separate values (user and posixAccount) specified as follows for LDAP users:

    Screenshot of Multi-valued String Editor that shows multiple values specified for Object Class.

    You can manage POSIX attributes by using the Active Directory Users and Computers MMC snap-in. The following example shows the Active Directory Attribute Editor. See Access Active Directory Attribute Editor for details.

    Active Directory Attribute Editor

  4. If you want to configure an LDAP-integrated NFSv4.1 Linux client, see Configure an NFS client for Azure NetApp Files.

  5. If your LDAP-enabled volumes use NFSv4.1, follow instructions in Configure NFSv4.1 domain to configure the /etc/idmapd.conf file.

    You need to set Domain in /etc/idmapd.conf to the domain that is configured in the Active Directory Connection on your NetApp account. For instance, if contoso.com is the configured domain in the NetApp account, then set Domain = contoso.com.

    Then you need to restart the rpcbind service on your host or reboot the host.

  6. Follow steps in Create an NFS volume for Azure NetApp Files to create an NFS volume. During the volume creation process, under the Protocol tab, enable the LDAP option.

    Screenshot that shows Create a Volume page with LDAP option.

  7. Optional - You can enable local NFS client users not present on the Windows LDAP server to access an NFS volume that has LDAP with extended groups enabled. To do so, enable the Allow local NFS users with LDAP option as follows:

    1. Select Active Directory connections. On an existing Active Directory connection, select the context menu (the three dots ), and select Edit.
    2. On the Edit Active Directory settings window that appears, select the Allow local NFS users with LDAP option.

    Screenshot that shows the Allow local NFS users with LDAP option

  8. Optional - If you have large topologies, and you use the Unix security style with a dual-protocol volume or LDAP with extended groups, you can use the LDAP Search Scope option to avoid "access denied" errors on Linux clients for Azure NetApp Files.

    The LDAP Search Scope option is configured through the Active Directory Connections page.

    To resolve the users and group from an LDAP server for large topologies, set the values of the User DN, Group DN, and Group Membership Filter options on the Active Directory Connections page as follows:

    • Specify nested User DN and Group DN in the format of OU=subdirectory,OU=directory,DC=domain,DC=com.
    • Specify Group Membership Filter in the format of (gidNumber=*).

    Screenshot that shows options related to LDAP Search Scope

Next steps