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         # Check that the Package names are correct.
  75         #
  76         pb = ndr_unpack(drsblobs.package_PackagesBlob,
  77                              binascii.a2b_hex(package.data))
  78         expected = ["Kerberos-Newer-Keys", "Kerberos", "WDigest", "SambaGPG"]
  79         self.assertEquals(expected, pb.names)
  80
  81         (pos, package) = get_package(sc, "Primary:SambaGPG")
  82         self.assertEquals(5, pos)
  83         self.assertEquals("Primary:SambaGPG", package.name)
  84
  85         # Check that the WDigest values are correct.
  86         #
  87         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
  88                              binascii.a2b_hex(wd_package.data))
  89         self.check_wdigests(digests)
  90
  91
  92     def test_supplementalCredentials_cleartext(self):
  93         self.add_user(clear_text=True)
  94         if not self.lp.get("password hash gpg key ids"):
  95             self.skipTest("No password hash gpg key ids, " +
  96                           "Primary:SambaGPG will not be generated")
  97
  98         sc = self.get_supplemental_creds()
  99
 100         # Check that we got all the expected supplemental credentials
 101         # And they are in the expected order.
 102         size = len(sc.sub.packages)
 103         self.assertEquals(6, size)
 104         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 105         self.assertEquals(1, pos)
 106         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 107
 108         (pos, package) = get_package(sc, "Primary:Kerberos")
 109         self.assertEquals(2, pos)
 110         self.assertEquals("Primary:Kerberos", package.name)
 111
 112         (pos, wd_package) = get_package(sc, "Primary:WDigest")
 113         self.assertEquals(3, pos)
 114         self.assertEquals("Primary:WDigest", wd_package.name)
 115
 116         (pos, ct_package) = get_package(sc, "Primary:CLEARTEXT")
 117         self.assertEquals(4, pos)
 118         self.assertEquals("Primary:CLEARTEXT", ct_package.name)
 119
 120         (pos, package) = get_package(sc, "Packages")
 121         self.assertEquals(5, pos)
 122         self.assertEquals("Packages", package.name)
 123
 124         (pos, package) = get_package(sc, "Primary:SambaGPG")
 125         self.assertEquals(6, pos)
 126         self.assertEquals("Primary:SambaGPG", package.name)
 127
 128         # Check that the WDigest values are correct.
 129         #
 130         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 131                              binascii.a2b_hex(wd_package.data))
 132         self.check_wdigests(digests)
 133
 134         # Check the clear text  value is correct.
 135         ct = ndr_unpack(drsblobs.package_PrimaryCLEARTEXTBlob,
 136                         binascii.a2b_hex(ct_package.data))
 137         self.assertEquals(USER_PASS.encode('utf-16-le'), ct.cleartext)
 138
 139     def assert_cleartext(self, expect_cleartext, password=None):
 140         """Checks cleartext is (or isn't) returned as expected"""
 141         sc = self.get_supplemental_creds()
 142         if expect_cleartext:
 143             (pos, ct_package) = get_package(sc, "Primary:CLEARTEXT")
 144             self.assertTrue(ct_package is not None, "Failed to retrieve cleartext")
 145
 146             # Check the clear-text value is correct.
 147             ct = ndr_unpack(drsblobs.package_PrimaryCLEARTEXTBlob,
 148                             binascii.a2b_hex(ct_package.data))
 149             self.assertEquals(password.encode('utf-16-le'), ct.cleartext)
 150         else:
 151             ct_package = get_package(sc, "Primary:CLEARTEXT")
 152             self.assertTrue(ct_package is None,
 153                             "Got cleartext when we shouldn't have")
 154
 155     def test_supplementalCredentials_cleartext_pso(self):
 156         """Checks that a PSO's cleartext setting can override the domain's"""
 157
 158         # create a user that stores plain-text passwords
 159         self.add_user(clear_text=True)
 160
 161         # check that clear-text is present in the supplementary-credentials
 162         self.assert_cleartext(expect_cleartext=True, password=USER_PASS)
 163
 164         # create a PSO overriding the plain-text setting & apply it to the user
 165         no_plaintext_pso = PasswordSettings("no-plaintext-PSO", self.ldb,
 166                                             precedence=200,
 167                                             store_plaintext=False)
 168         self.addCleanup(self.ldb.delete, no_plaintext_pso.dn)
 169         userdn = "cn=" + USER_NAME + ",cn=users," + self.base_dn
 170         no_plaintext_pso.apply_to(userdn)
 171
 172         # set the password to update the cleartext password stored
 173         new_password = samba.generate_random_password(32, 32)
 174         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 175
 176         # this time cleartext shouldn't be in the supplementary creds
 177         self.assert_cleartext(expect_cleartext=False)
 178
 179         # unapply PSO, update password, and check we get the cleartext again
 180         no_plaintext_pso.unapply(userdn)
 181         new_password = samba.generate_random_password(32, 32)
 182         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 183         self.assert_cleartext(expect_cleartext=True, password=new_password)
 184
 185         # Now update the domain setting and check we no longer get cleartext
 186         self.set_store_cleartext(False)
 187         new_password = samba.generate_random_password(32, 32)
 188         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 189         self.assert_cleartext(expect_cleartext=False)
 190
 191         # create a PSO overriding the domain setting & apply it to the user
 192         plaintext_pso = PasswordSettings("plaintext-PSO", self.ldb,
 193                                          precedence=100, store_plaintext=True)
 194         self.addCleanup(self.ldb.delete, plaintext_pso.dn)
 195         plaintext_pso.apply_to(userdn)
 196         new_password = samba.generate_random_password(32, 32)
 197         self.ldb.setpassword("(sAMAccountName=%s)" % USER_NAME, new_password)
 198         self.assert_cleartext(expect_cleartext=True, password=new_password)
 199
 200     def test_userPassword_multiple_hashes(self):
 201         self.add_user(options=[(
 202             "password hash userPassword schemes",
 203             "CryptSHA512 CryptSHA256 CryptSHA512")])
 204
 205         sc = self.get_supplemental_creds()
 206
 207         # Check that we got all the expected supplemental credentials
 208         # And they are in the expected order.
 209         size = len(sc.sub.packages)
 210         self.assertEquals(6, size)
 211
 212         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 213         self.assertEquals(1, pos)
 214         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 215
 216         (pos, package) = get_package(sc, "Primary:Kerberos")
 217         self.assertEquals(2, pos)
 218         self.assertEquals("Primary:Kerberos", package.name)
 219
 220         (pos, wp_package) = get_package(sc, "Primary:WDigest")
 221         self.assertEquals(3, pos)
 222         self.assertEquals("Primary:WDigest", wp_package.name)
 223
 224         (pos, up_package) = get_package(sc, "Primary:userPassword")
 225         self.assertEquals(4, pos)
 226         self.assertEquals("Primary:userPassword", up_package.name)
 227
 228         (pos, package) = get_package(sc, "Packages")
 229         self.assertEquals(5, pos)
 230         self.assertEquals("Packages", package.name)
 231
 232         (pos, package) = get_package(sc, "Primary:SambaGPG")
 233         self.assertEquals(6, pos)
 234         self.assertEquals("Primary:SambaGPG", package.name)
 235
 236         # Check that the WDigest values are correct.
 237         #
 238         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 239                              binascii.a2b_hex(wp_package.data))
 240         self.check_wdigests(digests)
 241
 242         # Check that the userPassword hashes are computed correctly
 243         # Expect three hashes to be calculated
 244         up = ndr_unpack(drsblobs.package_PrimaryUserPasswordBlob,
 245                         binascii.a2b_hex(up_package.data))
 246         self.checkUserPassword(up, [
 247             ("{CRYPT}", "6", None),
 248             ("{CRYPT}", "5", None),
 249             ("{CRYPT}", "6", None)
 250         ])
 251         self.checkNtHash(USER_PASS, up.current_nt_hash.hash)
 252
 253     def test_userPassword_multiple_hashes_rounds_specified(self):
 254         self.add_user(options=[(
 255             "password hash userPassword schemes",
 256             "CryptSHA512:rounds=5120 CryptSHA256:rounds=2560 CryptSHA512:rounds=5122")])
 257
 258         sc = self.get_supplemental_creds()
 259
 260         # Check that we got all the expected supplemental credentials
 261         # And they are in the expected order.
 262         size = len(sc.sub.packages)
 263         self.assertEquals(6, size)
 264
 265         (pos, package) = get_package(sc, "Primary:Kerberos-Newer-Keys")
 266         self.assertEquals(1, pos)
 267         self.assertEquals("Primary:Kerberos-Newer-Keys", package.name)
 268
 269         (pos, package) = get_package(sc, "Primary:Kerberos")
 270         self.assertEquals(2, pos)
 271         self.assertEquals("Primary:Kerberos", package.name)
 272
 273         (pos, wp_package) = get_package(sc, "Primary:WDigest")
 274         self.assertEquals(3, pos)
 275         self.assertEquals("Primary:WDigest", wp_package.name)
 276
 277         (pos, up_package) = get_package(sc, "Primary:userPassword")
 278         self.assertEquals(4, pos)
 279         self.assertEquals("Primary:userPassword", up_package.name)
 280
 281         (pos, package) = get_package(sc, "Packages")
 282         self.assertEquals(5, pos)
 283         self.assertEquals("Packages", package.name)
 284
 285         (pos, package) = get_package(sc, "Primary:SambaGPG")
 286         self.assertEquals(6, pos)
 287         self.assertEquals("Primary:SambaGPG", package.name)
 288
 289         # Check that the WDigest values are correct.
 290         #
 291         digests = ndr_unpack(drsblobs.package_PrimaryWDigestBlob,
 292                              binascii.a2b_hex(wp_package.data))
 293         self.check_wdigests(digests)
 294
 295         # Check that the userPassword hashes are computed correctly
 296         # Expect three hashes to be calculated
 297         up = ndr_unpack(drsblobs.package_PrimaryUserPasswordBlob,
 298                         binascii.a2b_hex(up_package.data))
 299         self.checkUserPassword(up, [
 300             ("{CRYPT}", "6", 5120),
 301             ("{CRYPT}", "5", 2560),
 302             ("{CRYPT}", "6", 5122)
 303         ])
 304         self.checkNtHash(USER_PASS, up.current_nt_hash.hash)