2 * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
10 * AUTHOR: Flavio Pescuma, MARA Systems AB <flavio@marasystems.com>
16 #define LDAP_DEPRECATED 1
18 #include "auth/digest/LDAP/ldap_backend.h"
20 #if _SQUID_WINDOWS_ && !_SQUID_CYGWIN_
22 #define snprintf _snprintf
26 #define LDAPAPI __cdecl
29 #ifndef LDAP_OPT_X_TLS
30 #define LDAP_OPT_X_TLS 0x6000
32 /* Some tricks to allow dynamic bind with ldap_start_tls_s entry point at
35 #undef ldap_start_tls_s
37 #define LDAP_START_TLS_S "ldap_start_tls_sW"
38 typedef WINLDAPAPI
ULONG(LDAPAPI
* PFldap_start_tls_s
) (IN PLDAP
, OUT PULONG
, OUT LDAPMessage
**, IN PLDAPControlW
*, IN PLDAPControlW
*);
40 #define LDAP_START_TLS_S "ldap_start_tls_sA"
41 typedef WINLDAPAPI
ULONG(LDAPAPI
* PFldap_start_tls_s
) (IN PLDAP
, OUT PULONG
, OUT LDAPMessage
**, IN PLDAPControlA
*, IN PLDAPControlA
*);
42 #endif /* LDAP_UNICODE */
43 PFldap_start_tls_s Win32_ldap_start_tls_s
;
44 #define ldap_start_tls_s(l,s,c) Win32_ldap_start_tls_s(l,NULL,NULL,s,c)
45 #endif /* LDAP_VERSION3 */
53 #define PROGRAM_NAME "digest_pw_auth(LDAP_backend)"
57 static LDAP
*ld
= NULL
;
58 static const char *passattr
= NULL
;
59 static char *ldapServer
= NULL
;
60 static const char *userbasedn
= NULL
;
61 static const char *userdnattr
= NULL
;
62 static const char *usersearchfilter
= NULL
;
63 static const char *binddn
= NULL
;
64 static const char *bindpasswd
= NULL
;
65 static const char *delimiter
= ":";
66 static const char *frealm
= "";
67 static int encrpass
= 0;
68 static int searchscope
= LDAP_SCOPE_SUBTREE
;
69 static int persistent
= 0;
70 static int noreferrals
= 0;
71 static int port
= LDAP_PORT
;
72 static int strip_nt_domain
= 0;
73 static int aliasderef
= LDAP_DEREF_NEVER
;
74 #if defined(NETSCAPE_SSL)
75 static char *sslpath
= NULL
;
76 static int sslinit
= 0;
78 static int connect_timeout
= 0;
79 static int timelimit
= LDAP_NO_LIMIT
;
82 /* Added for TLS support and version 3 */
83 static int use_tls
= 0;
84 static int version
= -1;
87 static void ldapconnect(void);
88 static int readSecret(const char *filename
);
90 /* Yuck.. we need to glue to different versions of the API */
92 #if defined(LDAP_API_VERSION) && LDAP_API_VERSION > 1823
94 squid_ldap_set_aliasderef(int deref
)
96 ldap_set_option(ld
, LDAP_OPT_DEREF
, &deref
);
99 squid_ldap_set_referrals(int referrals
)
101 int *value
= static_cast<int*>(referrals
? LDAP_OPT_ON
:LDAP_OPT_OFF
);
102 ldap_set_option(ld
, LDAP_OPT_REFERRALS
, value
);
105 squid_ldap_set_timelimit(int aTimeLimit
)
107 ldap_set_option(ld
, LDAP_OPT_TIMELIMIT
, &aTimeLimit
);
110 squid_ldap_set_connect_timeout(int aTimeLimit
)
112 #if defined(LDAP_OPT_NETWORK_TIMEOUT)
114 tv
.tv_sec
= aTimeLimit
;
116 ldap_set_option(ld
, LDAP_OPT_NETWORK_TIMEOUT
, &tv
);
117 #elif defined(LDAP_X_OPT_CONNECT_TIMEOUT)
119 ldap_set_option(ld
, LDAP_X_OPT_CONNECT_TIMEOUT
, &aTimeLimit
);
125 squid_ldap_errno(LDAP
* ld
)
130 squid_ldap_set_aliasderef(int deref
)
132 ld
->ld_deref
= deref
;
135 squid_ldap_set_referrals(int referrals
)
138 ld
->ld_options
|= ~LDAP_OPT_REFERRALS
;
140 ld
->ld_options
&= ~LDAP_OPT_REFERRALS
;
143 squid_ldap_set_timelimit(int aTimeLimit
)
145 ld
->ld_timelimit
= aTimeLimit
;
148 squid_ldap_set_connect_timeout(int aTimeLimit
)
150 fprintf(stderr
, "Connect timeouts not supported in your LDAP library\n");
153 squid_ldap_memfree(char *p
)
160 #ifdef LDAP_API_FEATURE_X_OPENLDAP
161 #if LDAP_VENDOR_VERSION > 194
162 #define HAS_URI_SUPPORT 1
167 ldap_escape_value(char *escaped
, int size
, const char *src
)
170 while (size
> 4 && *src
) {
181 snprintf(escaped
, 3, "%02x", (int) *src
);
199 getpassword(char *login
, char *realm
)
201 LDAPMessage
*res
= NULL
;
203 char **values
= NULL
;
205 char *password
= NULL
;
208 char searchbase
[8192];
211 if (usersearchfilter
) {
212 char escaped_login
[1024];
213 snprintf(searchbase
, sizeof(searchbase
), "%s", userbasedn
);
214 ldap_escape_value(escaped_login
, sizeof(escaped_login
), login
);
215 snprintf(filter
, sizeof(filter
), usersearchfilter
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
, escaped_login
);
218 debug("user filter '%s', searchbase '%s'\n", filter
, searchbase
);
220 rc
= ldap_search_s(ld
, searchbase
, searchscope
, filter
, NULL
, 0, &res
);
221 if (rc
!= LDAP_SUCCESS
) {
222 if (noreferrals
&& rc
== LDAP_PARTIAL_RESULTS
) {
223 /* Everything is fine. This is expected when referrals
228 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error '%s'\n", ldap_err2string(rc
));
229 #if defined(NETSCAPE_SSL)
230 if (sslpath
&& ((rc
== LDAP_SERVER_DOWN
) || (rc
== LDAP_CONNECT_ERROR
))) {
231 int sslerr
= PORT_GetError();
232 fprintf(stderr
, PROGRAM_NAME
": WARNING, SSL error %d (%s)\n", sslerr
, ldapssl_err2string(sslerr
));
235 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error, trying to recover'%s'\n", ldap_err2string(rc
));
237 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
249 } else if (userdnattr
) {
250 snprintf(filter
,8192,"%s=%s",userdnattr
,login
);
253 debug("searchbase '%s'\n", userbasedn
);
254 rc
= ldap_search_s(ld
, userbasedn
, searchscope
, filter
, NULL
, 0, &res
);
256 if (rc
== LDAP_SUCCESS
) {
257 entry
= ldap_first_entry(ld
, res
);
259 values
= ldap_get_values(ld
, entry
, passattr
);
265 debug("No attribute value found\n");
271 if (encrpass
&& *delimiter
) {
272 const char *t
= strtok(*value
, delimiter
);
273 if (t
&& strcmp(t
, realm
) == 0) {
274 password
= strtok(NULL
, delimiter
);
283 debug("password: %s\n", password
);
285 password
= xstrdup(password
);
286 ldap_value_free(values
);
290 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP error '%s'\n", ldap_err2string(rc
));
291 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
310 /* On Windows ldap_start_tls_s is available starting from Windows XP,
311 * so we need to bind at run-time with the function entry point
316 HMODULE WLDAP32Handle
;
318 WLDAP32Handle
= GetModuleHandle("wldap32");
319 if ((Win32_ldap_start_tls_s
= (PFldap_start_tls_s
) GetProcAddress(WLDAP32Handle
, LDAP_START_TLS_S
)) == NULL
) {
320 fprintf(stderr
, PROGRAM_NAME
": ERROR: TLS (-Z) not supported on this platform.\n");
328 if (strstr(ldapServer
, "://") != NULL
) {
329 rc
= ldap_initialize(&ld
, ldapServer
);
330 if (rc
!= LDAP_SUCCESS
) {
331 fprintf(stderr
, "\nUnable to connect to LDAPURI:%s\n", ldapServer
);
337 if (!sslinit
&& (ldapssl_client_init(sslpath
, NULL
) != LDAP_SUCCESS
)) {
338 fprintf(stderr
, "\nUnable to initialise SSL with cert path %s\n",
344 if ((ld
= ldapssl_init(ldapServer
, port
, 1)) == NULL
) {
345 fprintf(stderr
, "\nUnable to connect to SSL LDAP server: %s port:%d\n",
351 if ((ld
= ldap_init(ldapServer
, port
)) == NULL
) {
352 fprintf(stderr
, "\nUnable to connect to LDAP server:%s port:%d\n", ldapServer
, port
);
355 squid_ldap_set_connect_timeout(connect_timeout
);
359 version
= LDAP_VERSION2
;
361 if (ldap_set_option(ld
, LDAP_OPT_PROTOCOL_VERSION
, &version
)
363 fprintf(stderr
, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n",
369 #ifdef LDAP_OPT_X_TLS
370 if (version
!= LDAP_VERSION3
) {
371 fprintf(stderr
, "TLS requires LDAP version 3\n");
373 } else if (ldap_start_tls_s(ld
, NULL
, NULL
) != LDAP_SUCCESS
) {
374 fprintf(stderr
, "Could not Activate TLS connection\n");
378 fprintf(stderr
, "TLS not supported with your LDAP library\n");
384 squid_ldap_set_timelimit(timelimit
);
385 squid_ldap_set_referrals(!noreferrals
);
386 squid_ldap_set_aliasderef(aliasderef
);
387 if (binddn
&& bindpasswd
&& *binddn
&& *bindpasswd
) {
388 rc
= ldap_simple_bind_s(ld
, binddn
, bindpasswd
);
389 if (rc
!= LDAP_SUCCESS
) {
390 fprintf(stderr
, PROGRAM_NAME
" WARNING, could not bind to binddn '%s'\n", ldap_err2string(rc
));
395 debug("Connected OK\n");
399 LDAPArguments(int argc
, char **argv
)
401 setbuf(stdout
, NULL
);
403 while (argc
> 1 && argv
[1][0] == '-') {
404 const char *value
= "";
405 char option
= argv
[1][1];
416 if (strlen(argv
[1]) > 2) {
418 } else if (argc
> 2) {
431 fprintf(stderr
, "ERROR: Your LDAP library does not have URI support\n");
434 /* Fall thru to -h */
437 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
438 char *newhost
= static_cast<char*>(xmalloc(len
));
439 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
441 ldapServer
= newhost
;
443 ldapServer
= xstrdup(value
);
462 usersearchfilter
= value
;
468 if (strcmp(value
, "base") == 0)
469 searchscope
= LDAP_SCOPE_BASE
;
470 else if (strcmp(value
, "one") == 0)
471 searchscope
= LDAP_SCOPE_ONELEVEL
;
472 else if (strcmp(value
, "sub") == 0)
473 searchscope
= LDAP_SCOPE_SUBTREE
;
475 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown search scope '%s'\n", value
);
480 #if defined(NETSCAPE_SSL)
482 if (port
== LDAP_PORT
)
485 fprintf(stderr
, PROGRAM_NAME
" ERROR: -E unsupported with this LDAP library\n");
490 connect_timeout
= atoi(value
);
493 timelimit
= atoi(value
);
496 if (strcmp(value
, "never") == 0)
497 aliasderef
= LDAP_DEREF_NEVER
;
498 else if (strcmp(value
, "always") == 0)
499 aliasderef
= LDAP_DEREF_ALWAYS
;
500 else if (strcmp(value
, "search") == 0)
501 aliasderef
= LDAP_DEREF_SEARCHING
;
502 else if (strcmp(value
, "find") == 0)
503 aliasderef
= LDAP_DEREF_FINDING
;
505 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown alias dereference method '%s'\n", value
);
519 persistent
= !persistent
;
525 noreferrals
= !noreferrals
;
529 switch (atoi(value
)) {
531 version
= LDAP_VERSION2
;
534 version
= LDAP_VERSION3
;
537 fprintf(stderr
, "Protocol version should be 2 or 3\n");
542 if (version
== LDAP_VERSION2
) {
543 fprintf(stderr
, "TLS (-Z) is incompatible with version %d\n",
547 version
= LDAP_VERSION3
;
558 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown command line option '%c'\n", option
);
564 char *value
= argv
[1];
566 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
567 char *newhost
= static_cast<char*>(xmalloc(len
));
568 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
570 ldapServer
= newhost
;
572 ldapServer
= xstrdup(value
);
579 ldapServer
= (char *) "localhost";
581 if (!userbasedn
|| !passattr
|| (!*delimiter
&& !*frealm
)) {
582 fprintf(stderr
, "Usage: " PROGRAM_NAME
" -b basedn -F filter [options] ldap_server_name\n\n");
583 fprintf(stderr
, "\t-A password attribute(REQUIRED)\t\tUser attribute that contains the password\n");
584 fprintf(stderr
, "\t-l password realm delimiter(REQUIRED)\tCharacter(s) that divides the password attribute\n\t\t\t\t\t\tin realm and password tokens, default ':' realm:password, could be\n\t\t\t\t\t\tempty string if the password is alone in the password attribute\n");
585 fprintf(stderr
, "\t-r filtered realm\t\t\tonly honor Squid requests for this realm. Mandatory if the password is alone in\n\t\t\t\t\t\tthe password attribute, acting as the implicit realm\n");
586 fprintf(stderr
, "\t-b basedn (REQUIRED)\t\t\tbase dn under where to search for users\n");
587 fprintf(stderr
, "\t-e Encrypted passwords(REQUIRED)\tPassword are stored encrypted using HHA1\n");
588 fprintf(stderr
, "\t-F filter\t\t\t\tuser search filter pattern. %%s = login\n");
589 fprintf(stderr
, "\t-u attribute\t\t\t\tattribute to use in combination with the basedn to create the user DN\n");
590 fprintf(stderr
, "\t-s base|one|sub\t\t\t\tsearch scope\n");
591 fprintf(stderr
, "\t-D binddn\t\t\t\tDN to bind as to perform searches\n");
592 fprintf(stderr
, "\t-w bindpasswd\t\t\t\tpassword for binddn\n");
593 fprintf(stderr
, "\t-W secretfile\t\t\t\tread password for binddn from file secretfile\n");
595 fprintf(stderr
, "\t-H URI\t\t\t\t\tLDAPURI (defaults to ldap://localhost)\n");
597 fprintf(stderr
, "\t-h server\t\t\t\tLDAP server (defaults to localhost)\n");
598 fprintf(stderr
, "\t-p port\t\t\t\t\tLDAP server port (defaults to %d)\n", LDAP_PORT
);
599 fprintf(stderr
, "\t-P\t\t\t\t\tpersistent LDAP connection\n");
600 #if defined(NETSCAPE_SSL)
601 fprintf(stderr
, "\t-E sslcertpath\t\t\t\tenable LDAP over SSL\n");
603 fprintf(stderr
, "\t-c timeout\t\t\t\tconnect timeout\n");
604 fprintf(stderr
, "\t-t timelimit\t\t\t\tsearch time limit\n");
605 fprintf(stderr
, "\t-R\t\t\t\t\tdo not follow referrals\n");
606 fprintf(stderr
, "\t-a never|always|search|find\t\twhen to dereference aliases\n");
608 fprintf(stderr
, "\t-v 2|3\t\t\t\t\tLDAP version\n");
609 fprintf(stderr
, "\t-Z\t\t\t\t\tTLS encrypt the LDAP connection, requires\n\t\t\t\tLDAP version 3\n");
611 fprintf(stderr
, "\t-S\t\t\t\t\tStrip NT domain from usernames\n");
612 fprintf(stderr
, "\n");
613 fprintf(stderr
, "\tIf you need to bind as a user to perform searches then use the\n\t-D binddn -w bindpasswd or -D binddn -W secretfile options\n\n");
619 readSecret(const char *filename
)
625 if (!(f
= fopen(filename
, "r"))) {
626 fprintf(stderr
, PROGRAM_NAME
" ERROR: Can not read secret file %s\n", filename
);
629 if (!fgets(buf
, sizeof(buf
) - 1, f
)) {
630 fprintf(stderr
, PROGRAM_NAME
" ERROR: Secret file %s is empty\n", filename
);
634 /* strip whitespaces on end */
635 if ((e
= strrchr(buf
, '\n')))
637 if ((e
= strrchr(buf
, '\r')))
640 bindpasswd
= xstrdup(buf
);
642 fprintf(stderr
, PROGRAM_NAME
" ERROR: can not allocate memory\n");
650 LDAPHHA1(RequestData
* requestData
)
652 char *password
= NULL
;
655 // use the -l delimiter to find realm, or
656 // only honor the -r specified realm
657 const bool lookup
= (!*frealm
&& *delimiter
) ||
658 (*frealm
&& strcmp(requestData
->realm
, frealm
) == 0);
661 password
= getpassword(requestData
->user
, requestData
->realm
);
663 if (password
!= NULL
) {
665 xstrncpy(requestData
->HHA1
, password
, sizeof(requestData
->HHA1
));
668 DigestCalcHA1("md5", requestData
->user
, requestData
->realm
, password
, NULL
, NULL
, HA1
, requestData
->HHA1
);
672 requestData
->error
= -1;