ciecplib

The ciecplib python client provides a functions and command-line utilities to authenticate against SAML/ECP endpoints, and retrieve URLs from behind that authentication.

Installation

PipConda

$ python -m pip install ciecplib

Supported python versions: 3.5+.

Default pip install doesn’t include Kerberos Auth support

By default pip install ciecplib does not bundle Kerberos auth support that is optional as of requests-ecp 0.3.0.

The ciecplib[kerberos] extra can be used to automatically install requests-ecp[kerberos]:

python -m pip install ciecplib[kerberos]

This does not ensure that a working version of the underlying GSSAPI is installed (e.g, via MIT Kerberos). If you need Kerberos auth, and need to install GSSAPI itself on your system, it is recommended that you use Conda to install `ciecplib`.

User documentation

ciecplib Package

Functions

get(url, **kwargs)	Send a GET request using ECP authentication.
get_cert([endpoint, hours, username, ...])	Create an X.509 credential using SAML/ECP.
get_cookie(url[, endpoint, username, ...])	Create a SAML/ECP session cookie valid for the given URL
head(url, **kwargs)	Send a HEAD request using ECP authentication.
post(url, **kwargs)	Send a POST request using ECP authentication.

Classes

Session([idp, kerberos, username, password, ...])

requests.Session with default ECP auth and pre-populated cookies

API

• ciecplib package
  • Submodules
    • ciecplib.conftest module
    • ciecplib.cookies module
      • ECPCookieJar
        • ECPCookieJar.save()
      • extract_session_cookie()
      • has_session_cookies()
      • load_cookiejar()
    • ciecplib.env module
    • ciecplib.kerberos module
      • find_principal()
      • has_credential()
      • realm()
    • ciecplib.logging module
      • init_logging()
      • reset_logging()
    • ciecplib.requests module
      • get()
      • head()
      • post()
    • ciecplib.sessions module
      • Session
        • Session.close()
    • ciecplib.ui module
      • get_cert()
      • get_cookie()
    • ciecplib.utils module
      • EcpIdentityProvider
      • get_ecpcookie_path()
      • get_idp_url()
      • get_idps()
      • get_x509_proxy_path()
      • random_string()
    • ciecplib.x509 module
      • check_cert()
      • generate_proxy()
      • load_cert()
      • load_pkcs12()
      • print_cert_info()
      • time_left()
      • write_cert()

Command-line scripts

• ecp-cert-info
• ecp-curl
• ecp-get-cert
• ecp-get-cookie

Indices and tables

• Index

• Module Index

• Search Page