hswaw/ldapweb
4
0
Fork 0
Code Issues 3 Pull requests 1 Projects Wiki Activity Actions

*: blacken

Browse source
This commit is contained in:
q3k 2024-07-07 21:38:17 +02:00
parent f4c6620007
commit 1f51fbea85
17 changed files with 468 additions and 293 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
stubs/flask_wtf.pyi
View file

@ -3,7 +3,5 @@ import wtforms
from typing import Protocol
class FlaskForm(wtforms.Form):
def validate_on_submit(self) -> bool:
...
def is_submitted(self) -> bool:
...
def validate_on_submit(self) -> bool: ...
def is_submitted(self) -> bool: ...

3
stubs/kerberos.pyi
View file

@ -1,2 +1 @@
def changePassword(principal: str, current: str, new: str) -> bool:
...
def changePassword(principal: str, current: str, new: str) -> bool: ...

43
stubs/ldap.pyi
View file

@ -1,21 +1,19 @@
from enum import Enum
from typing import Protocol, List, Tuple, Dict, Optional
class Scope(Enum):
BASE = 'base'
ONELEVEL = 'onelevel'
SUBTREE = 'subtree'
BASE = "base"
ONELEVEL = "onelevel"
SUBTREE = "subtree"
SCOPE_BASE = Scope.BASE
SCOPE_ONELEVEL = Scope.ONELEVEL
SCOPE_SUBTREE = Scope.SUBTREE
class Mod(Enum):
ADD = 'add'
DELETE = 'delete'
REPLACE = 'replace'
ADD = "add"
DELETE = "delete"
REPLACE = "replace"
MOD_ADD = Mod.ADD
MOD_DELETE = Mod.DELETE
@ -23,21 +21,20 @@ MOD_REPLACE = Mod.REPLACE
ModEntry = Tuple[Mod, str, bytes | List[bytes]]
class LDAPError(Exception):
...
class NO_SUCH_OBJECT(LDAPError):
...
class LDAPError(Exception): ...
class NO_SUCH_OBJECT(LDAPError): ...
class ldapobject(Protocol):
def start_tls_s(self) -> None:
...
def simple_bind_s(self, dn: str, password: str) -> None:
...
def search_s(self, base: str, scope: Scope, filterstr: str = '(objectClass=*)', attrlist: Optional[List[str]] = None, attrsonly: int = 0) -> List[Tuple[str, Dict[str, List[bytes]]]]:
...
def modify_s(self, dn: str, modlist: List[ModEntry]) -> None:
...
def start_tls_s(self) -> None: ...
def simple_bind_s(self, dn: str, password: str) -> None: ...
def search_s(
self,
base: str,
scope: Scope,
filterstr: str = "(objectClass=*)",
attrlist: Optional[List[str]] = None,
attrsonly: int = 0,
) -> List[Tuple[str, Dict[str, List[bytes]]]]: ...
def modify_s(self, dn: str, modlist: List[ModEntry]) -> None: ...
def initialize(url: str) -> ldapobject:
...
def initialize(url: str) -> ldapobject: ...

26
webapp/__init__.py
View file

@ -17,32 +17,36 @@ class App(flask.Flask):
super().__init__(name)
if hasattr(config, "secret_key"):
self.secret_key = config.secret_key
if hasattr(config, "debug"):
self.debug = config.debug
def get_dn(self) -> Optional[str]:
return flask.session.get('dn')
return flask.session.get("dn")
def get_connection(self, dn: Optional[str] = None) -> Optional[ldap.ldapobject]:
dn = dn or self.get_dn()
if dn is None:
return None
return self.connections[dn]
def get_admin_connection(self) -> ldap.ldapobject:
conn = self.connections[config.ldap_admin_dn]
if not conn:
conn = self.connections.bind(config.ldap_admin_dn, config.ldap_admin_password)
conn = self.connections.bind(
config.ldap_admin_dn, config.ldap_admin_password
)
return conn
def get_profile(self, dn: Optional[str] = None) -> Optional[context.Profile]:
dn = dn or self.get_dn()
if dn is None:
return None
return self.profiles.get(dn)
def refresh_profile(self, conn: ldap.ldapobject, dn: Optional[str] = None) -> Optional[context.Profile]:
def refresh_profile(
self, conn: ldap.ldapobject, dn: Optional[str] = None
) -> Optional[context.Profile]:
dn = dn or self.get_dn()
if dn is None:
return None
@ -65,12 +69,12 @@ def inject_hackerspace_name() -> Dict[str, Any]:
return dict(hackerspace_name=config.hackerspace_name)
@app.template_filter('first')
@app.template_filter("first")
def ldap_first(v: str) -> str:
return v and v[0]
@app.template_filter('readable')
@app.template_filter("readable")
def readable_tf(n: str) -> str:
return config.readable_names.get(n, n)
@ -81,15 +85,19 @@ def start() -> None:
from webapp import views
from webapp import auth, admin, avatar, vcard, passwd
for module in (auth, admin, avatar, vcard, passwd):
app.register_blueprint(module.bp)
app.connections = pools.LDAPConnectionPool(config.ldap_url, timeout=300.0)
def drop_profile(dn: str) -> None:
if dn != config.ldap_admin_dn:
del app.profiles[dn]
app.connections.register_callback('drop', drop_profile)
app.connections.register_callback("drop", drop_profile)
app.connections.start()
app.profiles = {}
start()

121
webapp/admin.py
View file

