seafdav/wsgidav/dc/pam_dc.py
2021-11-10 20:30:51 +01:00

66 lines
2.1 KiB
Python

# -*- coding: utf-8 -*-
# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
"""
Implementation of a domain controller that allows users to authenticate against
a Pluggable Authentication Module ('PAM').
Used by HTTPAuthenticator. Only available on linux and macOS.
See https://wsgidav.readthedocs.io/en/latest/user_guide_configure.html
"""
import pam
from wsgidav import util
from wsgidav.dc.base_dc import BaseDomainController
__docformat__ = "reStructuredText"
_logger = util.get_module_logger(__name__)
class PAMDomainController(BaseDomainController):
def __init__(self, wsgidav_app, config):
super(PAMDomainController, self).__init__(wsgidav_app, config)
self.pam = pam.pam()
# auth_conf = config["http_authenticator"]
dc_conf = config.get("pam_dc", {})
self.pam_service = dc_conf.get("service", "login")
self.pam_encoding = dc_conf.get("encoding", "utf-8")
self.pam_resetcreds = dc_conf.get("resetcreds", True)
def __str__(self):
return "{}('{}')".format(self.__class__.__name__, self.pam_service)
def get_domain_realm(self, path_info, environ):
return "PAM({})".format(self.pam_service)
def require_authentication(self, realm, environ):
return True
def basic_auth_user(self, realm, user_name, password, environ):
pam = self.pam
is_ok = pam.authenticate(
user_name,
password,
service=self.pam_service,
resetcreds=self.pam_resetcreds,
encoding=self.pam_encoding,
)
if is_ok:
_logger.debug("User '{}' logged on.".format(user_name))
return True
_logger.warning(
"pam.authenticate('{}', '***', '{}') failed with code {}: {}".format(
user_name, self.pam_service, pam.code, pam.reason
)
)
return False
def supports_http_digest_auth(self):
# We don't have access to a plaintext password (or stored hash)
return False