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);
130 ldap_unbind_ext(conn, NULL, NULL);
133 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
135 ConfigTag* tag = ServerInstance->Config->ConfValue("ldapauth");
136 whitelistedcidrs.clear();
137 requiredattributes.clear();
139 base = tag->getString("baserdn");
140 attribute = tag->getString("attribute");
141 ldapserver = tag->getString("server");
142 allowpattern = tag->getString("allowpattern");
143 killreason = tag->getString("killreason");
144 std::string scope = tag->getString("searchscope");
145 username = tag->getString("binddn");
146 password = tag->getString("bindauth");
147 vhost = tag->getString("host");
148 verbose = tag->getBool("verbose"); /* Set to true if failed connects should be reported to operators */
149 useusername = tag->getBool("userfield");
151 ConfigTagList whitelisttags = ServerInstance->Config->ConfTags("ldapwhitelist");
153 for (ConfigIter i = whitelisttags.first; i != whitelisttags.second; ++i)
155 std::string cidr = i->second->getString("cidr");
157 whitelistedcidrs.push_back(cidr);
161 ConfigTagList attributetags = ServerInstance->Config->ConfTags("ldaprequire");
163 for (ConfigIter i = attributetags.first; i != attributetags.second; ++i)
165 const std::string attr = i->second->getString("attribute");
166 const std::string val = i->second->getString("value");
168 if (!attr.empty() && !val.empty())
169 requiredattributes.push_back(make_pair(attr, val));
173 searchscope = LDAP_SCOPE_BASE;
174 else if (scope == "onelevel")
175 searchscope = LDAP_SCOPE_ONELEVEL;
176 else searchscope = LDAP_SCOPE_SUBTREE;
184 ldap_unbind_ext(conn, NULL, NULL);
185 int res, v = LDAP_VERSION3;
186 res = ldap_initialize(&conn, ldapserver.c_str());
187 if (res != LDAP_SUCCESS)
190 ServerInstance->SNO->WriteToSnoMask('c', "LDAP connection failed: %s", ldap_err2string(res));
195 res = ldap_set_option(conn, LDAP_OPT_PROTOCOL_VERSION, (void *)&v);
196 if (res != LDAP_SUCCESS)
199 ServerInstance->SNO->WriteToSnoMask('c', "LDAP set protocol to v3 failed: %s", ldap_err2string(res));
200 ldap_unbind_ext(conn, NULL, NULL);
207 std::string SafeReplace(const std::string &text, std::map<std::string,
208 std::string> &replacements)
211 result.reserve(text.length());
213 for (unsigned int i = 0; i < text.length(); ++i) {
216 // find the first nonalpha
218 unsigned int start = i;
220 while (i < text.length() - 1 && isalpha(text[i + 1]))
223 std::string key = text.substr(start, (i - start) + 1);
224 result.append(replacements[key]);
233 void OnUserConnect(LocalUser *user) CXX11_OVERRIDE
235 std::string* cc = ldapVhost.get(user);
238 user->ChangeDisplayedHost(cc->c_str());
239 ldapVhost.unset(user);
243 ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
245 if ((!allowpattern.empty()) && (InspIRCd::Match(user->nick,allowpattern)))
247 ldapAuthed.set(user,1);
248 return MOD_RES_PASSTHRU;
251 for (std::vector<std::string>::iterator i = whitelistedcidrs.begin(); i != whitelistedcidrs.end(); i++)
253 if (InspIRCd::MatchCIDR(user->GetIPString(), *i, ascii_case_insensitive_map))
255 ldapAuthed.set(user,1);
256 return MOD_RES_PASSTHRU;
260 if (!CheckCredentials(user))
262 ServerInstance->Users->QuitUser(user, killreason);
265 return MOD_RES_PASSTHRU;
268 bool CheckCredentials(LocalUser* user)
274 if (user->password.empty())
277 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (No password provided)", user->GetFullRealHost().c_str());
282 // bind anonymously if no bind DN and authentication are given in the config
284 cred.bv_val = const_cast<char*>(password.c_str());
285 cred.bv_len = password.length();
287 if ((res = ldap_sasl_bind_s(conn, username.c_str(), LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL)) != LDAP_SUCCESS)
289 if (res == LDAP_SERVER_DOWN)
291 // Attempt to reconnect if the connection dropped
293 ServerInstance->SNO->WriteToSnoMask('a', "LDAP server has gone away - reconnecting...");
295 res = ldap_sasl_bind_s(conn, username.c_str(), LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL);
298 if (res != LDAP_SUCCESS)
301 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP bind failed: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
302 ldap_unbind_ext(conn, NULL, NULL);
309 std::string what = (attribute + "=" + (useusername ? user->ident : user->nick));
310 if ((res = ldap_search_ext_s(conn, base.c_str(), searchscope, what.c_str(), NULL, 0, NULL, NULL, NULL, 0, &msg)) != LDAP_SUCCESS)
312 // Do a second search, based on password, if it contains a :
313 // That is, PASS <user>:<password> will work.
314 size_t pos = user->password.find(":");
315 if (pos != std::string::npos)
317 // manpage says we must deallocate regardless of success or failure
318 // since we're about to do another query (and reset msg), first
322 std::string cutpassword = user->password.substr(0, pos);
323 res = ldap_search_ext_s(conn, base.c_str(), searchscope, cutpassword.c_str(), NULL, 0, NULL, NULL, NULL, 0, &msg);
325 if (res == LDAP_SUCCESS)
327 // Trim the user: prefix, leaving just 'pass' for later password check
328 user->password = user->password.substr(pos + 1);
332 // It may have found based on user:pass check above.
333 if (res != LDAP_SUCCESS)
336 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search failed: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
340 if (ldap_count_entries(conn, msg) > 1)
343 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search returned more than one result: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
348 if ((entry = ldap_first_entry(conn, msg)) == NULL)
351 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (LDAP search returned no results: %s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
354 cred.bv_val = (char*)user->password.data();
355 cred.bv_len = user->password.length();
356 RAIILDAPString DN(ldap_get_dn(conn, entry));
357 if ((res = ldap_sasl_bind_s(conn, DN, LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL)) != LDAP_SUCCESS)
360 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (%s)", user->GetFullRealHost().c_str(), ldap_err2string(res));
364 if (!requiredattributes.empty())
368 for (std::vector<std::pair<std::string, std::string> >::const_iterator it = requiredattributes.begin(); it != requiredattributes.end(); ++it)
370 const std::string &attr = it->first;
371 const std::string &val = it->second;
373 struct berval attr_value;
374 attr_value.bv_val = const_cast<char*>(val.c_str());
375 attr_value.bv_len = val.length();
377 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "LDAP compare: %s=%s", attr.c_str(), val.c_str());
379 authed = (ldap_compare_ext_s(conn, DN, attr.c_str(), &attr_value, NULL, NULL) == LDAP_COMPARE_TRUE);
388 ServerInstance->SNO->WriteToSnoMask('c', "Forbidden connection from %s (Lacks required LDAP attributes)", user->GetFullRealHost().c_str());
395 irc::commasepstream stream(DN);
397 // mashed map of key:value parts of the DN
398 std::map<std::string, std::string> dnParts;
401 while (stream.GetToken(dnPart))
403 std::string::size_type pos = dnPart.find('=');
404 if (pos == std::string::npos) // malformed
407 std::string key = dnPart.substr(0, pos);
408 std::string value = dnPart.substr(pos + 1, dnPart.length() - pos + 1); // +1s to skip the = itself
409 dnParts[key] = value;
412 // change host according to config key
413 ldapVhost.set(user, SafeReplace(vhost, dnParts));
416 ldapAuthed.set(user,1);
420 ModResult OnCheckReady(LocalUser* user) CXX11_OVERRIDE
422 return ldapAuthed.get(user) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
425 Version GetVersion() CXX11_OVERRIDE
427 return Version("Allow/Deny connections based upon answer from LDAP server", VF_VENDOR);
431 MODULE_INIT(ModuleLDAPAuth)