ntlm-auth 1.5.0
Creates NTLM authentication structures
License: MIT
Requires Python: >=2.6,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Keywords: authentication auth microsoft ntlm lm

ntlm-auth
=========

|Build Status|\ |Build status|\ |Coverage Status|

About this library
------------------

This library handles the low-level details of NTLM authentication for
use in authenticating with a service that uses NTLM. It will create and
parse the 3 different message types in the order required and produce a
base64 encoded value that can be attached to the HTTP header.

The goal of this library is to offer full NTLM support including signing
and sealing of messages as well as supporting MIC for message integrity
and the ability to customise and set limits on the messages sent. Please
see Features and Backlog for a list of what is and is not currently
supported.

Features
--------

-  LM, NTLM and NTLMv2 authentication
-  NTLM1 and NTLM2 extended session security
-  Set the The NTLM Compatibility level when sending messages
-  Channel Binding Tokens support, need to pass in the SHA256 hash of
   the certificate for it to work
-  Support for MIC to enhance the integrity of the messages
-  Support for session security with signing and sealing messages after
   authentication happens

Installation
------------

ntlm-auth supports Python 2.6, 2.7 and 3.3+

To install, use pip:

::

   pip install ntlm-auth

To install from source, download the source code, then run:

::

   python setup.py install

Usage
-----

Almost all users should use
`requests-ntlm <https://github.com/requests/requests-ntlm>`__ instead of
this library. The library requests-ntlm is a plugin that uses this
library under the hood and provides an easier function to use and
understand.

If you are set on using ntlm-auth directly to compute the message
structures this is a very basic outline of how it can be done. The code
examples are psuedocode and should be adapted for your purpose.

When initliasing the ntlm context you will have to supply the NTLM
compatibility level. The key difference between the different auth
levels are the ntlm_compatibility variable supplied when initialising
Ntlm. An overview of what each sets is below; \* ``0`` - LM Auth and
NTLMv1 Auth \* ``1`` - LM Auth and NTLMv1 Auth with Extended Session
Security (NTLM2) \* ``2`` - NTLMv1 Auth with Extended Session Security
(NTLM2) \* ``3`` - NTLMv2 Auth (Default Choice) \* ``4`` - NTLMv2 Auth
\* ``5`` - NTLMv2 Auth

Level 3 to 5 are the same from a client perspective but differ with how
the server handles the auth which is outside this project’s scope. This
setting is set independently on that server so choosing 3, 4 or 5 when
calling Ntlm will make no difference at all. See
`LmCompatibilityLevel <https://technet.microsoft.com/en-us/library/cc960646.aspx>`__
for more details.

Extended Session Security is a security feature designed to increase the
security of LM and NTLMv1 auth. It is no substitution for NTLMv2 but is
better than nothing and should be used if possible when you need NTLMv1
compatibility.

The variables required are outlined below; \* ``username`` - The
username to authenticate with, should not have the domain prefix,
i.e. USER not DOMAIN\USER \* ``password`` - The password of the user to
authenticate with \* ``domain`` - The domain of the user, i.e. DOMAIN.
Can be blank if not in a domain environment \* ``workstation`` - The
workstation you are running on. Can be blank if you do not wish to send
this \* ``cbt_data`` - (NTLMv2 only) The
``gss_channel_bindings.GssChannelBindingsStruct`` used to bind with the
auth response. Can be None if no binding needs to occur

LM Auth/NTLMv1 Auth
^^^^^^^^^^^^^^^^^^^

LM and NTLMv1 Auth are older authentication methods that should be
avoided where possible. Choosing between these authentication methods
are almost identical expect where you specify the ntlm_compatiblity
level.

.. code:: python

   import socket

   from ntlm_auth.ntlm import NtlmContext

   username = 'User'
   password = 'Password'
   domain = 'Domain' # Can be blank if you are not in a domain
   workstation = socket.gethostname().upper() # Can be blank if you wish to not send this info

   ntlm_context = NtlmContext(username, password, domain, workstation, ntlm_compatibility=0) # Put the ntlm_compatibility level here, 0-2 for LM Auth/NTLMv1 Auth
   negotiate_message = ntlm_context.step()

   # Attach the negotiate_message to your NTLM/NEGOTIATE HTTP header and send to the server. Get the challenge response back from the server
   challenge_message = http.response.headers['HEADERFIELD']

   authenticate_message = ntlm_context.step(challenge_message)

   # Attach the authenticate_message ot your NTLM_NEGOTIATE HTTP header and send to the server. You are now authenticated with NTLMv1

NTLMv2
^^^^^^

