Package: requests-kerberos
requests Kerberos/GSSAPI authentication libraryRequests 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:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth>>>r=requests.get("http://example.org",auth=HTTPKerberosAuth())...The entirerequests.apishould be supported.SetupIn order to use this library, there must already be a Kerberos Ticket-Granting
Ticket(TGT) cached in a Kerberos credential cache. Whether a TGT is available
can be easily determined by running theklistcommand. If no TGT is
available, then it first must be obtained by running thekinitcommand, or
pointing the $KRB5CCNAME to a credential cache with a valid TGT.In short, the library will handle the “negotiations” of Kerberos authentication,
but ensuring that an initial TGT is available and valid is the responsibility
of the user.Authentication FailuresClient authentication failures will be communicated to the caller by returning
the 401 response. A 401 response may also come from an expired Ticket-Granting
Ticket.Mutual AuthenticationREQUIREDBy default,HTTPKerberosAuthwill require mutual authentication from the
server, and if a server emits a non-error response which cannot be
authenticated, arequests_kerberos.errors.MutualAuthenticationErrorwill
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. If the
response content is more important than the need for mutual auth on errors,
(eg, for certain WinRM calls) the stripping behavior can be suppressed by
settingsanitize_mutual_error_response=False:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,REQUIRED>>>kerberos_auth=HTTPKerberosAuth(mutual_authentication=REQUIRED,sanitize_mutual_error_response=False)>>>r=requests.get("https://windows.example.org/wsman",auth=kerberos_auth)...OPTIONALIf you’d prefer to not require mutual authentication, you can set your
preference when constructing yourHTTPKerberosAuthobject:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,OPTIONAL>>>kerberos_auth=HTTPKerberosAuth(mutual_authentication=OPTIONAL)>>>r=requests.get("http://example.org",auth=kerberos_auth)...This will causerequests_kerberosto 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.DISABLEDWhile we don’t recommend it, if you’d prefer to never attempt mutual
authentication, you can do that as well:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,DISABLED>>>kerberos_auth=HTTPKerberosAuth(mutual_authentication=DISABLED)>>>r=requests.get("http://example.org",auth=kerberos_auth)...Preemptive AuthenticationHTTPKerberosAuthcan be forced to preemptively initiate the Kerberos
GSS exchange and present a Kerberos ticket on the initial request (and all
subsequent). By default, authentication only occurs after a401 Unauthorizedresponse containing a Kerberos or Negotiate challenge
is received from the origin server. This can cause mutual authentication
failures for hosts that use a persistent connection (eg, Windows/WinRM), as
no Kerberos challenges are sent after the initial auth handshake. This
behavior can be altered by settingforce_preemptive=True:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,REQUIRED>>>kerberos_auth=HTTPKerberosAuth(mutual_authentication=REQUIRED,force_preemptive=True)>>>r=requests.get("https://windows.example.org/wsman",auth=kerberos_auth)...Hostname OverrideIf communicating with a host whose DNS name doesn’t match its
kerberos hostname (eg, behind a content switch or load balancer),
the hostname used for the Kerberos GSS exchange can be overridden by
setting thehostname_overridearg:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,REQUIRED>>>kerberos_auth=HTTPKerberosAuth(hostname_override="internalhost.local")>>>r=requests.get("https://externalhost.example.org/",auth=kerberos_auth)...Explicit PrincipalHTTPKerberosAuthnormally uses the default principal (ie, the user for
whom you last rankinitorkswitch, or an SSO credential if
applicable). However, an explicit principal can be specified, which will
cause Kerberos to look for a matching credential cache for the named user.
This feature depends on OS support for collection-type credential caches,
as well as working principal support in PyKerberos (it is broken in many
builds). An explicit principal can be specified with theprincipalarg:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth,REQUIRED>>>kerberos_auth=HTTPKerberosAuth(principal="user@REALM")>>>r=requests.get("http://example.org",auth=kerberos_auth)...On Windows, WinKerberos is used instead of PyKerberos. WinKerberos allows the
use of arbitrary principals instead of a credential cache. Passwords can be
specified by following the formuser@realm:passwordforprincipal.Delegationrequests_kerberossupports credential delegation (GSS_C_DELEG_FLAG).
To enable delegation of credentials to a server that requests delegation, passdelegate=TruetoHTTPKerberosAuth:>>>importrequests>>>fromrequests_kerberosimportHTTPKerberosAuth>>>r=requests.get("http://example.org",auth=HTTPKerberosAuth(delegate=True))...Be careful to only allow delegation to servers you trust as they will be able
to impersonate you using the delegated credentials.LoggingThis library makes extensive use of Python’s logging facilities.Log messages are logged to therequests_kerberosandrequests_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.History0.14.0: 2021-12-05Added support for proxy authentication withHTTPendpoints.Support for proxyingHTTPSendpoints is not available due to limitations
of the underlying requests/urllib3 library.Fixed up stray bytes to str conversion.0.13.0: 2021-11-03Change Kerberos dependencies topyspnegoto modernise the underlying
Kerberos library that is used.Removed thewrap_winrmandunwrap_winrmfunctionsDropped support for Python 2 and raised minimum Python version to 3.6.Renamed thecontextattribute to_contextto indicate it’s meant for
internal use only.Fix Negotiate header regex pattern to avoid DoS affected patterns0.12.0: 2017-12-20Add support for channel binding tokens (assumes pykerberos support >= 1.2.1)Add support for kerberos message encryption (assumes pykerberos support >= 1.2.1)Misc CI/test fixes0.11.0: 2016-11-02Switch dependency on Windows from kerberos-sspi/pywin32 to WinKerberos.
This brings Custom Principal support to Windows users.0.10.0: 2016-05-18Make it possible to receive errors without having their contents and headers
stripped.Resolve a bug caused by passing theprincipalkeyword argument to
kerberos-sspi on Windows.0.9.0: 2016-05-06Support for principal, hostname, and realm override.Added support for mutual auth.0.8.0: 2016-01-07Support for Kerberos delegation.Fixed problems declaring kerberos-sspi on Windows installs.0.7.0: 2015-05-04Added 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-14Fix HTTPKerberosAuth not to treat non-file as a filePrevent infinite recursion when GSSErrors occurs0.6: 2014-11-04Handle mutual authentication (see pull request36)All users should upgrade immediately. This has been reported tooss-securityand we are awaiting a proper CVE identifier.Update: We were issued CVE-2014-8650Distribute as a wheel.0.5: 2014-05-14Allow non-HTTP service principals with HTTPKerberosAuth using a new optional
argumentservice.Fix bug insetup.pyon distributions where thecompilermodule is
not available.Add test dependencies tosetup.pysopython setup.py testwill work.0.4: 2013-10-26Minor updates in the READMEChange requirements to depend on requests above 1.1.00.3: 2013-06-02Work with servers operating on non-standard ports0.2: 2013-03-26Not documented0.1: Never releasedInitial Release