@ -11,88 +11,107 @@ from webapp import app, context, config, ldaputils, email, vcard
from typing import Callable, ParamSpec, List, Tuple, Optional, Dict, Protocol
bp = flask.Blueprint('admin', __name__)
bp = flask.Blueprint("admin", __name__)
Entry = Tuple[str, List[Tuple[str, str]]]
P = ParamSpec('P')
P = ParamSpec("P")
def admin_required_impl(f: Callable[P, werkzeug.Response]) -> Callable[P, werkzeug.Response]:
def admin_required_impl(
f: Callable[P, werkzeug.Response]
) -> Callable[P, werkzeug.Response]:
@functools.wraps(f)
def func(*a: P.args, **kw: P.kwargs) -> werkzeug.Response:
# TODO: Actually check for admin perms
if not flask.session['is_admin']:
if not flask.session["is_admin"]:
flask.abort(403)
return f(*a, **kw)
return func
def admin_required(f: Callable[P, werkzeug.Response]) -> Callable[P, werkzeug.Response]:
return webapp.auth.login_required(admin_required_impl(f))
def _get_user_list(conn: ldap.ldapobject, query: str = '&') -> List[Tuple[str, str]]:
def _get_user_list(conn: ldap.ldapobject, query: str = "&") -> List[Tuple[str, str]]:
"""
Returns List[Tuple[username, full name]] for query.
"""
all_users = []
results = conn.search_s(config.ldap_people, ldap.SCOPE_SUBTREE, f'(&(uid=*)(cn=*){ldaputils.wrap(query)})', attrlist=['uid', 'cn'])
results = conn.search_s(
config.ldap_people,
ldap.SCOPE_SUBTREE,
f"(&(uid=*)(cn=*){ldaputils.wrap(query)})",
attrlist=["uid", "cn"],
)
for user, attrs in results:
user_uid = attrs['uid'][0].decode()
user_cn = attrs['cn'][0].decode()
user_uid = attrs["uid"][0].decode()
user_cn = attrs["cn"][0].decode()
all_users.append((user_uid, user_cn))
all_users.sort(key=lambda user: user[0].lower())
return all_users
def _get_groupped_user_list(conn: ldap.ldapobject) -> List[Tuple[str, List[Tuple[str, str]]]]:
def _get_groupped_user_list(
conn: ldap.ldapobject,
) -> List[Tuple[str, List[Tuple[str, str]]]]:
"""
Returns all users (uid, full name), groupped by active groups.
"""
groupped_users = [
(group.capitalize(), _get_user_list(conn, f'memberOf={ldaputils.group_dn(group)}'))
(
group.capitalize(),
_get_user_list(conn, f"memberOf={ldaputils.group_dn(group)}"),
)
for group in config.ldap_active_groups
]
inactive_filter = ldaputils._not(
ldaputils.member_of_any(config.ldap_active_groups)
)
inactive_filter = ldaputils._not(ldaputils.member_of_any(config.ldap_active_groups))
groupped_users.append(
('Inactive users', _get_user_list(conn, inactive_filter))
)
groupped_users.append(("Inactive users", _get_user_list(conn, inactive_filter)))
return groupped_users
def _get_groups_of(conn: ldap.ldapobject, dn: str) -> List[str]:
filter =f'(&(objectClass=groupOfUniqueNames)(uniqueMember={dn}))'
filter = f"(&(objectClass=groupOfUniqueNames)(uniqueMember={dn}))"
groups = [
attrs['cn'][0].decode()
for group_dn, attrs in
conn.search_s(config.ldap_base, ldap.SCOPE_SUBTREE, filter)
attrs["cn"][0].decode()
for group_dn, attrs in conn.search_s(
config.ldap_base, ldap.SCOPE_SUBTREE, filter
)
]
return groups
def _is_user_protected(conn: ldap.ldapobject, groups: List[str]) -> bool:
return any(group in config.ldap_protected_groups for group in groups)
@bp.route('/admin/')
@bp.route("/admin/")
@admin_required
def admin_view() -> werkzeug.Response:
return flask.Response(flask.render_template('admin/index.html'))
return flask.Response(flask.render_template("admin/index.html"))
@bp.route('/admin/users/')
@bp.route("/admin/users/")
@admin_required
def admin_users_view() -> werkzeug.Response:
conn = app.get_connection()
assert conn is not None
groups = _get_groupped_user_list(conn)
return flask.Response(flask.render_template('admin/users.html', groups=groups))
return flask.Response(flask.render_template("admin/users.html", groups=groups))
@bp.route('/admin/users/<username>')
@bp.route("/admin/users/<username>")
@admin_required
def admin_user_view(username: str) -> werkzeug.Response:
ldaputils.validate_name(username)
@ -105,7 +124,11 @@ def admin_user_view(username: str) -> werkzeug.Response:
groups = _get_groups_of(conn, dn)
is_protected = _is_user_protected(conn, groups)
return flask.Response(flask.render_template('admin/user.html', profile=profile, groups=groups, is_protected=is_protected))
return flask.Response(
flask.render_template(
"admin/user.html", profile=profile, groups=groups, is_protected=is_protected
)
)
class AdminMixin:
@ -121,32 +144,42 @@ class AdminMixin:
class AdminOperationAdd(AdminMixin, vcard.OperationAdd):
pass
class AdminOperationModify(AdminMixin, vcard.OperationModify):
pass
class AdminOperationDelete(AdminMixin, vcard.OperationDelete):
pass
@bp.route('/admin/users/<username>/add_mifareidhash', methods=["GET", "POST"])
@bp.route("/admin/users/<username>/add_mifareidhash", methods=["GET", "POST"])
@admin_required
def admin_user_view_add_mifareidhash(username: str) -> werkzeug.Response:
dn = ldaputils.user_dn(username)
op = AdminOperationAdd(dn, "mifareidhash")
redirect = f'/admin/users/{username}'
return op.perform(success_redirect=redirect, fatal_redirect=redirect, action=f'/admin/users/{username}/add_mifareidhash')
redirect = f"/admin/users/{username}"
return op.perform(
success_redirect=redirect,
fatal_redirect=redirect,
action=f"/admin/users/{username}/add_mifareidhash",
)
@bp.route('/admin/users/<username>/del_mifareidhash/<uid>', methods=["GET", "POST"])
@bp.route("/admin/users/<username>/del_mifareidhash/<uid>", methods=["GET", "POST"])
@admin_required
def admin_user_view_del_mifareidhash(username: str, uid: str) -> werkzeug.Response:
dn = ldaputils.user_dn(username)
op = AdminOperationDelete(dn, uid)
redirect = f'/admin/users/{username}'
return op.perform(success_redirect=redirect, fatal_redirect=redirect, action=f'/admin/users/{username}/del_mifareidhash/{uid}')
redirect = f"/admin/users/{username}"
return op.perform(
success_redirect=redirect,
fatal_redirect=redirect,
action=f"/admin/users/{username}/del_mifareidhash/{uid}",
)
@bp.route('/admin/groups/')
@bp.route("/admin/groups/")
@admin_required
def admin_groups_view() -> werkzeug.Response:
conn = app.get_connection()
@ -159,16 +192,20 @@ def admin_groups_view() -> werkzeug.Response:
all_uids = set([uid for uid, cn in all_users])
groups = [
attrs['cn'][0].decode()
for group_dn, attrs in
conn.search_s(config.ldap_base, ldap.SCOPE_SUBTREE, 'objectClass=groupOfUniqueNames')
attrs["cn"][0].decode()
for group_dn, attrs in conn.search_s(
config.ldap_base, ldap.SCOPE_SUBTREE, "objectClass=groupOfUniqueNames"
)
]
filter_groups = filter((lambda cn: cn not in all_uids), groups)
return flask.Response(flask.render_template('admin/groups.html', groups=filter_groups))
return flask.Response(
flask.render_template("admin/groups.html", groups=filter_groups)
)
@bp.route('/admin/groups/<name>')
@bp.route("/admin/groups/<name>")
@admin_required
def admin_group_view(name: str) -> werkzeug.Response:
ldaputils.validate_name(name)
@ -177,8 +214,12 @@ def admin_group_view(name: str) -> werkzeug.Response:
assert conn is not None
group = context.LDAPEntry(conn, dn)
members = _get_user_list(conn, f'memberOf={ldaputils.group_dn(name)}')
members = _get_user_list(conn, f"memberOf={ldaputils.group_dn(name)}")
is_protected = name in config.ldap_protected_groups
return flask.Response(flask.render_template('admin/group.html', group=group, members=members, is_protected=is_protected))
return flask.Response(
flask.render_template(
"admin/group.html", group=group, members=members, is_protected=is_protected
)
)

