1# OpenLDAP: pkg/openldap-guide/admin/security.sdf,v 1.16.2.11 2010/04/13 20:22:34 kurt Exp 2# Copyright 1999-2010 The OpenLDAP Foundation, All Rights Reserved. 3# Portions Copyright 2008 Andrew Findlay. 4# COPYING RESTRICTIONS APPLY, see COPYRIGHT. 5 6H1: Security Considerations 7 8OpenLDAP Software is designed to run in a wide variety of computing 9environments from tightly-controlled closed networks to the global 10Internet. Hence, OpenLDAP Software supports many different security 11mechanisms. This chapter describes these mechanisms and discusses 12security considerations for using OpenLDAP Software. 13 14H2: Network Security 15 16H3: Selective Listening 17 18By default, {{slapd}}(8) will listen on both the IPv4 and IPv6 "any" 19addresses. It is often desirable to have {{slapd}} listen on select 20address/port pairs. For example, listening only on the IPv4 address 21{{EX:127.0.0.1}} will disallow remote access to the directory server. 22E.g.: 23 24> slapd -h ldap://127.0.0.1 25 26While the server can be configured to listen on a particular interface 27address, this doesn't necessarily restrict access to the server to 28only those networks accessible via that interface. To selective 29restrict remote access, it is recommend that an {{SECT:IP Firewall}} 30be used to restrict access. 31 32See {{SECT:Command-line Options}} and {{slapd}}(8) for more 33information. 34 35 36H3: IP Firewall 37 38{{TERM:IP}} firewall capabilities of the server system can be used 39to restrict access based upon the client's IP address and/or network 40interface used to communicate with the client. 41 42Generally, {{slapd}}(8) listens on port 389/tcp for {{F:ldap://}} 43sessions and port 636/tcp for {{F:ldaps://}}) sessions. {{slapd}}(8) 44may be configured to listen on other ports. 45 46As specifics of how to configure IP firewall are dependent on the 47particular kind of IP firewall used, no examples are provided here. 48See the document associated with your IP firewall. 49 50 51H3: TCP Wrappers 52 53{{slapd}}(8) supports {{TERM:TCP}} Wrappers. TCP Wrappers provide 54a rule-based access control system for controlling TCP/IP access 55to the server. For example, the {{host_options}}(5) rule: 56 57> slapd: 10.0.0.0/255.0.0.0 127.0.0.1 : ALLOW 58> slapd: ALL : DENY 59 60allows only incoming connections from the private network {{F:10.0.0.0}} 61and localhost ({{F:127.0.0.1}}) to access the directory service. 62 63Note: IP addresses are used as {{slapd}}(8) is not normally 64configured to perform reverse lookups. 65 66It is noted that TCP wrappers require the connection to be accepted. 67As significant processing is required just to deny a connection, 68it is generally advised that IP firewall protection be used instead 69of TCP wrappers. 70 71See {{hosts_access}}(5) for more information on TCP wrapper rules. 72 73 74H2: Data Integrity and Confidentiality Protection 75 76{{TERM[expand]TLS}} (TLS) can be used to provide data integrity and 77confidentiality protection. OpenLDAP supports negotiation of 78{{TERM:TLS}} ({{TERM:SSL}}) via both StartTLS and {{F:ldaps://}}. 79See the {{SECT:Using TLS}} chapter for more information. StartTLS 80is the standard track mechanism. 81 82A number of {{TERM[expand]SASL}} (SASL) mechanisms, such as 83{{TERM:DIGEST-MD5}} and {{TERM:GSSAPI}}, also provide data integrity 84and confidentiality protection. See the {{SECT:Using SASL}} chapter 85for more information. 86 87 88H3: Security Strength Factors 89 90The server uses {{TERM[expand]SSF}}s (SSF) to indicate the relative 91strength of protection. A SSF of zero (0) indicates no protections 92are in place. A SSF of one (1) indicates integrity protection are 93in place. A SSF greater than one (>1) roughly correlates to the 94effective encryption key length. For example, {{TERM:DES}} is 56, 95{{TERM:3DES}} is 112, and {{TERM:AES}} 128, 192, or 256. 96 97A number of administrative controls rely on SSFs associated with 98TLS and SASL protection in place on an LDAP session. 99 100{{EX:security}} controls disallow operations when appropriate 101protections are not in place. For example: 102 103> security ssf=1 update_ssf=112 104 105requires integrity protection for all operations and encryption 106protection, 3DES equivalent, for update operations (e.g. add, delete, 107modify, etc.). See {{slapd.conf}}(5) for details. 108 109For fine-grained control, SSFs may be used in access controls. 110See the {{SECT:Access Control}} section for more information. 111 112 113H2: Authentication Methods 114 115H3: "simple" method 116 117The LDAP "simple" method has three modes of operation: 118 119* anonymous, 120* unauthenticated, and 121* user/password authenticated. 122 123Anonymous access is requested by providing no name and no password 124to the "simple" bind operation. Unauthenticated access is requested 125by providing a name but no password. Authenticated access is 126requested by providing a valid name and password. 127 128An anonymous bind results in an {{anonymous}} authorization 129association. Anonymous bind mechanism is enabled by default, but 130can be disabled by specifying "{{EX:disallow bind_anon}}" in 131{{slapd.conf}}(5). 132 133Note: Disabling the anonymous bind mechanism does not prevent 134anonymous access to the directory. To require authentication to 135access the directory, one should instead specify "{{EX:require authc}}". 136 137An unauthenticated bind also results in an {{anonymous}} authorization 138association. Unauthenticated bind mechanism is disabled by default, 139but can be enabled by specifying "{{EX:allow bind_anon_cred}}" in 140{{slapd.conf}}(5). As a number of LDAP applications mistakenly 141generate unauthenticated bind request when authenticated access was 142intended (that is, they do not ensure a password was provided), 143this mechanism should generally remain disabled. 144 145A successful user/password authenticated bind results in a user 146authorization identity, the provided name, being associated with 147the session. User/password authenticated bind is enabled by default. 148However, as this mechanism itself offers no eavesdropping protection 149(e.g., the password is set in the clear), it is recommended that 150it be used only in tightly controlled systems or when the LDAP 151session is protected by other means (e.g., TLS, {{TERM:IPsec}}). 152Where the administrator relies on TLS to protect the password, it 153is recommended that unprotected authentication be disabled. This 154is done using the {{EX:security}} directive's {{EX:simple_bind}} 155option, which provides fine grain control over the level of confidential 156protection to require for {{simple}} user/password authentication. 157E.g., using {{EX:security simple_bind=56}} would require {{simple}} 158binds to use encryption of DES equivalent or better. 159 160The user/password authenticated bind mechanism can be completely 161disabled by setting "{{EX:disallow bind_simple}}". 162 163Note: An unsuccessful bind always results in the session having 164an {{anonymous}} authorization association. 165 166 167H3: SASL method 168 169The LDAP {{TERM:SASL}} method allows the use of any SASL authentication 170mechanism. The {{SECT:Using SASL}} section discusses the use of SASL. 171 172H2: Password Storage 173 174LDAP passwords are normally stored in the {{userPassword}} attribute. 175{{REF:RFC4519}} specifies that passwords are not stored in encrypted 176(or hashed) form. This allows a wide range of password-based 177authentication mechanisms, such as {{EX:DIGEST-MD5}} to be used. 178This is also the most interoperable storage scheme. 179 180However, it may be desirable to store a hash of password instead. 181{{slapd}}(8) supports a variety of storage schemes for the administrator 182to choose from. 183 184Note: Values of password attributes, regardless of storage scheme 185used, should be protected as if they were clear text. Hashed 186passwords are subject to {{dictionary attacks}} and {{brute-force 187attacks}}. 188 189The {{userPassword}} attribute is allowed to have more than one value, 190and it is possible for each value to be stored in a different form. 191During authentication, {{slapd}} will iterate through the values 192until it finds one that matches the offered password or until it 193runs out of values to inspect. The storage scheme is stored as a prefix 194on the value, so a hashed password using the Salted SHA1 ({{EX:SSHA}}) 195scheme looks like: 196 197> userPassword: {SSHA}DkMTwBl+a/3DQTxCYEApdUtNXGgdUac3 198 199The advantage of hashed passwords is that an attacker which 200discovers the hash does not have direct access to the actual password. 201Unfortunately, as dictionary and brute force attacks are generally 202quite easy for attackers to successfully mount, this advantage is 203marginal at best (this is why all modern Unix systems use shadow 204password files). 205 206The disadvantages of hashed storage is that they are non-standard, may 207cause interoperability problem, and generally preclude the use 208of stronger than Simple (or SASL/PLAIN) password-based authentication 209mechanisms such as {{EX:DIGEST-MD5}}. 210 211H3: SSHA password storage scheme 212 213This is the salted version of the SHA scheme. It is believed to be the 214most secure password storage scheme supported by {{slapd}}. 215 216These values represent the same password: 217 218> userPassword: {SSHA}DkMTwBl+a/3DQTxCYEApdUtNXGgdUac3 219> userPassword: {SSHA}d0Q0626PSH9VUld7yWpR0k6BlpQmtczb 220 221H3: CRYPT password storage scheme 222 223This scheme uses the operating system's {{crypt(3)}} hash function. 224It normally produces the traditional Unix-style 13 character hash, but 225on systems with {{EX:glibc2}} it can also generate the more secure 22634-byte MD5 hash. 227 228> userPassword: {CRYPT}aUihad99hmev6 229> userPassword: {CRYPT}$1$czBJdDqS$TmkzUAb836oMxg/BmIwN.1 230 231The advantage of the CRYPT scheme is that passwords can be 232transferred to or from an existing Unix password file without having 233to know the cleartext form. Both forms of {{crypt}} include salt so 234they have some resistance to dictionary attacks. 235 236Note: Since this scheme uses the operating system's {{crypt(3)}} 237hash function, it is therefore operating system specific. 238 239H3: MD5 password storage scheme 240 241This scheme simply takes the MD5 hash of the password and stores it in 242base64 encoded form: 243 244> userPassword: {MD5}Xr4ilOzQ4PCOq3aQ0qbuaQ== 245 246Although safer than cleartext storage, this is not a very secure 247scheme. The MD5 algorithm is fast, and because there is no salt the 248scheme is vulnerable to a dictionary attack. 249 250H3: SMD5 password storage scheme 251 252This improves on the basic MD5 scheme by adding salt (random data 253which means that there are many possible representations of a given 254plaintext password). For example, both of these values represent the 255same password: 256 257> userPassword: {SMD5}4QWGWZpj9GCmfuqEvm8HtZhZS6E= 258> userPassword: {SMD5}g2/J/7D5EO6+oPdklp5p8YtNFk4= 259 260H3: SHA password storage scheme 261 262Like the MD5 scheme, this simply feeds the password through an SHA 263hash process. SHA is thought to be more secure than MD5, but the lack 264of salt leaves the scheme exposed to dictionary attacks. 265 266> userPassword: {SHA}5en6G6MezRroT3XKqkdPOmY/BfQ= 267 268H3: SASL password storage scheme 269 270This is not really a password storage scheme at all. It uses the 271value of the {{userPassword}} attribute to delegate password 272verification to another process. See below for more information. 273 274Note: This is not the same as using SASL to authenticate the LDAP 275session. 276 277H3: KERBEROS password storage scheme 278 279This is not really a password storage scheme at all. It uses the 280value of the {{userPassword}} attribute to delegate password 281verification to Kerberos. 282 283Note: This is not the same as using Kerberos authentication of 284the LDAP session. 285 286This scheme could be said to defeat the advantages of Kerberos by 287causing the Kerberos password to be exposed to the {{slapd}} server 288(and possibly on the network as well). 289 290H2: Pass-Through authentication 291 292Since OpenLDAP 2.0 {{slapd}} has had the ability to delegate password 293verification to a separate process. This uses the {{sasl_checkpass(3)}} 294function so it can use any back-end server that Cyrus SASL supports for 295checking passwords. The choice is very wide, as one option is to use 296{{saslauthd(8)}} which in turn can use local files, Kerberos, an IMAP 297server, another LDAP server, or anything supported by the PAM mechanism. 298 299The server must be built with the {{EX:--enable-spasswd}} 300configuration option to enable pass-through authentication. 301 302Note: This is not the same as using a SASL mechanism to 303authenticate the LDAP session. 304 305Pass-Through authentication works only with plaintext passwords, as 306used in the "simple bind" and "SASL PLAIN" authentication mechanisms.}} 307 308Pass-Through authentication is selective: it only affects users whose 309{{userPassword}} attribute has a value marked with the "{SASL}" 310scheme. The format of the attribute is: 311 312> userPassword: {SASL}username@realm 313 314The {{username}} and {{realm}} are passed to the SASL authentication 315mechanism and are used to identify the account whose password is to be 316verified. This allows arbitrary mapping between entries in OpenLDAP 317and accounts known to the backend authentication service. 318 319Note: There is no support for changing passwords in the backend 320via {{slapd}}. 321 322It would be wise to use access control to prevent users from changing 323their passwords through LDAP where they have pass-through authentication 324enabled. 325 326 327H3: Configuring slapd to use an authentication provider 328 329Where an entry has a "{SASL}" password value, OpenLDAP delegates the 330whole process of validating that entry's password to Cyrus SASL. All 331the configuration is therefore done in SASL config files. 332 333The first 334file to be considered is confusingly named {{slapd.conf}} and is 335typically found in the SASL library directory, often 336{{EX:/usr/lib/sasl2/slapd.conf}} This file governs the use of SASL 337when talking LDAP to {{slapd}} as well as the use of SASL backends for 338pass-through authentication. See {{EX:options.html}} in the {{PRD:Cyrus SASL}} 339docs for full details. Here is a simple example for a server that will 340use {{saslauthd}} to verify passwords: 341 342> mech_list: plain 343> pwcheck_method: saslauthd 344> saslauthd_path: /var/run/sasl2/mux 345 346H3: Configuring saslauthd 347 348{{saslauthd}} is capable of using many different authentication 349services: see {{saslauthd(8)}} for details. A common requirement is to 350delegate some or all authentication to another LDAP server. Here is a 351sample {{EX:saslauthd.conf}} that uses Microsoft Active Directory (AD): 352 353> ldap_servers: ldap://dc1.example.com/ ldap://dc2.example.com/ 354> 355> ldap_search_base: cn=Users,DC=ad,DC=example,DC=com 356> ldap_filter: (userPrincipalName=%u) 357> 358> ldap_bind_dn: cn=saslauthd,cn=Users,DC=ad,DC=example,DC=com 359> ldap_password: secret 360 361In this case, {{saslauthd}} is run with the {{EX:ldap}} authentication 362mechanism and is set to combine the SASL realm with the login name: 363 364> saslauthd -a ldap -r 365 366This means that the "username@realm" string from the {{userPassword}} 367attribute ends up being used to search AD for 368"userPrincipalName=username@realm" - the password is then verified by 369attempting to bind to AD using the entry found by the search and the 370password supplied by the LDAP client. 371 372H3: Testing pass-through authentication 373 374It is usually best to start with the back-end authentication provider 375and work through {{saslauthd}} and {{slapd}} towards the LDAP client. 376 377In the AD example above, first check that the DN and password that 378{{saslauthd}} will use when it connects to AD are valid: 379 380> ldapsearch -x -H ldap://dc1.example.com/ \ 381> -D cn=saslauthd,cn=Users,DC=ad,DC=example,DC=com \ 382> -w secret \ 383> -b '' \ 384> -s base 385 386Next check that a sample AD user can be found: 387 388> ldapsearch -x -H ldap://dc1.example.com/ \ 389> -D cn=saslauthd,cn=Users,DC=ad,DC=example,DC=com \ 390> -w secret \ 391> -b cn=Users,DC=ad,DC=example,DC=com \ 392> "(userPrincipalName=user@ad.example.com)" 393 394Check that the user can bind to AD: 395 396> ldapsearch -x -H ldap://dc1.example.com/ \ 397> -D cn=user,cn=Users,DC=ad,DC=example,DC=com \ 398> -w userpassword \ 399> -b cn=user,cn=Users,DC=ad,DC=example,DC=com \ 400> -s base \ 401> "(objectclass=*)" 402 403If all that works then {{saslauthd}} should be able to do the same: 404 405> testsaslauthd -u user@ad.example.com -p userpassword 406> testsaslauthd -u user@ad.example.com -p wrongpassword 407 408Now put the magic token into an entry in OpenLDAP: 409 410> userPassword: {SASL}user@ad.example.com 411 412It should now be possible to bind to OpenLDAP using the DN of that 413entry and the password of the AD user. 414 415