/usr/lib/python2.7/dist-packages/twext/who/ldap/_service.py is in python-twext 0.1.b2.dev15059-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 | # -*- test-case-name: twext.who.ldap.test.test_service -*-
##
# Copyright (c) 2013-2015 Apple Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##
from __future__ import print_function
"""
LDAP directory service implementation.
"""
from Queue import Queue, Empty
from threading import RLock
from uuid import UUID
import collections
import ldap.async
from twisted.python.constants import Names, NamedConstant
from twisted.internet.defer import succeed, inlineCallbacks, returnValue
from twisted.internet.threads import deferToThreadPool
from twisted.cred.credentials import IUsernamePassword
from twisted.python.threadpool import ThreadPool
from twisted.internet import reactor
from twext.python.log import Logger
from twext.python.types import MappingProxyType
from ..idirectory import (
DirectoryServiceError, DirectoryAvailabilityError,
FieldName as BaseFieldName, RecordType as BaseRecordType,
IPlaintextPasswordVerifier, DirectoryConfigurationError
)
from ..directory import (
DirectoryService as BaseDirectoryService,
DirectoryRecord as BaseDirectoryRecord,
)
from ..expression import (
MatchExpression, ExistsExpression, BooleanExpression,
CompoundExpression, Operand, MatchType
)
from ..util import ConstantsContainer
from ._constants import LDAPAttribute, LDAPObjectClass
from ._util import (
ldapQueryStringFromMatchExpression,
ldapQueryStringFromCompoundExpression,
ldapQueryStringFromBooleanExpression,
ldapQueryStringFromExistsExpression,
)
from zope.interface import implementer
#
# Exceptions
#
class LDAPError(DirectoryServiceError):
"""
LDAP error.
"""
def __init__(self, message, ldapError=None):
super(LDAPError, self).__init__(message)
self.ldapError = ldapError
class LDAPConfigurationError(ValueError):
"""
LDAP configuration error.
"""
class LDAPConnectionError(DirectoryAvailabilityError):
"""
LDAP connection error.
"""
def __init__(self, message, ldapError=None):
super(LDAPConnectionError, self).__init__(message)
self.ldapError = ldapError
class LDAPBindAuthError(LDAPConnectionError):
"""
LDAP bind auth error.
"""
class LDAPQueryError(LDAPError):
"""
LDAP query error.
"""
#
# Data type extensions
#
class FieldName(Names):
dn = NamedConstant()
dn.description = u"distinguished name"
memberDNs = NamedConstant()
memberDNs.description = u"member DNs"
memberDNs.multiValue = True
#
# LDAP schema descriptions
#
class RecordTypeSchema(object):
"""
Describes the LDAP schema for a record type.
"""
def __init__(self, relativeDN, attributes):
"""
@param relativeDN: The relative distinguished name for the record type.
This is prepended to the service's base distinguished name when
searching for records of this type.
@type relativeDN: L{unicode}
@param attributes: Attribute/value pairs that are expected for records
of this type.
@type attributes: iterable of sequences containing two L{unicode}s
"""
self.relativeDN = relativeDN
self.attributes = tuple(tuple(pair) for pair in attributes)
# We use strings (constant.value) instead of constants for the values in
# these mappings because it's meant to be configurable by application users,
# and user input forms such as config files aren't going to be able to use
# the constants.
# Maps field name -> LDAP attribute names
# NOTE: you must provide a mapping for uid
DEFAULT_FIELDNAME_ATTRIBUTE_MAP = MappingProxyType({
# FieldName.dn: (LDAPAttribute.dn.value,),
# BaseFieldName.uid: (LDAPAttribute.dn.value,),
BaseFieldName.guid: (LDAPAttribute.generatedUUID.value,),
BaseFieldName.shortNames: (LDAPAttribute.uid.value,),
BaseFieldName.fullNames: (LDAPAttribute.cn.value,),
BaseFieldName.emailAddresses: (LDAPAttribute.mail.value,),
BaseFieldName.password: (LDAPAttribute.userPassword.value,),
})
# Information about record types
DEFAULT_RECORDTYPE_SCHEMAS = MappingProxyType({
BaseRecordType.user: RecordTypeSchema(
# ou=person
relativeDN=u"ou={0}".format(LDAPObjectClass.person.value),
# (objectClass=inetOrgPerson)
attributes=(
(
LDAPAttribute.objectClass.value,
LDAPObjectClass.inetOrgPerson.value,
),
),
),
BaseRecordType.group: RecordTypeSchema(
# ou=groupOfNames
relativeDN=u"ou={0}".format(LDAPObjectClass.groupOfNames.value),
# (objectClass=groupOfNames)
attributes=(
(
LDAPAttribute.objectClass.value,
LDAPObjectClass.groupOfNames.value,
),
),
),
})
#
# Directory Service
#
class DirectoryService(BaseDirectoryService):
"""
LDAP directory service.
"""
log = Logger()
fieldName = ConstantsContainer((BaseFieldName, FieldName))
recordType = ConstantsContainer((
BaseRecordType.user, BaseRecordType.group,
))
def __init__(
self,
url,
baseDN,
credentials=None,
timeout=None,
tlsCACertificateFile=None,
tlsCACertificateDirectory=None,
useTLS=False,
fieldNameToAttributesMap=DEFAULT_FIELDNAME_ATTRIBUTE_MAP,
recordTypeSchemas=DEFAULT_RECORDTYPE_SCHEMAS,
extraFilters=None,
ownThreadpool=True,
threadPoolMax=10,
connectionMax=10,
_debug=False,
):
"""
@param url: The URL of the LDAP server to connect to.
@type url: L{unicode}
@param baseDN: The base DN for queries.
@type baseDN: L{unicode}
@param credentials: The credentials to use to authenticate with the
LDAP server.
@type credentials: L{IUsernamePassword}
@param timeout: A timeout, in seconds, for LDAP queries.
@type timeout: number
@param tlsCACertificateFile: ...
@type tlsCACertificateFile: L{FilePath}
@param tlsCACertificateDirectory: ...
@type tlsCACertificateDirectory: L{FilePath}
@param useTLS: Enable the use of TLS.
@type useTLS: L{bool}
@param fieldNameToAttributesMap: A mapping of field names to LDAP
attribute names.
@type fieldNameToAttributesMap: mapping with L{NamedConstant} keys and
sequence of L{unicode} values
@param recordTypeSchemas: Schema information for record types.
@type recordTypeSchemas: mapping from L{NamedConstant} to
L{RecordTypeSchema}
@param extraFilters: A dict (keyed off recordType) of extra filter
fragments to AND in to any generated queries.
@type extraFilters: L{dicts} of L{unicode}
"""
self.url = url
self._baseDN = baseDN
self._credentials = credentials
self._timeout = timeout
self._extraFilters = extraFilters
if tlsCACertificateFile is None:
self._tlsCACertificateFile = None
else:
self._tlsCACertificateFile = tlsCACertificateFile.path
if tlsCACertificateDirectory is None:
self._tlsCACertificateDirectory = None
else:
self._tlsCACertificateDirectory = tlsCACertificateDirectory.path
self._useTLS = useTLS
if _debug:
self._debug = 255
else:
self._debug = None
if self.fieldName.recordType in fieldNameToAttributesMap:
raise TypeError("Record type field may not be mapped")
if BaseFieldName.uid not in fieldNameToAttributesMap:
raise DirectoryConfigurationError("Mapping for uid required")
self._fieldNameToAttributesMap = fieldNameToAttributesMap
self._attributeToFieldNameMap = {}
for name, attributes in fieldNameToAttributesMap.iteritems():
for attribute in attributes:
if ":" in attribute:
attribute, ignored = attribute.split(":", 1)
self._attributeToFieldNameMap.setdefault(
attribute, []
).append(name)
self._recordTypeSchemas = recordTypeSchemas
attributesToFetch = set()
for attributes in fieldNameToAttributesMap.values():
for attribute in attributes:
if ":" in attribute:
attribute, ignored = attribute.split(":", 1)
attributesToFetch.add(attribute.encode("utf-8"))
self._attributesToFetch = list(attributesToFetch)
# Threaded connection pool. The connection size limit here is the size for connections doing queries.
# There will also be one-off connections for authentications which also run in their own threads. Thus
# the threadpool max ought to be larger than the connection max to allow for both pooled query connections
# and one-off auth-only connections.
self.ownThreadpool = ownThreadpool
if self.ownThreadpool:
self.threadpool = ThreadPool(minthreads=1, maxthreads=threadPoolMax, name="LDAPDirectoryService")
else:
# Use the default threadpool but adjust its size to fit our needs
self.threadpool = reactor.getThreadPool()
self.threadpool.adjustPoolsize(
max(threadPoolMax, self.threadpool.max)
)
self.connectionMax = connectionMax
self.connectionCreateLock = RLock()
self.connections = []
self.connectionQueue = Queue()
self.poolStats = collections.defaultdict(int)
self.activeCount = 0
reactor.callWhenRunning(self.start)
reactor.addSystemEventTrigger('during', 'shutdown', self.stop)
def start(self):
"""
Start up this service. Initialize the threadpool (if we own it).
"""
if self.ownThreadpool:
self.threadpool.start()
def stop(self):
"""
Stop the service. Stop the threadpool if we own it and do other clean-up.
"""
if self.ownThreadpool:
self.threadpool.stop()
# FIXME: we should probably also close the pool of active connections too
@property
def realmName(self):
return u"{self.url}".format(self=self)
class Connection(object):
"""
ContextManager object for getting a connection from the pool. On exit the connection
will be put back in the pool if no exception was raised. Otherwise, the connection will be
removed from the active connection list, which will allow a new "clean" connection to
be created later if needed.
"""
def __init__(self, ds):
self.ds = ds
def __enter__(self):
self.connection = self.ds._getConnection()
return self.connection
def __exit__(self, exc_type, exc_val, exc_tb):
if exc_type is None:
self.ds._returnConnection(self.connection)
return True
else:
self.ds._failedConnection(self.connection)
return False
def _getConnection(self):
"""
Get a connection from the connection pool. This will retrieve a connection from the connection
pool L{Queue} object. If the L{Queue} is empty, it will check to see whether a new connection can
be created (based on the connection limit), and if so create that and use it. If no new
connections can be created, it will block on the L{Queue} until an existing, in-use, connection
is put back.
"""
try:
connection = self.connectionQueue.get(block=False)
except Empty:
# Note we use a lock here to prevent a race condition in which multiple requests for a new connection
# could succeed even though the connection counts starts out one less than the maximum. This can happen
# because self._connect() can take a while.
self.connectionCreateLock.acquire()
if len(self.connections) < self.connectionMax:
connection = self._connect()
self.connections.append(connection)
self.connectionCreateLock.release()
else:
self.connectionCreateLock.release()
self.poolStats["connection-blocked"] += 1
connection = self.connectionQueue.get()
self.poolStats["connection-{}".format(self.connections.index(connection))] += 1
self.activeCount += 1
self.poolStats["connection-max"] = max(self.poolStats["connection-max"], self.activeCount)
return connection
def _returnConnection(self, connection):
"""
A connection is no longer needed - return it to the pool.
"""
self.activeCount -= 1
self.connectionQueue.put(connection)
def _failedConnection(self, connection):
"""
A connection has failed - remove it from the list of active connections. A new
one will be created if needed.
"""
self.activeCount -= 1
self.poolStats["connection-errors"] += 1
self.connections.remove(connection)
def _connect(self):
"""
Connect to the directory server.
This will always be called in a thread to prevent blocking.
@returns: The connection object.
@rtype: L{ldap.ldapobject.LDAPObject}
@raises: L{LDAPConnectionError} if unable to connect.
"""
# FIXME: ldap connection objects are not thread safe, so let's set up
# a connection pool
self.log.debug("Connecting to LDAP at {log_source.url}")
connection = self._newConnection()
if self._credentials is not None:
if IUsernamePassword.providedBy(self._credentials):
try:
connection.simple_bind_s(
self._credentials.username,
self._credentials.password,
)
self.log.debug(
"Bound to LDAP as {credentials.username}",
credentials=self._credentials
)
except (
ldap.INVALID_CREDENTIALS, ldap.INVALID_DN_SYNTAX
) as e:
self.log.error(
"Unable to bind to LDAP as {credentials.username}",
credentials=self._credentials
)
raise LDAPBindAuthError(
self._credentials.username, e
)
else:
raise LDAPConnectionError(
"Unknown credentials type: {0}"
.format(self._credentials)
)
return connection
def _newConnection(self):
"""
Create a new LDAP connection and initialize and start TLS if required.
This will always be called in a thread to prevent blocking.
@returns: The connection object.
@rtype: L{ldap.ldapobject.LDAPObject}
@raises: L{LDAPConnectionError} if unable to connect.
"""
connection = ldap.initialize(self.url)
# FIXME: Use trace_file option to wire up debug logging when
# Twisted adopts the new logging stuff.
for option, value in (
(ldap.OPT_TIMEOUT, self._timeout),
(ldap.OPT_X_TLS_CACERTFILE, self._tlsCACertificateFile),
(ldap.OPT_X_TLS_CACERTDIR, self._tlsCACertificateDirectory),
(ldap.OPT_DEBUG_LEVEL, self._debug),
):
if value is not None:
connection.set_option(option, value)
if self._useTLS:
self.log.debug("Starting TLS for {log_source.url}")
connection.start_tls_s()
return connection
def _authenticateUsernamePassword(self, dn, password):
"""
Open a secondary connection to the LDAP server and try binding to it
with the given credentials
@returns: True if the password is correct, False otherwise
@rtype: deferred C{bool}
@raises: L{LDAPConnectionError} if unable to connect.
"""
return deferToThreadPool(
reactor, self.threadpool,
self._authenticateUsernamePassword_inThread, dn, password
)
def _authenticateUsernamePassword_inThread(self, dn, password):
"""
Open a secondary connection to the LDAP server and try binding to it
with the given credentials.
This method is always called in a thread.
@returns: True if the password is correct, False otherwise
@rtype: C{bool}
@raises: L{LDAPConnectionError} if unable to connect.
"""
self.log.debug("Authenticating {dn}", dn=dn)
connection = self._newConnection()
try:
connection.simple_bind_s(dn, password)
self.log.debug("Authenticated {dn}", dn=dn)
return True
except (
ldap.INVALID_CREDENTIALS, ldap.INVALID_DN_SYNTAX
):
self.log.debug("Unable to authenticate {dn}", dn=dn)
return False
finally:
# TODO: should we explicitly "close" the connection in a finally
# clause rather than just let it go out of scope and be garbage collected
# at some indeterminate point in the future? Up side is that we won't hang
# on to the connection or other resources for longer than needed. Down side
# is we will take a little bit of extra time in this call to close it down.
# If we do decide to "close" then we probably have to use one of the "unbind"
# methods on the L{LDAPObject}.
connection = None
def _recordsFromQueryString(
self, queryString, recordTypes=None,
limitResults=None, timeoutSeconds=None
):
return deferToThreadPool(
reactor, self.threadpool,
self._recordsFromQueryString_inThread,
queryString,
recordTypes,
limitResults=limitResults,
timeoutSeconds=timeoutSeconds
)
def _addExtraFilter(self, recordType, queryString):
if self._extraFilters and self._extraFilters.get(recordType, ""):
queryString = "(&{extra}{query})".format(
extra=self._extraFilters[recordType], query=queryString
)
return queryString
def _recordsFromQueryString_inThread(
self, queryString, recordTypes=None,
limitResults=None, timeoutSeconds=None
):
"""
This method is always called in a thread.
"""
records = []
with DirectoryService.Connection(self) as connection:
if recordTypes is None:
recordTypes = self.recordTypes()
for recordType in recordTypes:
if limitResults is not None:
if limitResults < 1:
break
try:
rdn = self._recordTypeSchemas[recordType].relativeDN
except KeyError:
# Skip this unknown record type
continue
rdn = (
ldap.dn.str2dn(rdn.lower()) +
ldap.dn.str2dn(self._baseDN.lower())
)
filteredQuery = self._addExtraFilter(recordType, queryString)
self.log.debug(
"Performing LDAP query: {rdn} {query} {recordType}{limit}{timeout}",
rdn=rdn,
query=filteredQuery,
recordType=recordType,
limit=" limit={}".format(limitResults) if limitResults else "",
timeout=" timeout={}".format(timeoutSeconds) if timeoutSeconds else "",
)
try:
s = ldap.async.List(connection)
s.startSearch(
ldap.dn.dn2str(rdn),
ldap.SCOPE_SUBTREE,
filteredQuery,
attrList=self._attributesToFetch,
timeout=timeoutSeconds if timeoutSeconds else -1,
sizelimit=limitResults if limitResults else 0
)
s.processResults()
except ldap.SIZELIMIT_EXCEEDED as e:
self.log.debug("LDAP result limit exceeded: {}".format(limitResults,))
except ldap.TIMELIMIT_EXCEEDED as e:
self.log.warn("LDAP timeout exceeded: {} seconds".format(timeoutSeconds,))
except ldap.FILTER_ERROR as e:
self.log.error(
"Unable to perform query {query!r}: {err}",
query=queryString, err=e
)
raise LDAPQueryError("Unable to perform query", e)
except ldap.NO_SUCH_OBJECT as e:
# self.log.warn("RDN {rdn} does not exist, skipping", rdn=rdn)
continue
except ldap.INVALID_SYNTAX as e:
self.log.error(
"LDAP invalid syntax {query!r}: {err}",
query=queryString, err=e
)
continue
except ldap.SERVER_DOWN as e:
self.log.error(
"LDAP server unavailable"
)
raise LDAPQueryError("LDAP server down", e)
except Exception as e:
self.log.error(
"LDAP error {query!r}: {err}",
query=queryString, err=e
)
raise LDAPQueryError("Unable to perform query", e)
reply = [resultItem for _ignore_resultType, resultItem in s.allResults]
newRecords = self._recordsFromReply(reply, recordType=recordType)
self.log.debug(
"Records from LDAP query ({rdn} {query} {recordType}): {count}",
rdn=rdn,
query=queryString,
recordType=recordType,
count=len(newRecords)
)
if limitResults is not None:
limitResults = limitResults - len(newRecords)
records.extend(newRecords)
self.log.debug(
"LDAP result count ({query}): {count}",
query=queryString,
count=len(records)
)
return records
def _recordWithDN(self, dn):
return deferToThreadPool(
reactor, self.threadpool,
self._recordWithDN_inThread, dn
)
def _recordWithDN_inThread(self, dn):
"""
This method is always called in a thread.
@param dn: The DN of the record to search for
@type dn: C{str}
"""
with DirectoryService.Connection(self) as connection:
self.log.debug("Performing LDAP DN query: {dn}", dn=dn)
try:
reply = connection.search_s(
dn,
ldap.SCOPE_SUBTREE,
"(objectClass=*)",
attrlist=self._attributesToFetch
)
records = self._recordsFromReply(reply)
except ldap.NO_SUCH_OBJECT:
records = []
except ldap.INVALID_DN_SYNTAX:
self.log.warn("Invalid LDAP DN syntax: '{dn}'", dn=dn)
records = []
if len(records):
return records[0]
else:
return None
def _recordsFromReply(self, reply, recordType=None):
records = []
for dn, recordData in reply:
# Determine the record type
if recordType is None:
recordType = recordTypeForDN(
self._baseDN, self._recordTypeSchemas, dn
)
if recordType is None:
recordType = recordTypeForRecordData(
self._recordTypeSchemas, recordData
)
if recordType is None:
self.log.debug(
"Ignoring LDAP record data; unable to determine record "
"type: {recordData!r}",
recordData=recordData,
)
continue
# Populate a fields dictionary
fields = {}
for fieldName, attributeRules in self._fieldNameToAttributesMap.iteritems():
valueType = self.fieldName.valueType(fieldName)
for attributeRule in attributeRules:
attributeName = attributeRule.split(":")[0]
if attributeName in recordData:
values = recordData[attributeName]
if valueType in (unicode, UUID):
if not isinstance(values, list):
values = [values]
if valueType is unicode:
newValues = []
for v in values:
if isinstance(v, unicode):
# because the ldap unit test produces
# unicode values (?)
newValues.append(v)
else:
newValues.append(unicode(v, "utf-8"))
else:
try:
newValues = [valueType(v) for v in values]
except Exception, e:
self.log.warn(
"Can't parse value {name} {values} ({error})",
name=fieldName, values=values, error=str(e)
)
continue
if self.fieldName.isMultiValue(fieldName):
if fieldName in fields:
fields[fieldName].extend(newValues)
else:
fields[fieldName] = newValues
else:
# First one in the list wins
if fieldName not in fields:
fields[fieldName] = newValues[0]
elif valueType is bool:
if not isinstance(values, list):
values = [values]
if ":" in attributeRule:
ignored, trueValue = attributeRule.split(":")
else:
trueValue = "true"
for value in values:
if value == trueValue:
fields[fieldName] = True
break
else:
fields[fieldName] = False
elif issubclass(valueType, Names):
if not isinstance(values, list):
values = [values]
attribute, attributeValue, fieldValue = attributeRule.split(":")
for value in values:
if value == attributeValue:
# convert to a constant
try:
fieldValue = valueType.lookupByName(fieldValue)
fields[fieldName] = fieldValue
except ValueError:
pass
break
else:
raise LDAPConfigurationError(
"Unknown value type {0} for field {1}".format(
valueType, fieldName
)
)
# Skip any results missing the uid, which is a required field
if self.fieldName.uid not in fields:
continue
# Set record type and dn fields
fields[self.fieldName.recordType] = recordType
fields[self.fieldName.dn] = dn.decode("utf-8")
# Make a record object from fields.
record = DirectoryRecord(self, fields)
records.append(record)
# self.log.debug("LDAP results: {records}", records=records)
return records
def recordsFromNonCompoundExpression(
self, expression, recordTypes=None, records=None, limitResults=None,
timeoutSeconds=None
):
if isinstance(expression, MatchExpression):
queryString = ldapQueryStringFromMatchExpression(
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
return self._recordsFromQueryString(
queryString, recordTypes=recordTypes,
limitResults=limitResults, timeoutSeconds=timeoutSeconds
)
elif isinstance(expression, ExistsExpression):
queryString = ldapQueryStringFromExistsExpression(
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
return self._recordsFromQueryString(
queryString, recordTypes=recordTypes,
limitResults=limitResults, timeoutSeconds=timeoutSeconds
)
elif isinstance(expression, BooleanExpression):
queryString = ldapQueryStringFromBooleanExpression(
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
return self._recordsFromQueryString(
queryString, recordTypes=recordTypes,
limitResults=limitResults, timeoutSeconds=timeoutSeconds
)
return BaseDirectoryService.recordsFromNonCompoundExpression(
self, expression, records=records, limitResults=limitResults,
timeoutSeconds=timeoutSeconds
)
def recordsFromCompoundExpression(
self, expression, recordTypes=None, records=None,
limitResults=None, timeoutSeconds=None
):
if not expression.expressions:
return succeed(())
queryString = ldapQueryStringFromCompoundExpression(
expression,
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
return self._recordsFromQueryString(
queryString, recordTypes=recordTypes,
limitResults=limitResults, timeoutSeconds=timeoutSeconds
)
def recordsWithRecordType(
self, recordType, limitResults=None, timeoutSeconds=None
):
queryString = ldapQueryStringFromExistsExpression(
ExistsExpression(self.fieldName.uid),
self._fieldNameToAttributesMap, self._recordTypeSchemas
)
return self._recordsFromQueryString(
queryString, recordTypes=[recordType],
limitResults=limitResults, timeoutSeconds=timeoutSeconds
)
# def updateRecords(self, records, create=False):
# for record in records:
# return fail(NotAllowedError("Record updates not allowed."))
# return succeed(None)
# def removeRecords(self, uids):
# for uid in uids:
# return fail(NotAllowedError("Record removal not allowed."))
# return succeed(None)
@implementer(IPlaintextPasswordVerifier)
class DirectoryRecord(BaseDirectoryRecord):
"""
LDAP directory record.
"""
@inlineCallbacks
def members(self):
members = set()
if self.recordType != self.service.recordType.group:
returnValue(())
# Scan through the memberDNs, grouping them by record type (which we
# deduce by their RDN). If we have a fieldname that corresponds to
# the most specific slice of the DN, we can bundle that into a
# single CompoundExpression to fault in all the DNs belonging to the
# same base RDN, reducing the number of requests from 1-per-member to
# 1-per-record-type. Any memberDNs we can't group in this way are
# simply faulted in by DN at the end.
fieldValuesByRecordType = {}
# dictionary key = recordType, value = tuple(fieldName, value)
faultByDN = []
# the DNs we need to fault in individually
for dnStr in getattr(self, "memberDNs", []):
try:
recordType = recordTypeForDN(
self.service._baseDN, self.service._recordTypeSchemas, dnStr
)
dn = ldap.dn.str2dn(dnStr.lower())
attrName, value, ignored = dn[0][0]
fieldName = self.service._attributeToFieldNameMap[attrName][0]
fieldValuesByRecordType.setdefault(recordType, []).append((fieldName, value))
continue
except:
# For whatever reason we can't group this DN in with the others
# so we'll add it to faultByDN just below
pass
# have to fault in by dn
faultByDN.append(dnStr)
for recordType, fieldValue in fieldValuesByRecordType.iteritems():
if fieldValue:
matchExpressions = []
for fieldName, value in fieldValue:
matchExpressions.append(
MatchExpression(
fieldName,
value.decode("utf-8"),
matchType=MatchType.equals
)
)
expression = CompoundExpression(
matchExpressions,
Operand.OR
)
for record in (yield self.service.recordsFromCompoundExpression(
expression, recordTypes=[recordType]
)):
members.add(record)
for dnStr in faultByDN:
record = yield self.service._recordWithDN(dnStr.replace("+", "\+"))
members.add(record)
returnValue(members)
# @inlineCallbacks
def groups(self):
raise NotImplementedError()
#
# Verifiers for twext.who.checker stuff.
#
def verifyPlaintextPassword(self, password):
return self.service._authenticateUsernamePassword(self.dn, password)
def normalizeDNstr(dnStr):
"""
Convert to lowercase and remove extra whitespace
@param dnStr: dn
@type dnStr: C{str}
@return: normalized dn C{str}
"""
return ' '.join(ldap.dn.dn2str(ldap.dn.str2dn(dnStr.lower())).split())
def reverseDict(source):
new = {}
for key, values in source.iteritems():
for value in values:
new.setdefault(value, []).append(key)
return new
def recordTypeForDN(baseDnStr, recordTypeSchemas, dnStr):
"""
Examine a DN to determine which recordType it belongs to
@param baseDnStr: The base DN
@type baseDnStr: string
@param recordTypeSchemas: Schema information for record types.
@type recordTypeSchemas: mapping from L{NamedConstant} to
L{RecordTypeSchema}
@param dnStr: DN to compare
@type dnStr: string
@return: recordType string, or None if no match
"""
dn = ldap.dn.str2dn(dnStr.lower())
baseDN = ldap.dn.str2dn(baseDnStr.lower())
for recordType, schema in recordTypeSchemas.iteritems():
combined = ldap.dn.str2dn(schema.relativeDN.lower()) + baseDN
if dnContainedIn(dn, combined):
return recordType
return None
def dnContainedIn(child, parent):
"""
Return True if child dn is contained within parent dn, otherwise False.
"""
return child[-len(parent):] == parent
def recordTypeForRecordData(recordTypeSchemas, recordData):
"""
Given info about record types, determine the record type for a blob of
LDAP record data.
@param recordTypeSchemas: Schema information for record types.
@type recordTypeSchemas: mapping from L{NamedConstant} to
L{RecordTypeSchema}
@param recordData: LDAP record data.
@type recordData: mapping
"""
for recordType, schema in recordTypeSchemas.iteritems():
for attribute, value in schema.attributes:
dataValue = recordData.get(attribute)
# If the data value (e.g. objectClass) is a list, see if the
# expected value is contained in that list, otherwise directly
# compare.
if isinstance(dataValue, list):
if value not in dataValue:
break
else:
if value != dataValue:
break
else:
return recordType
return None
|