6 * AUTHOR: Flavio Pescuma, MARA Systems AB <flavio@marasystems.com>
8 #define SQUID_NO_ALLOC_PROTECT 1
11 #define LDAP_DEPRECATED 1
13 #include "ldap_backend.h"
15 #ifdef _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 #include "edir_ldapext.h"
49 #define PROGRAM_NAME "digest_pw_auth(LDAP_backend)"
53 static LDAP
*ld
= NULL
;
54 static const char *passattr
= NULL
;
55 static char *ldapServer
= NULL
;
56 static const char *userbasedn
= NULL
;
57 static const char *userdnattr
= NULL
;
58 static const char *usersearchfilter
= NULL
;
59 static const char *binddn
= NULL
;
60 static const char *bindpasswd
= NULL
;
61 static const char *delimiter
= ":";
62 static int encrpass
= 0;
63 static int searchscope
= LDAP_SCOPE_SUBTREE
;
64 static int persistent
= 0;
65 static int noreferrals
= 0;
66 static int port
= LDAP_PORT
;
67 static int strip_nt_domain
= 0;
68 static int edir_universal_passwd
= 0;
69 static int aliasderef
= LDAP_DEREF_NEVER
;
70 #if defined(NETSCAPE_SSL)
71 static char *sslpath
= NULL
;
72 static int sslinit
= 0;
74 static int connect_timeout
= 0;
75 static int timelimit
= LDAP_NO_LIMIT
;
78 /* Added for TLS support and version 3 */
79 static int use_tls
= 0;
80 static int version
= -1;
83 static void ldapconnect(void);
84 static int readSecret(const char *filename
);
86 /* Yuck.. we need to glue to different versions of the API */
88 #if defined(LDAP_API_VERSION) && LDAP_API_VERSION > 1823
90 squid_ldap_set_aliasderef(int deref
)
92 ldap_set_option(ld
, LDAP_OPT_DEREF
, &deref
);
95 squid_ldap_set_referrals(int referrals
)
97 int *value
= static_cast<int*>(referrals
? LDAP_OPT_ON
:LDAP_OPT_OFF
);
98 ldap_set_option(ld
, LDAP_OPT_REFERRALS
, value
);
101 squid_ldap_set_timelimit(int aTimeLimit
)
103 ldap_set_option(ld
, LDAP_OPT_TIMELIMIT
, &aTimeLimit
);
106 squid_ldap_set_connect_timeout(int aTimeLimit
)
108 #if defined(LDAP_OPT_NETWORK_TIMEOUT)
110 tv
.tv_sec
= aTimeLimit
;
112 ldap_set_option(ld
, LDAP_OPT_NETWORK_TIMEOUT
, &tv
);
113 #elif defined(LDAP_X_OPT_CONNECT_TIMEOUT)
115 ldap_set_option(ld
, LDAP_X_OPT_CONNECT_TIMEOUT
, &aTimeLimit
);
121 squid_ldap_errno(LDAP
* ld
)
126 squid_ldap_set_aliasderef(int deref
)
128 ld
->ld_deref
= deref
;
131 squid_ldap_set_referrals(int referrals
)
134 ld
->ld_options
|= ~LDAP_OPT_REFERRALS
;
136 ld
->ld_options
&= ~LDAP_OPT_REFERRALS
;
139 squid_ldap_set_timelimit(int aTimeLimit
)
141 ld
->ld_timelimit
= aTimeLimit
;
144 squid_ldap_set_connect_timeout(int aTimeLimit
)
146 fprintf(stderr
, "ERROR: Connect timeouts not supported in your LDAP library\n");
149 squid_ldap_memfree(char *p
)
156 #ifdef LDAP_API_FEATURE_X_OPENLDAP
157 #if LDAP_VENDOR_VERSION > 194
158 #define HAS_URI_SUPPORT 1
163 ldap_escape_value(char *escaped
, int size
, const char *src
)
166 while (size
> 4 && *src
) {
176 snprintf(escaped
, 3, "%02x", (int) *src
++);
191 getpassword(char *login
, char *realm
)
193 LDAPMessage
*res
= NULL
;
195 char **values
= NULL
;
197 char *password
= NULL
;
200 char searchbase
[8192];
201 char *universal_password
= NULL
;
202 size_t universal_password_len
= 256;
206 if (usersearchfilter
) {
207 char escaped_login
[1024];
208 snprintf(searchbase
, sizeof(searchbase
), "%s", userbasedn
);
209 ldap_escape_value(escaped_login
, sizeof(escaped_login
), login
);
210 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
);
213 debug("user filter '%s', searchbase '%s'\n", filter
, searchbase
);
215 rc
= ldap_search_s(ld
, searchbase
, searchscope
, filter
, NULL
, 0, &res
);
216 if (rc
!= LDAP_SUCCESS
) {
217 if (noreferrals
&& rc
== LDAP_PARTIAL_RESULTS
) {
218 /* Everything is fine. This is expected when referrals
223 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error '%s'\n", ldap_err2string(rc
));
224 #if defined(NETSCAPE_SSL)
225 if (sslpath
&& ((rc
== LDAP_SERVER_DOWN
) || (rc
== LDAP_CONNECT_ERROR
))) {
226 int sslerr
= PORT_GetError();
227 fprintf(stderr
, PROGRAM_NAME
": WARNING, SSL error %d (%s)\n", sslerr
, ldapssl_err2string(sslerr
));
230 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP search error, trying to recover'%s'\n", ldap_err2string(rc
));
232 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
244 } else if (userdnattr
) {
245 snprintf(searchbase
, 8192, "%s=%s, %s", userdnattr
, login
, userbasedn
);
248 debug("searchbase '%s'\n", searchbase
);
249 rc
= ldap_search_s(ld
, searchbase
, searchscope
, NULL
, NULL
, 0, &res
);
251 if (rc
== LDAP_SUCCESS
) {
252 entry
= ldap_first_entry(ld
, res
);
254 debug("ldap dn: %s\n", ldap_get_dn(ld
, entry
));
255 if (edir_universal_passwd
) {
257 /* allocate some memory for the universal password returned by NMAS */
258 universal_password
= (char*)calloc(1, universal_password_len
);
259 values
= (char**)calloc(1, sizeof(char *));
261 /* actually talk to NMAS to get a password */
262 nmas_res
= nds_get_password(ld
, ldap_get_dn(ld
, entry
), &universal_password_len
, universal_password
);
263 if (nmas_res
== LDAP_SUCCESS
&& universal_password
) {
264 debug("NMAS returned value %s\n", universal_password
);
265 values
[0] = universal_password
;
267 debug("Error reading Universal Password: %d = %s\n", nmas_res
, ldap_err2string(nmas_res
));
270 values
= ldap_get_values(ld
, entry
, passattr
);
277 debug("No attribute value found\n");
278 if (edir_universal_passwd
)
279 free(universal_password
);
286 if (strcmp(strtok(*value
, delimiter
), realm
) == 0) {
287 password
= strtok(NULL
, delimiter
);
296 debug("password: %s\n", password
);
298 password
= xstrdup(password
);
299 if (edir_universal_passwd
) {
301 free(universal_password
);
303 ldap_value_free(values
);
308 fprintf(stderr
, PROGRAM_NAME
" WARNING, LDAP error '%s'\n", ldap_err2string(rc
));
309 /* try to connect to the LDAP server agin, maybe my persisten conexion failed. */
330 /* On Windows ldap_start_tls_s is available starting from Windows XP,
331 * so we need to bind at run-time with the function entry point
336 HMODULE WLDAP32Handle
;
338 WLDAP32Handle
= GetModuleHandle("wldap32");
339 if ((Win32_ldap_start_tls_s
= (PFldap_start_tls_s
) GetProcAddress(WLDAP32Handle
, LDAP_START_TLS_S
)) == NULL
) {
340 fprintf(stderr
, PROGRAM_NAME
": ERROR: TLS (-Z) not supported on this platform.\n");
348 if (strstr(ldapServer
, "://") != NULL
) {
349 rc
= ldap_initialize(&ld
, ldapServer
);
350 if (rc
!= LDAP_SUCCESS
) {
351 fprintf(stderr
, "\nUnable to connect to LDAPURI:%s\n", ldapServer
);
357 if (!sslinit
&& (ldapssl_client_init(sslpath
, NULL
) != LDAP_SUCCESS
)) {
358 fprintf(stderr
, "\nUnable to initialise SSL with cert path %s\n",
364 if ((ld
= ldapssl_init(ldapServer
, port
, 1)) == NULL
) {
365 fprintf(stderr
, "\nUnable to connect to SSL LDAP server: %s port:%d\n",
371 if ((ld
= ldap_init(ldapServer
, port
)) == NULL
) {
372 fprintf(stderr
, "\nUnable to connect to LDAP server:%s port:%d\n", ldapServer
, port
);
375 squid_ldap_set_connect_timeout(connect_timeout
);
379 version
= LDAP_VERSION2
;
381 if (ldap_set_option(ld
, LDAP_OPT_PROTOCOL_VERSION
, &version
)
383 fprintf(stderr
, "Could not set LDAP_OPT_PROTOCOL_VERSION %d\n",
389 #ifdef LDAP_OPT_X_TLS
390 if ((version
== LDAP_VERSION3
) && (ldap_start_tls_s(ld
, NULL
, NULL
) == LDAP_SUCCESS
)) {
391 fprintf(stderr
, "Could not Activate TLS connection\n");
396 fprintf(stderr
, "TLS not supported with your LDAP library\n");
402 squid_ldap_set_timelimit(timelimit
);
403 squid_ldap_set_referrals(!noreferrals
);
404 squid_ldap_set_aliasderef(aliasderef
);
405 if (binddn
&& bindpasswd
&& *binddn
&& *bindpasswd
) {
406 rc
= ldap_simple_bind_s(ld
, binddn
, bindpasswd
);
407 if (rc
!= LDAP_SUCCESS
) {
408 fprintf(stderr
, PROGRAM_NAME
" WARNING, could not bind to binddn '%s'\n", ldap_err2string(rc
));
413 debug("Connected OK\n");
417 LDAPArguments(int argc
, char **argv
)
419 setbuf(stdout
, NULL
);
421 while (argc
> 1 && argv
[1][0] == '-') {
422 const char *value
= "";
423 char option
= argv
[1][1];
436 if (strlen(argv
[1]) > 2) {
438 } else if (argc
> 2) {
451 fprintf(stderr
, "ERROR: Your LDAP library does not have URI support\n");
454 /* Fall thru to -h */
457 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
458 char *newhost
= (char*)malloc(len
);
459 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
461 ldapServer
= newhost
;
463 ldapServer
= xstrdup(value
);
479 usersearchfilter
= value
;
485 if (strcmp(value
, "base") == 0)
486 searchscope
= LDAP_SCOPE_BASE
;
487 else if (strcmp(value
, "one") == 0)
488 searchscope
= LDAP_SCOPE_ONELEVEL
;
489 else if (strcmp(value
, "sub") == 0)
490 searchscope
= LDAP_SCOPE_SUBTREE
;
492 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown search scope '%s'\n", value
);
497 #if defined(NETSCAPE_SSL)
499 if (port
== LDAP_PORT
)
502 fprintf(stderr
, PROGRAM_NAME
" ERROR: -E unsupported with this LDAP library\n");
507 connect_timeout
= atoi(value
);
510 timelimit
= atoi(value
);
513 if (strcmp(value
, "never") == 0)
514 aliasderef
= LDAP_DEREF_NEVER
;
515 else if (strcmp(value
, "always") == 0)
516 aliasderef
= LDAP_DEREF_ALWAYS
;
517 else if (strcmp(value
, "search") == 0)
518 aliasderef
= LDAP_DEREF_SEARCHING
;
519 else if (strcmp(value
, "find") == 0)
520 aliasderef
= LDAP_DEREF_FINDING
;
522 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown alias dereference method '%s'\n", value
);
536 persistent
= !persistent
;
542 noreferrals
= !noreferrals
;
546 switch (atoi(value
)) {
548 version
= LDAP_VERSION2
;
551 version
= LDAP_VERSION3
;
554 fprintf(stderr
, "Protocol version should be 2 or 3\n");
559 if (version
== LDAP_VERSION2
) {
560 fprintf(stderr
, "TLS (-Z) is incompatible with version %d\n",
564 version
= LDAP_VERSION3
;
575 edir_universal_passwd
= 1;
578 fprintf(stderr
, PROGRAM_NAME
" ERROR: Unknown command line option '%c'\n", option
);
584 char *value
= argv
[1];
586 int len
= strlen(ldapServer
) + 1 + strlen(value
) + 1;
587 char *newhost
= (char*)malloc(len
);
588 snprintf(newhost
, len
, "%s %s", ldapServer
, value
);
590 ldapServer
= newhost
;
592 ldapServer
= xstrdup(value
);
599 ldapServer
= (char *) "localhost";
601 if (!userbasedn
|| !((passattr
!= NULL
) || (edir_universal_passwd
&& usersearchfilter
&& version
== LDAP_VERSION3
&& use_tls
))) {
602 fprintf(stderr
, "Usage: " PROGRAM_NAME
" -b basedn -f filter [options] ldap_server_name\n\n");
603 fprintf(stderr
, "\t-A password attribute(REQUIRED)\t\tUser attribute that contains the password\n");
604 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");
605 fprintf(stderr
, "\t-b basedn (REQUIRED)\t\t\tbase dn under where to search for users\n");
606 fprintf(stderr
, "\t-e Encrypted passwords(REQUIRED)\tPassword are stored encrypted using HHA1\n");
607 fprintf(stderr
, "\t-F filter\t\t\t\tuser search filter pattern. %%s = login\n");
608 fprintf(stderr
, "\t-u attribute\t\t\t\tattribute to use in combination with the basedn to create the user DN\n");
609 fprintf(stderr
, "\t-s base|one|sub\t\t\t\tsearch scope\n");
610 fprintf(stderr
, "\t-D binddn\t\t\t\tDN to bind as to perform searches\n");
611 fprintf(stderr
, "\t-w bindpasswd\t\t\t\tpassword for binddn\n");
612 fprintf(stderr
, "\t-W secretfile\t\t\t\tread password for binddn from file secretfile\n");
614 fprintf(stderr
, "\t-H URI\t\t\t\t\tLDAPURI (defaults to ldap://localhost)\n");
616 fprintf(stderr
, "\t-h server\t\t\t\tLDAP server (defaults to localhost)\n");
617 fprintf(stderr
, "\t-p port\t\t\t\t\tLDAP server port (defaults to %d)\n", LDAP_PORT
);
618 fprintf(stderr
, "\t-P\t\t\t\t\tpersistent LDAP connection\n");
619 #if defined(NETSCAPE_SSL)
620 fprintf(stderr
, "\t-E sslcertpath\t\t\t\tenable LDAP over SSL\n");
622 fprintf(stderr
, "\t-c timeout\t\t\t\tconnect timeout\n");
623 fprintf(stderr
, "\t-t timelimit\t\t\t\tsearch time limit\n");
624 fprintf(stderr
, "\t-R\t\t\t\t\tdo not follow referrals\n");
625 fprintf(stderr
, "\t-a never|always|search|find\t\twhen to dereference aliases\n");
627 fprintf(stderr
, "\t-v 2|3\t\t\t\t\tLDAP version\n");
628 fprintf(stderr
, "\t-Z\t\t\t\t\tTLS encrypt the LDAP connection, requires\n\t\t\t\tLDAP version 3\n");
630 fprintf(stderr
, "\t-S\t\t\t\t\tStrip NT domain from usernames\n");
631 fprintf(stderr
, "\t-n\t\t\t\t\tGet an eDirectory Universal Password from Novell NMAS\n\t\t\t\t\t\t(requires bind credentials, version 3, TLS, and a search filter)\n");
632 fprintf(stderr
, "\n");
633 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");
639 readSecret(const char *filename
)
645 if (!(f
= fopen(filename
, "r"))) {
646 fprintf(stderr
, PROGRAM_NAME
" ERROR: Can not read secret file %s\n", filename
);
649 if (!fgets(buf
, sizeof(buf
) - 1, f
)) {
650 fprintf(stderr
, PROGRAM_NAME
" ERROR: Secret file %s is empty\n", filename
);
654 /* strip whitespaces on end */
655 if ((e
= strrchr(buf
, '\n')))
657 if ((e
= strrchr(buf
, '\r')))
660 bindpasswd
= xstrdup(buf
);
662 fprintf(stderr
, PROGRAM_NAME
" ERROR: can not allocate memory\n");
670 LDAPHHA1(RequestData
* requestData
)
674 password
= getpassword(requestData
->user
, requestData
->realm
);
675 if (password
!= NULL
) {
677 xstrncpy(requestData
->HHA1
, password
, sizeof(requestData
->HHA1
));
680 DigestCalcHA1("md5", requestData
->user
, requestData
->realm
, password
, NULL
, NULL
, HA1
, requestData
->HHA1
);
684 requestData
->error
= -1;