1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
|
%global _empty_manifest_terminate_build 0
Name: python-requests-credssp
Version: 2.0.0
Release: 1
Summary: HTTPS CredSSP authentication with the requests library.
License: MIT
URL: https://github.com/jborean93/requests-credssp
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/bc/c3/de13b8598287440ab1df7eba97b93278d309dffb920f0163a09e089b71ec/requests-credssp-2.0.0.tar.gz
BuildArch: noarch
Requires: python3-cryptography
Requires: python3-pyspnego
Requires: python3-requests
Requires: python3-pyspnego[kerberos]
%description
# requests-credssp
[](https://github.com/jborean93/requests-credssp/actions/workflows/ci.yml)
[](https://codecov.io/gh/jborean93/requests-credssp)
[](https://badge.fury.io/py/requests-credssp)
[](https://github.com/jborean93/request-credssp/blob/master/LICENSE)
## About this library
This package allows for HTTPS CredSSP authentication using the requests
library. CredSSP is a Microsoft authentication that allows your credentials to
be delegated to a server giving you double hop authentication.
## Features
This library supports the following CredSSP features
* Protocol version 2 to 6
* Initial authentication with NTLM or Kerberos
* Message encryption support using the `wrap` and `unwrap` functions
## Requirements
The following Python libraries are required;
* Python 3.6+
* [cryptography](https://github.com/pyca/cryptography)
* [pyspnego](https://github.com/jborean93/pyspnego)
* [requests>=2.0.0](https://pypi.python.org/pypi/requests)
* For Kerberos authentication on Unix [python-gssapi](https://github.com/pythongssapi/python-gssapi) and [pykrb5](https://github.com/jborean93/pykrb5) installed with `requests-credssp[kerberos]`
By default, this library can authenticate with a Windows host using NTLM
messages, if Kerberos authentication is desired, please read the below.
## Installation
To install requests-credssp, simply run
```
pip install requests-credssp
# to install the optional Kerberos functionality, run (see below)
pip install requests-credssp[kerberos]
```
### Kerberos on Linux
To add support for Kerberos authentication on a non-Windows host, the Kerberos
system headers must be installed and the `python-gssapi` library installed. To
install the Kerberos system headers you can install the following packages;
```
# Via Yum (Centos RHEL)
yum -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Dnf (Fedora)
dnf -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Apt (Ubuntu)
apt-get -y install python-dev libkrb5-dev krb5-user
# Via Portage (Gentoo)
emerge -av app-crypt/mit-krb5
emerge -av dev-python/setuptools
# Via pkg (FreeBSD)
sudo pkg install security/krb5
# Via OpenCSW (Solaris)
pkgadd -d http://get.opencsw.org/now
/opt/csw/bin/pkgutil -U
/opt/csw/bin/pkgutil -y -i libkrb5_3
# Via Pacman (Arch Linux)
pacman -S krb5
```
Once installed, the Python Kerberos libraries can be installed with
```
pip install requests-credssp[kerberos]
```
Once installed, the file `/etc/krb5.conf` should be configured so it can talk
with the Kerberos KDC.
To add proper SPNEGO support with `python-gssapi`, the
[gss-ntlmssp](https://github.com/simo5/gss-ntlmssp) should also be installed
which adds NTLM as a supported GSSAPI mechanism required for proper SPNEGO
interoperability with Windows. This package can be installed with;
```
# Via Yum (Centos RHEL) - requires epel-release
yum -y install epel-release
yum -y install gssntlmssp
# Via Dnf (Fedora)
dnf -y install gssntlmssp
# Via Apt (Ubuntu)
apt-get -y install gss-ntlmssp
# Via Pacman (Arch Linux)
pacman -S gss-ntlmssp
```
## Additional Info
The CredSSP protocol is quite complex and uses a lot of other protocols or
standards to work properly. This unfortunately means some older hosts or
settings are incompatible or require some workarounds to get working. Currently
you can configure the following settings when initialising the CredSSP class;
* `auth_mechanism`: The authentication mechanism to use initially, default is `auto`
* `disable_tlsv1_2`: Whether to disable `TLSv1.2` support and work with older protocols like `TLSv1.0`, default is `False`
* `minimum_version`: The minimum CredSSP server version that is required by the client, default is `2`
### Authentication Mechanisms
Part of the CredSSP protocol is to authenticate the user's credentials using
the SPNEGO protocol. The SPNEGO protocol is also called `Negotiate` and is
able to negotiate a common protocol between the client and the server which
can currently be either `NTLM` or `Kerberos`. Kerberos is a tricky protocol
to have set up but should be used wherever it is possible as NTLM uses older
standards that are considered broken from a security perspective.
Due to historical decisions and that Kerberos is not always available by
default, the base install of `requests-credssp` will only work with `NTLM`.
When the Kerberos packages are installed and configured, `requests-credssp`
will automatically attempt to use `Kerberos` if possible but fall back to
`NTLM` if it fails like it would with `SPNEGO`. If you wish to force either
`Kerberos` or `NTLM` instead of relying on the `SPNEGO` mechanism, you can set
`auth_mechanism=<auth_mech>` when creating `HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
# use SPNEGO (default if omitted)
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='auto')
# only allow Kerberos
credssp_auth = HttpCredSSPAuth('user@REALM.COM', 'password',
auth_mechanism='kerberos')
# only allow NTLM
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='ntlm')
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### TLS Protocol Versions
As CredSSP uses TLS to encrypt the tokens that are transferred between the
client and the server, it is succeptible to differing implementations of SSL.
By default, `requests-credssp` will work with server's that offer TLSv1.2
but older Windows hosts that do not support this newer protocol version will
TLSv1.2 was added in Windows Server 2012 and Windows 8 where older hosts need
an optional update to be installed for it to work. If this update cannot be
installed or you are willing to accept the risks of using the older TLS
protocols, `requests-credssp` can be set to disable TLSv1.2 and work with
older protocols like so;
```python
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', disable_tlsv1_2=True)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### CredSSP Protocol Versions
Recently Microsoft has released a security update to CredSSP to mitigate
[CVE 2018-0886](https://support.microsoft.com/en-us/help/4093492/credssp-updates-for-cve-2018-0886-march-13-2018).
The update added 2 new CredSSP protocol versions, `5` and `6` which changes
the way the client and server authenticate each other. While these changes are
transparent to someone who uses this library, it may be prudent to set the
minimum version that this client would authenticate with. This means that any
older server's who have not been patched for this vulnerability will be
rejected.
To set a minimum protocol version that will only allow servers that have been
patched for `CVE 2018-0886`, set `minimum_version=5` when creating
`HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', minimum_version=5)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### Message Encryption
You can use this library to encrypt and decrypt messages sent to and from the
server. Message encryption is done over the TLS channel that was negotiated in
the authentication stage. The below is an example of encrypting and decrypting
messages, note this is only a basic example and not a working script and the
actual implementation depends on the protocol that is reading the messages.
```python
import requests
from requests_credssp import HttpCredSSPAuth
# build the auth request and sent an empty message to authenticate
hostname = "server"
session = requests.Session()
session.auth = HttpCredSSPAuth('domain\\user', 'password')
request = requests.Request('POST', "https://%s:5986/wsman" % server, data=None)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
context = session.auth.contexts[hostname]
# encrypt the message using the wrap command
message = b'hi server'
encrypted_message = context.wrap(message)
# send the encrypted message and get the encrypted response
request = requests.Request('POST', 'https://server:5986/wsman', data=encrypted_message)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
# decrypt the encrypted response from the server
encrypted_response = response.content
decrypted_response = context.unwrap(encrypted_response)
```
## Logging
This library uses the standard Python logging facilities. Log messages are
logged to the `requests_credssp` and `requests_credssp.credssp` named loggers.
If you are receiving any errors or wish to debug the CredSSP process you should
enable DEBUG level logs. These logs show fine grain information such as the
protocol and cipher negotiated and each CredSSP token used in the
authentication process.
## Backlog
* Add support for different credential types like smart card and redirected credentials
%package -n python3-requests-credssp
Summary: HTTPS CredSSP authentication with the requests library.
Provides: python-requests-credssp
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-requests-credssp
# requests-credssp
[](https://github.com/jborean93/requests-credssp/actions/workflows/ci.yml)
[](https://codecov.io/gh/jborean93/requests-credssp)
[](https://badge.fury.io/py/requests-credssp)
[](https://github.com/jborean93/request-credssp/blob/master/LICENSE)
## About this library
This package allows for HTTPS CredSSP authentication using the requests
library. CredSSP is a Microsoft authentication that allows your credentials to
be delegated to a server giving you double hop authentication.
## Features
This library supports the following CredSSP features
* Protocol version 2 to 6
* Initial authentication with NTLM or Kerberos
* Message encryption support using the `wrap` and `unwrap` functions
## Requirements
The following Python libraries are required;
* Python 3.6+
* [cryptography](https://github.com/pyca/cryptography)
* [pyspnego](https://github.com/jborean93/pyspnego)
* [requests>=2.0.0](https://pypi.python.org/pypi/requests)
* For Kerberos authentication on Unix [python-gssapi](https://github.com/pythongssapi/python-gssapi) and [pykrb5](https://github.com/jborean93/pykrb5) installed with `requests-credssp[kerberos]`
By default, this library can authenticate with a Windows host using NTLM
messages, if Kerberos authentication is desired, please read the below.
## Installation
To install requests-credssp, simply run
```
pip install requests-credssp
# to install the optional Kerberos functionality, run (see below)
pip install requests-credssp[kerberos]
```
### Kerberos on Linux
To add support for Kerberos authentication on a non-Windows host, the Kerberos
system headers must be installed and the `python-gssapi` library installed. To
install the Kerberos system headers you can install the following packages;
```
# Via Yum (Centos RHEL)
yum -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Dnf (Fedora)
dnf -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Apt (Ubuntu)
apt-get -y install python-dev libkrb5-dev krb5-user
# Via Portage (Gentoo)
emerge -av app-crypt/mit-krb5
emerge -av dev-python/setuptools
# Via pkg (FreeBSD)
sudo pkg install security/krb5
# Via OpenCSW (Solaris)
pkgadd -d http://get.opencsw.org/now
/opt/csw/bin/pkgutil -U
/opt/csw/bin/pkgutil -y -i libkrb5_3
# Via Pacman (Arch Linux)
pacman -S krb5
```
Once installed, the Python Kerberos libraries can be installed with
```
pip install requests-credssp[kerberos]
```
Once installed, the file `/etc/krb5.conf` should be configured so it can talk
with the Kerberos KDC.
To add proper SPNEGO support with `python-gssapi`, the
[gss-ntlmssp](https://github.com/simo5/gss-ntlmssp) should also be installed
which adds NTLM as a supported GSSAPI mechanism required for proper SPNEGO
interoperability with Windows. This package can be installed with;
```
# Via Yum (Centos RHEL) - requires epel-release
yum -y install epel-release
yum -y install gssntlmssp
# Via Dnf (Fedora)
dnf -y install gssntlmssp
# Via Apt (Ubuntu)
apt-get -y install gss-ntlmssp
# Via Pacman (Arch Linux)
pacman -S gss-ntlmssp
```
## Additional Info
The CredSSP protocol is quite complex and uses a lot of other protocols or
standards to work properly. This unfortunately means some older hosts or
settings are incompatible or require some workarounds to get working. Currently
you can configure the following settings when initialising the CredSSP class;
* `auth_mechanism`: The authentication mechanism to use initially, default is `auto`
* `disable_tlsv1_2`: Whether to disable `TLSv1.2` support and work with older protocols like `TLSv1.0`, default is `False`
* `minimum_version`: The minimum CredSSP server version that is required by the client, default is `2`
### Authentication Mechanisms
Part of the CredSSP protocol is to authenticate the user's credentials using
the SPNEGO protocol. The SPNEGO protocol is also called `Negotiate` and is
able to negotiate a common protocol between the client and the server which
can currently be either `NTLM` or `Kerberos`. Kerberos is a tricky protocol
to have set up but should be used wherever it is possible as NTLM uses older
standards that are considered broken from a security perspective.
Due to historical decisions and that Kerberos is not always available by
default, the base install of `requests-credssp` will only work with `NTLM`.
When the Kerberos packages are installed and configured, `requests-credssp`
will automatically attempt to use `Kerberos` if possible but fall back to
`NTLM` if it fails like it would with `SPNEGO`. If you wish to force either
`Kerberos` or `NTLM` instead of relying on the `SPNEGO` mechanism, you can set
`auth_mechanism=<auth_mech>` when creating `HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
# use SPNEGO (default if omitted)
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='auto')
# only allow Kerberos
credssp_auth = HttpCredSSPAuth('user@REALM.COM', 'password',
auth_mechanism='kerberos')
# only allow NTLM
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='ntlm')
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### TLS Protocol Versions
As CredSSP uses TLS to encrypt the tokens that are transferred between the
client and the server, it is succeptible to differing implementations of SSL.
By default, `requests-credssp` will work with server's that offer TLSv1.2
but older Windows hosts that do not support this newer protocol version will
TLSv1.2 was added in Windows Server 2012 and Windows 8 where older hosts need
an optional update to be installed for it to work. If this update cannot be
installed or you are willing to accept the risks of using the older TLS
protocols, `requests-credssp` can be set to disable TLSv1.2 and work with
older protocols like so;
```python
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', disable_tlsv1_2=True)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### CredSSP Protocol Versions
Recently Microsoft has released a security update to CredSSP to mitigate
[CVE 2018-0886](https://support.microsoft.com/en-us/help/4093492/credssp-updates-for-cve-2018-0886-march-13-2018).
The update added 2 new CredSSP protocol versions, `5` and `6` which changes
the way the client and server authenticate each other. While these changes are
transparent to someone who uses this library, it may be prudent to set the
minimum version that this client would authenticate with. This means that any
older server's who have not been patched for this vulnerability will be
rejected.
To set a minimum protocol version that will only allow servers that have been
patched for `CVE 2018-0886`, set `minimum_version=5` when creating
`HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', minimum_version=5)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### Message Encryption
You can use this library to encrypt and decrypt messages sent to and from the
server. Message encryption is done over the TLS channel that was negotiated in
the authentication stage. The below is an example of encrypting and decrypting
messages, note this is only a basic example and not a working script and the
actual implementation depends on the protocol that is reading the messages.
```python
import requests
from requests_credssp import HttpCredSSPAuth
# build the auth request and sent an empty message to authenticate
hostname = "server"
session = requests.Session()
session.auth = HttpCredSSPAuth('domain\\user', 'password')
request = requests.Request('POST', "https://%s:5986/wsman" % server, data=None)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
context = session.auth.contexts[hostname]
# encrypt the message using the wrap command
message = b'hi server'
encrypted_message = context.wrap(message)
# send the encrypted message and get the encrypted response
request = requests.Request('POST', 'https://server:5986/wsman', data=encrypted_message)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
# decrypt the encrypted response from the server
encrypted_response = response.content
decrypted_response = context.unwrap(encrypted_response)
```
## Logging
This library uses the standard Python logging facilities. Log messages are
logged to the `requests_credssp` and `requests_credssp.credssp` named loggers.
If you are receiving any errors or wish to debug the CredSSP process you should
enable DEBUG level logs. These logs show fine grain information such as the
protocol and cipher negotiated and each CredSSP token used in the
authentication process.
## Backlog
* Add support for different credential types like smart card and redirected credentials
%package help
Summary: Development documents and examples for requests-credssp
Provides: python3-requests-credssp-doc
%description help
# requests-credssp
[](https://github.com/jborean93/requests-credssp/actions/workflows/ci.yml)
[](https://codecov.io/gh/jborean93/requests-credssp)
[](https://badge.fury.io/py/requests-credssp)
[](https://github.com/jborean93/request-credssp/blob/master/LICENSE)
## About this library
This package allows for HTTPS CredSSP authentication using the requests
library. CredSSP is a Microsoft authentication that allows your credentials to
be delegated to a server giving you double hop authentication.
## Features
This library supports the following CredSSP features
* Protocol version 2 to 6
* Initial authentication with NTLM or Kerberos
* Message encryption support using the `wrap` and `unwrap` functions
## Requirements
The following Python libraries are required;
* Python 3.6+
* [cryptography](https://github.com/pyca/cryptography)
* [pyspnego](https://github.com/jborean93/pyspnego)
* [requests>=2.0.0](https://pypi.python.org/pypi/requests)
* For Kerberos authentication on Unix [python-gssapi](https://github.com/pythongssapi/python-gssapi) and [pykrb5](https://github.com/jborean93/pykrb5) installed with `requests-credssp[kerberos]`
By default, this library can authenticate with a Windows host using NTLM
messages, if Kerberos authentication is desired, please read the below.
## Installation
To install requests-credssp, simply run
```
pip install requests-credssp
# to install the optional Kerberos functionality, run (see below)
pip install requests-credssp[kerberos]
```
### Kerberos on Linux
To add support for Kerberos authentication on a non-Windows host, the Kerberos
system headers must be installed and the `python-gssapi` library installed. To
install the Kerberos system headers you can install the following packages;
```
# Via Yum (Centos RHEL)
yum -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Dnf (Fedora)
dnf -y install python-devel krb5-devel krb5-libs krb5-workstation
# Via Apt (Ubuntu)
apt-get -y install python-dev libkrb5-dev krb5-user
# Via Portage (Gentoo)
emerge -av app-crypt/mit-krb5
emerge -av dev-python/setuptools
# Via pkg (FreeBSD)
sudo pkg install security/krb5
# Via OpenCSW (Solaris)
pkgadd -d http://get.opencsw.org/now
/opt/csw/bin/pkgutil -U
/opt/csw/bin/pkgutil -y -i libkrb5_3
# Via Pacman (Arch Linux)
pacman -S krb5
```
Once installed, the Python Kerberos libraries can be installed with
```
pip install requests-credssp[kerberos]
```
Once installed, the file `/etc/krb5.conf` should be configured so it can talk
with the Kerberos KDC.
To add proper SPNEGO support with `python-gssapi`, the
[gss-ntlmssp](https://github.com/simo5/gss-ntlmssp) should also be installed
which adds NTLM as a supported GSSAPI mechanism required for proper SPNEGO
interoperability with Windows. This package can be installed with;
```
# Via Yum (Centos RHEL) - requires epel-release
yum -y install epel-release
yum -y install gssntlmssp
# Via Dnf (Fedora)
dnf -y install gssntlmssp
# Via Apt (Ubuntu)
apt-get -y install gss-ntlmssp
# Via Pacman (Arch Linux)
pacman -S gss-ntlmssp
```
## Additional Info
The CredSSP protocol is quite complex and uses a lot of other protocols or
standards to work properly. This unfortunately means some older hosts or
settings are incompatible or require some workarounds to get working. Currently
you can configure the following settings when initialising the CredSSP class;
* `auth_mechanism`: The authentication mechanism to use initially, default is `auto`
* `disable_tlsv1_2`: Whether to disable `TLSv1.2` support and work with older protocols like `TLSv1.0`, default is `False`
* `minimum_version`: The minimum CredSSP server version that is required by the client, default is `2`
### Authentication Mechanisms
Part of the CredSSP protocol is to authenticate the user's credentials using
the SPNEGO protocol. The SPNEGO protocol is also called `Negotiate` and is
able to negotiate a common protocol between the client and the server which
can currently be either `NTLM` or `Kerberos`. Kerberos is a tricky protocol
to have set up but should be used wherever it is possible as NTLM uses older
standards that are considered broken from a security perspective.
Due to historical decisions and that Kerberos is not always available by
default, the base install of `requests-credssp` will only work with `NTLM`.
When the Kerberos packages are installed and configured, `requests-credssp`
will automatically attempt to use `Kerberos` if possible but fall back to
`NTLM` if it fails like it would with `SPNEGO`. If you wish to force either
`Kerberos` or `NTLM` instead of relying on the `SPNEGO` mechanism, you can set
`auth_mechanism=<auth_mech>` when creating `HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
# use SPNEGO (default if omitted)
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='auto')
# only allow Kerberos
credssp_auth = HttpCredSSPAuth('user@REALM.COM', 'password',
auth_mechanism='kerberos')
# only allow NTLM
credssp_auth = HttpCredSSPAuth('domain\\user', 'password',
auth_mechanism='ntlm')
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### TLS Protocol Versions
As CredSSP uses TLS to encrypt the tokens that are transferred between the
client and the server, it is succeptible to differing implementations of SSL.
By default, `requests-credssp` will work with server's that offer TLSv1.2
but older Windows hosts that do not support this newer protocol version will
TLSv1.2 was added in Windows Server 2012 and Windows 8 where older hosts need
an optional update to be installed for it to work. If this update cannot be
installed or you are willing to accept the risks of using the older TLS
protocols, `requests-credssp` can be set to disable TLSv1.2 and work with
older protocols like so;
```python
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', disable_tlsv1_2=True)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### CredSSP Protocol Versions
Recently Microsoft has released a security update to CredSSP to mitigate
[CVE 2018-0886](https://support.microsoft.com/en-us/help/4093492/credssp-updates-for-cve-2018-0886-march-13-2018).
The update added 2 new CredSSP protocol versions, `5` and `6` which changes
the way the client and server authenticate each other. While these changes are
transparent to someone who uses this library, it may be prudent to set the
minimum version that this client would authenticate with. This means that any
older server's who have not been patched for this vulnerability will be
rejected.
To set a minimum protocol version that will only allow servers that have been
patched for `CVE 2018-0886`, set `minimum_version=5` when creating
`HttpCredSSPAuth` like so;
```
import requests
from requests_credssp import HttpCredSSPAuth
credssp_auth = HttpCredSSPAuth('domain\\user', 'password', minimum_version=5)
r = requests.get("https://server:5986/wsman", auth=credssp_auth)
```
### Message Encryption
You can use this library to encrypt and decrypt messages sent to and from the
server. Message encryption is done over the TLS channel that was negotiated in
the authentication stage. The below is an example of encrypting and decrypting
messages, note this is only a basic example and not a working script and the
actual implementation depends on the protocol that is reading the messages.
```python
import requests
from requests_credssp import HttpCredSSPAuth
# build the auth request and sent an empty message to authenticate
hostname = "server"
session = requests.Session()
session.auth = HttpCredSSPAuth('domain\\user', 'password')
request = requests.Request('POST', "https://%s:5986/wsman" % server, data=None)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
context = session.auth.contexts[hostname]
# encrypt the message using the wrap command
message = b'hi server'
encrypted_message = context.wrap(message)
# send the encrypted message and get the encrypted response
request = requests.Request('POST', 'https://server:5986/wsman', data=encrypted_message)
prepared_request = self.session.prepare_request(request)
response = session.send(prepared_request)
# decrypt the encrypted response from the server
encrypted_response = response.content
decrypted_response = context.unwrap(encrypted_response)
```
## Logging
This library uses the standard Python logging facilities. Log messages are
logged to the `requests_credssp` and `requests_credssp.credssp` named loggers.
If you are receiving any errors or wish to debug the CredSSP process you should
enable DEBUG level logs. These logs show fine grain information such as the
protocol and cipher negotiated and each CredSSP token used in the
authentication process.
## Backlog
* Add support for different credential types like smart card and redirected credentials
%prep
%autosetup -n requests-credssp-2.0.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-requests-credssp -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Mar 09 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.0-1
- Package Spec generated
|