test_context_deprecated.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. """tests for passlib.context
  2. this file is a clone of the 1.5 test_context.py,
  3. containing the tests using the legacy CryptPolicy api.
  4. it's being preserved here to ensure the old api doesn't break
  5. (until Passlib 1.8, when this and the legacy api will be removed).
  6. """
  7. #=============================================================================
  8. # imports
  9. #=============================================================================
  10. from __future__ import with_statement
  11. # core
  12. from logging import getLogger
  13. import os
  14. import warnings
  15. # site
  16. try:
  17. from pkg_resources import resource_filename
  18. except ImportError:
  19. resource_filename = None
  20. # pkg
  21. from passlib import hash
  22. from passlib.context import CryptContext, CryptPolicy, LazyCryptContext
  23. from passlib.utils import to_bytes, to_unicode
  24. import passlib.utils.handlers as uh
  25. from passlib.tests.utils import TestCase, set_file
  26. from passlib.registry import (register_crypt_handler_path,
  27. _has_crypt_handler as has_crypt_handler,
  28. _unload_handler_name as unload_handler_name,
  29. )
  30. # module
  31. log = getLogger(__name__)
  32. #=============================================================================
  33. #
  34. #=============================================================================
  35. class CryptPolicyTest(TestCase):
  36. """test CryptPolicy object"""
  37. # TODO: need to test user categories w/in all this
  38. descriptionPrefix = "CryptPolicy"
  39. #===================================================================
  40. # sample crypt policies used for testing
  41. #===================================================================
  42. #---------------------------------------------------------------
  43. # sample 1 - average config file
  44. #---------------------------------------------------------------
  45. # NOTE: copy of this is stored in file passlib/tests/sample_config_1s.cfg
  46. sample_config_1s = """\
  47. [passlib]
  48. schemes = des_crypt, md5_crypt, bsdi_crypt, sha512_crypt
  49. default = md5_crypt
  50. all.vary_rounds = 10%%
  51. bsdi_crypt.max_rounds = 30000
  52. bsdi_crypt.default_rounds = 25000
  53. sha512_crypt.max_rounds = 50000
  54. sha512_crypt.min_rounds = 40000
  55. """
  56. sample_config_1s_path = os.path.abspath(os.path.join(
  57. os.path.dirname(__file__), "sample_config_1s.cfg"))
  58. if not os.path.exists(sample_config_1s_path) and resource_filename:
  59. # in case we're zipped up in an egg.
  60. sample_config_1s_path = resource_filename("passlib.tests",
  61. "sample_config_1s.cfg")
  62. # make sure sample_config_1s uses \n linesep - tests rely on this
  63. assert sample_config_1s.startswith("[passlib]\nschemes")
  64. sample_config_1pd = dict(
  65. schemes = [ "des_crypt", "md5_crypt", "bsdi_crypt", "sha512_crypt"],
  66. default = "md5_crypt",
  67. # NOTE: not maintaining backwards compat for rendering to "10%"
  68. all__vary_rounds = 0.1,
  69. bsdi_crypt__max_rounds = 30000,
  70. bsdi_crypt__default_rounds = 25000,
  71. sha512_crypt__max_rounds = 50000,
  72. sha512_crypt__min_rounds = 40000,
  73. )
  74. sample_config_1pid = {
  75. "schemes": "des_crypt, md5_crypt, bsdi_crypt, sha512_crypt",
  76. "default": "md5_crypt",
  77. # NOTE: not maintaining backwards compat for rendering to "10%"
  78. "all.vary_rounds": 0.1,
  79. "bsdi_crypt.max_rounds": 30000,
  80. "bsdi_crypt.default_rounds": 25000,
  81. "sha512_crypt.max_rounds": 50000,
  82. "sha512_crypt.min_rounds": 40000,
  83. }
  84. sample_config_1prd = dict(
  85. schemes = [ hash.des_crypt, hash.md5_crypt, hash.bsdi_crypt, hash.sha512_crypt],
  86. default = "md5_crypt", # NOTE: passlib <= 1.5 was handler obj.
  87. # NOTE: not maintaining backwards compat for rendering to "10%"
  88. all__vary_rounds = 0.1,
  89. bsdi_crypt__max_rounds = 30000,
  90. bsdi_crypt__default_rounds = 25000,
  91. sha512_crypt__max_rounds = 50000,
  92. sha512_crypt__min_rounds = 40000,
  93. )
  94. #---------------------------------------------------------------
  95. # sample 2 - partial policy & result of overlay on sample 1
  96. #---------------------------------------------------------------
  97. sample_config_2s = """\
  98. [passlib]
  99. bsdi_crypt.min_rounds = 29000
  100. bsdi_crypt.max_rounds = 35000
  101. bsdi_crypt.default_rounds = 31000
  102. sha512_crypt.min_rounds = 45000
  103. """
  104. sample_config_2pd = dict(
  105. # using this to test full replacement of existing options
  106. bsdi_crypt__min_rounds = 29000,
  107. bsdi_crypt__max_rounds = 35000,
  108. bsdi_crypt__default_rounds = 31000,
  109. # using this to test partial replacement of existing options
  110. sha512_crypt__min_rounds=45000,
  111. )
  112. sample_config_12pd = dict(
  113. schemes = [ "des_crypt", "md5_crypt", "bsdi_crypt", "sha512_crypt"],
  114. default = "md5_crypt",
  115. # NOTE: not maintaining backwards compat for rendering to "10%"
  116. all__vary_rounds = 0.1,
  117. bsdi_crypt__min_rounds = 29000,
  118. bsdi_crypt__max_rounds = 35000,
  119. bsdi_crypt__default_rounds = 31000,
  120. sha512_crypt__max_rounds = 50000,
  121. sha512_crypt__min_rounds=45000,
  122. )
  123. #---------------------------------------------------------------
  124. # sample 3 - just changing default
  125. #---------------------------------------------------------------
  126. sample_config_3pd = dict(
  127. default="sha512_crypt",
  128. )
  129. sample_config_123pd = dict(
  130. schemes = [ "des_crypt", "md5_crypt", "bsdi_crypt", "sha512_crypt"],
  131. default = "sha512_crypt",
  132. # NOTE: not maintaining backwards compat for rendering to "10%"
  133. all__vary_rounds = 0.1,
  134. bsdi_crypt__min_rounds = 29000,
  135. bsdi_crypt__max_rounds = 35000,
  136. bsdi_crypt__default_rounds = 31000,
  137. sha512_crypt__max_rounds = 50000,
  138. sha512_crypt__min_rounds=45000,
  139. )
  140. #---------------------------------------------------------------
  141. # sample 4 - category specific
  142. #---------------------------------------------------------------
  143. sample_config_4s = """
  144. [passlib]
  145. schemes = sha512_crypt
  146. all.vary_rounds = 10%%
  147. default.sha512_crypt.max_rounds = 20000
  148. admin.all.vary_rounds = 5%%
  149. admin.sha512_crypt.max_rounds = 40000
  150. """
  151. sample_config_4pd = dict(
  152. schemes = [ "sha512_crypt" ],
  153. # NOTE: not maintaining backwards compat for rendering to "10%"
  154. all__vary_rounds = 0.1,
  155. sha512_crypt__max_rounds = 20000,
  156. # NOTE: not maintaining backwards compat for rendering to "5%"
  157. admin__all__vary_rounds = 0.05,
  158. admin__sha512_crypt__max_rounds = 40000,
  159. )
  160. #---------------------------------------------------------------
  161. # sample 5 - to_string & deprecation testing
  162. #---------------------------------------------------------------
  163. sample_config_5s = sample_config_1s + """\
  164. deprecated = des_crypt
  165. admin__context__deprecated = des_crypt, bsdi_crypt
  166. """
  167. sample_config_5pd = sample_config_1pd.copy()
  168. sample_config_5pd.update(
  169. deprecated = [ "des_crypt" ],
  170. admin__context__deprecated = [ "des_crypt", "bsdi_crypt" ],
  171. )
  172. sample_config_5pid = sample_config_1pid.copy()
  173. sample_config_5pid.update({
  174. "deprecated": "des_crypt",
  175. "admin.context.deprecated": "des_crypt, bsdi_crypt",
  176. })
  177. sample_config_5prd = sample_config_1prd.copy()
  178. sample_config_5prd.update({
  179. # XXX: should deprecated return the actual handlers in this case?
  180. # would have to modify how policy stores info, for one.
  181. "deprecated": ["des_crypt"],
  182. "admin__context__deprecated": ["des_crypt", "bsdi_crypt"],
  183. })
  184. #===================================================================
  185. # constructors
  186. #===================================================================
  187. def setUp(self):
  188. TestCase.setUp(self)
  189. warnings.filterwarnings("ignore",
  190. r"The CryptPolicy class has been deprecated")
  191. warnings.filterwarnings("ignore",
  192. r"the method.*hash_needs_update.*is deprecated")
  193. warnings.filterwarnings("ignore", "The 'all' scheme is deprecated.*")
  194. warnings.filterwarnings("ignore", "bsdi_crypt rounds should be odd")
  195. def test_00_constructor(self):
  196. """test CryptPolicy() constructor"""
  197. policy = CryptPolicy(**self.sample_config_1pd)
  198. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  199. policy = CryptPolicy(self.sample_config_1pd)
  200. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  201. self.assertRaises(TypeError, CryptPolicy, {}, {})
  202. self.assertRaises(TypeError, CryptPolicy, {}, dummy=1)
  203. # check key with too many separators is rejected
  204. self.assertRaises(TypeError, CryptPolicy,
  205. schemes = [ "des_crypt", "md5_crypt", "bsdi_crypt", "sha512_crypt"],
  206. bad__key__bsdi_crypt__max_rounds = 30000,
  207. )
  208. # check nameless handler rejected
  209. class nameless(uh.StaticHandler):
  210. name = None
  211. self.assertRaises(ValueError, CryptPolicy, schemes=[nameless])
  212. # check scheme must be name or crypt handler
  213. self.assertRaises(TypeError, CryptPolicy, schemes=[uh.StaticHandler])
  214. # check name conflicts are rejected
  215. class dummy_1(uh.StaticHandler):
  216. name = 'dummy_1'
  217. self.assertRaises(KeyError, CryptPolicy, schemes=[dummy_1, dummy_1])
  218. # with unknown deprecated value
  219. self.assertRaises(KeyError, CryptPolicy,
  220. schemes=['des_crypt'],
  221. deprecated=['md5_crypt'])
  222. # with unknown default value
  223. self.assertRaises(KeyError, CryptPolicy,
  224. schemes=['des_crypt'],
  225. default='md5_crypt')
  226. def test_01_from_path_simple(self):
  227. """test CryptPolicy.from_path() constructor"""
  228. # NOTE: this is separate so it can also run under GAE
  229. # test preset stored in existing file
  230. path = self.sample_config_1s_path
  231. policy = CryptPolicy.from_path(path)
  232. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  233. # test if path missing
  234. self.assertRaises(EnvironmentError, CryptPolicy.from_path, path + 'xxx')
  235. def test_01_from_path(self):
  236. """test CryptPolicy.from_path() constructor with encodings"""
  237. path = self.mktemp()
  238. # test "\n" linesep
  239. set_file(path, self.sample_config_1s)
  240. policy = CryptPolicy.from_path(path)
  241. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  242. # test "\r\n" linesep
  243. set_file(path, self.sample_config_1s.replace("\n","\r\n"))
  244. policy = CryptPolicy.from_path(path)
  245. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  246. # test with custom encoding
  247. uc2 = to_bytes(self.sample_config_1s, "utf-16", source_encoding="utf-8")
  248. set_file(path, uc2)
  249. policy = CryptPolicy.from_path(path, encoding="utf-16")
  250. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  251. def test_02_from_string(self):
  252. """test CryptPolicy.from_string() constructor"""
  253. # test "\n" linesep
  254. policy = CryptPolicy.from_string(self.sample_config_1s)
  255. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  256. # test "\r\n" linesep
  257. policy = CryptPolicy.from_string(
  258. self.sample_config_1s.replace("\n","\r\n"))
  259. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  260. # test with unicode
  261. data = to_unicode(self.sample_config_1s)
  262. policy = CryptPolicy.from_string(data)
  263. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  264. # test with non-ascii-compatible encoding
  265. uc2 = to_bytes(self.sample_config_1s, "utf-16", source_encoding="utf-8")
  266. policy = CryptPolicy.from_string(uc2, encoding="utf-16")
  267. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  268. # test category specific options
  269. policy = CryptPolicy.from_string(self.sample_config_4s)
  270. self.assertEqual(policy.to_dict(), self.sample_config_4pd)
  271. def test_03_from_source(self):
  272. """test CryptPolicy.from_source() constructor"""
  273. # pass it a path
  274. policy = CryptPolicy.from_source(self.sample_config_1s_path)
  275. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  276. # pass it a string
  277. policy = CryptPolicy.from_source(self.sample_config_1s)
  278. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  279. # pass it a dict (NOTE: make a copy to detect in-place modifications)
  280. policy = CryptPolicy.from_source(self.sample_config_1pd.copy())
  281. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  282. # pass it existing policy
  283. p2 = CryptPolicy.from_source(policy)
  284. self.assertIs(policy, p2)
  285. # pass it something wrong
  286. self.assertRaises(TypeError, CryptPolicy.from_source, 1)
  287. self.assertRaises(TypeError, CryptPolicy.from_source, [])
  288. def test_04_from_sources(self):
  289. """test CryptPolicy.from_sources() constructor"""
  290. # pass it empty list
  291. self.assertRaises(ValueError, CryptPolicy.from_sources, [])
  292. # pass it one-element list
  293. policy = CryptPolicy.from_sources([self.sample_config_1s])
  294. self.assertEqual(policy.to_dict(), self.sample_config_1pd)
  295. # pass multiple sources
  296. policy = CryptPolicy.from_sources(
  297. [
  298. self.sample_config_1s_path,
  299. self.sample_config_2s,
  300. self.sample_config_3pd,
  301. ])
  302. self.assertEqual(policy.to_dict(), self.sample_config_123pd)
  303. def test_05_replace(self):
  304. """test CryptPolicy.replace() constructor"""
  305. p1 = CryptPolicy(**self.sample_config_1pd)
  306. # check overlaying sample 2
  307. p2 = p1.replace(**self.sample_config_2pd)
  308. self.assertEqual(p2.to_dict(), self.sample_config_12pd)
  309. # check repeating overlay makes no change
  310. p2b = p2.replace(**self.sample_config_2pd)
  311. self.assertEqual(p2b.to_dict(), self.sample_config_12pd)
  312. # check overlaying sample 3
  313. p3 = p2.replace(self.sample_config_3pd)
  314. self.assertEqual(p3.to_dict(), self.sample_config_123pd)
  315. def test_06_forbidden(self):
  316. """test CryptPolicy() forbidden kwds"""
  317. # salt not allowed to be set
  318. self.assertRaises(KeyError, CryptPolicy,
  319. schemes=["des_crypt"],
  320. des_crypt__salt="xx",
  321. )
  322. self.assertRaises(KeyError, CryptPolicy,
  323. schemes=["des_crypt"],
  324. all__salt="xx",
  325. )
  326. # schemes not allowed for category
  327. self.assertRaises(KeyError, CryptPolicy,
  328. schemes=["des_crypt"],
  329. user__context__schemes=["md5_crypt"],
  330. )
  331. #===================================================================
  332. # reading
  333. #===================================================================
  334. def test_10_has_schemes(self):
  335. """test has_schemes() method"""
  336. p1 = CryptPolicy(**self.sample_config_1pd)
  337. self.assertTrue(p1.has_schemes())
  338. p3 = CryptPolicy(**self.sample_config_3pd)
  339. self.assertTrue(not p3.has_schemes())
  340. def test_11_iter_handlers(self):
  341. """test iter_handlers() method"""
  342. p1 = CryptPolicy(**self.sample_config_1pd)
  343. s = self.sample_config_1prd['schemes']
  344. self.assertEqual(list(p1.iter_handlers()), s)
  345. p3 = CryptPolicy(**self.sample_config_3pd)
  346. self.assertEqual(list(p3.iter_handlers()), [])
  347. def test_12_get_handler(self):
  348. """test get_handler() method"""
  349. p1 = CryptPolicy(**self.sample_config_1pd)
  350. # check by name
  351. self.assertIs(p1.get_handler("bsdi_crypt"), hash.bsdi_crypt)
  352. # check by missing name
  353. self.assertIs(p1.get_handler("sha256_crypt"), None)
  354. self.assertRaises(KeyError, p1.get_handler, "sha256_crypt", required=True)
  355. # check default
  356. self.assertIs(p1.get_handler(), hash.md5_crypt)
  357. def test_13_get_options(self):
  358. """test get_options() method"""
  359. p12 = CryptPolicy(**self.sample_config_12pd)
  360. self.assertEqual(p12.get_options("bsdi_crypt"),dict(
  361. # NOTE: not maintaining backwards compat for rendering to "10%"
  362. vary_rounds = 0.1,
  363. min_rounds = 29000,
  364. max_rounds = 35000,
  365. default_rounds = 31000,
  366. ))
  367. self.assertEqual(p12.get_options("sha512_crypt"),dict(
  368. # NOTE: not maintaining backwards compat for rendering to "10%"
  369. vary_rounds = 0.1,
  370. min_rounds = 45000,
  371. max_rounds = 50000,
  372. ))
  373. p4 = CryptPolicy.from_string(self.sample_config_4s)
  374. self.assertEqual(p4.get_options("sha512_crypt"), dict(
  375. # NOTE: not maintaining backwards compat for rendering to "10%"
  376. vary_rounds=0.1,
  377. max_rounds=20000,
  378. ))
  379. self.assertEqual(p4.get_options("sha512_crypt", "user"), dict(
  380. # NOTE: not maintaining backwards compat for rendering to "10%"
  381. vary_rounds=0.1,
  382. max_rounds=20000,
  383. ))
  384. self.assertEqual(p4.get_options("sha512_crypt", "admin"), dict(
  385. # NOTE: not maintaining backwards compat for rendering to "5%"
  386. vary_rounds=0.05,
  387. max_rounds=40000,
  388. ))
  389. def test_14_handler_is_deprecated(self):
  390. """test handler_is_deprecated() method"""
  391. pa = CryptPolicy(**self.sample_config_1pd)
  392. pb = CryptPolicy(**self.sample_config_5pd)
  393. self.assertFalse(pa.handler_is_deprecated("des_crypt"))
  394. self.assertFalse(pa.handler_is_deprecated(hash.bsdi_crypt))
  395. self.assertFalse(pa.handler_is_deprecated("sha512_crypt"))
  396. self.assertTrue(pb.handler_is_deprecated("des_crypt"))
  397. self.assertFalse(pb.handler_is_deprecated(hash.bsdi_crypt))
  398. self.assertFalse(pb.handler_is_deprecated("sha512_crypt"))
  399. # check categories as well
  400. self.assertTrue(pb.handler_is_deprecated("des_crypt", "user"))
  401. self.assertFalse(pb.handler_is_deprecated("bsdi_crypt", "user"))
  402. self.assertTrue(pb.handler_is_deprecated("des_crypt", "admin"))
  403. self.assertTrue(pb.handler_is_deprecated("bsdi_crypt", "admin"))
  404. # check deprecation is overridden per category
  405. pc = CryptPolicy(
  406. schemes=["md5_crypt", "des_crypt"],
  407. deprecated=["md5_crypt"],
  408. user__context__deprecated=["des_crypt"],
  409. )
  410. self.assertTrue(pc.handler_is_deprecated("md5_crypt"))
  411. self.assertFalse(pc.handler_is_deprecated("des_crypt"))
  412. self.assertFalse(pc.handler_is_deprecated("md5_crypt", "user"))
  413. self.assertTrue(pc.handler_is_deprecated("des_crypt", "user"))
  414. def test_15_min_verify_time(self):
  415. """test get_min_verify_time() method"""
  416. # silence deprecation warnings for min verify time
  417. warnings.filterwarnings("ignore", category=DeprecationWarning)
  418. pa = CryptPolicy()
  419. self.assertEqual(pa.get_min_verify_time(), 0)
  420. self.assertEqual(pa.get_min_verify_time('admin'), 0)
  421. pb = pa.replace(min_verify_time=.1)
  422. self.assertEqual(pb.get_min_verify_time(), 0)
  423. self.assertEqual(pb.get_min_verify_time('admin'), 0)
  424. #===================================================================
  425. # serialization
  426. #===================================================================
  427. def test_20_iter_config(self):
  428. """test iter_config() method"""
  429. p5 = CryptPolicy(**self.sample_config_5pd)
  430. self.assertEqual(dict(p5.iter_config()), self.sample_config_5pd)
  431. self.assertEqual(dict(p5.iter_config(resolve=True)), self.sample_config_5prd)
  432. self.assertEqual(dict(p5.iter_config(ini=True)), self.sample_config_5pid)
  433. def test_21_to_dict(self):
  434. """test to_dict() method"""
  435. p5 = CryptPolicy(**self.sample_config_5pd)
  436. self.assertEqual(p5.to_dict(), self.sample_config_5pd)
  437. self.assertEqual(p5.to_dict(resolve=True), self.sample_config_5prd)
  438. def test_22_to_string(self):
  439. """test to_string() method"""
  440. pa = CryptPolicy(**self.sample_config_5pd)
  441. s = pa.to_string() # NOTE: can't compare string directly, ordering etc may not match
  442. pb = CryptPolicy.from_string(s)
  443. self.assertEqual(pb.to_dict(), self.sample_config_5pd)
  444. s = pa.to_string(encoding="latin-1")
  445. self.assertIsInstance(s, bytes)
  446. #===================================================================
  447. #
  448. #===================================================================
  449. #=============================================================================
  450. # CryptContext
  451. #=============================================================================
  452. class CryptContextTest(TestCase):
  453. """test CryptContext class"""
  454. descriptionPrefix = "CryptContext"
  455. def setUp(self):
  456. TestCase.setUp(self)
  457. warnings.filterwarnings("ignore",
  458. r"CryptContext\(\)\.replace\(\) has been deprecated.*")
  459. warnings.filterwarnings("ignore",
  460. r"The CryptContext ``policy`` keyword has been deprecated.*")
  461. warnings.filterwarnings("ignore", ".*(CryptPolicy|context\.policy).*(has|have) been deprecated.*")
  462. warnings.filterwarnings("ignore",
  463. r"the method.*hash_needs_update.*is deprecated")
  464. #===================================================================
  465. # constructor
  466. #===================================================================
  467. def test_00_constructor(self):
  468. """test constructor"""
  469. # create crypt context using handlers
  470. cc = CryptContext([hash.md5_crypt, hash.bsdi_crypt, hash.des_crypt])
  471. c,b,a = cc.policy.iter_handlers()
  472. self.assertIs(a, hash.des_crypt)
  473. self.assertIs(b, hash.bsdi_crypt)
  474. self.assertIs(c, hash.md5_crypt)
  475. # create context using names
  476. cc = CryptContext(["md5_crypt", "bsdi_crypt", "des_crypt"])
  477. c,b,a = cc.policy.iter_handlers()
  478. self.assertIs(a, hash.des_crypt)
  479. self.assertIs(b, hash.bsdi_crypt)
  480. self.assertIs(c, hash.md5_crypt)
  481. # policy kwd
  482. policy = cc.policy
  483. cc = CryptContext(policy=policy)
  484. self.assertEqual(cc.to_dict(), policy.to_dict())
  485. cc = CryptContext(policy=policy, default="bsdi_crypt")
  486. self.assertNotEqual(cc.to_dict(), policy.to_dict())
  487. self.assertEqual(cc.to_dict(), dict(schemes=["md5_crypt","bsdi_crypt","des_crypt"],
  488. default="bsdi_crypt"))
  489. self.assertRaises(TypeError, setattr, cc, 'policy', None)
  490. self.assertRaises(TypeError, CryptContext, policy='x')
  491. def test_01_replace(self):
  492. """test replace()"""
  493. cc = CryptContext(["md5_crypt", "bsdi_crypt", "des_crypt"])
  494. self.assertIs(cc.policy.get_handler(), hash.md5_crypt)
  495. cc2 = cc.replace()
  496. self.assertIsNot(cc2, cc)
  497. # NOTE: was not able to maintain backward compatibility with this...
  498. ##self.assertIs(cc2.policy, cc.policy)
  499. cc3 = cc.replace(default="bsdi_crypt")
  500. self.assertIsNot(cc3, cc)
  501. # NOTE: was not able to maintain backward compatibility with this...
  502. ##self.assertIs(cc3.policy, cc.policy)
  503. self.assertIs(cc3.policy.get_handler(), hash.bsdi_crypt)
  504. def test_02_no_handlers(self):
  505. """test no handlers"""
  506. # check constructor...
  507. cc = CryptContext()
  508. self.assertRaises(KeyError, cc.identify, 'hash', required=True)
  509. self.assertRaises(KeyError, cc.hash, 'secret')
  510. self.assertRaises(KeyError, cc.verify, 'secret', 'hash')
  511. # check updating policy after the fact...
  512. cc = CryptContext(['md5_crypt'])
  513. p = CryptPolicy(schemes=[])
  514. cc.policy = p
  515. self.assertRaises(KeyError, cc.identify, 'hash', required=True)
  516. self.assertRaises(KeyError, cc.hash, 'secret')
  517. self.assertRaises(KeyError, cc.verify, 'secret', 'hash')
  518. #===================================================================
  519. # policy adaptation
  520. #===================================================================
  521. sample_policy_1 = dict(
  522. schemes = [ "des_crypt", "md5_crypt", "phpass", "bsdi_crypt",
  523. "sha256_crypt"],
  524. deprecated = [ "des_crypt", ],
  525. default = "sha256_crypt",
  526. bsdi_crypt__max_rounds = 30,
  527. bsdi_crypt__default_rounds = 25,
  528. bsdi_crypt__vary_rounds = 0,
  529. sha256_crypt__max_rounds = 3000,
  530. sha256_crypt__min_rounds = 2000,
  531. sha256_crypt__default_rounds = 3000,
  532. phpass__ident = "H",
  533. phpass__default_rounds = 7,
  534. )
  535. def test_12_hash_needs_update(self):
  536. """test hash_needs_update() method"""
  537. cc = CryptContext(**self.sample_policy_1)
  538. # check deprecated scheme
  539. self.assertTrue(cc.hash_needs_update('9XXD4trGYeGJA'))
  540. self.assertFalse(cc.hash_needs_update('$1$J8HC2RCr$HcmM.7NxB2weSvlw2FgzU0'))
  541. # check min rounds
  542. self.assertTrue(cc.hash_needs_update('$5$rounds=1999$jD81UCoo.zI.UETs$Y7qSTQ6mTiU9qZB4fRr43wRgQq4V.5AAf7F97Pzxey/'))
  543. self.assertFalse(cc.hash_needs_update('$5$rounds=2000$228SSRje04cnNCaQ$YGV4RYu.5sNiBvorQDlO0WWQjyJVGKBcJXz3OtyQ2u8'))
  544. # check max rounds
  545. self.assertFalse(cc.hash_needs_update('$5$rounds=3000$fS9iazEwTKi7QPW4$VasgBC8FqlOvD7x2HhABaMXCTh9jwHclPA9j5YQdns.'))
  546. self.assertTrue(cc.hash_needs_update('$5$rounds=3001$QlFHHifXvpFX4PLs$/0ekt7lSs/lOikSerQ0M/1porEHxYq7W/2hdFpxA3fA'))
  547. #===================================================================
  548. # border cases
  549. #===================================================================
  550. def test_30_nonstring_hash(self):
  551. """test non-string hash values cause error"""
  552. warnings.filterwarnings("ignore", ".*needs_update.*'scheme' keyword is deprecated.*")
  553. #
  554. # test hash=None or some other non-string causes TypeError
  555. # and that explicit-scheme code path behaves the same.
  556. #
  557. cc = CryptContext(["des_crypt"])
  558. for hash, kwds in [
  559. (None, {}),
  560. # NOTE: 'scheme' kwd is deprecated...
  561. (None, {"scheme": "des_crypt"}),
  562. (1, {}),
  563. ((), {}),
  564. ]:
  565. self.assertRaises(TypeError, cc.hash_needs_update, hash, **kwds)
  566. cc2 = CryptContext(["mysql323"])
  567. self.assertRaises(TypeError, cc2.hash_needs_update, None)
  568. #===================================================================
  569. # eoc
  570. #===================================================================
  571. #=============================================================================
  572. # LazyCryptContext
  573. #=============================================================================
  574. class dummy_2(uh.StaticHandler):
  575. name = "dummy_2"
  576. class LazyCryptContextTest(TestCase):
  577. descriptionPrefix = "LazyCryptContext"
  578. def setUp(self):
  579. TestCase.setUp(self)
  580. # make sure this isn't registered before OR after
  581. unload_handler_name("dummy_2")
  582. self.addCleanup(unload_handler_name, "dummy_2")
  583. # silence some warnings
  584. warnings.filterwarnings("ignore",
  585. r"CryptContext\(\)\.replace\(\) has been deprecated")
  586. warnings.filterwarnings("ignore", ".*(CryptPolicy|context\.policy).*(has|have) been deprecated.*")
  587. def test_kwd_constructor(self):
  588. """test plain kwds"""
  589. self.assertFalse(has_crypt_handler("dummy_2"))
  590. register_crypt_handler_path("dummy_2", "passlib.tests.test_context")
  591. cc = LazyCryptContext(iter(["dummy_2", "des_crypt"]), deprecated=["des_crypt"])
  592. self.assertFalse(has_crypt_handler("dummy_2", True))
  593. self.assertTrue(cc.policy.handler_is_deprecated("des_crypt"))
  594. self.assertEqual(cc.policy.schemes(), ["dummy_2", "des_crypt"])
  595. self.assertTrue(has_crypt_handler("dummy_2", True))
  596. def test_callable_constructor(self):
  597. """test create_policy() hook, returning CryptPolicy"""
  598. self.assertFalse(has_crypt_handler("dummy_2"))
  599. register_crypt_handler_path("dummy_2", "passlib.tests.test_context")
  600. def create_policy(flag=False):
  601. self.assertTrue(flag)
  602. return CryptPolicy(schemes=iter(["dummy_2", "des_crypt"]), deprecated=["des_crypt"])
  603. cc = LazyCryptContext(create_policy=create_policy, flag=True)
  604. self.assertFalse(has_crypt_handler("dummy_2", True))
  605. self.assertTrue(cc.policy.handler_is_deprecated("des_crypt"))
  606. self.assertEqual(cc.policy.schemes(), ["dummy_2", "des_crypt"])
  607. self.assertTrue(has_crypt_handler("dummy_2", True))
  608. #=============================================================================
  609. # eof
  610. #=============================================================================