python/samba/tests/password_hash_gpgme.py

   1 # Tests for Tests for source4/dsdb/samdb/ldb_modules/password_hash.c
   2 #
   3 # Copyright (C) Catalyst IT Ltd. 2017
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18
  19 """
  20 Tests for source4/dsdb/samdb/ldb_modules/password_hash.c
  21 These tests need to be run in an environment in which
  22 io->ac->gpg_key_ids != NULL, so that the gpg supplemental credentials
  23 are generated. The functional level needs to be >= 2008 so that the
  24 kerberos newer keys are generated.
  25 """
  26
  27
  28 from samba.tests.password_hash import (
  29     PassWordHashTests,
  30     get_package,
  31     USER_PASS,
  32     USER_NAME
  33 )
  34 from samba.ndr import ndr_unpack
  35 from samba.dcerpc import drsblobs
  36 import binascii
  37 from samba.tests.pso import PasswordSettings
  38 import samba
  39
  40
  41 class PassWordHashGpgmeTests(PassWordHashTests):
  42
  43     def setUp(self):
  44         super(PassWordHashGpgmeTests, self).setUp()
  45
  46     def test_default_supplementalCredentials(self):
  47         self.add_user()
  48         if not self.lp.get("password hash gpg key ids"):
  49             self.skipTest("No password hash gpg key ids, " +
  50                           "Primary:SambaGPG will not be generated")
  51
  52         sc = self.get_supplemental_creds()
  53
  54         # Check that we got all the expected supplemental credentials
  55         # And they are in the expected order.
  56         size = len(sc.sub.packages)
  57         self.assertEquals(5, size)
  58         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
  59         self.assertEquals(1, pos)
  60         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
  61
  62         (pos, package) = get_package(sc, "Primary:Kerberos")
  63         self.assertEquals(2, pos)
  64         self.assertEquals("Primary:Kerberos", package.name)
  65
  66         (pos, wd_package) = get_package(sc, "Primary:WDigest")
  67         self.assertEquals(3, pos)
  68         self.assertEquals("Primary:WDigest", wd_package.name)
  69
  70         (pos, package) = get_package(sc, "Packages")
  71         self.assertEquals(4, pos)
  72         self.assertEquals("Packages", package.name)
  73
  74         (pos, package) = get_package(sc, "Primary:SambaGPG")
  75         self.assertEquals(5, pos)
  76         self.assertEquals("Primary:SambaGPG", package.name)
  77
  78         # Check that the WDigest values are correct.
  79         #
  80         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
  81                              binascii.a2b_hex(wd_package.data))
  82         self.check_wdigests(digests)
  83
  84         # Check that the Package names are correct.
  85         #
  86         pb = ndr_unpack(drsblobs.package_PackagesBlob,
  87                              binascii.a2b_hex(package.data))
  88         expected = ["Kerberos-Newer-Keys", "Kerberos", "WDigest", "SambaGPG"]
  89         self.assertEquals(expected, pb.names)
  90
  91     def test_supplementalCredentials_cleartext(self):
  92         self.add_user(clear_text=True)
  93         if not self.lp.get("password hash gpg key ids"):
  94             self.skipTest("No password hash gpg key ids, " +
  95                           "Primary:SambaGPG will not be generated")
  96
  97         sc = self.get_supplemental_creds()
  98
  99         # Check that we got all the expected supplemental credentials
 100         # And they are in the expected order.
 101         size = len(sc.sub.packages)
 102         self.assertEquals(6, size)
 103         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 104         self.assertEquals(1, pos)
 105         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 106
 107         (pos, package) = get_package(sc, "Primary:Kerberos")
 108         self.assertEquals(2, pos)
 109         self.assertEquals("Primary:Kerberos", package.name)
 110
 111         (pos, wd_package) = get_package(sc, "Primary:WDigest")
 112         self.assertEquals(3, pos)
 113         self.assertEquals("Primary:WDigest", wd_package.name)
 114
 115         (pos, ct_package) = get_package(sc, "Primary:CLEARTEXT")
 116         self.assertEquals(4, pos)
 117         self.assertEquals("Primary:CLEARTEXT", ct_package.name)
 118
 119         (pos, package) = get_package(sc, "Packages")
 120         self.assertEquals(5, pos)
 121         self.assertEquals("Packages", package.name)
 122
 123         (pos, package) = get_package(sc, "Primary:SambaGPG")
 124         self.assertEquals(6, pos)
 125         self.assertEquals("Primary:SambaGPG", package.name)
 126
 127         # Check that the WDigest values are correct.
 128         #
 129         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 130                              binascii.a2b_hex(wd_package.data))
 131         self.check_wdigests(digests)
 132
 133         # Check the clear text  value is correct.
 134         ct = ndr_unpack(drsblobs.package_PrimaryCLEARTEXTBlob,
 135                         binascii.a2b_hex(ct_package.data))
 136         self.assertEquals(USER_PASS.encode('utf-16-le'), ct.cleartext)
 137
 138     def assert_cleartext(self, expect_cleartext, password=None):
 139         """Checks cleartext is (or isn't) returned as expected"""
 140         sc = self.get_supplemental_creds()
 141         if expect_cleartext:
 142             (pos, ct_package) = get_package(sc, "Primary:CLEARTEXT")
 143             self.assertTrue(ct_package is not None, "Failed to retrieve cleartext")
 144
 145             # Check the clear-text value is correct.
 146             ct = ndr_unpack(drsblobs.package_PrimaryCLEARTEXTBlob,
 147                             binascii.a2b_hex(ct_package.data))
 148             self.assertEquals(password.encode('utf-16-le'), ct.cleartext)
 149         else:
 150             ct_package = get_package(sc, "Primary:CLEARTEXT")
 151             self.assertTrue(ct_package is None,
 152                             "Got cleartext when we shouldn't have")
 153
 154     def test_supplementalCredentials_cleartext_pso(self):
 155         """Checks that a PSO's cleartext setting can override the domain's"""
 156
 157         # create a user that stores plain-text passwords
 158         self.add_user(clear_text=True)
 159
 160         # check that clear-text is present in the supplementary-credentials
 161         self.assert_cleartext(expect_cleartext=True, password=USER_PASS)
 162
 163         # create a PSO overriding the plain-text setting & apply it to the user
 164         no_plaintext_pso = PasswordSettings("no-plaintext-PSO", self.ldb,
 165                                             precedence=200,
 166                                             store_plaintext=False)
 167         self.addCleanup(self.ldb.delete, no_plaintext_pso.dn)
 168         userdn = "cn=" + USER_NAME + ",cn=users," + self.base_dn
 169         no_plaintext_pso.apply_to(userdn)
 170
 171         # set the password to update the cleartext password stored
 172         new_password = samba.generate_random_password(32, 32)
 173         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 174
 175         # this time cleartext shouldn't be in the supplementary creds
 176         self.assert_cleartext(expect_cleartext=False)
 177
 178         # unapply PSO, update password, and check we get the cleartext again
 179         no_plaintext_pso.unapply(userdn)
 180         new_password = samba.generate_random_password(32, 32)
 181         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 182         self.assert_cleartext(expect_cleartext=True, password=new_password)
 183
 184         # Now update the domain setting and check we no longer get cleartext
 185         self.set_store_cleartext(False)
 186         new_password = samba.generate_random_password(32, 32)
 187         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 188         self.assert_cleartext(expect_cleartext=False)
 189
 190         # create a PSO overriding the domain setting & apply it to the user
 191         plaintext_pso = PasswordSettings("plaintext-PSO", self.ldb,
 192                                          precedence=100, store_plaintext=True)
 193         self.addCleanup(self.ldb.delete, plaintext_pso.dn)
 194         plaintext_pso.apply_to(userdn)
 195         new_password = samba.generate_random_password(32, 32)
 196         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 197         self.assert_cleartext(expect_cleartext=True, password=new_password)
 198
 199     def test_userPassword_multiple_hashes(self):
 200         self.add_user(options=[(
 201             "password hash userPassword schemes",
 202             "CryptSHA512 CryptSHA256 CryptSHA512")])
 203
 204         sc = self.get_supplemental_creds()
 205
 206         # Check that we got all the expected supplemental credentials
 207         # And they are in the expected order.
 208         size = len(sc.sub.packages)
 209         self.assertEquals(6, size)
 210
 211         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 212         self.assertEquals(1, pos)
 213         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 214
 215         (pos, package) = get_package(sc, "Primary:Kerberos")
 216         self.assertEquals(2, pos)
 217         self.assertEquals("Primary:Kerberos", package.name)
 218
 219         (pos, wp_package) = get_package(sc, "Primary:WDigest")
 220         self.assertEquals(3, pos)
 221         self.assertEquals("Primary:WDigest", wp_package.name)
 222
 223         (pos, up_package) = get_package(sc, "Primary:userPassword")
 224         self.assertEquals(4, pos)
 225         self.assertEquals("Primary:userPassword", up_package.name)
 226
 227         (pos, package) = get_package(sc, "Packages")
 228         self.assertEquals(5, pos)
 229         self.assertEquals("Packages", package.name)
 230
 231         (pos, package) = get_package(sc, "Primary:SambaGPG")
 232         self.assertEquals(6, pos)
 233         self.assertEquals("Primary:SambaGPG", package.name)
 234
 235         # Check that the WDigest values are correct.
 236         #
 237         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 238                              binascii.a2b_hex(wp_package.data))
 239         self.check_wdigests(digests)
 240
 241         # Check that the userPassword hashes are computed correctly
 242         # Expect three hashes to be calculated
 243         up = ndr_unpack(drsblobs.package_PrimaryUserPasswordBlob,
 244                         binascii.a2b_hex(up_package.data))
 245         self.checkUserPassword(up, [
 246             ("{CRYPT}", "6", None),
 247             ("{CRYPT}", "5", None),
 248             ("{CRYPT}", "6", None)
 249         ])
 250         self.checkNtHash(USER_PASS, up.current_nt_hash.hash)
 251
 252     def test_userPassword_multiple_hashes_rounds_specified(self):
 253         self.add_user(options=[(
 254             "password hash userPassword schemes",
 255             "CryptSHA512:rounds=5120 CryptSHA256:rounds=2560 CryptSHA512:rounds=5122")])
 256
 257         sc = self.get_supplemental_creds()
 258
 259         # Check that we got all the expected supplemental credentials
 260         # And they are in the expected order.
 261         size = len(sc.sub.packages)
 262         self.assertEquals(6, size)
 263
 264         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 265         self.assertEquals(1, pos)
 266         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 267
 268         (pos, package) = get_package(sc, "Primary:Kerberos")
 269         self.assertEquals(2, pos)
 270         self.assertEquals("Primary:Kerberos", package.name)
 271
 272         (pos, wp_package) = get_package(sc, "Primary:WDigest")
 273         self.assertEquals(3, pos)
 274         self.assertEquals("Primary:WDigest", wp_package.name)
 275
 276         (pos, up_package) = get_package(sc, "Primary:userPassword")
 277         self.assertEquals(4, pos)
 278         self.assertEquals("Primary:userPassword", up_package.name)
 279
 280         (pos, package) = get_package(sc, "Packages")
 281         self.assertEquals(5, pos)
 282         self.assertEquals("Packages", package.name)
 283
 284         (pos, package) = get_package(sc, "Primary:SambaGPG")
 285         self.assertEquals(6, pos)
 286         self.assertEquals("Primary:SambaGPG", package.name)
 287
 288         # Check that the WDigest values are correct.
 289         #
 290         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 291                              binascii.a2b_hex(wp_package.data))
 292         self.check_wdigests(digests)
 293
 294         # Check that the userPassword hashes are computed correctly
 295         # Expect three hashes to be calculated
 296         up = ndr_unpack(drsblobs.package_PrimaryUserPasswordBlob,
 297                         binascii.a2b_hex(up_package.data))
 298         self.checkUserPassword(up, [
 299             ("{CRYPT}", "6", 5120),
 300             ("{CRYPT}", "5", 2560),
 301             ("{CRYPT}", "6", 5122)
 302         ])
 303         self.checkNtHash(USER_PASS, up.current_nt_hash.hash)