summaryrefslogtreecommitdiff
path: root/python/samba/tests/ntlm_auth_base.py
blob: 546c89762cc61a33b6d07badf5f047b77b7d08a7 (plain)
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
# Unix SMB/CIFS implementation.
# A test for the ntlm_auth tool
# Copyright (C) Kai Blin <kai@samba.org> 2008
# Copyright (C) Samuel Cabrero <scabrero@suse.de> 2018
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
"""Test ntlm_auth
This test program will start ntlm_auth with the given command line switches and
see if it will get the expected results.
"""

import os
import samba
import subprocess
from samba.tests import BlackboxTestCase

class NTLMAuthTestCase(BlackboxTestCase):

    def setUp(self):
        super(NTLMAuthTestCase, self).setUp()
        bindir = os.path.normpath(os.getenv("BINDIR", "./bin"))
        self.ntlm_auth_path = os.path.join(bindir, 'ntlm_auth')
        self.lp = samba.tests.env_loadparm()
        self.winbind_separator = self.lp.get('winbind separator')

    def readLine(self, text_stream):
        buf = text_stream.readline()
        newline = buf.find('\n')
        if newline == -1:
            raise Exception("Failed to read line")
        return buf[:newline]

    def writeLine(self, text_stream, buf):
        text_stream.write(buf)
        text_stream.write("\n")

    def run_helper(self,
                   client_username=None,
                   client_password=None,
                   client_domain=None,
                   client_use_cached_creds=False,
                   server_username=None,
                   server_password=None,
                   server_domain=None,
                   client_helper="ntlmssp-client-1",
                   server_helper="squid-2.5-ntlmssp",
                   server_use_winbind=False,
                   require_membership=None,
                   target_hostname=None,
                   target_service=None):
        self.assertTrue(os.access(self.ntlm_auth_path, os.X_OK))

        if client_username is None:
            raise Exception("client_username required")

        # Client helper args
        client_args = []
        client_args.append(self.ntlm_auth_path)
        client_args.append("--helper-protocol=%s" % client_helper)
        client_args.append("--username=%s" % client_username)
        if client_domain:
            client_args.append("--domain=%s" % client_domain)
        if client_use_cached_creds:
            client_args.append("--use-cached-creds")
        else:
            if client_password is None:
                raise Exception("client_password required")
            client_args.append("--password=%s" % client_password)
        if target_service:
            client_args.append("--target-service=%s" % target_service)
        if target_hostname:
            client_args.append("--target-hostname=%s" % target_hostname)
        client_args.append("--configfile=%s" % self.lp.configfile)

        # Server helper args
        server_args = []
        server_args.append(self.ntlm_auth_path)
        server_args.append("--helper-protocol=%s" % server_helper)
        server_args.append("--configfile=%s" % self.lp.configfile)
        if not server_use_winbind:
            if server_username is None or server_password is None or server_domain is None:
                raise Exception("Server credentials required if not using winbind")
            server_args.append("--username=%s" % server_username)
            server_args.append("--password=%s" % server_password)
            server_args.append("--domain=%s" % server_domain)
            if require_membership is not None:
                raise Exception("Server must be using winbind for require-membership-of")
        else:
            if require_membership is not None:
                server_args.append("--require-membership-of=%s" % require_membership)

        # Run helpers
        result = False
        server_proc = subprocess.Popen(server_args, stdout=subprocess.PIPE, stdin=subprocess.PIPE, bufsize=0, universal_newlines=True)
        client_proc = subprocess.Popen(client_args, stdout=subprocess.PIPE, stdin=subprocess.PIPE, bufsize=0, universal_newlines=True)

        try:
            if client_helper == "ntlmssp-client-1" and server_helper == "squid-2.5-ntlmssp":
                self.writeLine(client_proc.stdin, "YR")
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("YR "))

                self.writeLine(server_proc.stdin, buf)
                buf = self.readLine(server_proc.stdout)
                self.assertTrue(buf.startswith("TT "))

                self.writeLine(client_proc.stdin, buf)
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("AF "))

                # Client sends 'AF <base64 blob>' but server
                # expects 'KK <base64 blob>'
                buf = buf.replace("AF", "KK", 1)

                self.writeLine(server_proc.stdin, buf)
                buf = self.readLine(server_proc.stdout)
                result = buf.startswith("AF ")
            elif client_helper == "ntlmssp-client-1" and server_helper == "gss-spnego":
                self.writeLine(client_proc.stdin, "YR")
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("YR "))

                self.writeLine(server_proc.stdin, buf)
                buf = self.readLine(server_proc.stdout)
                self.assertTrue(buf.startswith("TT "))

                self.writeLine(client_proc.stdin, buf)
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("AF "))

                # Client sends 'AF <base64 blob>' but server expects 'KK <abse64 blob>'
                buf = buf.replace("AF", "KK", 1)

                self.writeLine(server_proc.stdin, buf)
                buf = self.readLine(server_proc.stdout)
                result = buf.startswith("AF * ")
            elif client_helper == "gss-spnego-client" and server_helper == "gss-spnego":
                self.writeLine(server_proc.stdin, "YR")
                buf = self.readLine(server_proc.stdout)

                while True:
                    if (buf.startswith("NA * ")):
                        result = False
                        break

                    self.assertTrue(buf.startswith("AF ") or buf.startswith("TT "))

                    self.writeLine(client_proc.stdin, buf)
                    buf = self.readLine(client_proc.stdout)

                    if buf.startswith("AF"):
                        result = True
                        break

                    self.assertTrue(buf.startswith("AF ") or buf.startswith("KK ") or buf.startswith("TT "))

                    self.writeLine(server_proc.stdin, buf)
                    buf = self.readLine(server_proc.stdout)

                    if buf.startswith("AF * "):
                        result = True
                        break
            else:
                self.fail("Helper protocols not handled")

            if result is True and client_helper == "ntlmssp-client-1":
                self.writeLine(client_proc.stdin, "GK")
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("GK "))

                self.writeLine(client_proc.stdin, "GF")
                buf = self.readLine(client_proc.stdout)
                self.assertTrue(buf.startswith("GF "))

            if result is True and server_helper == "squid-2.5-ntlmssp":
                self.writeLine(server_proc.stdin, "GK")
                buf = self.readLine(server_proc.stdout)
                self.assertTrue(buf.startswith("GK "))

                self.writeLine(server_proc.stdin, "GF")
                buf = self.readLine(server_proc.stdout)
                self.assertTrue(buf.startswith("GF "))

            client_proc.stdin.close()
            client_proc.wait()
            self.assertEqual(client_proc.returncode, 0)

            server_proc.stdin.close()
            server_proc.wait()
            self.assertEqual(server_proc.returncode, 0)

            return result
        except:
            client_proc.kill()
            client_proc.wait()
            server_proc.kill()
            server_proc.wait()
            raise