6 * AUTHOR: Flavio Pescuma, MARA Systems AB <flavio@marasystems.com>
11 #define LDAP_DEPRECATED 1
13 #include "ldap_backend.h"
15 #if _SQUID_MSWIN_ /* Native Windows port and MinGW */
17 #define snprintf _snprintf
21 #define LDAPAPI __cdecl
24 #ifndef LDAP_OPT_X_TLS
25 #define LDAP_OPT_X_TLS 0x6000
27 /* Some tricks to allow dynamic bind with ldap_start_tls_s entry point at
30 #undef ldap_start_tls_s
32 #define LDAP_START_TLS_S "ldap_start_tls_sW"
33 typedef WINLDAPAPI
ULONG(LDAPAPI
* PFldap_start_tls_s
) (IN PLDAP
, OUT PULONG
, OUT LDAPMessage
**, IN PLDAPControlW
*, IN PLDAPControlW
*);
35 #define LDAP_START_TLS_S "ldap_start_tls_sA"
36 typedef WINLDAPAPI
ULONG(LDAPAPI
* PFldap_start_tls_s
) (IN PLDAP
, OUT PULONG
, OUT LDAPMessage
**, IN PLDAPControlA
*, IN PLDAPControlA
*);
37 #endif /* LDAP_UNICODE */
38 PFldap_start_tls_s Win32_ldap_start_tls_s
;
39 #define ldap_start_tls_s(l,s,c) Win32_ldap_start_tls_s(l,NULL,NULL,s,c)
40 #endif /* LDAP_VERSION3 */
48 #define PROGRAM_NAME "digest_pw_auth(LDAP_backend)"
52 static LDAP
*ld
= NULL
;
53 static const char *passattr
= NULL
;
54 static char *ldapServer
= NULL
;
55 static const char *userbasedn
= NULL
;
56 static const char *userdnattr
= NULL
;
57 static const char *usersearchfilter
= NULL
;
58 static const char *binddn
= NULL
;
59 static const char *bindpasswd
= NULL
;
60 static const char *delimiter
= ":";
61 static int encrpass
= 0;
62 static int searchscope
= LDAP_SCOPE_SUBTREE
;
63 static int persistent
= 0;
64 static int noreferrals
= 0;
65 static int port
= LDAP_PORT
;
66 static int strip_nt_domain
= 0;
67 static int aliasderef
= LDAP_DEREF_NEVER
;
68 #if defined(NETSCAPE_SSL)
69 static char *sslpath
= NULL
;
70 static int sslinit
= 0;
72 static int connect_timeout
= 0;
73 static int timelimit
= LDAP_NO_LIMIT
;
76 /* Added for TLS support and version 3 */
77 static int use_tls
= 0;
78 static int version
= -1;
81 static void ldapconnect(void);
82 static int readSecret(const char *filename
);
84 /* Yuck.. we need to glue to different versions of the API */
86 #if defined(LDAP_API_VERSION) && LDAP_API_VERSION > 1823
88 squid_ldap_set_aliasderef(int deref
)
90 ldap_set_option(ld
, LDAP_OPT_DEREF
, &deref
);
93 squid_ldap_set_referrals(int referrals
)
95 int *value
= static_cast<int*>(referrals
? LDAP_OPT_ON
:LDAP_OPT_OFF
);
96 ldap_set_option(ld
, LDAP_OPT_REFERRALS
, value
);
99 squid_ldap_set_timelimit(int aTimeLimit
)
101 ldap_set_option(ld
, LDAP_OPT_TIMELIMIT
, &aTimeLimit
);
104 squid_ldap_set_connect_timeout(int aTimeLimit
)
106 #if defined(LDAP_OPT_NETWORK_TIMEOUT)
108 tv
.tv_sec
= aTimeLimit
;
110 ldap_set_option(ld
, LDAP_OPT_NETWORK_TIMEOUT
, &tv
);
111 #elif defined(LDAP_X_OPT_CONNECT_TIMEOUT)
113 ldap_set_option(ld
, LDAP_X_OPT_CONNECT_TIMEOUT
, &aTimeLimit
);
119 squid_ldap_errno(LDAP
* ld
)
124 squid_ldap_set_aliasderef(int deref
)
126 ld
->ld_deref
= deref
;
129 squid_ldap_set_referrals(int referrals
)
132 ld
->ld_options
|= ~LDAP_OPT_REFERRALS
;
134 ld
->ld_options
&= ~LDAP_OPT_REFERRALS
;
137 squid_ldap_set_timelimit(int aTimeLimit
)
139 ld
->ld_timelimit
= aTimeLimit
;
142 squid_ldap_set_connect_timeout(int aTimeLimit
)
144 fprintf(stderr
, "Connect timeouts not supported in your LDAP library\n");
147 squid_ldap_memfree(char *p
)
154 #ifdef LDAP_API_FEATURE_X_OPENLDAP
155 #if LDAP_VENDOR_VERSION > 194
156 #define HAS_URI_SUPPORT 1
161 ldap_escape_value(char *escaped
, int size
, const char *src
)
164 while (size
> 4 && *src
) {
175 snprintf(escaped
, 3, "%02x", (int) *src
);
193 getpassword(char *login
, char *realm
)
195 LDAPMessage
*res
= NULL
;
197 char **values
= NULL
;
199 char *password
= NULL
;
202 char searchbase
[8192];
205 if (usersearchfilter
) {
206 char escaped_login
[1024];
207 snprintf(searchbase
, sizeof(searchbase
), "%s", userbasedn
);
208 ldap_escape_value(escaped_login
, sizeof(escaped_login
), login
);
209 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
);
212 debug("user filter '%s', searchbase '%s'\n", filter
, searchbase
);
214 rc
= ldap_search_s(ld
, searchbase
, searchscope
, filter
, NULL
, 0, &res
);
215 if (rc
!= LDAP_SUCCESS
) {
216 if (noreferrals
&& rc
== LDAP_PARTIAL_RESULTS
) {
217 /* Everything is fine. This is expected when referrals
222 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error '%s'\n", ldap_err2string(rc
));
223 #if defined(NETSCAPE_SSL)
224 if (sslpath
&& ((rc
== LDAP_SERVER_DOWN
) || (rc
== LDAP_CONNECT_ERROR
))) {
225 int sslerr
= PORT_GetError();
226 fprintf(stderr
, PROGRAM_NAME
": WARNING, SSL error %d (%s)\n", sslerr
, ldapssl_err2string(sslerr
));
229 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error, trying to recover'%s'\n", ldap_err2string(rc
));
231 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
243 } else if (userdnattr
) {
244 snprintf(filter
,8192,"%s=%s",userdnattr
,login
);
247 debug("searchbase '%s'\n", userbasedn
);
248 rc
= ldap_search_s(ld
, userbasedn
, searchscope
, filter
, NULL
, 0, &res
);
250 if (rc
== LDAP_SUCCESS
) {
251 entry
= ldap_first_entry(ld
, res
);
253 values
= ldap_get_values(ld
, entry
, passattr
);
259 debug("No attribute value found\n");
266 if (strcmp(strtok(*value
, delimiter
), realm
) == 0) {
267 password
= strtok(NULL
, delimiter
);
276 debug("password: %s\n", password
);
278 password
= xstrdup(password
);
279 ldap_value_free(values
);
283 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP error '%s'\n", ldap_err2string(rc
));
284 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
303 /* On Windows ldap_start_tls_s is available starting from Windows XP,
304 * so we need to bind at run-time with the function entry point
309 HMODULE WLDAP32Handle
;
311 WLDAP32Handle
= GetModuleHandle("wldap32");
312 if ((Win32_ldap_start_tls_s
= (PFldap_start_tls_s
) GetProcAddress(WLDAP32Handle
, LDAP_START_TLS_S
)) == NULL
) {
313 fprintf(stderr
, PROGRAM_NAME
": ERROR: TLS (-Z) not supported on this platform.\n");
321 if (strstr(ldapServer
, "://") != NULL
) {
322 rc
= ldap_initialize(&ld
, ldapServer
);
323 if (rc
!= LDAP_SUCCESS
) {
324 fprintf(stderr
, "\nUnable to connect to LDAPURI:%s\n", ldapServer
);
330 if (!sslinit
&& (ldapssl_client_init(sslpath
, NULL
) != LDAP_SUCCESS
)) {
331 fprintf(stderr
, "\nUnable to initialise SSL with cert path %s\n",
337 if ((ld
= ldapssl_init(ldapServer
, port
, 1)) == NULL
) {
338 fprintf(stderr
, "\nUnable to connect to SSL LDAP server: %s port:%d\n",
344 if ((ld
= ldap_init(ldapServer
, port
)) == NULL
) {
345 fprintf(stderr
, "\nUnable to connect to LDAP server:%s port:%d\n", ldapServer
, port
);
348 squid_ldap_set_connect_timeout(connect_timeout
);
352 version
= LDAP_VERSION2
;
354 if (ldap_set_option(ld
, LDAP_OPT_PROTOCOL_VERSION
, &version
)
356 fprintf(stderr
, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n",
362 #ifdef LDAP_OPT_X_TLS
363 if (version
!= LDAP_VERSION3
) {
364 fprintf(stderr
, "TLS requires LDAP version 3\n");
366 } else if (ldap_start_tls_s(ld
, NULL
, NULL
) != LDAP_SUCCESS
) {
367 fprintf(stderr
, "Could not Activate TLS connection\n");
371 fprintf(stderr
, "TLS not supported with your LDAP library\n");
377 squid_ldap_set_timelimit(timelimit
);
378 squid_ldap_set_referrals(!noreferrals
);
379 squid_ldap_set_aliasderef(aliasderef
);
380 if (binddn
&& bindpasswd
&& *binddn
&& *bindpasswd
) {
381 rc
= ldap_simple_bind_s(ld
, binddn
, bindpasswd
);
382 if (rc
!= LDAP_SUCCESS
) {
383 fprintf(stderr
, PROGRAM_NAME
" WARNING, could not bind to binddn '%s'\n", ldap_err2string(rc
));
388 debug("Connected OK\n");
392 LDAPArguments(int argc
, char **argv
)
394 setbuf(stdout
, NULL
);
396 while (argc
> 1 && argv
[1][0] == '-') {
397 const char *value
= "";
398 char option
= argv
[1][1];
409 if (strlen(argv
[1]) > 2) {
411 } else if (argc
> 2) {
424 fprintf(stderr
, "ERROR: Your LDAP library does not have URI support\n");
427 /* Fall thru to -h */
430 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
431 char *newhost
= (char*)malloc(len
);
432 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
434 ldapServer
= newhost
;
436 ldapServer
= xstrdup(value
);
452 usersearchfilter
= value
;
458 if (strcmp(value
, "base") == 0)
459 searchscope
= LDAP_SCOPE_BASE
;
460 else if (strcmp(value
, "one") == 0)
461 searchscope
= LDAP_SCOPE_ONELEVEL
;
462 else if (strcmp(value
, "sub") == 0)
463 searchscope
= LDAP_SCOPE_SUBTREE
;
465 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown search scope '%s'\n", value
);
470 #if defined(NETSCAPE_SSL)
472 if (port
== LDAP_PORT
)
475 fprintf(stderr
, PROGRAM_NAME
" ERROR: -E unsupported with this LDAP library\n");
480 connect_timeout
= atoi(value
);
483 timelimit
= atoi(value
);
486 if (strcmp(value
, "never") == 0)
487 aliasderef
= LDAP_DEREF_NEVER
;
488 else if (strcmp(value
, "always") == 0)
489 aliasderef
= LDAP_DEREF_ALWAYS
;
490 else if (strcmp(value
, "search") == 0)
491 aliasderef
= LDAP_DEREF_SEARCHING
;
492 else if (strcmp(value
, "find") == 0)
493 aliasderef
= LDAP_DEREF_FINDING
;
495 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown alias dereference method '%s'\n", value
);
509 persistent
= !persistent
;
515 noreferrals
= !noreferrals
;
519 switch (atoi(value
)) {
521 version
= LDAP_VERSION2
;
524 version
= LDAP_VERSION3
;
527 fprintf(stderr
, "Protocol version should be 2 or 3\n");
532 if (version
== LDAP_VERSION2
) {
533 fprintf(stderr
, "TLS (-Z) is incompatible with version %d\n",
537 version
= LDAP_VERSION3
;
548 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown command line option '%c'\n", option
);
554 char *value
= argv
[1];
556 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
557 char *newhost
= (char*)malloc(len
);
558 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
560 ldapServer
= newhost
;
562 ldapServer
= xstrdup(value
);
569 ldapServer
= (char *) "localhost";
571 if (!userbasedn
|| !passattr
) {
572 fprintf(stderr
, "Usage: " PROGRAM_NAME
" -b basedn -f filter [options] ldap_server_name\n\n");
573 fprintf(stderr
, "\t-A password attribute(REQUIRED)\t\tUser attribute that contains the password\n");
574 fprintf(stderr
, "\t-l password realm delimiter(REQUIRED)\tCharater(s) that devides the password attribute\n\t\t\t\t\t\tin realm and password tokens, default ':' realm:password\n");
575 fprintf(stderr
, "\t-b basedn (REQUIRED)\t\t\tbase dn under where to search for users\n");
576 fprintf(stderr
, "\t-e Encrypted passwords(REQUIRED)\tPassword are stored encrypted using HHA1\n");
577 fprintf(stderr
, "\t-F filter\t\t\t\tuser search filter pattern. %%s = login\n");
578 fprintf(stderr
, "\t-u attribute\t\t\t\tattribute to use in combination with the basedn to create the user DN\n");
579 fprintf(stderr
, "\t-s base|one|sub\t\t\t\tsearch scope\n");
580 fprintf(stderr
, "\t-D binddn\t\t\t\tDN to bind as to perform searches\n");
581 fprintf(stderr
, "\t-w bindpasswd\t\t\t\tpassword for binddn\n");
582 fprintf(stderr
, "\t-W secretfile\t\t\t\tread password for binddn from file secretfile\n");
584 fprintf(stderr
, "\t-H URI\t\t\t\t\tLDAPURI (defaults to ldap://localhost)\n");
586 fprintf(stderr
, "\t-h server\t\t\t\tLDAP server (defaults to localhost)\n");
587 fprintf(stderr
, "\t-p port\t\t\t\t\tLDAP server port (defaults to %d)\n", LDAP_PORT
);
588 fprintf(stderr
, "\t-P\t\t\t\t\tpersistent LDAP connection\n");
589 #if defined(NETSCAPE_SSL)
590 fprintf(stderr
, "\t-E sslcertpath\t\t\t\tenable LDAP over SSL\n");
592 fprintf(stderr
, "\t-c timeout\t\t\t\tconnect timeout\n");
593 fprintf(stderr
, "\t-t timelimit\t\t\t\tsearch time limit\n");
594 fprintf(stderr
, "\t-R\t\t\t\t\tdo not follow referrals\n");
595 fprintf(stderr
, "\t-a never|always|search|find\t\twhen to dereference aliases\n");
597 fprintf(stderr
, "\t-v 2|3\t\t\t\t\tLDAP version\n");
598 fprintf(stderr
, "\t-Z\t\t\t\t\tTLS encrypt the LDAP connection, requires\n\t\t\t\tLDAP version 3\n");
600 fprintf(stderr
, "\t-S\t\t\t\t\tStrip NT domain from usernames\n");
601 fprintf(stderr
, "\n");
602 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");
608 readSecret(const char *filename
)
614 if (!(f
= fopen(filename
, "r"))) {
615 fprintf(stderr
, PROGRAM_NAME
" ERROR: Can not read secret file %s\n", filename
);
618 if (!fgets(buf
, sizeof(buf
) - 1, f
)) {
619 fprintf(stderr
, PROGRAM_NAME
" ERROR: Secret file %s is empty\n", filename
);
623 /* strip whitespaces on end */
624 if ((e
= strrchr(buf
, '\n')))
626 if ((e
= strrchr(buf
, '\r')))
629 bindpasswd
= xstrdup(buf
);
631 fprintf(stderr
, PROGRAM_NAME
" ERROR: can not allocate memory\n");
639 LDAPHHA1(RequestData
* requestData
)
643 password
= getpassword(requestData
->user
, requestData
->realm
);
644 if (password
!= NULL
) {
646 xstrncpy(requestData
->HHA1
, password
, sizeof(requestData
->HHA1
));
649 DigestCalcHA1("md5", requestData
->user
, requestData
->realm
, password
, NULL
, NULL
, HA1
, requestData
->HHA1
);
653 requestData
->error
= -1;