2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2011 Pierre Carrier <pierre@spotify.com>
5 * Copyright (C) 2009-2010 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
7 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
8 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
9 * Copyright (C) 2008 Dennis Friis <peavey@inspircd.org>
10 * Copyright (C) 2007 Carsten Valdemar Munk <carsten.munk+inspircd@gmail.com>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 # pragma comment(lib, "ldap.lib")
35 # pragma comment(lib, "lber.lib")
38 /* $LinkerFlags: -lldap */
44 RAIILDAPString(char *Str)
59 operator std::string()
65 struct RAIILDAPMessage
81 operator LDAPMessage*()
86 LDAPMessage **operator &()
94 class ModuleLDAPAuth : public Module
96 LocalIntExt ldapAuthed;
97 LocalStringExt ldapVhost;
99 std::string attribute;
100 std::string ldapserver;
101 std::string allowpattern;
102 std::string killreason;
103 std::string username;
104 std::string password;
106 std::vector<std::string> whitelistedcidrs;
107 std::vector<std::pair<std::string, std::string> > requiredattributes;
115 : ldapAuthed("ldapauth", this)
116 , ldapVhost("ldapauth_vhost", this)
121 void init() CXX11_OVERRIDE
123 ServerInstance->Modules->AddService(ldapAuthed);
124 ServerInstance->Modules->AddService(ldapVhost);
131 ldap_unbind_ext(conn, NULL, NULL);
134 void OnRehash(User* user) CXX11_OVERRIDE
136 ConfigTag* tag = ServerInstance->Config->ConfValue("ldapauth");
137 whitelistedcidrs.clear();
138 requiredattributes.clear();
140 base = tag->getString("baserdn");
141 attribute = tag->getString("attribute");
142 ldapserver = tag->getString("server");
143 allowpattern = tag->getString("allowpattern");
144 killreason = tag->getString("killreason");
145 std::string scope = tag->getString("searchscope");
146 username = tag->getString("binddn");
147 password = tag->getString("bindauth");
148 vhost = tag->getString("host");
149 verbose = tag->getBool("verbose"); /* Set to true if failed connects should be reported to operators */
150 useusername = tag->getBool("userfield");
152 ConfigTagList whitelisttags = ServerInstance->Config->ConfTags("ldapwhitelist");
154 for (ConfigIter i = whitelisttags.first; i != whitelisttags.second; ++i)
156 std::string cidr = i->second->getString("cidr");
158 whitelistedcidrs.push_back(cidr);
162 ConfigTagList attributetags = ServerInstance->Config->ConfTags("ldaprequire");
164 for (ConfigIter i = attributetags.first; i != attributetags.second; ++i)
166 const std::string attr = i->second->getString("attribute");
167 const std::string val = i->second->getString("value");
169 if (!attr.empty() && !val.empty())
170 requiredattributes.push_back(make_pair(attr, val));
174 searchscope = LDAP_SCOPE_BASE;
175 else if (scope == "onelevel")
176 searchscope = LDAP_SCOPE_ONELEVEL;
177 else searchscope = LDAP_SCOPE_SUBTREE;
185 ldap_unbind_ext(conn, NULL, NULL);
186 int res, v = LDAP_VERSION3;
187 res = ldap_initialize(&conn, ldapserver.c_str());
188 if (res != LDAP_SUCCESS)
191 ServerInstance->SNO->WriteToSnoMask('c', "LDAP connection failed: %s", ldap_err2string(res));
196 res = ldap_set_option(conn, LDAP_OPT_PROTOCOL_VERSION, (void *)&v);
197 if (res != LDAP_SUCCESS)
200 ServerInstance->SNO->WriteToSnoMask('c', "LDAP set protocol to v3 failed: %s", ldap_err2string(res));
201 ldap_unbind_ext(conn, NULL, NULL);
208 std::string SafeReplace(const std::string &text, std::map<std::string,
209 std::string> &replacements)
212 result.reserve(text.length());
214 for (unsigned int i = 0; i < text.length(); ++i) {
217 // find the first nonalpha
219 unsigned int start = i;
221 while (i < text.length() - 1 && isalpha(text[i + 1]))
224 std::string key = text.substr(start, (i - start) + 1);
225 result.append(replacements[key]);
234 void OnUserConnect(LocalUser *user) CXX11_OVERRIDE
236 std::string* cc = ldapVhost.get(user);
239 user->ChangeDisplayedHost(cc->c_str());
240 ldapVhost.unset(user);
244 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
246 if ((!allowpattern.empty()) && (InspIRCd::Match(user->nick,allowpattern)))
248 ldapAuthed.set(user,1);
249 return MOD_RES_PASSTHRU;
252 for (std::vector<std::string>::iterator i = whitelistedcidrs.begin(); i != whitelistedcidrs.end(); i++)
254 if (InspIRCd::MatchCIDR(user->GetIPString(), *i, ascii_case_insensitive_map))
256 ldapAuthed.set(user,1);
257 return MOD_RES_PASSTHRU;
261 if (!CheckCredentials(user))
263 ServerInstance->Users->QuitUser(user, killreason);
266 return MOD_RES_PASSTHRU;
269 bool CheckCredentials(LocalUser* user)
275 if (user->password.empty())
278 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (No password provided)", user->GetFullRealHost().c_str());
283 // bind anonymously if no bind DN and authentication are given in the config
285 cred.bv_val = const_cast<char*>(password.c_str());
286 cred.bv_len = password.length();
288 if ((res = ldap_sasl_bind_s(conn, username.c_str(), LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL)) != LDAP_SUCCESS)
290 if (res == LDAP_SERVER_DOWN)
292 // Attempt to reconnect if the connection dropped
294 ServerInstance->SNO->WriteToSnoMask('a', "LDAP server has gone away - reconnecting...");
296 res = ldap_sasl_bind_s(conn, username.c_str(), LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL);
299 if (res != LDAP_SUCCESS)
302 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP bind failed: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
303 ldap_unbind_ext(conn, NULL, NULL);
310 std::string what = (attribute + "=" + (useusername ? user->ident : user->nick));
311 if ((res = ldap_search_ext_s(conn, base.c_str(), searchscope, what.c_str(), NULL, 0, NULL, NULL, NULL, 0, &msg)) != LDAP_SUCCESS)
313 // Do a second search, based on password, if it contains a :
314 // That is, PASS <user>:<password> will work.
315 size_t pos = user->password.find(":");
316 if (pos != std::string::npos)
318 // manpage says we must deallocate regardless of success or failure
319 // since we're about to do another query (and reset msg), first
323 std::string cutpassword = user->password.substr(0, pos);
324 res = ldap_search_ext_s(conn, base.c_str(), searchscope, cutpassword.c_str(), NULL, 0, NULL, NULL, NULL, 0, &msg);
326 if (res == LDAP_SUCCESS)
328 // Trim the user: prefix, leaving just 'pass' for later password check
329 user->password = user->password.substr(pos + 1);
333 // It may have found based on user:pass check above.
334 if (res != LDAP_SUCCESS)
337 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search failed: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
341 if (ldap_count_entries(conn, msg) > 1)
344 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search returned more than one result: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
349 if ((entry = ldap_first_entry(conn, msg)) == NULL)
352 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search returned no results: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
355 cred.bv_val = (char*)user->password.data();
356 cred.bv_len = user->password.length();
357 RAIILDAPString DN(ldap_get_dn(conn, entry));
358 if ((res = ldap_sasl_bind_s(conn, DN, LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL)) != LDAP_SUCCESS)
361 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (%s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
365 if (!requiredattributes.empty())
369 for (std::vector<std::pair<std::string, std::string> >::const_iterator it = requiredattributes.begin(); it != requiredattributes.end(); ++it)
371 const std::string &attr = it->first;
372 const std::string &val = it->second;
374 struct berval attr_value;
375 attr_value.bv_val = const_cast<char*>(val.c_str());
376 attr_value.bv_len = val.length();
378 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "LDAP compare: %s=%s", attr.c_str(), val.c_str());
380 authed = (ldap_compare_ext_s(conn, DN, attr.c_str(), &attr_value, NULL, NULL) == LDAP_COMPARE_TRUE);
389 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (Lacks required LDAP attributes)", user->GetFullRealHost().c_str());
396 irc::commasepstream stream(DN);
398 // mashed map of key:value parts of the DN
399 std::map<std::string, std::string> dnParts;
402 while (stream.GetToken(dnPart))
404 std::string::size_type pos = dnPart.find('=');
405 if (pos == std::string::npos) // malformed
408 std::string key = dnPart.substr(0, pos);
409 std::string value = dnPart.substr(pos + 1, dnPart.length() - pos + 1); // +1s to skip the = itself
410 dnParts[key] = value;
413 // change host according to config key
414 ldapVhost.set(user, SafeReplace(vhost, dnParts));
417 ldapAuthed.set(user,1);
421 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
423 return ldapAuthed.get(user) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
426 Version GetVersion() CXX11_OVERRIDE
428 return Version("Allow/Deny connections based upon answer from LDAP server", VF_VENDOR);
432 MODULE_INIT(ModuleLDAPAuth)