47
webapp/auth.py
View file

@ -8,9 +8,10 @@ from webapp import app, avatar, config, ldaputils
from typing import TypeVar, Callable, ParamSpec, Dict, Any, Optional
bp = flask.Blueprint('auth', __name__)
bp = flask.Blueprint("auth", __name__)
P = ParamSpec("P")
P = ParamSpec('P')
def login_required(f: Callable[P, werkzeug.Response]) -> Callable[P, werkzeug.Response]:
@functools.wraps(f)
@ -18,17 +19,23 @@ def login_required(f: Callable[P, werkzeug.Response]) -> Callable[P, werkzeug.Re
conn = app.get_connection()
if not conn:
flask.session.clear()
flask.flash('You must log in to continue', category='warning')
return flask.redirect('/login?' + urllib.parse.urlencode({'goto': flask.request.path}))
flask.flash("You must log in to continue", category="warning")
return flask.redirect(
"/login?" + urllib.parse.urlencode({"goto": flask.request.path})
)
return f(*a, **kw)
return func
def req_to_ctx() -> Dict[str, Any]:
return dict(flask.request.form.items())
@bp.route('/login', methods=["GET"])
@bp.route("/login", methods=["GET"])
def login_form() -> werkzeug.Response:
return flask.Response(flask.render_template('login.html', **req_to_ctx()))
return flask.Response(flask.render_template("login.html", **req_to_ctx()))
def _connect_to_ldap(dn: str, password: str) -> Optional[ldap.ldapobject]:
try:
@ -37,7 +44,8 @@ def _connect_to_ldap(dn: str, password: str) -> Optional[ldap.ldapobject]:
print("Could not connect to server:", error_message)
return None
@bp.route('/login', methods=["POST"])
@bp.route("/login", methods=["POST"])
def login_action() -> werkzeug.Response:
# LDAP usernames/DNs are case-insensitive, so we normalize them just in
# case,
@ -51,27 +59,34 @@ def login_action() -> werkzeug.Response:
# Now that we have logged in, we can retrieve the 'real' username (which
# might be cased differently from the login name).
res = conn.search_s(dn, ldap.SCOPE_SUBTREE)
for (k, vs) in res[0][1].items():
if k == 'uid':
for k, vs in res[0][1].items():
if k == "uid":
username = vs[0].decode()
# Check if user belongs to admin group
is_admin = bool(conn.search_s(dn, ldap.SCOPE_SUBTREE, ldaputils.member_of_any(config.ldap_admin_groups)))
is_admin = bool(
conn.search_s(
dn,
ldap.SCOPE_SUBTREE,
ldaputils.member_of_any(config.ldap_admin_groups),
)
)
flask.session["username"] = username
flask.session['dn'] = dn
flask.session['is_admin'] = is_admin
flask.session["dn"] = dn
flask.session["is_admin"] = is_admin
app.refresh_profile(conn)
avatar.cache.reset_user(username)
avatar.hash_cache.reset()
return flask.redirect(goto)
else:
flask.flash("Invalid credentials.", category='danger')
flask.flash("Invalid credentials.", category="danger")
return login_form()
@bp.route('/logout')
@bp.route("/logout")
@login_required
def logout_action() -> werkzeug.Response:
app.connections.unbind(flask.session['dn'])
app.connections.unbind(flask.session["dn"])
flask.session.clear()
return flask.redirect('/')
return flask.redirect("/")

79
webapp/avatar.py
View file

@ -21,8 +21,8 @@ from webapp import app, ldaputils, config
from typing import List
bp = flask.Blueprint('avatar', __name__)
log = logging.getLogger('ldap-web.avatar')
bp = flask.Blueprint("avatar", __name__)
log = logging.getLogger("ldap-web.avatar")
# Stolen from https://stackoverflow.com/questions/43512615/reshaping-rectangular-image-to-square
@ -46,14 +46,22 @@ def resize_image(image: Image.Image, length: int) -> Image.Image:
# The image is in portrait mode. Height is bigger than width.
# This makes the width fit the LENGTH in pixels while conserving the ration.
resized_image = image.resize((length, int(image.size[1] * (length / image.size[0]))))
resized_image = image.resize(
(length, int(image.size[1] * (length / image.size[0])))
)
# Amount of pixel to lose in total on the height of the image.
required_loss = (resized_image.size[1] - length)
required_loss = resized_image.size[1] - length
# Crop the height of the image so as to keep the center part.
resized_image = resized_image.crop(
box=(0, required_loss // 2, length, resized_image.size[1] - required_loss // 2))
box=(
0,
required_loss // 2,
length,
resized_image.size[1] - required_loss // 2,
)
)
# We now have a length*length pixels image.
return resized_image
@ -61,14 +69,22 @@ def resize_image(image: Image.Image, length: int) -> Image.Image:
# This image is in landscape mode or already squared. The width is bigger than the heihgt.
# This makes the height fit the LENGTH in pixels while conserving the ration.
resized_image = image.resize((int(image.size[0] * (length / image.size[1])), length))
resized_image = image.resize(
(int(image.size[0] * (length / image.size[1])), length)
)
# Amount of pixel to lose in total on the width of the image.
required_loss = resized_image.size[0] - length
# Crop the width of the image so as to keep 1080 pixels of the center part.
resized_image = resized_image.crop(
box=(required_loss // 2, 0, resized_image.size[0] - required_loss // 2, length))
box=(
required_loss // 2,
0,
resized_image.size[0] - required_loss // 2,
length,
)
)
# We now have a length*length pixels image.
return resized_image
@ -78,7 +94,7 @@ def process_upload(data: bytes) -> bytes:
img = Image.open(io.BytesIO(data))
img = resize_image(img, 256)
res = io.BytesIO()
img.save(res, 'PNG')
img.save(res, "PNG")
return base64.b64encode(res.getvalue())
@ -90,18 +106,18 @@ def default_avatar(uid: str) -> bytes:
Create little generative avatar for people who don't have a custom one
configured.
"""
img = Image.new('RGBA', (256, 256), (255, 255, 255, 0))
img = Image.new("RGBA", (256, 256), (255, 255, 255, 0))
draw = ImageDraw.Draw(img)
# Deterministic rng for stable output.
rng = random.Random(uid)
# Pick a nice random neon color.
n_h, n_s, n_l = rng.random(), 0.5 + rng.random()/2.0, 0.4 + rng.random()/5.0
n_h, n_s, n_l = rng.random(), 0.5 + rng.random() / 2.0, 0.4 + rng.random() / 5.0
# Use muted version for background.
r, g, b = [int(256*i) for i in colorsys.hls_to_rgb(n_h, n_l+0.3, n_s-0.1)]
draw.rectangle([(0, 0), (256, 256)], fill=(r,g,b,255))
r, g, b = [int(256 * i) for i in colorsys.hls_to_rgb(n_h, n_l + 0.3, n_s - 0.1)]
draw.rectangle([(0, 0), (256, 256)], fill=(r, g, b, 255))
# Scale logo by randomized factor.
factor = 0.7 + 0.1 * rng.random()
@ -112,20 +128,20 @@ def default_avatar(uid: str) -> bytes:
overlay = overlay.crop(box=(0, 0, w, w))
# Give it a little nudge.
overlay = overlay.rotate((rng.random() - 0.5) * 100) # type: ignore
overlay = overlay.rotate((rng.random() - 0.5) * 100) # type: ignore
# Colorize with full neon color.
r, g, b = [int(256*i) for i in colorsys.hls_to_rgb(n_h,n_l,n_s)]
pixels = overlay.load() # type: ignore
r, g, b = [int(256 * i) for i in colorsys.hls_to_rgb(n_h, n_l, n_s)]
pixels = overlay.load() # type: ignore
for x in range(img.size[0]):
for y in range(img.size[1]):
alpha = pixels[x, y][3]
pixels[x, y] = (r, g, b, alpha)
img.alpha_composite(overlay) # type: ignore
img.alpha_composite(overlay) # type: ignore
res = io.BytesIO()
img.save(res, 'PNG')
img.save(res, "PNG")
return res.getvalue()
@ -160,10 +176,10 @@ class AvatarCacheEntry:
res = io.BytesIO()
img = resize_image(img, 256)
img.save(res, 'PNG')
img.save(res, "PNG")
self._converted = res.getvalue()
return flask.Response(self._converted, mimetype='image/png')
return flask.Response(self._converted, mimetype="image/png")
class AvatarCache:
@ -210,10 +226,10 @@ class AvatarCache:
is_user_found = len(res) == 1
if is_user_found:
for attr, vs in res[0][1].items():
if attr == 'jpegPhoto':
if attr == "jpegPhoto":
for v in vs:
# Temporary workaround: treat empty jpegPhoto as no avatar.
if v == b'':
if v == b"":
avatar = None
break
@ -230,7 +246,7 @@ class AvatarCache:
if avatar is None:
# don't generate avatars for non-users to reduce DoS potential
# (note: capacifier already leaks existence of users, so whatever)
avatar = default_avatar(uid if is_user_found else 'default')
avatar = default_avatar(uid if is_user_found else "default")
# Save avatar in cache.
entry = AvatarCacheEntry(uid, avatar)
@ -239,12 +255,13 @@ class AvatarCache:
# And serve the entry.
return entry.serve()
cache = AvatarCache()
def hash_for_uid(uid: str) -> str:
# NOTE: Gravatar documentation says to use SHA256, but everyone passes MD5 instead
email = f'{uid}@hackerspace.pl'.strip().lower()
email = f"{uid}@hackerspace.pl".strip().lower()
hasher = hashlib.md5()
hasher.update(email.encode())
return hasher.hexdigest()
@ -253,9 +270,11 @@ def hash_for_uid(uid: str) -> str:
def get_all_user_uids(conn: ldap.ldapobject) -> List[str]:
all_uids = []
results = conn.search_s(config.ldap_people, ldap.SCOPE_SUBTREE, 'uid=*', attrlist=['uid'])
results = conn.search_s(
config.ldap_people, ldap.SCOPE_SUBTREE, "uid=*", attrlist=["uid"]
)
for user, attrs in results:
uid = attrs['uid'][0].decode()
uid = attrs["uid"][0].decode()
all_uids.append(uid)
return all_uids
@ -269,7 +288,7 @@ class HashCache:
def get(self, email_hash: str) -> str:
self.rebuild_if_needed()
return self.entries.get(email_hash, 'default')
return self.entries.get(email_hash, "default")
def reset(self) -> None:
self.entries = {}
@ -285,7 +304,7 @@ class HashCache:
conn = app.get_admin_connection()
users = get_all_user_uids(conn)
self.deadline = time.time() + config.avatar_cache_timeout
self.entries = { hash_for_uid(uid): uid for uid in users }
self.entries = {hash_for_uid(uid): uid for uid in users}
hash_cache = HashCache()
@ -296,12 +315,12 @@ def sanitize_email_hash(hash: str) -> str:
lowercases, removes file extension (probably)
"""
hash = hash.lower()
if hash.endswith('.png') or hash.endswith('.jpg'):
if hash.endswith(".png") or hash.endswith(".jpg"):
hash = hash[:-4]
return hash
@bp.route('/avatar/<email_hash>', methods=['GET'])
@bp.route("/avatar/<email_hash>", methods=["GET"])
def gravatar_serve(email_hash: str) -> flask.Response:
"""
Serves avatar in a Gravatar-compatible(ish) way, i.e. by email hash, not user name.
@ -310,6 +329,6 @@ def gravatar_serve(email_hash: str) -> flask.Response:
return cache.get(uid)
@bp.route('/avatar/user/<uid>', methods=['GET'])
@bp.route("/avatar/user/<uid>", methods=["GET"])
def avatar_serve(uid: str) -> flask.Response:
return cache.get(uid)

118
webapp/config.py
View file

@ -5,7 +5,7 @@ import os
from typing import Dict, Set, List, Tuple, Any, TypeVar
hackerspace_name: str = 'Warsaw Hackerspace'
hackerspace_name: str = "Warsaw Hackerspace"
secret_key: str = secrets.token_hex(32)
# Kerberos configuration
@ -13,86 +13,104 @@ kadmin_principal_map: str = "{}@HACKERSPACE.PL"
# LDAP configuration
ldap_url: str = 'ldap://ldap.hackerspace.pl'
ldap_base: str = 'dc=hackerspace,dc=pl'
ldap_people: str = 'ou=people,dc=hackerspace,dc=pl'
ldap_user_dn_format: str = 'uid={},ou=people,dc=hackerspace,dc=pl'
ldap_group_dn_format: str = 'cn={},ou=group,dc=hackerspace,dc=pl'
ldap_url: str = "ldap://ldap.hackerspace.pl"
ldap_base: str = "dc=hackerspace,dc=pl"
ldap_people: str = "ou=people,dc=hackerspace,dc=pl"
ldap_user_dn_format: str = "uid={},ou=people,dc=hackerspace,dc=pl"
ldap_group_dn_format: str = "cn={},ou=group,dc=hackerspace,dc=pl"
# LDAP user groups allowed to see /admin
ldap_admin_groups: List[str] = os.getenv('LDAPWEB_ADMIN_GROUPS', 'ldap-admin,staff,zarzad').split(',')
ldap_admin_groups: List[str] = os.getenv(
"LDAPWEB_ADMIN_GROUPS", "ldap-admin,staff,zarzad"
).split(",")
# LDAP user groups indicating that a user is active
ldap_active_groups: List[str] = os.getenv('LDAPWEB_ACTIVE_GROUPS', 'fatty,starving,potato').split(',')
ldap_active_groups: List[str] = os.getenv(
"LDAPWEB_ACTIVE_GROUPS", "fatty,starving,potato"
).split(",")
# LDAP service user with admin privileges (for admin listings, creating new users)
ldap_admin_dn: str = os.getenv('LDAPWEB_ADMIN_DN', 'cn=ldapweb,ou=services,dc=hackerspace,dc=pl')
ldap_admin_password: str = os.getenv('LDAPWEB_ADMIN_PASSWORD', 'unused')
ldap_admin_dn: str = os.getenv(
"LDAPWEB_ADMIN_DN", "cn=ldapweb,ou=services,dc=hackerspace,dc=pl"
)
ldap_admin_password: str = os.getenv("LDAPWEB_ADMIN_PASSWORD", "unused")
# Protected LDAP user groups
# These groups (and their members) cannot be modified by admin UI
ldap_protected_groups: List[str] = (
'staff,zarzad,ldap-admin'.split(',') +
os.getenv('LDAPWEB_PROTECTED_GROUPS', '').split(',')
)
ldap_protected_groups: List[str] = "staff,zarzad,ldap-admin".split(",") + os.getenv(
"LDAPWEB_PROTECTED_GROUPS", ""
).split(",")
# Email notification (paper trail) configuration
smtp_server: str = 'mail.hackerspace.pl'
smtp_format: str = '{}@hackerspace.pl'
smtp_user: str = os.getenv('LDAPWEB_SMTP_USER', 'ldapweb')
smtp_password: str = os.getenv('LDAPWEB_SMTP_PASSWORD', 'unused')
smtp_server: str = "mail.hackerspace.pl"
smtp_format: str = "{}@hackerspace.pl"
smtp_user: str = os.getenv("LDAPWEB_SMTP_USER", "ldapweb")
smtp_password: str = os.getenv("LDAPWEB_SMTP_PASSWORD", "unused")
papertrail_recipients: str = os.getenv('LDAPWEB_PAPERTRAIL_RECIPIENTS', 'zarzad@hackerspace.pl')
papertrail_recipients: str = os.getenv(
"LDAPWEB_PAPERTRAIL_RECIPIENTS", "zarzad@hackerspace.pl"
)
# Avatar server
avatar_cache_timeout: int = int(os.getenv('LDAPWEB_AVATAR_CACHE_TIMEOUT', '1800'))
avatar_cache_timeout: int = int(os.getenv("LDAPWEB_AVATAR_CACHE_TIMEOUT", "1800"))
# LDAP attribute configuration
readable_names: Dict[str, str] = {
'jpegphoto': 'Avatar',
'commonname': 'Common Name',
'givenname': 'Given Name',
'gecos': 'GECOS (public name)',
'surname': 'Surname',
'loginshell': 'Shell',
'telephonenumber': 'Phone Number',
'mobiletelephonenumber': 'Mobile Number',
'sshpublickey': 'SSH Public Key',
'mifareidhash': 'MIFARE ID Hash',
'mail': 'Email Adress',
'mailroutingaddress': 'Email Adress (external)',
"jpegphoto": "Avatar",
"commonname": "Common Name",
"givenname": "Given Name",
"gecos": "GECOS (public name)",
"surname": "Surname",
"loginshell": "Shell",
"telephonenumber": "Phone Number",
"mobiletelephonenumber": "Mobile Number",
"sshpublickey": "SSH Public Key",
"mifareidhash": "MIFARE ID Hash",
"mail": "Email Adress",
"mailroutingaddress": "Email Adress (external)",
}
full_name: Dict[str, str] = {
'cn': 'commonname',
'gecos': 'gecos',
'sn': 'surname',
'mobile': 'mobiletelephonenumber',
'l': 'locality',
"cn": "commonname",
"gecos": "gecos",
"sn": "surname",
"mobile": "mobiletelephonenumber",
"l": "locality",
}
can_add: Set[str] = {
'jpegphoto',
'telephonenumber',
'mobiletelephonenumber',
'sshpublickey',
"jpegphoto",
"telephonenumber",
"mobiletelephonenumber",
"sshpublickey",
}
can_delete: Set[str] = can_add
can_modify: Set[str] = can_add | {
'jpegphoto',
'givenname',
'surname',
'commonname',
'gecos',
"jpegphoto",
"givenname",
"surname",
"commonname",
"gecos",
}
can: Dict[str, Set[str]] = {
"add": can_add,
"mod": can_modify,
"del": can_delete,
"admin": {"mifareidhash"},
}
can: Dict[str, Set[str]] = { 'add': can_add, 'mod': can_modify, 'del': can_delete, 'admin': {'mifareidhash'} }
FormField = Tuple[type[wtforms.Field], Dict[str, Any]]
default_field: FormField = (wtforms.fields.StringField, {})
fields: Dict[str, FormField] = {
'jpegphoto': (wtforms.fields.FileField, {'validators': []}),
'mobiletelephonenumber': (wtforms.fields.StringField, {'validators': [wtforms.validators.Regexp(r'[+0-9 ]+')]}),
'telephonenumber': (wtforms.fields.StringField, {'validators': [wtforms.validators.Regexp(r'[+0-9 ]+')]}),
"jpegphoto": (wtforms.fields.FileField, {"validators": []}),
"mobiletelephonenumber": (
wtforms.fields.StringField,
{"validators": [wtforms.validators.Regexp(r"[+0-9 ]+")]},
),
"telephonenumber": (
wtforms.fields.StringField,
{"validators": [wtforms.validators.Regexp(r"[+0-9 ]+")]},
),
}

15
webapp/context.py
View file

@ -10,10 +10,12 @@ from webapp import config, validation
from typing import Optional, Dict, List
class Attr:
"""
A concrete attribute (with value) on a Profile.
"""
name: str
readable_name: Optional[str]
value: bytes
@ -26,10 +28,10 @@ class Attr:
self.name = name
self.readable_name = config.readable_names.get(name)
self.value = value
self.uid = hashlib.sha1(name.encode('utf-8') + value).hexdigest()
self.uid = hashlib.sha1(name.encode("utf-8") + value).hexdigest()
def __str__(self) -> str:
return self.value.decode('utf-8')
return self.value.decode("utf-8")
@dataclass
@ -37,6 +39,7 @@ class LDAPEntry:
"""
An LDAP entry, eg. a user profile or a group.
"""
# Map from uid/hash to attr.
fields: Dict[str, Attr]
# DN of this entry
@ -44,7 +47,7 @@ class LDAPEntry:
def __init__(self, conn: ldap.ldapobject, dn: str):
res = conn.search_s(dn, ldap.SCOPE_SUBTREE)
assert(len(res) == 1)
assert len(res) == 1
self.dn = dn
self.fields = {}
for attr, vs in res[0][1].items():
@ -52,7 +55,6 @@ class LDAPEntry:
a = Attr(attr, v)
self.fields[a.uid] = a
def get_attr(self, attr: str) -> Optional[Attr]:
for v in self.fields.values():
if v.name == attr:
@ -68,7 +70,7 @@ class LDAPEntry:
@property
def name(self) -> str:
res = self.get_attr('commonname')
res = self.get_attr("commonname")
assert res is not None
return res.value.decode()
@ -77,6 +79,7 @@ class Profile(LDAPEntry):
"""
A user profile.
"""
# Map from uid/hash to attr.
fields: Dict[str, Attr]
# DN of this profile
@ -84,6 +87,6 @@ class Profile(LDAPEntry):
@property
def username(self) -> str:
res = self.get_attr('uid')
res = self.get_attr("uid")
assert res is not None
return res.value.decode()

51
webapp/email.py
View file

@ -8,6 +8,7 @@ from webapp import config, context
cached_connection: Optional[smtplib.SMTP] = None
def test_connection_open(conn: smtplib.SMTP) -> bool:
try:
status = conn.noop()[0]
@ -15,37 +16,43 @@ def test_connection_open(conn: smtplib.SMTP) -> bool:
status = -1
return True if status == 250 else False
def create_connection() -> smtplib.SMTP:
conn = smtplib.SMTP_SSL(config.smtp_server)
conn.login(config.smtp_user, config.smtp_password)
return conn
conn = smtplib.SMTP_SSL(config.smtp_server)
conn.login(config.smtp_user, config.smtp_password)
return conn
def get_connection() -> smtplib.SMTP:
global cached_connection
if cached_connection is not None and test_connection_open(cached_connection):
global cached_connection
if cached_connection is not None and test_connection_open(cached_connection):
return cached_connection
cached_connection = create_connection()
return cached_connection
cached_connection = create_connection()
return cached_connection
def send_email(conn: smtplib.SMTP, subject: str, body: str, recipient_emails: str) -> None:
msg = EmailMessage()
msg.set_content(body)
msg['Subject'] = subject
def send_email(
conn: smtplib.SMTP, subject: str, body: str, recipient_emails: str
) -> None:
msg = EmailMessage()
msg.set_content(body)
msg["Subject"] = subject
sender_email = config.smtp_format.format(config.smtp_user)
msg['From'] = f'LDAPWeb <{sender_email}>'
msg['To'] = recipient_emails
sender_email = config.smtp_format.format(config.smtp_user)
msg["From"] = f"LDAPWeb <{sender_email}>"
msg["To"] = recipient_emails
conn.send_message(msg)
conn.send_message(msg)
def send_papertrail(title: str, description: str) -> None:
username = flask.session.get('username')
current_time = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
username = flask.session.get("username")
current_time = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
subject = f'[LDAPWeb] {title}'
body = f"Changed by {username} at {current_time}:\n\n{description or title}"
recipients = config.papertrail_recipients
subject = f"[LDAPWeb] {title}"
body = f"Changed by {username} at {current_time}:\n\n{description or title}"
recipients = config.papertrail_recipients
conn = get_connection()
send_email(conn, subject, body, recipients)
conn = get_connection()
send_email(conn, subject, body, recipients)

56
webapp/ldaputils.py
View file

@ -5,45 +5,55 @@ from webapp import config
from typing import List, Tuple, Any, Dict
def is_valid_name(name: str) -> bool:
"""`true` if `name` is a safe ldap uid/cn"""
return re.match(r'^[a-zA-Z_][a-zA-Z0-9-_\.]*\Z', name) is not None
"""`true` if `name` is a safe ldap uid/cn"""
return re.match(r"^[a-zA-Z_][a-zA-Z0-9-_\.]*\Z", name) is not None
def validate_name(name: str) -> None:
"""Raises `RuntimeError` if `name` is not a safe ldap uid/cn"""
if not is_valid_name(name):
raise RuntimeError('Invalid name')
"""Raises `RuntimeError` if `name` is not a safe ldap uid/cn"""
if not is_valid_name(name):
raise RuntimeError("Invalid name")
def user_dn(uid: str) -> str:
validate_name(uid)
return config.ldap_user_dn_format.format(uid)
validate_name(uid)
return config.ldap_user_dn_format.format(uid)
def group_dn(cn: str) -> str:
validate_name(cn)
return config.ldap_group_dn_format.format(cn)
validate_name(cn)
return config.ldap_group_dn_format.format(cn)
def wrap(filter: str) -> str:
if len(filter) and filter[0] == '(' and filter[-1] == ')':
return filter
else:
return f'({filter})'
if len(filter) and filter[0] == "(" and filter[-1] == ")":
return filter
else:
return f"({filter})"
def _or(*filters: str) -> str:
wrapped = ''.join(wrap(f) for f in filters)
return f'(|{wrapped})'
wrapped = "".join(wrap(f) for f in filters)
return f"(|{wrapped})"
def _and(*filters: str) -> str:
wrapped = ''.join(wrap(f) for f in filters)
return f'(&{wrapped})'
wrapped = "".join(wrap(f) for f in filters)
return f"(&{wrapped})"
def _not(filter: str) -> str:
wrapped = wrap(filter)
return f'(!{wrapped})'
wrapped = wrap(filter)
return f"(!{wrapped})"
def member_of_any(groups: List[str]) -> str:
"""Returns a filter that matches users that are a member of any of the given group names"""
return _or(*(f'memberOf={group_dn(group)}' for group in groups))
"""Returns a filter that matches users that are a member of any of the given group names"""
return _or(*(f"memberOf={group_dn(group)}" for group in groups))
def groups_of_user(uid: str) -> str:
"""Returns a filter that matches groups that have the given user as a member"""
return f'(&(objectClass=groupOfUniqueNames)(uniqueMember={user_dn(uid)}))'
"""Returns a filter that matches groups that have the given user as a member"""
return f"(&(objectClass=groupOfUniqueNames)(uniqueMember={user_dn(uid)}))"

12
webapp/lru.py
View file

@ -7,17 +7,19 @@ import time
from dataclasses import dataclass
from typing import Dict, Generic, TypeVar, List, Callable, Optional
log = logging.getLogger('ldap-web.lru')
log = logging.getLogger("ldap-web.lru")
K = TypeVar('K')
V = TypeVar('V')
K = TypeVar("K")
V = TypeVar("V")
Cb = Callable[[K], None]
@dataclass
class _Entry(Generic[V]):
c: V
atime: float
class LRUPool(threading.Thread, Generic[K, V]):
"""A key-value pool to store objects with a timeout.
@ -75,7 +77,7 @@ class LRUPool(threading.Thread, Generic[K, V]):
self.lock.release()
def _drop(self, key: K) -> Optional[V]:
for f in self.callbacks.get('drop', []):
for f in self.callbacks.get("drop", []):
f(key)
res = self.pool.pop(key, None)
if res is None:
@ -88,5 +90,3 @@ class LRUPool(threading.Thread, Generic[K, V]):
return self._drop(key)
finally:
self.lock.release()

29
webapp/passwd.py
View file

@ -8,35 +8,38 @@ import werkzeug
from webapp import app, context, config
from webapp.auth import login_required
bp = flask.Blueprint('passwd', __name__)
bp = flask.Blueprint("passwd", __name__)
@bp.route('/passwd', methods=["GET"])
@bp.route("/passwd", methods=["GET"])
@login_required
def passwd_form() -> werkzeug.Response:
return flask.Response(flask.render_template('passwd.html'))
return flask.Response(flask.render_template("passwd.html"))
def _passwd_kadmin(current: str, new: str) -> bool:
username = flask.session.get('username')
username = flask.session.get("username")
try:
principal_name = config.kadmin_principal_map.format(username)
return kerberos.changePassword(principal_name, current, new)
except Exception as e:
print('Kerberos error:', e)
logging.exception('kpasswd failed')
print("Kerberos error:", e)
logging.exception("kpasswd failed")
return False
@bp.route('/passwd', methods=["POST"])
@bp.route("/passwd", methods=["POST"])
@login_required
def passwd_action() -> werkzeug.Response:
current, new, confirm = (flask.request.form[n] for n in ('current', 'new', 'confirm'))
current, new, confirm = (
flask.request.form[n] for n in ("current", "new", "confirm")
)
if new != confirm:
flask.flash("New passwords don't match", category='danger')
return flask.Response(flask.render_template('passwd.html'))
flask.flash("New passwords don't match", category="danger")
return flask.Response(flask.render_template("passwd.html"))
if _passwd_kadmin(current, new):
flask.flash('Password changed', category='info')
flask.flash("Password changed", category="info")
else:
flask.flash('Wrong password', category='danger')
return flask.Response(flask.render_template('passwd.html'))
flask.flash("Wrong password", category="danger")
return flask.Response(flask.render_template("passwd.html"))

5
webapp/pools.py
View file

@ -6,6 +6,7 @@ from typing import Optional, Any
Pool = lru.LRUPool[str, ldap.ldapobject]
class LDAPConnectionPool(Pool):
def __init__(self, url: str, use_tls: bool = True, **kwargs: Any) -> None:
super().__init__(**kwargs)
@ -16,7 +17,7 @@ class LDAPConnectionPool(Pool):
self.lock.acquire()
try:
conn = ldap.initialize(self.url)
if(self.use_tls):
if self.use_tls:
conn.start_tls_s()
conn.simple_bind_s(dn, password)
return self._insert(dn, conn)
@ -25,5 +26,3 @@ class LDAPConnectionPool(Pool):
def unbind(self, dn: str) -> Optional[ldap.ldapobject]:
return self.drop(dn)

10
webapp/validation.py
View file

@ -4,13 +4,17 @@ import flask
from webapp import config
def sanitize_perms() -> None:
config.can = { k: set(map(sanitize_ldap, v)) for k,v in config.can.items() }
config.can = {k: set(map(sanitize_ldap, v)) for k, v in config.can.items()}
def sanitize_readable() -> None:
config.readable_names = { sanitize_ldap(k): v for k, v in config.readable_names.items() }
config.readable_names = {
sanitize_ldap(k): v for k, v in config.readable_names.items()