python_cas package¶

python-cas implements CAS protocol (Central Authentication Server) client.

https://github.com/python-cas/python-cas

Module contents¶

class cas.CASClient(*args, **kwargs)[source]¶: Bases: object

class cas.CASClientBase(service_url=None, server_url=None, extra_login_params=None, renew=False, username_attribute=None, verify_ssl_certificate=True)[source]¶

Bases: object

get_login_url()[source]¶: Generates CAS login URL

get_logout_url(redirect_url=None)[source]¶: Generates CAS logout URL

get_proxy_ticket(pgt)[source]¶: Returns proxy ticket given the proxy granting ticket

get_proxy_url(pgt)[source]¶: Returns proxy url, given the proxy granting ticket

logout_redirect_param_name = 'service'¶

verify_ticket(ticket)[source]¶: must return a triple

class cas.CASClientV1(service_url=None, server_url=None, extra_login_params=None, renew=False, username_attribute=None, verify_ssl_certificate=True)[source]¶

Bases: cas.CASClientBase

CAS Client Version 1

logout_redirect_param_name = 'url'¶

verify_ticket(ticket)[source]¶

Verifies CAS 1.0 authentication ticket.

Returns username on success and None on failure.

class cas.CASClientV2(proxy_callback=None, *args, **kwargs)[source]¶

Bases: cas.CASClientBase

CAS Client Version 2

get_verification_response(ticket)[source]¶

logout_redirect_param_name = 'url'¶

classmethod parse_attributes_xml_element(element)[source]¶

classmethod parse_response_xml(response)[source]¶

url_suffix = 'serviceValidate'¶

classmethod verify_response(response)[source]¶

verify_ticket(ticket)[source]¶: Verifies CAS 2.0+/3.0+ XML-based authentication ticket and returns extended attributes

class cas.CASClientV3(proxy_callback=None, *args, **kwargs)[source]¶

Bases: cas.CASClientV2, cas.SingleLogoutMixin

CAS Client Version 3

logout_redirect_param_name = 'service'¶

classmethod parse_attributes_xml_element(element)[source]¶

url_suffix = 'p3/serviceValidate'¶

classmethod verify_response(response)[source]¶

class cas.CASClientWithSAMLV1(proxy_callback=None, *args, **kwargs)[source]¶

Bases: cas.CASClientV2, cas.SingleLogoutMixin

CASClient 3.0+ with SAML

fetch_saml_validation(ticket)[source]¶

classmethod get_saml_assertion(ticket)[source]¶

http://www.jasig.org/cas/protocol#samlvalidate-cas-3.0

SAML request values:

RequestID [REQUIRED]:: unique identifier for the request
IssueInstant [REQUIRED]:: timestamp of the request
samlp:AssertionArtifact [REQUIRED]:: the valid CAS Service Ticket obtained as a response parameter at login.

verify_ticket(ticket, **kwargs)[source]¶

Verifies CAS 3.0+ XML-based authentication ticket and returns extended attributes.

@date: 2011-11-30 @author: Carlos Gonzalez Vila <carlewis@gmail.com>

Returns username and attributes on success and None,None on failure.

exception cas.CASError[source]¶: Bases: ValueError

class cas.SingleLogoutMixin[source]¶

Bases: object

classmethod get_saml_slos(logout_request)[source]¶: returns saml logout ticket info

classmethod verify_logout_request(logout_request, ticket)[source]¶: verifies the single logout request came from the CAS server returns True if the logout_request is valid, False otherwise