Skip to main content

A Kerberos authentication handler for python-requests

Project description

requests Kerberos/GSSAPI authentication library

Requests is an HTTP library, written in Python, for human beings. This library adds optional Kerberos/GSSAPI authentication support and supports mutual authentication. Basic GET usage:

>>> import requests
>>> from requests_kerberos import HTTPKerberosAuth
>>> r = requests.get("http://example.org", auth=HTTPKerberosAuth())
...

The entire requests.api should be supported.

Authentication Failures

Client authentication failures will be communicated to the caller by returning the 401 response.

Mutual Authentication

By default, HTTPKerberosAuth will require mutual authentication from the server, and if a server emits a non-error response which cannot be authenticated, a requests_kerberos.errors.MutualAuthenticationError will be raised. If a server emits an error which cannot be authenticated, it will be returned to the user but with its contents and headers stripped.

OPTIONAL

If you’d prefer to not require mutual authentication, you can set your preference when constructing your HTTPKerberosAuth object:

>>> import requests
>>> from requests_kerberos import HTTPKerberosAuth, OPTIONAL
>>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
>>> r = requests.get("http://example.org", auth=kerberos_auth)
...

This will cause requests_kerberos to attempt mutual authentication if the server advertises that it supports it, and cause a failure if authentication fails, but not if the server does not support it at all.

DISABLED

While we don’t recommend it, if you’d prefer to never attempt mutual authentication, you can do that as well:

>>> import requests
>>> from requests_kerberos import HTTPKerberosAuth, DISABLED
>>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=DISABLED)
>>> r = requests.get("http://example.org", auth=kerberos_auth)
...

Logging

This library makes extensive use of Python’s logging facilities.

Log messages are logged to the requests_kerberos and requests_kerberos.kerberos_ named loggers.

If you are having difficulty we suggest you configure logging. Issues with the underlying kerberos libraries will be made apparent. Additionally, copious debug information is made available which may assist in troubleshooting if you increase your log level all the way up to debug.

History

0.7.0: 2015-05-04

  • Added Windows native authentication support by adding kerberos-sspi as an alternative backend.

  • Prevent infinite recursion when a server returns 401 to an authorization attempt.

  • Reduce the logging during successful responses.

0.6.1: 2014-11-14

  • Fix HTTPKerberosAuth not to treat non-file as a file

  • Prevent infinite recursion when GSSErrors occurs

0.6: 2014-11-04

  • Handle mutual authentication (see pull request 36)

    All users should upgrade immediately. This has been reported to oss-security and we are awaiting a proper CVE identifier.

    Update: We were issued CVE-2014-8650

  • Distribute as a wheel.

0.5: 2014-05-14

  • Allow non-HTTP service principals with HTTPKerberosAuth using a new optional argument service.

  • Fix bug in setup.py on distributions where the compiler module is not available.

  • Add test dependencies to setup.py so python setup.py test will work.

0.4: 2013-10-26

  • Minor updates in the README

  • Change requirements to depend on requests above 1.1.0

0.3: 2013-06-02

  • Work with servers operating on non-standard ports

0.2: 2013-03-26

  • Not documented

0.1: Never released

  • Initial Release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

requests-kerberos-0.7.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

requests_kerberos-0.7.0-py2.py3-none-any.whl (9.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file requests-kerberos-0.7.0.tar.gz.

File metadata

File hashes

Hashes for requests-kerberos-0.7.0.tar.gz
Algorithm Hash digest
SHA256 741848f86f4046acece245aa9a1189470152f1949c1454aedb283ff5f3735c92
MD5 d7cde195a95536c83a2ffd8a7050be4c
BLAKE2b-256 ef257bed0011f7373fa961c50bcc79f238cec6abdc85b76300d5b9ce3dce8aa3

See more details on using hashes here.

File details

Details for the file requests_kerberos-0.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for requests_kerberos-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2f9e598c895e3d70204170876e5909e7910319b376542a3771c1b67b1eb349e2
MD5 384f5ee3e9922bc790feda79f0441538
BLAKE2b-256 89f1d733eaeb8ee836eb89aed8c67264914e0116ecfb4f8afa27a800efc77d33

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page