Skip to content
Snippets Groups Projects
test_mfa.py 18.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • 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
    import unittest
    import datetime
    import time
    
    from flask import url_for, session
    
    # These imports are required, because otherwise we get circular imports?!
    from uffd import ldap, user
    
    from uffd.user.models import User
    from uffd.session.views import get_current_user, is_valid_session
    from uffd.mfa.models import MFAMethod, MFAType, RecoveryCodeMethod, TOTPMethod, WebauthnMethod, _hotp
    from uffd import create_app, db
    
    from utils import dump, UffdTestCase
    
    class TestMfaPrimitives(unittest.TestCase):
    	def test_hotp(self):
    		self.assertEqual(_hotp(5555555, b'\xae\xa3T\x05\x89\xd6\xb76\xf61r\x92\xcc\xb5WZ\xe6)\x05q'), '458290')
    		self.assertEqual(_hotp(5555555, b'\xae\xa3T\x05\x89\xd6\xb76\xf61r\x92\xcc\xb5WZ\xe6)\x05q', digits=8), '20458290')
    		for digits in range(1, 10):
    			self.assertEqual(len(_hotp(1, b'abcd', digits=digits)), digits)
    		self.assertEqual(_hotp(1234, b''), '161024')
    		self.assertEqual(_hotp(0, b'\x04\x8fM\xcc\x7f\x82\x9c$a\x1b\xb3'), '279354')
    		self.assertEqual(_hotp(2**64-1, b'abcde'), '899292')
    
    def get_user():
    	return User.from_ldap_dn('uid=testuser,ou=users,dc=example,dc=com')
    
    def get_admin():
    	return User.from_ldap_dn('uid=testadmin,ou=users,dc=example,dc=com')
    
    def get_fido2_test_cred():
    	try:
    		from fido2.ctap2 import AttestedCredentialData
    	except ImportError:
    		self.skipTest('fido2 could not be imported')
    	# Example public key from webauthn spec 6.5.1.1
    	return AttestedCredentialData(bytes.fromhex('00000000000000000000000000000000'+'0040'+'053cbcc9d37a61d3bac87cdcc77ee326256def08ab15775d3a720332e4101d14fae95aeee3bc9698781812e143c0597dc6e180595683d501891e9dd030454c0a'+'A501020326200121582065eda5a12577c2bae829437fe338701a10aaa375e1bb5b5de108de439c08551d2258201e52ed75701163f7f9e40ddf9f341b3dc9ba860af7e0ca7ca7e9eecd0084d19c'))
    
    class TestMfaMethodModels(UffdTestCase):
    	def test_common_attributes(self):
    		method = MFAMethod(user=get_user(), name='testname')
    		self.assertTrue(method.created <= datetime.datetime.now())
    		self.assertEqual(method.name, 'testname')
    		self.assertEqual(method.user.loginname, 'testuser')
    		method.user = get_admin()
    		self.assertEqual(method.user.loginname, 'testadmin')
    
    	def test_recovery_code_method(self):
    		method = RecoveryCodeMethod(user=get_user())
    		db.session.add(method)
    		db.session.commit()
    		db.session = db.create_scoped_session() # Ensure the next query does not return the cached method object
    		_method = RecoveryCodeMethod.query.get(method.id)
    		self.assertFalse(hasattr(_method, 'code'))
    		self.assertFalse(_method.verify(''))
    		self.assertFalse(_method.verify('A'*8))
    		self.assertTrue(_method.verify(method.code))
    
    	def test_totp_method_attributes(self):
    		method = TOTPMethod(user=get_user(), name='testname')
    		self.assertEqual(method.name, 'testname')
    		# Restore method with key parameter
    		_method = TOTPMethod(user=get_user(), key=method.key, name='testname')
    		self.assertEqual(_method.name, 'testname')
    		self.assertEqual(method.raw_key, _method.raw_key)
    		self.assertEqual(method.issuer, _method.issuer)
    		self.assertEqual(method.accountname, _method.accountname)
    		self.assertEqual(method.key_uri, _method.key_uri)
    		db.session.add(method)
    		db.session.commit()
    		db.session = db.create_scoped_session() # Ensure the next query does not return the cached method object
    		# Restore method from db
    		_method = TOTPMethod.query.get(method.id)
    		self.assertEqual(_method.name, 'testname')
    		self.assertEqual(method.raw_key, _method.raw_key)
    		self.assertEqual(method.issuer, _method.issuer)
    		self.assertEqual(method.accountname, _method.accountname)
    		self.assertEqual(method.key_uri, _method.key_uri)
    
    	def test_totp_method_verify(self):
    		method = TOTPMethod(user=get_user())
    		counter = int(time.time()/30)
    		self.assertFalse(method.verify(''))
    		self.assertFalse(method.verify(_hotp(counter-2, method.raw_key)))
    		self.assertTrue(method.verify(_hotp(counter, method.raw_key)))
    		self.assertFalse(method.verify(_hotp(counter+2, method.raw_key)))
    
    	def test_webauthn_method(self):
    		data = get_fido2_test_cred()
    		method = WebauthnMethod(user=get_user(), cred=data, name='testname')
    		self.assertEqual(method.name, 'testname')
    		db.session.add(method)
    		db.session.commit()
    		db.session = db.create_scoped_session() # Ensure the next query does not return the cached method object
    		_method = WebauthnMethod.query.get(method.id)
    		self.assertEqual(_method.name, 'testname')
    		self.assertEqual(bytes(method.cred), bytes(_method.cred))
    		self.assertEqual(data.credential_id, _method.cred.credential_id)
    		self.assertEqual(data.public_key, _method.cred.public_key)
    		# We only test (de-)serialization here, as everything else is currently implemented in the views
    
    class TestMfaViews(UffdTestCase):
    	def setUp(self):
    		super().setUp()
    		db.session.add(RecoveryCodeMethod(user=get_admin()))
    		db.session.add(TOTPMethod(user=get_admin(), name='Admin Phone'))
    		# We don't want to skip all tests only because fido2 is not installed!
    		#db.session.add(WebauthnMethod(user=get_admin(), cred=get_fido2_test_cred(), name='Admin FIDO2 dongle'))
    		db.session.commit()
    
    	def login(self):
    		self.client.post(path=url_for('session.login'),
    			data={'loginname': 'testuser', 'password': 'userpassword'}, follow_redirects=True)
    
    	def add_recovery_codes(self, count=10):
    		user = get_user()
    		for _ in range(count):
    			db.session.add(RecoveryCodeMethod(user=user))
    		db.session.commit()
    
    	def add_totp(self):
    		db.session.add(TOTPMethod(user=get_user(), name='My phone'))
    		db.session.commit()
    
    	def add_webauthn(self):
    		db.session.add(WebauthnMethod(user=get_user(), cred=get_fido2_test_cred(), name='My FIDO2 dongle'))
    		db.session.commit()
    
    	def test_setup_disabled(self):
    		self.login()
    		r = self.client.get(path=url_for('mfa.setup'), follow_redirects=True)
    		dump('mfa_setup_disabled', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_setup_recovery_codes(self):
    		self.login()
    		self.add_recovery_codes()
    		r = self.client.get(path=url_for('mfa.setup'), follow_redirects=True)
    		dump('mfa_setup_only_recovery_codes', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_setup_enabled(self):
    		self.login()
    		self.add_recovery_codes()
    		self.add_totp()
    		self.add_webauthn()
    		r = self.client.get(path=url_for('mfa.setup'), follow_redirects=True)
    		dump('mfa_setup_enabled', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_setup_few_recovery_codes(self):
    		self.login()
    		self.add_totp()
    		self.add_recovery_codes(1)
    		r = self.client.get(path=url_for('mfa.setup'), follow_redirects=True)
    		dump('mfa_setup_few_recovery_codes', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_setup_no_recovery_codes(self):
    		self.login()
    		self.add_totp()
    		r = self.client.get(path=url_for('mfa.setup'), follow_redirects=True)
    		dump('mfa_setup_no_recovery_codes', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_disable(self):
    		self.login()
    		self.add_recovery_codes()
    		self.add_totp()
    		admin_methods = len(MFAMethod.query.filter_by(dn=get_admin().dn).all())
    		r = self.client.get(path=url_for('mfa.disable'), follow_redirects=True)
    		dump('mfa_disable', r)
    		self.assertEqual(r.status_code, 200)
    		r = self.client.post(path=url_for('mfa.disable_confirm'), follow_redirects=True)
    		dump('mfa_disable_submit', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_admin().dn).all()), admin_methods)
    
    	def test_disable_recovery_only(self):
    		self.login()
    		self.add_recovery_codes()
    		admin_methods = len(MFAMethod.query.filter_by(dn=get_admin().dn).all())
    		self.assertNotEqual(len(MFAMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.get(path=url_for('mfa.disable'), follow_redirects=True)
    		dump('mfa_disable_recovery_only', r)
    		self.assertEqual(r.status_code, 200)
    		r = self.client.post(path=url_for('mfa.disable_confirm'), follow_redirects=True)
    		dump('mfa_disable_recovery_only_submit', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_admin().dn).all()), admin_methods)
    
    	def test_admin_disable(self):
    		for method in MFAMethod.query.filter_by(dn=get_admin().dn).all():
    			if not isinstance(method, RecoveryCodeMethod):
    				db.session.delete(method)
    		db.session.commit()
    		self.add_recovery_codes()
    		self.add_totp()
    		self.client.post(path=url_for('session.login'),
    			data={'loginname': 'testadmin', 'password': 'adminpassword'}, follow_redirects=True)
    		self.assertTrue(is_valid_session())
    		admin_methods = len(MFAMethod.query.filter_by(dn=get_admin().dn).all())
    		r = self.client.get(path=url_for('mfa.admin_disable', uid=get_user().uid), follow_redirects=True)
    		dump('mfa_admin_disable', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_user().dn).all()), 0)
    		self.assertEqual(len(MFAMethod.query.filter_by(dn=get_admin().dn).all()), admin_methods)
    
    	def test_setup_recovery(self):
    		self.login()
    		self.assertEqual(len(RecoveryCodeMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.post(path=url_for('mfa.setup_recovery'), follow_redirects=True)
    		dump('mfa_setup_recovery', r)
    		self.assertEqual(r.status_code, 200)
    		methods = RecoveryCodeMethod.query.filter_by(dn=get_current_user().dn).all()
    		self.assertNotEqual(len(methods), 0)
    		r = self.client.post(path=url_for('mfa.setup_recovery'), follow_redirects=True)
    		dump('mfa_setup_recovery_reset', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(RecoveryCodeMethod.query.filter_by(id=methods[0].id).all()), 0)
    		self.assertNotEqual(len(methods), 0)
    
    	def test_setup_totp(self):
    		self.login()
    		self.add_recovery_codes()
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		dump('mfa_setup_totp', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertNotEqual(len(session.get('mfa_totp_key', '')), 0)
    
    	def test_setup_totp_without_recovery(self):
    		self.login()
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		dump('mfa_setup_totp_without_recovery', r)
    		self.assertEqual(r.status_code, 200)
    
    	def test_setup_totp_finish(self):
    		self.login()
    		self.add_recovery_codes()
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		method = TOTPMethod(get_current_user(), key=session.get('mfa_totp_key', ''))
    		code = _hotp(int(time.time()/30), method.raw_key)
    		r = self.client.post(path=url_for('mfa.setup_totp_finish', name='My TOTP Authenticator'), data={'code': code}, follow_redirects=True)
    		dump('mfa_setup_totp_finish', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 1)
    
    	def test_setup_totp_finish_without_recovery(self):
    		self.login()
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		method = TOTPMethod(get_current_user(), key=session.get('mfa_totp_key', ''))
    		code = _hotp(int(time.time()/30), method.raw_key)
    		r = self.client.post(path=url_for('mfa.setup_totp_finish', name='My TOTP Authenticator'), data={'code': code}, follow_redirects=True)
    		dump('mfa_setup_totp_finish_without_recovery', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    
    	def test_setup_totp_finish_wrong_code(self):
    		self.login()
    		self.add_recovery_codes()
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		method = TOTPMethod(get_current_user(), key=session.get('mfa_totp_key', ''))
    		code = _hotp(int(time.time()/30), method.raw_key)
    		code = str(int(code[0])+1)[-1] + code[1:]
    		r = self.client.post(path=url_for('mfa.setup_totp_finish', name='My TOTP Authenticator'), data={'code': code}, follow_redirects=True)
    		dump('mfa_setup_totp_finish_wrong_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    
    	def test_setup_totp_finish_empty_code(self):
    		self.login()
    		self.add_recovery_codes()
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    		r = self.client.get(path=url_for('mfa.setup_totp', name='My TOTP Authenticator'), follow_redirects=True)
    		r = self.client.post(path=url_for('mfa.setup_totp_finish', name='My TOTP Authenticator'), data={'code': ''}, follow_redirects=True)
    		dump('mfa_setup_totp_finish_empty_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 0)
    
    	def test_delete_totp(self):
    		self.login()
    		self.add_recovery_codes()
    		self.add_totp()
    		method = TOTPMethod(get_current_user(), name='test')
    		db.session.add(method)
    		db.session.commit()
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 2)
    		r = self.client.get(path=url_for('mfa.delete_totp', id=method.id), follow_redirects=True)
    		dump('mfa_delete_totp', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertEqual(len(TOTPMethod.query.filter_by(id=method.id).all()), 0)
    		self.assertEqual(len(TOTPMethod.query.filter_by(dn=get_current_user().dn).all()), 1)
    
    	# TODO: webauthn setup tests
    
    	def test_auth_integration(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		db.session.commit()
    		self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('session.login'),
    			data={'loginname': 'testuser', 'password': 'userpassword'}, follow_redirects=True)
    		dump('mfa_auth_redirected', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertIn(b'/mfa/auth', r.data)
    		self.assertFalse(is_valid_session())
    		r = self.client.get(path=url_for('mfa.auth'), follow_redirects=False)
    		dump('mfa_auth', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    
    	def test_auth_disabled(self):
    		self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('session.login'),
    			data={'loginname': 'testuser', 'password': 'userpassword'}, follow_redirects=False)
    		r = self.client.get(path=url_for('mfa.auth', ref='/redirecttarget'), follow_redirects=False)
    		self.assertEqual(r.status_code, 302)
    		self.assertTrue(r.location.endswith('/redirecttarget'))
    		self.assertTrue(is_valid_session())
    
    	def test_auth_recovery_only(self):
    		self.add_recovery_codes()
    		self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('session.login'),
    			data={'loginname': 'testuser', 'password': 'userpassword'}, follow_redirects=False)
    		r = self.client.get(path=url_for('mfa.auth', ref='/redirecttarget'), follow_redirects=False)
    		self.assertEqual(r.status_code, 302)
    		self.assertTrue(r.location.endswith('/redirecttarget'))
    		self.assertTrue(is_valid_session())
    
    	def test_auth_recovery_code(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		method = RecoveryCodeMethod(user=get_user())
    		db.session.add(method)
    		db.session.commit()
    		method_id = method.id
    		self.login()
    		r = self.client.get(path=url_for('mfa.auth'), follow_redirects=False)
    		dump('mfa_auth_recovery_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('mfa.auth_finish', ref='/redirecttarget'), data={'code': method.code})
    		self.assertEqual(r.status_code, 302)
    		self.assertTrue(r.location.endswith('/redirecttarget'))
    		self.assertTrue(is_valid_session())
    		self.assertEqual(len(RecoveryCodeMethod.query.filter_by(id=method_id).all()), 0)
    
    	def test_auth_totp_code(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		method = TOTPMethod(user=get_user(), name='testname')
    		raw_key = method.raw_key
    		db.session.add(method)
    		db.session.commit()
    		self.login()
    		r = self.client.get(path=url_for('mfa.auth'), follow_redirects=False)
    		dump('mfa_auth_totp_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    		code = _hotp(int(time.time()/30), raw_key)
    		r = self.client.post(path=url_for('mfa.auth_finish'), data={'code': code}, follow_redirects=True)
    		dump('mfa_auth_totp_code_submit', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertTrue(is_valid_session())
    
    	def test_auth_empty_code(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		self.login()
    		r = self.client.get(path=url_for('mfa.auth'), follow_redirects=False)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('mfa.auth_finish'), data={'code': ''}, follow_redirects=True)
    		dump('mfa_auth_empty_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    
    	def test_auth_invalid_code(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		method = TOTPMethod(user=get_user(), name='testname')
    		raw_key = method.raw_key
    		db.session.add(method)
    		db.session.commit()
    		self.login()
    		r = self.client.get(path=url_for('mfa.auth'), follow_redirects=False)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    		code = _hotp(int(time.time()/30), raw_key)
    		code = str(int(code[0])+1)[-1] + code[1:]
    		r = self.client.post(path=url_for('mfa.auth_finish'), data={'code': code}, follow_redirects=True)
    		dump('mfa_auth_invalid_code', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    
    	def test_auth_ratelimit(self):
    		self.add_recovery_codes()
    		self.add_totp()
    		method = TOTPMethod(user=get_user(), name='testname')
    		raw_key = method.raw_key
    		db.session.add(method)
    		db.session.commit()
    		self.login()
    		self.assertFalse(is_valid_session())
    		code = _hotp(int(time.time()/30), raw_key)
    		inv_code = str(int(code[0])+1)[-1] + code[1:]
    		for i in range(20):
    			r = self.client.post(path=url_for('mfa.auth_finish'), data={'code': inv_code}, follow_redirects=True)
    			self.assertEqual(r.status_code, 200)
    			self.assertFalse(is_valid_session())
    		r = self.client.post(path=url_for('mfa.auth_finish'), data={'code': code}, follow_redirects=True)
    		dump('mfa_auth_ratelimit', r)
    		self.assertEqual(r.status_code, 200)
    		self.assertFalse(is_valid_session())
    
    	# TODO: webauthn auth tests