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
|
import random
import string
from datetime import date, datetime, time
import pytest
import sqlalchemy as sa
from sqlalchemy_utils import ColorType, PhoneNumberType, StringEncryptedType
from sqlalchemy_utils.types import JSONType
from sqlalchemy_utils.types.encrypted.encrypted_type import (
AesEngine,
AesGcmEngine,
DatetimeHandler,
FernetEngine,
InvalidCiphertextError
)
cryptography = None
try:
import cryptography # noqa
except ImportError:
pass
@pytest.fixture
def User(Base, encryption_engine, test_key, padding_mechanism):
class User(Base):
__tablename__ = 'user'
id = sa.Column(sa.Integer, primary_key=True)
username = sa.Column(StringEncryptedType(
sa.Unicode,
test_key,
encryption_engine,
padding_mechanism)
)
access_token = sa.Column(StringEncryptedType(
sa.String,
test_key,
encryption_engine,
padding_mechanism)
)
is_active = sa.Column(StringEncryptedType(
sa.Boolean,
test_key,
encryption_engine,
padding_mechanism)
)
accounts_num = sa.Column(StringEncryptedType(
sa.Integer,
test_key,
encryption_engine,
padding_mechanism)
)
phone = sa.Column(StringEncryptedType(
PhoneNumberType,
test_key,
encryption_engine,
padding_mechanism)
)
color = sa.Column(StringEncryptedType(
ColorType,
test_key,
encryption_engine,
padding_mechanism)
)
date = sa.Column(StringEncryptedType(
sa.Date,
test_key,
encryption_engine,
padding_mechanism)
)
time = sa.Column(StringEncryptedType(
sa.Time,
test_key,
encryption_engine,
padding_mechanism)
)
datetime = sa.Column(StringEncryptedType(
sa.DateTime,
test_key,
encryption_engine,
padding_mechanism)
)
enum = sa.Column(StringEncryptedType(
sa.Enum('One', name='user_enum_t'),
test_key,
encryption_engine,
padding_mechanism)
)
json = sa.Column(StringEncryptedType(
JSONType,
test_key,
encryption_engine,
padding_mechanism)
)
return User
@pytest.fixture
def test_key():
return 'secretkey1234'
@pytest.fixture
def user_name():
return 'someone'
@pytest.fixture
def user_phone():
return '(555) 555-5555'
@pytest.fixture
def user_color():
return '#fff'
@pytest.fixture
def user_enum():
return 'One'
@pytest.fixture
def user_json():
return {"key": "value"}
@pytest.fixture
def user_date():
return date(2010, 10, 2)
@pytest.fixture
def user_time():
return time(10, 12)
@pytest.fixture
def user_datetime():
return datetime(2010, 10, 2, 10, 12, 45, 2334)
@pytest.fixture
def test_token():
token = ''
characters = string.ascii_letters + string.digits
for _ in range(60):
token += ''.join(random.choice(characters))
return token
@pytest.fixture
def active():
return True
@pytest.fixture
def accounts_num():
return 2
@pytest.fixture
def user(
request,
session,
User,
user_name,
user_phone,
user_color,
user_date,
user_time,
user_enum,
user_json,
user_datetime,
test_token,
active,
accounts_num
):
# set the values to the user object
user = User()
user.username = user_name
user.phone = user_phone
user.color = user_color
user.date = user_date
user.time = user_time
user.enum = user_enum
user.json = user_json
user.datetime = user_datetime
user.access_token = test_token
user.is_active = active
user.accounts_num = accounts_num
session.add(user)
session.commit()
try:
return session.get(User, user.id)
except AttributeError:
# sqlalchemy 1.3
return session.query(User).get(user.id)
@pytest.fixture
def datetime_with_micro_and_timezone():
import pytz
tz = pytz.timezone('Pacific/Tahiti')
return datetime(2017, 8, 21, 4, 26, 36, 523010, tzinfo=tz)
@pytest.fixture
def datetime_with_micro():
return datetime(2017, 8, 21, 10, 12, 45, 22)
@pytest.fixture
def datetime_simple():
return datetime(2017, 8, 21, 10, 12, 45)
@pytest.fixture
def time_with_micro():
return time(10, 12, 45, 22)
@pytest.fixture
def time_simple():
return time(10, 12, 45)
@pytest.fixture
def date_simple():
return date(2017, 8, 21)
@pytest.mark.skipif('cryptography is None')
class EncryptedTypeTestCase:
@pytest.fixture
def Team(self, Base, encryption_engine, padding_mechanism):
self._team_key = None
class Team(Base):
__tablename__ = 'team'
id = sa.Column(sa.Integer, primary_key=True)
key = sa.Column(sa.String(50))
name = sa.Column(StringEncryptedType(
sa.Unicode,
lambda: self._team_key,
encryption_engine,
padding_mechanism)
)
return Team
@pytest.fixture
def init_models(self, User, Team):
pass
def test_unicode(self, user, user_name):
assert user.username == user_name
def test_string(self, user, test_token):
assert user.access_token == test_token
def test_boolean(self, user, active):
assert user.is_active == active
def test_integer(self, user, accounts_num):
assert user.accounts_num == accounts_num
def test_phone_number(self, user, user_phone):
assert str(user.phone) == user_phone
def test_color(self, user, user_color):
assert user.color.hex == user_color
def test_date(self, user, user_date):
assert user.date == user_date
def test_datetime(self, user, user_datetime):
assert user.datetime == user_datetime
def test_time(self, user, user_time):
assert user.time == user_time
def test_enum(self, user, user_enum):
assert user.enum == user_enum
def test_json(self, user, user_json):
assert user.json == user_json
def test_lookup_key(self, session, Team):
# Add teams
self._team_key = 'one'
team = Team(key=self._team_key, name='One')
session.add(team)
session.commit()
team_1_id = team.id
self._team_key = 'two'
team = Team(key=self._team_key)
team.name = 'Two'
session.add(team)
session.commit()
team_2_id = team.id
# Lookup teams
self._team_key = session.query(Team.key).filter_by(
id=team_1_id
).one()[0]
try:
team = session.get(Team, team_1_id)
except AttributeError:
# sqlalchemy 1.3
team = session.query(Team).get(team_1_id)
assert team.name == 'One'
session.expunge_all()
self._team_key = session.query(Team.key).filter_by(
id=team_2_id
).one()[0]
try:
team = session.get(Team, team_2_id)
except AttributeError:
# sqlalchemy 1.3
team = session.query(Team).get(team_2_id)
assert team.name == 'Two'
session.expunge_all()
# Remove teams
session.query(Team).delete()
session.commit()
class AesEncryptedTypeTestCase(EncryptedTypeTestCase):
@pytest.fixture
def encryption_engine(self):
return AesEngine
def test_lookup_by_encrypted_string(self, session, User, user, user_name):
test = session.query(User).filter(
User.username == user_name
).first()
assert test.username == user.username
class TestAesEncryptedTypeWithPKCS5Padding(AesEncryptedTypeTestCase):
@pytest.fixture
def padding_mechanism(self):
return 'pkcs5'
class TestAesEncryptedTypeWithOneAndZeroesPadding(AesEncryptedTypeTestCase):
@pytest.fixture
def padding_mechanism(self):
return 'oneandzeroes'
class TestAesEncryptedTypeWithZeroesPadding(AesEncryptedTypeTestCase):
@pytest.fixture
def padding_mechanism(self):
return 'zeroes'
class TestAesEncryptedTypeTestcaseWithNaivePadding(AesEncryptedTypeTestCase):
@pytest.fixture
def padding_mechanism(self):
return 'naive'
def test_decrypt_raises_value_error_with_invalid_key(self, session, Team):
self._team_key = 'one'
team = Team(key=self._team_key, name='One')
session.add(team)
session.commit()
self._team_key = 'notone'
with pytest.raises(ValueError):
assert team.name == 'One'
class TestFernetEncryptedTypeTestCase(EncryptedTypeTestCase):
@pytest.fixture
def encryption_engine(self):
return FernetEngine
@pytest.fixture
def padding_mechanism(self):
return None
class TestDatetimeHandler:
def test_datetime_with_micro_and_timezone(
self, datetime_with_micro_and_timezone
):
original_datetime = datetime_with_micro_and_timezone
original_datetime_isoformat = original_datetime.isoformat()
python_type = datetime
assert DatetimeHandler.process_value(
original_datetime_isoformat,
python_type
) == original_datetime
def test_datetime_with_micro(self, datetime_with_micro):
original_datetime = datetime_with_micro
original_datetime_isoformat = original_datetime.isoformat()
python_type = datetime
assert DatetimeHandler.process_value(
original_datetime_isoformat,
python_type
) == original_datetime
def test_datetime_simple(self, datetime_simple):
original_datetime = datetime_simple
original_datetime_isoformat = original_datetime.isoformat()
python_type = datetime
assert DatetimeHandler.process_value(
original_datetime_isoformat,
python_type
) == original_datetime
def test_time_with_micro(self, time_with_micro):
original_time = time_with_micro
original_time_isoformat = original_time.isoformat()
python_type = time
assert DatetimeHandler.process_value(
original_time_isoformat,
python_type
) == original_time
def test_time_simple(self, time_simple):
original_time = time_simple
original_time_isoformat = original_time.isoformat()
python_type = time
assert DatetimeHandler.process_value(
original_time_isoformat,
python_type
) == original_time
def test_date_simple(self, date_simple):
original_date = date_simple
original_date_isoformat = original_date.isoformat()
python_type = date
assert DatetimeHandler.process_value(
original_date_isoformat,
python_type
) == original_date
@pytest.mark.skipif('cryptography is None')
class TestAesGcmEngine:
KEY = b'0123456789ABCDEF'
def setup_method(self):
self.engine = AesGcmEngine()
self.engine._initialize_engine(TestAesGcmEngine.KEY)
def test_roundtrip(self):
for number in range(0, 36):
plaintext = '0123456789abcdefghijklmnopqrstuvwxyz'[:number]
encrypted = self.engine.encrypt(plaintext)
decrypted = self.engine.decrypt(encrypted)
assert plaintext == decrypted, (
"Round-trip failed for len: %d" % number
)
def test_modified_iv_fails_to_decrypt(self):
plaintext = 'abcdefgh'
encrypted = self.engine.encrypt(plaintext)
# 3rd char will be IV. Modify it
POS = 3
encrypted = encrypted[:POS] + \
('A' if encrypted[POS] != 'A' else 'B') + \
encrypted[POS + 1:]
with pytest.raises(InvalidCiphertextError):
self.engine.decrypt(encrypted)
def test_modified_tag_fails_to_decrypt(self):
plaintext = 'abcdefgh'
encrypted = self.engine.encrypt(plaintext)
# 19th char will be tag. Modify it
POS = 19
encrypted = encrypted[:POS] + \
('A' if encrypted[POS] != 'A' else 'B') + \
encrypted[POS + 1:]
with pytest.raises(InvalidCiphertextError):
self.engine.decrypt(encrypted)
def test_modified_ciphertext_fails_to_decrypt(self):
plaintext = 'abcdefgh'
encrypted = self.engine.encrypt(plaintext)
# 43rd char will be ciphertext. Modify it
POS = 43
encrypted = encrypted[:POS] + \
('A' if encrypted[POS] != 'A' else 'B') + \
encrypted[POS + 1:]
with pytest.raises(InvalidCiphertextError):
self.engine.decrypt(encrypted)
def test_too_short_ciphertext_fails_to_decrypt(self):
plaintext = 'abcdefgh'
encrypted = self.engine.encrypt(plaintext)[:20]
with pytest.raises(InvalidCiphertextError):
self.engine.decrypt(encrypted)
def test_different_ciphertexts_each_time(self):
plaintext = 'abcdefgh'
encrypted1 = self.engine.encrypt(plaintext)
encrypted2 = self.engine.encrypt(plaintext)
assert self.engine.decrypt(encrypted1) == \
self.engine.decrypt(encrypted2)
# The following has a very low probability of failing
# accidentally (2^-96)
assert encrypted1 != encrypted2
class TestAesGcmEncryptedType(EncryptedTypeTestCase):
@pytest.fixture
def encryption_engine(self):
return AesGcmEngine
# GCM doesn't need padding. This is here just because we're reusing test
# code that requires this
@pytest.fixture
def padding_mechanism(self):
return 'pkcs5'
def test_lookup_by_encrypted_string(self, session, User, user, user_name):
test = session.query(User).filter(
User.username == "someonex"
).first()
# With probability 1-2^-96, the 2 different encryptions will choose a
# different IV, and will therefore result in different ciphertexts.
# Thus, the 2 values will almost certainly be different, even though
# we're really searching for the same username. Hence, the above search
# will fail
assert test is None
|