The HTTP NTLM proxy and/or server authentication library.
Project description
requests-ntlm2
requests-ntlm2, which is based on requests-ntlm, allows for HTTP NTLM authentication using the requests library.
Installation
pip install requests-ntlm2
Usage
Basic Usage
HttpNtlmAuth extends requests AuthBase, so usage is simple:
import requests
from requests_ntlm2 import HttpNtlmAuth
auth=HttpNtlmAuth('domain\\username','password')
requests.get("http://ntlm_protected_site.com", auth=auth)
Changing NTLM compatibility level
See this MS doc on LM compatibility levels. requests_ntlm2 defaults to
compatibility level 3 which supports NTLMv2 [only]. You can change the compatibility level as follows:
import requests
from requests_ntlm2 import HttpNtlmAuth, NtlmCompatibility
username = 'domain\\username'
password = 'password123'
ntlm_compatibility = NtlmCompatibility.LM_AND_NTLMv1_WITH_ESS # => level 1
auth=HttpNtlmAuth(username, password, ntlm_compatibility=ntlm_compatibility)
requests.get("http://ntlm_protected_site.com", auth=auth)
Using with Requests Session
HttpNtlmAuth can be used in conjunction with a Session in order to
make use of connection pooling. Since NTLM authenticates connections,
this is more efficient. Otherwise, each request will go through a new
NTLM challenge-response.
import requests
from requests_ntlm2 import HttpNtlmAuth
session = requests.Session()
session.auth = HttpNtlmAuth('domain\\username','password')
session.get('http://ntlm_protected_site.com')
HTTP CONNECT Usage
When using requests-ntlm2 to create SSL proxy tunnel via
HTTP CONNECT, the so-called
"NTLM Dance" - ie, the NTLM authentication handshake - has to be done at the lower level
(at httplib level) at tunnel-creation step. This means that you should use the HttpNtlmAdapter
and requests session. This HttpNtlmAdapter is responsible for sending proxy auth information
downstream.
Here is a basic example:
import requests
from requests_ntlm2 import (
HttpNtlmAuth,
HttpNtlmAdapter,
NtlmCompatibility
)
username = '...'
password = '...'
proxy_ip = '...'
proxy_port = '...'
proxies = {
'http': 'http://{}:{}'.format(proxy_ip, proxy_port),
'https': 'http://{}:{}'.format(proxy_ip, proxy_port)
}
ntlm_compatibility = NtlmCompatibility.NTLMv2_DEFAULT
session = requests.Session()
session.mount(
'https://',
HttpNtlmAdapter(
username,
password,
ntlm_compatibility=ntlm_compatibility
)
)
session.mount(
'http://',
HttpNtlmAdapter(
username,
password,
ntlm_compatibility=ntlm_compatibility
)
)
session.auth = HttpNtlmAuth(
username,
password,
ntlm_compatibility=ntlm_compatibility
)
session.proxies = proxies
response = session.get('http:/foobar.com')
Requirements
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file requests_ntlm2-6.4.2.tar.gz.
File metadata
- Download URL: requests_ntlm2-6.4.2.tar.gz
- Upload date:
- Size: 13.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
08f224e0b3c8466ae0eb2616496aa2509ae2eb223fdeae9d7dda6b6156d766a4
|
|
| MD5 |
3d73d66924326be8c651eabc0ea44990
|
|
| BLAKE2b-256 |
e9f971538d975488524cbc6472bb4347f402c45af5bcc8c3ecceff8df81369a4
|
File details
Details for the file requests_ntlm2-6.4.2-py2.py3-none-any.whl.
File metadata
- Download URL: requests_ntlm2-6.4.2-py2.py3-none-any.whl
- Upload date:
- Size: 15.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db946006efa344f5cf01f59a7ea556d7ef4e2cb59fe81c826c77f6b1ca25b9e1
|
|
| MD5 |
c3b6fe7ae16ab2bc2c218c5787ff9758
|
|
| BLAKE2b-256 |
ecc8a1c8db48032e1242cf273c3353eb0c3581a04db16f7bb08d5f98e3e0e3a6
|
