Windows Negotiate Authentication Client and Server

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jborean93 from gravatar.com jborean93 Avatar for mattclay from gravatar.com mattclay Avatar for nitzmahone from gravatar.com nitzmahone

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Jordan Borean
  • Tags windows, spnego, negotiate, ntlm, kerberos, sspi, gssapi, auth
  • Requires: Python >=3.6
Classifiers

Project description

Python SPNEGO Library

Test workflow codecov PyPI version License

Library to handle SPNEGO (Negotiate, NTLM, Kerberos) and CredSSP authentication. Also includes a packet parser that can be used to decode raw NTLM/SPNEGO/Kerberos tokens into a human readable format.

Requirements

See How to Install for more details

Optional Requirements

The following Python libraries can be installed to add extra features that do not come with the base package:

How to Install

To install pyspnego with all basic features, run

pip install pyspnego

Kerberos Authentication

While pyspnego supports Kerberos authentication on Linux, it isn't included by default due to its reliance on system packages to be present.

To install these packages, run the below

# Debian/Ubuntu
apt-get install gcc python3-dev libkrb5-dev

# Centos/RHEL
yum install gcc python-devel krb5-devel

# Fedora
dnf install gcc python-devel krb5-devel

# Arch Linux
pacman -S gcc krb5

Once installed you can install the Python packages with

pip install pyspnego[kerberos]

Kerberos also needs to be configured to talk to the domain but that is outside the scope of this page.

While NTLM auth works out of the box, it is recommended to install the gss-ntlmssp library for full Negotiate support. This can be done with

# Debian/Ubuntu
apt-get install gss-ntlmssp

# Centos/RHEL
yum install gssntlmssp

# Fedora
dnf install gssntlmssp

# Arch Linux
# AUR package https://aur.archlinux.org/packages/gss-ntlmssp/

How to Use

See the examples section for examples on how to use the authentication side of the library.

Note: While server/acceptor authentication is available for all protocols it is highly recommended you have the system GSSAPI and NTLM system libraries present for acceptor authentication. Pyspnego NTLM acceptor authentication should work but it is not as thoroughly tested as the GSSAPI implementation.

CredSSP Authentication

Since version 0.2.0, pyspnego can be used for CredSSP authentication. While this isn't part of the SPNEGO/Negotiate protocol it uses common features and code like ASN.1 structures and even Negotiate auth as part of the CredSSP process. Both initiate and accept usages are supported when specifying protocol='credssp' but there are no guarantees the acceptor is free of any bugs so use with caution.

Backlog

  • Add support for anonymous authentication
  • See if pywinrm wants to use this

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jborean93 from gravatar.com jborean93 Avatar for mattclay from gravatar.com mattclay Avatar for nitzmahone from gravatar.com nitzmahone

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Jordan Borean
  • Tags windows, spnego, negotiate, ntlm, kerberos, sspi, gssapi, auth
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

0.11.2

0.11.1

0.11.0

0.10.2

0.10.1 yanked

Reason this release was yanked:

Yet another name

0.10.0 yanked

Reason this release was yanked:

sspi dep will be renamed as it conflicts with a pywin32 namespace

0.9.2

0.9.1

0.9.0

0.8.0

0.7.0

0.6.3

0.6.2

0.6.1

0.6.0

0.5.4

0.5.3

0.5.2

0.5.1

This version

0.5.0

0.4.0

0.3.1

0.3.0

0.2.0

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.1.0rc3 pre-release

0.1.0rc2 pre-release

0.1.0rc1 pre-release

0.1.0b2 pre-release

0.1.0b1 pre-release

Download files

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

Source Distribution

pyspnego-0.5.0.tar.gz (325.7 kB view hashes)

Uploaded Source

Built Distributions

pyspnego-0.5.0-py2.py3-none-any.whl (122.5 kB view hashes)

Uploaded Python 2 Python 3

pyspnego-0.5.0-cp310-cp310-win_amd64.whl (199.3 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

pyspnego-0.5.0-cp310-cp310-win32.whl (189.3 kB view hashes)

Uploaded CPython 3.10 Windows x86

pyspnego-0.5.0-cp39-cp39-win_amd64.whl (199.2 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

pyspnego-0.5.0-cp39-cp39-win32.whl (189.2 kB view hashes)

Uploaded CPython 3.9 Windows x86

pyspnego-0.5.0-cp38-cp38-win_amd64.whl (199.7 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

pyspnego-0.5.0-cp38-cp38-win32.whl (189.8 kB view hashes)

Uploaded CPython 3.8 Windows x86

pyspnego-0.5.0-cp37-cp37m-win_amd64.whl (197.9 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

pyspnego-0.5.0-cp37-cp37m-win32.whl (188.0 kB view hashes)

Uploaded CPython 3.7m Windows x86

pyspnego-0.5.0-cp36-cp36m-win_amd64.whl (208.6 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

pyspnego-0.5.0-cp36-cp36m-win32.whl (194.3 kB view hashes)

Uploaded CPython 3.6m Windows x86

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