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
|
# attmap.py - attribute mapping class
#
# Copyright (C) 2011-2019 Arthur de Jong
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA
"""Module for handling attribute mappings used for LDAP searches.
>>> attrs = Attributes(
... uid='uid',
... userPassword='userPassword',
... uidNumber='uidNumber',
... gidNumber='gidNumber',
... gecos='"${gecos:-$cn}"',
... homeDirectory='homeDirectory',
... loginShell='loginShell')
>>> 'cn' in attrs.attributes()
True
>>> attrs.translate({'uid': ['UIDVALUE', '2nduidvalue'], 'cn': ['COMMON NAME', ]}) == {
... 'uid': ['UIDVALUE', '2nduidvalue'], 'loginShell': [], 'userPassword': [],
... 'uidNumber': [], 'gidNumber': [], 'gecos': ['COMMON NAME'], 'homeDirectory': []}
True
>>> attrs['uidNumber'] # a representation fit for logging and filters
'uidNumber'
>>> attrs['gecos']
'"${gecos:-$cn}"'
"""
import re
import ldap.dn
from ldap.filter import escape_filter_chars
from expr import Expression
# exported names
__all__ = ('Attributes', )
# TODO: support objectSid attributes
# regular expression to match function attributes
attribute_func_re = re.compile(r'^(?P<function>[a-z]+)\((?P<attribute>.*)\)$')
class SimpleMapping(str):
"""Simple mapping to another attribute name."""
def attributes(self):
return [self]
def mk_filter(self, value):
return '(%s=%s)' % (
self, escape_filter_chars(str(value)))
def values(self, variables):
"""Expand the expression using the variables specified."""
return variables.get(self, [])
class ExpressionMapping(object):
"""Class for parsing and expanding an expression."""
def __init__(self, value):
"""Parse the expression as a string."""
self.value = value
self.expression = Expression(value[1:-1])
def __str__(self):
return self.value
def __repr__(self):
return repr(str(self))
def values(self, variables):
"""Expand the expression using the variables specified."""
return [self.expression.value(variables)]
def attributes(self):
"""Return the attributes defined in the expression."""
return self.expression.variables()
class FunctionMapping(object):
"""Mapping to a function to another attribute."""
def __init__(self, mapping):
self.mapping = mapping
m = attribute_func_re.match(mapping)
self.attribute = m.group('attribute')
self.function = getattr(self, m.group('function'))
def __str__(self):
return self.mapping
def __repr__(self):
return repr(str(self))
def upper(self, value):
return value.upper()
def lower(self, value):
return value.lower()
def attributes(self):
return [self.attribute]
def mk_filter(self, value):
return '(%s=%s)' % (
self.attribute, escape_filter_chars(value))
def values(self, variables):
return [self.function(value)
for value in variables.get(self.attribute, [])]
class Attributes(dict):
"""Dictionary-like class for handling attribute mapping."""
def __init__(self, *args, **kwargs):
self.update(*args, **kwargs)
def __setitem__(self, attribute, mapping):
# translate the mapping into a mapping object
if mapping[0] == '"' and mapping[-1] == '"':
mapping = ExpressionMapping(mapping)
elif '(' in mapping:
mapping = FunctionMapping(mapping)
else:
mapping = SimpleMapping(mapping)
super(Attributes, self).__setitem__(attribute, mapping)
def update(self, *args, **kwargs):
for arg in args:
other = dict(arg)
for key in other:
self[key] = other[key]
for key in kwargs:
self[key] = kwargs[key]
def attributes(self):
"""Return the attributes that are referenced in this attribute mapping.
These are the attributes that should be requested in the search.
"""
attributes = set()
for mapping in self.values():
attributes.update(mapping.attributes())
return list(attributes)
def mk_filter(self, attribute, value):
"""Construct a search filter for the attribute value combination."""
mapping = self.get(attribute, SimpleMapping(attribute))
return mapping.mk_filter(value)
def translate(self, variables):
"""Return a dictionary with every attribute mapped to their value."""
results = dict()
for attribute, mapping in self.items():
results[attribute] = mapping.values(variables)
return results
def get_rdn_value(self, dn, attribute):
"""Extract the attribute value from from DN or return None."""
return self.translate(dict(
(x, [y])
for x, y, z in ldap.dn.str2dn(dn)[0]
))[attribute][0]
|