Skip to content

Authentication¤

CouchbaseAuthenticator¤

Bases: dict

Source code in src/couchbase_haystack/document_stores/auth.py 
 8
 9
10
11
class CouchbaseAuthenticator(dict):
    def get_cb_auth(self) -> Union[PasswordAuthenticator, CertificateAuthenticator]:
        """This method should be implemented in a subclass."""
        raise NotImplementedError("This method should be implemented in a subclass.")

get_cb_auth ¤

get_cb_auth() -> Union[PasswordAuthenticator, CertificateAuthenticator]

This method should be implemented in a subclass.

Source code in src/couchbase_haystack/document_stores/auth.py 
 9
10
11
def get_cb_auth(self) -> Union[PasswordAuthenticator, CertificateAuthenticator]:
    """This method should be implemented in a subclass."""
    raise NotImplementedError("This method should be implemented in a subclass.")

CouchbasePasswordAuthenticator¤

Bases: CouchbaseAuthenticator

Password-based authenticator for Couchbase.

Parameters:

  • username (Secret, default: from_env_var('CB_USERNAME') ) –

    Username to use for authentication.

  • password (Secret, default: from_env_var('CB_PASSWORD') ) –

    Password to use for authentication.

  • cert_path (Optional[str], default: None ) –

    Path of the certificate trust store. Defaults to None.

Source code in src/couchbase_haystack/document_stores/auth.py 
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
class CouchbasePasswordAuthenticator(CouchbaseAuthenticator):
    """Password-based authenticator for Couchbase.

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

    def __init__(
        self,
        username: Secret = Secret.from_env_var("CB_USERNAME"),
        password: Secret = Secret.from_env_var("CB_PASSWORD"),
        cert_path: Optional[str] = None,
        **kwargs,  # type: Dict[str, Any]
    ):
        self.username = username
        self.password = password
        self.cert_path = cert_path
        self.kwargs = kwargs
        parent_kwargs = {"username": self.username, "password": self.password, "cert_path": self.cert_path, "kwargs": kwargs}
        parent_kwargs.update(self.kwargs)
        super().__init__(**parent_kwargs)

    def get_cb_auth(self) -> PasswordAuthenticator:
        return PasswordAuthenticator(self.username.resolve_value(), self.password.resolve_value(), self.cert_path, **self.kwargs)

    def to_dict(self) -> Dict[str, Any]:
        """Serializes the component to a dictionary.

        Returns:
            Dictionary with serialized data.
        """
        return default_to_dict(
            self,
            username=self.username.to_dict(),
            password=self.password.to_dict(),
            cert_path=self.cert_path,
            **self.kwargs,
        )

    @classmethod
    def from_dict(cls, data: Dict[str, Any]) -> "CouchbasePasswordAuthenticator":
        """Deserializes the component from a dictionary.

        Args:
            data: Dictionary to deserialize from.

        Returns:
            Deserialized component.
        """
        deserialize_secrets_inplace(data["init_parameters"], keys=["username", "password"])
        return default_from_dict(cls, data)

to_dict ¤

to_dict() -> Dict[str, Any]

Serializes the component to a dictionary.

Returns:

  • Dict[str, Any] –

    Dictionary with serialized data.

Source code in src/couchbase_haystack/document_stores/auth.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
def to_dict(self) -> Dict[str, Any]:
    """Serializes the component to a dictionary.

    Returns:
        Dictionary with serialized data.
    """
    return default_to_dict(
        self,
        username=self.username.to_dict(),
        password=self.password.to_dict(),
        cert_path=self.cert_path,
        **self.kwargs,
    )

from_dict classmethod ¤

from_dict(data: Dict[str, Any]) -> CouchbasePasswordAuthenticator

Deserializes the component from a dictionary.

Parameters:

  • data (Dict[str, Any]) –

    Dictionary to deserialize from.

Returns:

Source code in src/couchbase_haystack/document_stores/auth.py 
55
56
57
58
59
60
61
62
63
64
65
66
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "CouchbasePasswordAuthenticator":
    """Deserializes the component from a dictionary.

    Args:
        data: Dictionary to deserialize from.

    Returns:
        Deserialized component.
    """
    deserialize_secrets_inplace(data["init_parameters"], keys=["username", "password"])
    return default_from_dict(cls, data)

CouchbaseCertificateAuthenticator¤

Bases: dict

Certificate-based authenticator for Couchbase.

Parameters:

  • cert_path (Optional[str], default: None ) –

    Path to the client certificate file. Defaults to None.

  • key_path (Optional[str], default: None ) –

    Path to the client key file. Defaults to None.

  • trust_store_path (Optional[str], default: None ) –

    Path to the certificate trust store. Defaults to None.

Source code in src/couchbase_haystack/document_stores/auth.py 
 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
class CouchbaseCertificateAuthenticator(dict):
    """Certificate-based authenticator for Couchbase.

    Args:
        cert_path: Path to the client certificate file. Defaults to None.
        key_path: Path to the client key file. Defaults to None.
        trust_store_path: Path to the certificate trust store. Defaults to None.
    """

    def __init__(self, cert_path: Optional[str] = None, key_path: Optional[str] = None, trust_store_path: Optional[str] = None):
        self.cert_path = cert_path
        self.key_path = key_path
        self.trust_store_path = trust_store_path
        parent_kwargs = {
            "cert_path": cert_path,
            "key_path": key_path,
            "trust_store_path": trust_store_path,
        }
        super().__init__(**parent_kwargs)

    def get_cb_auth(self) -> CertificateAuthenticator:
        return CertificateAuthenticator(cert_path=self.cert_path, key_path=self.key_path, trust_store_path=self.trust_store_path)

    def to_dict(self) -> Dict[str, Any]:
        """Serializes the component to a dictionary.

        Returns:
            Dictionary with serialized data.
        """
        return default_to_dict(self, cert_path=self.cert_path, key_path=self.key_path, trust_store_path=self.trust_store_path)

    @classmethod
    def from_dict(cls, data: Dict[str, Any]) -> "CouchbaseCertificateAuthenticator":
        """Deserializes the component from a dictionary.

        Args:
            data: Dictionary to deserialize from.

        Returns:
            Deserialized component.
        """
        return default_from_dict(cls, data)

to_dict ¤

to_dict() -> Dict[str, Any]

Serializes the component to a dictionary.

Returns:

  • Dict[str, Any] –

    Dictionary with serialized data.

Source code in src/couchbase_haystack/document_stores/auth.py 
92
93
94
95
96
97
98
def to_dict(self) -> Dict[str, Any]:
    """Serializes the component to a dictionary.

    Returns:
        Dictionary with serialized data.
    """
    return default_to_dict(self, cert_path=self.cert_path, key_path=self.key_path, trust_store_path=self.trust_store_path)

from_dict classmethod ¤

from_dict(data: Dict[str, Any]) -> CouchbaseCertificateAuthenticator

Deserializes the component from a dictionary.

Parameters:

  • data (Dict[str, Any]) –

    Dictionary to deserialize from.

Returns:

Source code in src/couchbase_haystack/document_stores/auth.py 
100
101
102
103
104
105
106
107
108
109
110
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "CouchbaseCertificateAuthenticator":
    """Deserializes the component from a dictionary.

    Args:
        data: Dictionary to deserialize from.

    Returns:
        Deserialized component.
    """
    return default_from_dict(cls, data)