Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

85 lines (65 sloc) 2.694 kB
"""Credentials Classes"""
import logging
LOGGER = logging.getLogger(__name__)
class PlainCredentials(object):
"""The PlainCredentials class returns the properly formatted username and
password to the Connection. As of this version of Pika, only
PlainCredentials are supported. To authenticate with Pika, simply create a
credentials object passing in the username and password and pass that to
the ConnectionParameters object.
If you do not pass in credentials to the ConnectionParameters object, it
will create credentials for 'guest' with the password of 'guest'.
If you pass True to erase_on_connect the credentials will not be stored
in memory after the Connection attempt has been made. This means that you
will not be able to use a Reconnection Strategy successfully if this is
enabled.
"""
TYPE = 'PLAIN'
def __init__(self, username, password, erase_on_connect=False):
"""
Parameters:
- username: plain text string value
- password: plain text string value
- erase_on_connect: bool erase credentials on connect. Default: False
"""
self.username = username
self.password = password
self.erase_on_connect = erase_on_connect
def response_for(self, start):
"""
Validate that our type of authentication is supported
"""
if PlainCredentials.TYPE not in start.mechanisms.split():
return None, None
return PlainCredentials.TYPE, '\0%s\0%s' % \
(self.username, self.password)
def erase_credentials(self):
"""
Called by Connection when it no longer needs the credentials
"""
if self.erase_on_connect:
LOGGER.info("Erasing stored credential values")
self.username = None
self.password = None
class ExternalCredentials(object):
"""
The ExternalCredentials class allows the connection to use EXTERNAL
authentication, generally with a client SSL certificate.
"""
TYPE = 'EXTERNAL'
def __init__(self):
self.erase_on_connect = False
def response_for(self, start):
"""
Validate that our type of authentication is supported
"""
if ExternalCredentials.TYPE not in start.mechanisms.split():
return None, None
return ExternalCredentials.TYPE, ''
def erase_credentials(self):
"""
Called by Connection when it no longer needs the credentials
"""
pass
# Append custom credential types to this list for validation support
VALID_TYPES = [PlainCredentials, ExternalCredentials]
Jump to Line
Something went wrong with that request. Please try again.