Class PasswordAuthenticator

couchbase/auth.py:30–100

Password authentication mechanism. Args: username (str): Username to use for authentication. password (str): Password to use for authentication. cert_path (str, optional): Path of the certificate trust store. Defaults to None.

class PasswordAuthenticator(Authenticator):
    """
    Password authentication mechanism.

    Args:
        username (str): Username to use for authentication.
        password (str): Password to use for authentication.
        cert_path (str, optional): Path of the certificate trust store. Defaults to None.
    """

    def __init__(self,
                 username,          # type: str
                 password,          # type: str
                 cert_path=None,    # type: Optional[str]
                 **kwargs           # type: Dict[str, Any]
                 ):
        """PasswordAuthenticator instance."""
        if not isinstance(username, str):
            msg = 'The username must be a str.'
            raise InvalidArgumentException(msg)

        if not isinstance(password, str):
            msg = 'The password must be a str.'
            raise InvalidArgumentException(msg)

        if cert_path is not None and not isinstance(cert_path, str):
            msg = 'The cert_path must be a str representing the path to the certificate trust store.'
            raise InvalidArgumentException(msg)

        allowed_sasl_mechanisms = kwargs.pop('allowed_sasl_mechanisms', None)
        if allowed_sasl_mechanisms is not None:
            msg = None
            if isinstance(allowed_sasl_mechanisms, str):
                allowed_sasl_mechanisms = allowed_sasl_mechanisms.split(',')
            if isinstance(allowed_sasl_mechanisms, list):
                if not all(map(lambda x: isinstance(x, str), allowed_sasl_mechanisms)):
                    msg = 'The allowed_sasl_mechanisms must be a list of str SASL mechanisms.'
            else:
                msg = ('The allowed_sasl_mechanisms must be a list of str SASL mechanisms '
                       ' or a comma separated str of SASL mechanisms.')
            if msg:
                raise InvalidArgumentException(msg)

        self._username = username
        self._password = password
        self._cert_path = cert_path
        self._allowed_sasl_mechanisms = allowed_sasl_mechanisms

        super().__init__(**self.as_dict())

    def valid_keys(self):
        return ['username', 'password', 'cert_path', 'sasl_mech_force', 'allowed_sasl_mechanisms']

    def as_dict(self):
        d = {
            'username': self._username,
            'password': self._password,
            'allowed_sasl_mechanisms': self._allowed_sasl_mechanisms