hop.auth

class hop.auth.Auth(user, password, ssl=True, method=<SASLMethod.SCRAM_SHA_512: 3>, **kwargs)

Attach SASL-based authentication to a client.

Returns client-based auth options when called.

userstr

Username to authenticate with.

passwordstr

Password to authenticate with.

sslbool, optional

Whether to enable SSL (enabled by default).

methodSASLMethod, optional

The SASL method to authenticate, default = SASLMethod.SCRAM_SHA_512. See valid SASL methods in SASLMethod.

ssl_ca_locationstr, optional

If using SSL via a self-signed cert, a path/location to the certificate.

hop.auth.get_auth_path()

Determines the default location for auth configuration.

Returns:

The path to the authentication configuration file.

hop.auth.load_auth(authfile='/home/docs/.config/hop/config.toml')

Configures an Auth instance given a configuration file.

Args:

authfile: Path to a configuration file, loading from

the default location if not given.

Returns:

A configured Auth instance.

Raises:

KeyError: An error occurred parsing the configuration file.