Manual Chapter :
LDAP User Authentication
Applies To:
Show VersionsBIG-IQ Centralized Management
- 8.3.0, 8.2.0, 8.1.0
LDAP User Authentication
Use my LDAP server to authenticate BIG-IQ users
F5 BIG-IQ Centralized Management supports encrypted connections to your company's LDAP server (LDAP server versions 2 and 3, OpenLDAP directory, and Apache Directory Server) using one of these methods, with certificate validation:
- StartTLS - (with server certificate validation enabled) This is the recommended and most secure method.
- LDAPS - Typically used for connections to older servers, such as those running LDAPv2.
After you set up BIG-IQ to use your LDAP server, you can add users and user groups that authenticated by the LDAP server.
Before integrating BIG-IQ with your LDAP server for authentication
Before integrating LDAP server authentication with the F5 BIG-IQ Centralized Management system, you must gather the following information.
Required information | Notes |
---|---|
Host name of the LDAP server | For the SSL server certificate validation to succeed, you must use a FQDN. For example: ldap.example.com The FQDN must match the FQDN in the CN (Common Name) attribute of the subject of the X509 certificate for the LDAP server. For example, an LDAP server might present a certificate that includes the following subject data: Subject: C=US, ST=Washington, L=Seattle, O=ldap1, OU=F5 Networks, CN=ldap.example.com/emailAddress=ldap@example.com If the value of the host name does not match the FQDN in the CN field, authentication will fail. Specifying an IP address instead of a FQDN results in such a mismatch. |
Port of the LDAP server | The default port is 389 for StartTLS and 636 for LDAPS, unless otherwise specified. If your LDAP server uses an alternate, non-standard port, you need to specify it in the authentication settings. |
LDAP server's SSL certificate | For the BIG-IQ to trust the SSL certificate presented by your LDAP server, you must provide a PEM-formatted certificate in the authentication provider settings. To establish the SSL connection to the LDAP server, the BIG-IQ must trust any one of the SSL certificates in the chain presented by the server during the SSL handshake. As an alternative to the LDAP server's SSL certificate, you can use the issuing CA’s SSL certificate instead. A typical scenario where the issuing CA’s certificate is used instead, is when a domain controller uses multiple servers, each with a different certificate. In this case, all the certificates would have the same issuing CA, often the company’s own CA. |
Root Distinguished Name | This is the Root DN for your directory. The BIG-IQ uses it as the starting point in the directory when it searches for users and groups. |
LDAP users | You'll need to create BIG-IQ users and groups that map to the remote users and groups on the LDAP server. User access to certain BIG-IQ screens and features is dependent on the BIG-IQ roles you associate to the user. You can also manage user access based on the roles associated to the groups the user belongs to on your LDAP server. To authenticate a user against the remote LDAP server, choose one of the following options:
|
LDAP groups | While not needed for user authentication if a User Bind Template is provided, a Bind User Distinguished Name must be provided to be able to search for groups. However, it is not necessary for either login or group search if your LDAP server allows anonymous binds (insecure option, not recommended). If your company does not allow dedicated bind accounts, any directory user with permissions to search the directory for groups can be used to bind instead. |
Set up BIG-IQ to use your LDAP server for user
authentication
Before you can set up BIG-IQ to authenticate users against your LDAP server, you have
to specify your LDAP server settings on F5 BIG-IQ Centralized Management and perform all
the tasks outlined in the section titled,
Before integrating
BIG-IQ with your LDAP server
. You can configure BIG-IQ to use one or more of your company's LDAP
servers to authenticate users. Some fields are pre-populated with values that work
well for most LDAP servers with standard configurations and schemas. Feel free to
change these default values as need to match settings on your own LDAP server.
- On the left, click.
- Click theAddbutton.
- From theProvider Typelist, select yourLDAPserver.
- In theNamefield, type a name for this new provider.This must be a unique name, and can be a maximum of 152 characters.
- In theServerssettingHostfield, type or paste the FQDN of your authentication server, and specify the port.By default, BIG-IQ uses port 636 for LDAPS and 389 for StartTLS. It's best to leave these defaults.For the SSL server certificate validation to succeed, you must use a Fully Qualified Domain Name (FDQN), rather than an IP address. The FQDN must match the FQDN in the Common Name attribute of the subject of the X509 certificate presented by the LDAP server. For example, an LDAP server might present a certificate that includes the following subject data:
If your authentication server uses an alternate, non-standard port, you need to specify it in the authentication provider settings.Subject: C=US, ST=Washington, L=Seattle, O=ldap1, OU=F5 Networks, CN=ldap.example.com/emailAddress=ldap@example.com - From theSSLlist, select how you want BIG-IQ to communicate with your authentication server.
- StartTLS- In almost all cases, you'll want to select this option, because it is the most secure option. You'll want to keep server certificate validation option enabled.
- LDAPS- This is primarily used to connect to older servers, running an older version of the LDAP protocol (LDAPv2).
- Disabled- This option to disables SSL and is not secure and not recommended.
- In theSSL Certificatefield, type or paste your LDAP server's SSL certificate in PEM format.To establish the SSL connection to the LDAP server, the BIG-IQ must trust any one of the SSL certificates in the chain presented by the authentication server during the SSL handshake.As an alternative to the server certificate, you can use the issuing CA’s SSL certificate instead. A typical scenario where the issuing CA’s certificate is used is the case where an authentication provider uses multiple LDAP servers, each with a different certificate and all the certificates have the same issuing CA.
- In theBind User Distinguished NameandBind User Passwordfields, type the full distinguished name and password for the dedicated bind account with directory search permissions.
- In theUser Bind Templatefield, type or paste the user in the Distinguished Name formatuid={username},ou=people,o=sevenSeas.
- In theUser Search Filterfield, type the filter expression you want to use to find users.For example:(&(uid={username}))
- In theRoot Distinguished Namefield, type the distinguished names (DN) of the root context that contains both users and groups.The DN of the root context must be a full distinguished name. BIG-IQ uses it as the starting point in the directory when it searches for users and groups.
- For theAuthentication Methodsetting, specify a method.
- Simple- Select this option to require a user name and password for authentication.
- None- Select this option to ignore the user name and password. This option is not recommended.
No password authentication is used if you selectNone. - For theSearch Scopesetting, select an option to specify the depth at which searches are made, relative to the Root Distinguished Name.
- In theConnect Timeoutfield, type the number of seconds after which the BIG-IQ system stops trying to authenticate a user or user group.
- In theRead Timeoutfield, type the number of seconds the BIG-IQ system will wait for a response to a query.
- The default query for theGroup Search Filtersetting works well for most directories that use a standard LDAP configuration schema.This returns all the groups under the provided Root DN that matches the search term for theRemote Group Filtersetting on the group search screen. However, feel free to delete two of the three clauses involvingobjectClass, leaving only the one corresponding to your directory schema.For example:(&(+[[-[[|(objectClass=posixGroup) (objectClass=groupOfUniqueNames)(objectClass=groupOfNames)) (]]-+[[]]+objectCategory=group)(+[[]]+]]+cn={searchterm}-[[*]]-+[[+[[*]]+]]+))
- For theGroup Membership User Attributesetting, the default value works well for most providers that use a standard schema.When authenticating a user, BIG-IQ uses this query to get all of the groups on the provider servers to which the user belongs. Feel free however to simplify it and leave only the one of the three clauses that matches your directory schema. In you change the query, you can use the token{userDN}anywhere the user's distinguished name should be substituted in the query and the token{username}anywhere the user’s login name should be substituted.
- If you want to authenticate users with certificates rather than a user name and password, select theEnable Client Certificate Authenticationcheck box.Be sure to test your authentication provider settings before you enable this feature, to make sure BIB-IQ can successfully authenticate against the remote directly. Otherwise, you could get locked out of BIG-IQ.
- Choose the CA certificate file.
- Specify theCertificate Username Attributeso BIG-IQ can extract the user information from the file. In most cases the default CN works.
- For theCertificate Username Filter, specify the exact user name. This can be a sub-string, but it has to match what you type here.
- For theCertificate Revocation List, you can optionally select one or more files.If you want BIG-IQ to authenticate locally in the event certificate authentication fails,
- select theEnable Local Authentication Fallbackcheck box.
- If you don't want the authentication provider to display on the BIG-IQ login screen, for theHide Providersetting, select theHide provider on login screencheck box.
- To verify these provider settings, type a user and password, and click theTestbutton.
Add a BIG-IQ user authenticated by my LDAP server and associate it
with a role
If you want to add a user authenticated against your LDAP server, you first have to
configure your LDAP server settings on BIG-IQ.
Once you understand exactly who you want to
perform certain tasks, you can provide them access to particular areas of BIG-IQ by
adding them as a user and assigning the appropriate built-in or custom role. You can
assign as many roles as required to cover the user's responsibilities.
For the LDAP-authenticated user to access BIG-IQ, you must put
the local user in a BIG-IQ role, or put in a role in a local group mapped to one of
the user’s groups on the LDAP server.
- On the left, click.
- Click theAddbutton.
- From theAuth Providerlist, select yourLDAPserver.
- In theUser Namefield, type the name for this user.
- In theFull Namefield, type a name to identify the individual with this type of user access.The full name can contain a combination of letters, symbols, numbers and spaces.
- For theRolessetting, from theAvailablelist, select each user role you want to associate with this user, and move it to theSelectedlist.Be sure to let your users know that their access to certain parts of the BIG-IQ user interface depends on which role they are assigned.
If this BIG-IQ is part of an HA pair, you must log in to the secondary BIG-IQ
system, click
System
->
BIG-IQ HA
, click the
BIG-IQ HA Settings
button, then click the Log Out &
Refresh
button. This procedure is required because BIG-IQ handles
users and user groups differently than other data synchronized between BIG-IQ
systems in an HA pair. If you don't perform this procedure, this new user cannot
successfully log in to the secondary system. Create an LDAP
authenticated user group
For the LDAP-authenticated user to access BIG-IQ, you must put the
local user in a BIG-IQ role, or put in a role a local group that is mapped to one of the
user’s groups on the LDAP server.
Create a user group to offer individual users the same privileges on F5
BIG-IQ Centralized Management. This user group will be authorized by your LDAP
server.
- At the left, click.The User Groups screen opens.
- Click theAddbutton.
- From theAuth Providerlist, select yourLDAPserver.
- There are two ways to specify the remote group to map to:
- If you specified a bind user and a group search filter for authentication, then type a term to filter into theRemote Group Filterfield (for example,*Engineers*). Alternatively, you can leave it blank, or use the wildcard * to return all groups. Then click theSearchbutton to view the list.The default Group Search Filter query,(&(objectCategory=group)(cn={searchterm}*)), works well for most Active Directory controllers that use a standard schema. This query returns all the groups under the provided Root DN that match the search term entered as the Remote Group Filter expression on the group search page. You can modify this query as needed to match your directory schema.
- If you have not configured these options, in theGroup Distinguishedfield, type the exact name of the group.
- From theAvailable Roleslist, select the user roles that have the privileges you want to grant to this user group and move them to theSelectedlist.
If
this BIG-IQ is part of an HA pair, you must log in to the secondary BIG-IQ system, click
System
-> BIG-IQ HA
,
click the BIG-IQ HA Settings
button, then click the Log Out & Refresh
button. This procedure is required
because BIG-IQ handles users and user groups differently than other data synchronized
between BIG-IQ systems in an HA pair. If you don't perform this procedure, this new user
cannot successfully log in to the secondary system.