SASLPlain Class

SASL Plain AMQP authentication. This is SASL authentication using a basic username and password.

Inheritance

AMQPAuth

SASLPlain

Constructor

SASLPlain(hostname, username, password, port=5671, verify=None, http_proxy=None, transport_type=<TransportType.Amqp: 1>, encoding='UTF-8')

Parameters

hostname

str or bytes

Required

The AMQP endpoint hostname.

username

bytes or str

Required

The authentication username.

password

bytes or str

Required

The authentication password.

port

int

default value: 5671

The TLS port - default for AMQP is 5671.

verify

str

default value: None

The path to a user-defined certificate.

http_proxy

dict

default value: None

HTTP proxy configuration. This should be a dictionary with the following keys present: 'proxy_hostname' and 'proxy_port'. Additional optional keys are 'username' and 'password'.

transport_type

<xref:uamqp.TransportType>

default value: TransportType.Amqp

The transport protocol type - default is ~uamqp.TransportType.Amqp. ~uamqp.TransportType.AmqpOverWebsocket is applied when http_proxy is set or the transport type is explicitly requested.

encoding

str

default value: UTF-8

The encoding to use if hostname and credentials are provided as a str. Default is 'UTF-8'.