NTLMv2 Auth is the newest NTLM auth method from Microsoft and should be
the option chosen by default unless you require an older auth method.
The implementation is the same as NTLMv1 but with the addition of the
optional ``server_certificate_hash`` variable and the
``ntlm_compatibility`` is not specified.

.. code:: python

   import base64
   import socket

   from ntlm_auth.gss_channel_bindings import GssChannelBindingsStruct
   from ntlm_auth.ntlm import NtlmContext

   username = 'User'
   password = 'Password'
   domain = 'Domain' # Can be blank if you are not in a domain
   workstation = socket.gethostname().upper() # Can be blank if you wish to not send this info

   # create the CBT struct if you wish to bind it with the auth response
   server_certificate_hash = '96B2FC1EC30792619286A0C7FD62863E81A6564E72829CBC0A46F7B1D5D92A18'
   certificate_digest = base64.b16decode(server_certificate_hash)
   cbt_data = GssChannelBindingsStruct()
   cbt_data[cbt_data.APPLICATION_DATA] = b'tls-server-end-point:' + certificate_digest

   ntlm_context = NtlmContext(username, password, domain, workstation, cbt_data, ntlm_compatibility=3)
   negotiate_message = ntlm_context.step()

   # Attach the negotiate_message to your NTLM/NEGOTIATE HTTP header and send to the server. Get the challenge response back from the server
   challenge_message = http.response.headers['HEADERFIELD']

   authenticate_message = ntlm_context.step(challenge_message)

   # Attach the authenticate_message ot your NTLM_NEGOTIATE HTTP header and send to the server. You are now authenticated with NTLMv1

Signing/Sealing
^^^^^^^^^^^^^^^

All version of NTLM supports signing (integrity) and sealing
(confidentiality) of message content. This function can add these
improvements to a message that is sent and received from the server.
While it does encrypt the data if supported by the server it is only
done with RC4 with a 128-bit key which is not very secure and on older
systems this key length could be 56 or 40 bit. This functionality while
tested and conforms with the Microsoft documentation has yet to be fully
tested in an integrated environment. Once again this has not been
thoroughly tested and has only passed unit tests and their expections.

.. code:: python

   import base64
   import socket

   from ntlm_auth.ntlm import NtlmContext

   username = 'User'
   password = 'Password'
   domain = 'Domain' # Can be blank if you are not in a domain
   workstation = socket.gethostname().upper() # Can be blank if you wish to not send this info

   # create the CBT struct if you wish to bind it with the auth response
   server_certificate_hash = '96B2FC1EC30792619286A0C7FD62863E81A6564E72829CBC0A46F7B1D5D92A18'
   certificate_digest = base64.b16decode(server_certificate_hash)
   cbt_data = GssChannelBindingsStruct()
   cbt_data[cbt_data.APPLICATION_DATA] = b'tls-server-end-point:' + certificate_digest

   ntlm_context = NtlmContext(username, password, domain, workstation, cbt_data, ntlm_compatibility=3)
   negotiate_message = ntlm_context.step()

   # Attach the negotiate_message to your NTLM/NEGOTIATE HTTP header and send to the server. Get the challenge response back from the server
   challenge_message = http.response.headers['HEADERFIELD']

   authenticate_message = ntlm_context.step(challenge_message)

   # Attach the authenticate_message ot your NTLM_NEGOTIATE HTTP header and send to the server. You are now authenticated with NTLMv1

   # Encrypt the message with the wrapping function and send the message
   enc_message = ntlm_context.wrap("Message to send", encrypt=True)
   request.body = msg_data
   request.send

   # Receive the response from the server and decrypt
   response_msg = response.content
   response = ntlm_context.unwrap(response_msg)

Backlog
-------

-  Automatically get windows version if running on windows, use default
   if not that case
-  Add param when initialising the ntlm context to throw an exception
   and cancel auth if the server doesn’t support 128-bit keys for
   sealing
-  Add param when initialising the ntlm context to not send the MIC
   structure for older servers
-  Add param to independently verify the target name returned from the
   server and the value passed in

.. |Build Status| image:: https://travis-ci.org/jborean93/ntlm-auth.svg?branch=master
   :target: https://travis-ci.org/jborean93/ntlm-auth
.. |Build status| image:: https://ci.appveyor.com/api/projects/status/osvvfgmhfk4anvu0/branch/master?svg=true
   :target: https://ci.appveyor.com/project/jborean93/ntlm-auth/branch/master
.. |Coverage Status| image:: https://coveralls.io/repos/github/jborean93/ntlm-auth/badge.svg?branch=master
   :target: https://coveralls.io/github/jborean93/ntlm-auth?branch=master