[comment]: # ({3a0ed9f2-3a0ed9f2})
# 3 Authentication
[comment]: # ({/3a0ed9f2-3a0ed9f2})
[comment]: # ({656d8d42-656d8d42})
### Overview
In *Administration → Authentication* the global user authentication
method to Zabbix can be specified. The available methods are internal,
HTTP, LDAP and SAML authentication.
By default, Zabbix uses internal Zabbix authentication for all users. It
is possible to change the default method to [LDAP](#ldap_authentication)
system-wide or enable LDAP authentication only for specific user groups.
To set LDAP as default authentication method for all users, navigate to
the *LDAP* tab and configure authentication parameters, then return to
the *Authentication* tab and switch *Default authentication* selector to
LDAP.
Note that the authentication method can be fine-tuned on the [user
group](/manual/config/users_and_usergroups/usergroup) level. Even if
LDAP authentication is set globally, some user groups can still be
authenticated by Zabbix. These groups must have [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) set
to Internal. Vice versa, if internal authentication is used globally,
LDAP authentication details can be specified and used for specific user
groups whose [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) is
set to LDAP. If a user is included into at least one user group with
LDAP authentication, this user will not be able to use internal
authentication method.
[HTTP](#http_authentication) and [SAML 2.0](#saml_authentication)
authentication methods can be used in addition to the default
authentication method.
[comment]: # ({/656d8d42-656d8d42})
[comment]: # ({096ce00b-096ce00b})
### HTTP authentication
HTTP or web server-based authentication (for example: Basic
Authentication, NTLM/Kerberos) can be used to check user names and
passwords. Note that a user must exist in Zabbix as well, however its
Zabbix password will not be used.
::: noteimportant
Be careful! Make sure that web server
authentication is configured and works properly before switching it
on.
:::
Configuration parameters:
|Parameter|Description|
|---------|-----------|
|*Enable HTTP authentication*|Mark the checkbox to enable HTTP authentication.|
|*Default login form*|Specify whether to direct non-authenticated users to:
**Zabbix login form** - standard Zabbix login page.
**HTTP login form** - HTTP login page.
It is recommended to enable web-server based authentication for the `index_http.php` page only. If *Default login form* is set to 'HTTP login page' the user will be logged in automatically if web server authentication module will set valid user login in the `$_SERVER` variable.
Supported `$_SERVER` keys are `PHP_AUTH_USER`, `REMOTE_USER`, `AUTH_USER`.|
|*Remove domain name*|A comma-delimited list of domain names that should be removed from the username.
E.g. `comp,any` - if username is 'Admin\@any', 'comp\\Admin', user will be logged in as 'Admin'; if username is 'notacompany\\Admin', login will be denied.|
|*Case sensitive login*|Unmark the checkbox to disable case-sensitive login (enabled by default) for usernames.
E.g. disable case-sensitive login and log in with, for example, 'ADMIN' user even if the Zabbix user is 'Admin'.
*Note* that with case-sensitive login disabled the login will be denied if multiple users exist in Zabbix database with similar usernames (e.g. Admin, admin).|
::: noteclassic
In case of web server authentication all users (even with
[frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) set
to LDAP/Internal) will be authenticated by the web server, not by
Zabbix!
:::
::: notetip
For internal users who are unable to log in using HTTP
credentials (with HTTP login form set as default) leading to the 401
error, you may want to add a `ErrorDocument 401 /index.php?form=default`
line to basic authentication directives, which will redirect to the
regular Zabbix login form.
:::
[comment]: # ({/096ce00b-096ce00b})
[comment]: # ({8893a7d1-b032eddc})
### LDAP authentication
External LDAP authentication can be used to check user names and
passwords. Note that a user must exist in Zabbix as well, however its
Zabbix password will not be used.
Zabbix LDAP authentication works at least with Microsoft Active
Directory and OpenLDAP.
Configuration parameters:
|Parameter|Description|
|---------|-----------|
|*Enable LDAP authentication*|Mark the checkbox to enable LDAP authentication.|
|*LDAP host*|Name of LDAP server. For example: ldap://ldap.zabbix.com
For secure LDAP server use *ldaps* protocol.
ldaps://ldap.zabbix.com
With OpenLDAP 2.x.x and later, a full LDAP URI of the form ldap://hostname:port or ldaps://hostname:port may be used.|
|*Port*|Port of LDAP server. Default is 389.
For secure LDAP connection port number is normally 636.
Not used when using full LDAP URIs.|
|*Base DN*|Base path to search accounts:
ou=Users,ou=system (for OpenLDAP),
DC=company,DC=com (for Microsoft Active Directory)|
|*Search attribute*|LDAP account attribute used for search:
uid (for OpenLDAP),
sAMAccountName (for Microsoft Active Directory)|
|*Bind DN*|LDAP account for binding and searching over the LDAP server, examples:
uid=ldap\_search,ou=system (for OpenLDAP),
CN=ldap\_search,OU=user\_group,DC=company,DC=com (for Microsoft Active Directory)
Anonymous binding is also supported.|
|*Case-sensitive login*|Unmark the checkbox to disable case-sensitive login (enabled by default) for usernames.
E.g. disable case-sensitive login and log in with, for example, 'ADMIN' user even if the Zabbix user is 'Admin'.
*Note* that with case-sensitive login disabled the login will be denied if multiple users exist in Zabbix database with similar usernames (e.g. Admin, admin).|
|*Bind password*|LDAP password of the account for binding and searching over the LDAP server.|
|*Test authentication*|Header of a section for testing|
|*Login*|Name of a test user (which is currently logged in the Zabbix frontend). This user name must exist in the LDAP server.
Zabbix will not activate LDAP authentication if it is unable to authenticate the test user.|
|*User password*|LDAP password of the test user.|
::: notewarning
In case of trouble with certificates, to make a
secure LDAP connection (ldaps) work you may need to add a
`TLS_REQCERT allow` line to the /etc/openldap/ldap.conf configuration
file. It may decrease the security of connection to the LDAP
catalog.
:::
::: notetip
It is recommended to create a separate LDAP account (*Bind DN*) to perform binding and searching over the LDAP server with minimal privileges in the LDAP instead of using real user accounts (used for logging in the Zabbix frontend).
Such an approach provides more security and does not require changing the *Bind password* when the user changes his own password in the LDAP server.
In the table above it's *ldap\_search* account name.
:::
[comment]: # ({/8893a7d1-b032eddc})
[comment]: # ({cc7ae197-cc7ae197})
### SAML authentication
SAML 2.0 authentication can be used to sign in to Zabbix. Note that a
user must exist in Zabbix, however, its Zabbix password will not be
used. If authentication is successful, then Zabbix will match a local
username with the username attribute returned by SAML.
::: noteclassic
If SAML authentication is enabled, users will be able to
choose between logging in locally or via SAML Single Sign-On.
:::
[comment]: # ({/cc7ae197-cc7ae197})
[comment]: # ({6700a0b3-6700a0b3})
#### Setting up the identity provider
In order to work with Zabbix, a SAML identity provider
([onelogin.com](https://onelogin.com), [auth0.com](https://auth0.com),
[okta.com](https://okta.com), etc.) needs to be configured in the
following way:
- *Assertion Consumer URL* should be set to
`/index_sso.php?acs`
- *Single Logout URL* should be set to
`/index_sso.php?sls`
`` examples: %% ,
,
/zabbix %%
[comment]: # ({/6700a0b3-6700a0b3})
[comment]: # ({be70e1a1-be70e1a1})
#### Setting up Zabbix
::: noteimportant
It is required to install php-openssl if you want
to use SAML authentication in the frontend.
:::
To use SAML authentication Zabbix should be configured in the following
way:
1\. Private key and certificate should be stored in the
*ui/conf/certs*/, unless custom paths are provided in
[zabbix.conf.php](authentication#advanced_settings).
By default, Zabbix will look in the following locations:
- ui/conf/certs/sp.key - SP private key file
- ui/conf/certs/sp.crt - SP cert file
- ui/conf/certs/idp.crt - IDP cert file
2\. All of the most important settings can be configured in the Zabbix
frontend. However, it is possible to specify additional settings in the
[configuration file](authentication#advanced_settings).
Configuration parameters, available in the Zabbix frontend:
|Parameter|Description|
|---------|-----------|
|*Enable SAML authentication*|Mark the checkbox to enable SAML authentication.|
|*IDP entity ID*|The unique identifier of SAML identity provider.|
|*SSO service URL*|The URL users will be redirected to when logging in.|
|*SLO Service URL*|The URL users will be redirected to when logging out. If left empty, the SLO service will not be used.|
|// Username attribute//|SAML attribute to be used as a username when logging into Zabbix.
List of supported values is determined by the identity provider.
Examples:
uid
userprincipalname
samaccountname
username
userusername
|
|*SP entity ID*|The unique identifier of SAML service provider.|
|*SP name ID format*|Defines which name identifier format should be used.
Examples:
|
|*Sign*|Mark the checkboxes to select entities for which SAML signature should be enabled:
*Messages*
*Assertions*
*AuthN requests*
*Logout requests*
*Logout responses*|
|*Encrypt*|Mark the checkboxes to select entities for which SAML encryption should be enabled:
*Assertions*
*Name ID*|
|*Case-sensitive login*|Mark the checkbox to enable case-sensitive login (disabled by default) for usernames.
E.g. disable case-sensitive login and log in with, for example, 'ADMIN' user even if the Zabbix user is 'Admin'.
*Note* that with case-sensitive login disabled the login will be denied if multiple users exist in Zabbix database with similar usernames (e.g. Admin, admin).|
[comment]: # ({/be70e1a1-be70e1a1})
[comment]: # ({be372f8e-be372f8e})
##### Advanced settings
Additional SAML parameters can be configured in the Zabbix frontend
configuration file (*zabbix.conf.php*):
- $SSO\['SP\_KEY'\] = '';
- $SSO\['SP\_CERT'\] = '';
- $SSO\['IDP\_CERT'\] = '';
- $SSO\['SETTINGS'\]
::: noteclassic
Zabbix uses [OneLogin's SAML PHP
Toolkit](https://github.com/onelogin/php-saml/tree/3.4.1) library
(version 3.4.1). The structure of $SSO\['SETTINGS'\] section should be
similar to the structure used by the library. For the description of
configuration options, see official library
[documentation](https://github.com/onelogin/php-saml/tree/3.4.1/#user-content-settings).
:::
Only the following options can be set as part of $SSO\['SETTINGS'\]:
- *strict*
- *baseurl*
- *compress*
- *contactPerson*
- *organization*
- *sp* (only options specified in this list)
- *attributeConsumingService*
- *x509certNew*
- *idp* (only options specified in this list)
- *singleLogoutService* (only one option)
- *responseUrl*
- *certFingerprint*
- *certFingerprintAlgorithm*
- *x509certMulti*
- *security* (only options specified in this list)
- *signMetadata*
- *wantNameId*
- *requestedAuthnContext*
- *requestedAuthnContextComparison*
- *wantXMLValidation*
- *relaxDestinationValidation*
- *destinationStrictlyMatches*
- *rejectUnsolicitedResponsesWithInResponseTo*
- *signatureAlgorithm*
- *digestAlgorithm*
- *lowercaseUrlencoding*
All other options will be taken from the database and cannot be
overridden. The *debug* option will be ignored.
In addition, if Zabbix UI is behind a proxy or a load balancer, the
custom *use\_proxy\_headers* option can be used:
- *false* (default) - ignore the option;
- *true* - use X-Forwarded-\* HTTP headers for building the base URL.
**Configuration example:**
$SSO['SETTINGS'] = [
'security' => [
'signatureAlgorithm' => 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384'
'digestAlgorithm' => 'http://www.w3.org/2001/04/xmldsig-more#sha384',
// ...
],
// ...
];
[comment]: # ({/be372f8e-be372f8e})