base.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729
  1. import base64
  2. import random
  3. import re
  4. import string
  5. from django.utils import timezone
  6. from httpretty import httpretty, core as hr_core
  7. from rest_framework.reverse import reverse
  8. from rest_framework.test import APITestCase, APIClient
  9. from rest_framework.utils import json
  10. from api import settings
  11. from desecapi.models import User, Domain, Token, RRset, RR
  12. class DesecAPIClient(APIClient):
  13. @staticmethod
  14. def _http_header_base64_conversion(content):
  15. return base64.b64encode(content.encode()).decode()
  16. def set_credentials(self, authorization):
  17. self.credentials(HTTP_AUTHORIZATION=authorization)
  18. def set_credentials_basic_auth(self, part_1, part_2=None):
  19. if not part_1 and not part_2:
  20. self.set_credentials('')
  21. else:
  22. s = part_1 if not part_2 else '%s:%s' % (part_1, part_2)
  23. self.set_credentials('Basic ' + self._http_header_base64_conversion(s))
  24. def set_credentials_token_auth(self, token):
  25. if token is None:
  26. self.set_credentials('')
  27. else:
  28. self.set_credentials('Token ' + token)
  29. def __init__(self, *args, **kwargs):
  30. super().__init__(*args, **kwargs)
  31. self.reverse = DesecTestCase.reverse
  32. def post_rr_set(self, domain_name, **kwargs):
  33. kwargs.setdefault('subname', '')
  34. kwargs.setdefault('ttl', 60)
  35. return self.post(
  36. self.reverse('v1:rrsets', name=domain_name),
  37. kwargs,
  38. )
  39. def get_rr_sets(self, domain_name, **kwargs):
  40. return self.get(
  41. self.reverse('v1:rrsets', name=domain_name),
  42. kwargs
  43. )
  44. def get_rr_set(self, domain_name, subname, type_):
  45. return self.get(
  46. self.reverse('v1:rrset@', name=domain_name, subname=subname, type=type_)
  47. )
  48. def put_rr_set(self, domain_name, subname, type_, **kwargs):
  49. return self.put(
  50. self.reverse('v1:rrset@', name=domain_name, subname=subname, type=type_),
  51. kwargs
  52. )
  53. def patch_rr_set(self, domain_name, subname, type_, **kwargs):
  54. return self.patch(
  55. self.reverse('v1:rrset@', name=domain_name, subname=subname, type=type_),
  56. kwargs
  57. )
  58. def delete_rr_set(self, domain_name, subname, type_):
  59. return self.delete(
  60. self.reverse('v1:rrset@', name=domain_name, subname=subname, type=type_)
  61. )
  62. # TODO add and use {post,get,delete,...}_domain
  63. class AssertRequestsContextManager:
  64. """
  65. Checks that in its context, certain expected requests are made.
  66. """
  67. @classmethod
  68. def _flatten_nested_lists(cls, l):
  69. for i in l:
  70. if isinstance(i, list) or isinstance(i, tuple):
  71. yield from cls._flatten_nested_lists(i)
  72. else:
  73. yield i
  74. def __init__(self, test_case, expected_requests, single_expectation_single_request=True, expect_order=True):
  75. """
  76. Initialize a context that checks for made HTTP requests.
  77. Args:
  78. test_case: Test case in which this context lives. Used to fail test if observed requests do not meet
  79. expectations.
  80. expected_requests: (Possibly nested) list of requests, represented by kwarg-dictionaries for
  81. `httpretty.register_uri`.
  82. single_expectation_single_request: If True (default), each expected request needs to be matched by exactly
  83. one observed request.
  84. expect_order: If True (default), requests made are expected in order of expectations given.
  85. """
  86. self.test_case = test_case
  87. self.expected_requests = list(self._flatten_nested_lists(expected_requests))
  88. self.single_expectation_single_request = single_expectation_single_request
  89. self.expect_order = expect_order
  90. self.old_httpretty_entries = None
  91. def __enter__(self):
  92. hr_core.POTENTIAL_HTTP_PORTS.add(8081) # FIXME should depend on self.expected_requests
  93. self.expected_requests = self.expected_requests
  94. self.old_httpretty_entries = httpretty._entries.copy() # FIXME accessing private properties of httpretty
  95. for request in self.expected_requests:
  96. httpretty.register_uri(**request)
  97. @staticmethod
  98. def _find_matching_request(pattern, requests):
  99. for request in requests:
  100. if pattern['method'] == request[0] and pattern['uri'].match(request[1]):
  101. return request
  102. return None
  103. def __exit__(self, exc_type, exc_val, exc_tb):
  104. # organize seen requests in a primitive data structure
  105. seen_requests = [
  106. (r.command, 'http://%s%s' % (r.headers['Host'], r.path)) for r in httpretty.latest_requests
  107. ]
  108. httpretty.reset()
  109. hr_core.POTENTIAL_HTTP_PORTS.add(8081) # FIXME should depend on self.expected_requests
  110. httpretty._entries = self.old_httpretty_entries
  111. unmatched_requests = seen_requests[:]
  112. # go through expected requests one by one
  113. requests_to_check = list(self.expected_requests)[:]
  114. while requests_to_check:
  115. request = requests_to_check.pop(0)
  116. # match request
  117. match = None
  118. if self.expect_order:
  119. if not self.single_expectation_single_request:
  120. raise ValueError(
  121. 'Checking of multiple (possibly zero) requests per expectation and checking of request '
  122. 'order simultaneously is not implemented, sorry.')
  123. if unmatched_requests:
  124. match = self._find_matching_request(request, [unmatched_requests[0]])
  125. else:
  126. match = self._find_matching_request(
  127. request, unmatched_requests if self.single_expectation_single_request else seen_requests)
  128. # check match
  129. if not match and self.single_expectation_single_request:
  130. self.test_case.fail(('Expected to see a %s request on\n\n%s,\n\nbut only saw these %i '
  131. 'requests:\n\n%s\n\nAll expected requests:\n\n%s\n\n'
  132. 'Hint: check for possible duplicates in your expectation.\n' +
  133. ('Hint: Is the expectation order correct?' if self.expect_order else '')) % (
  134. request['method'], request['uri'], len(seen_requests),
  135. '\n'.join(map(str, seen_requests)),
  136. '\n'.join(map(str, [(r['method'], r['uri']) for r in self.expected_requests])),
  137. ))
  138. if match:
  139. unmatched_requests.remove(match)
  140. # see if any requests were unexpected
  141. if unmatched_requests and self.single_expectation_single_request:
  142. self.test_case.fail('While waiting for %i request(s), we saw %i unexpected request(s). The unexpected '
  143. 'request(s) was/were:\n\n%s\n\nAll recorded requests:\n\n%s\n\nAll expected requests:'
  144. '\n\n%s' % (
  145. len(self.expected_requests),
  146. len(unmatched_requests),
  147. '\n'.join(map(str, unmatched_requests)),
  148. '\n'.join(map(str, seen_requests)),
  149. '\n'.join(map(str, [(r['method'], r['uri']) for r in self.expected_requests])),
  150. ))
  151. class MockPDNSTestCase(APITestCase):
  152. """
  153. This test case provides a "mocked Internet" environment with a mock pdns API interface. All internet connections,
  154. HTTP or otherwise, that this test case is unaware of will result in an exception.
  155. By default, requests are intercepted but unexpected will result in a failed test. To set pdns API request
  156. expectations, use the `with MockPDNSTestCase.assertPdns*` context managers.
  157. Subclasses may not touch httpretty.enable() or httpretty.disable(). For 'local' usage, httpretty.register_uri()
  158. and httpretty.reset() may be used.
  159. """
  160. PDNS_ZONES = r'/zones'
  161. PDNS_ZONE_CRYPTO_KEYS = r'/zones/(?P<id>[^/]+)/cryptokeys'
  162. PDNS_ZONE = r'/zones/(?P<id>[^/]+)'
  163. PDNS_ZONE_NOTIFY = r'/zones/(?P<id>[^/]+)/notify'
  164. @classmethod
  165. def get_full_pdns_url(cls, path_regex, ns='LORD', **kwargs):
  166. api = getattr(settings, 'NS%s_PDNS_API' % ns)
  167. return re.compile('^' + api + cls.fill_regex_groups(path_regex, **kwargs) + '$')
  168. @classmethod
  169. def fill_regex_groups(cls, template, **kwargs):
  170. s = template
  171. for name, value in kwargs.items():
  172. if value is None:
  173. continue
  174. pattern = r'\(\?P\<%s\>[^\)]+\)' % name
  175. if not re.search(pattern, s):
  176. raise ValueError('Tried to fill field %s in template %s, but it does not exist.' % (name, template))
  177. s = re.sub(
  178. pattern=pattern,
  179. repl=value,
  180. string=s,
  181. )
  182. return s
  183. @classmethod
  184. def _pdns_zone_id_heuristic(cls, name):
  185. """
  186. Returns an educated guess of the pdns zone id for a given zone name.
  187. """
  188. if not name:
  189. return None
  190. name = cls._normalize_name(name)
  191. return name.translate(str.maketrans({'/': '=2F', '_': '=5F'})) # make sure =5F is not lower-cased
  192. @classmethod
  193. def _normalize_name(cls, arg):
  194. if not arg:
  195. return None
  196. if not isinstance(arg, list):
  197. return cls._normalize_name([arg])[0]
  198. else:
  199. return [x.rstrip('.') + '.' for x in arg]
  200. @classmethod
  201. def request_pdns_zone_create(cls):
  202. return {
  203. 'method': 'POST',
  204. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONES),
  205. 'status': 201,
  206. 'body': None,
  207. }
  208. @classmethod
  209. def request_pdns_zone_create_422(cls):
  210. request = cls.request_pdns_zone_create()
  211. request['status'] = 422
  212. return request
  213. @classmethod
  214. def request_pdns_zone_create_already_exists(cls, existing_domains=None):
  215. existing_domains = cls._normalize_name(existing_domains)
  216. def request_callback(r, _, response_headers):
  217. body = json.loads(r.parsed_body)
  218. if not existing_domains or body['name'] in existing_domains:
  219. return [422, response_headers, json.dumps({'error': 'Domain \'%s\' already exists' % body['name']})]
  220. else:
  221. return [200, response_headers, '']
  222. request = cls.request_pdns_zone_create_422()
  223. request['body'] = request_callback
  224. request.pop('status')
  225. return request
  226. @classmethod
  227. def request_pdns_zone_delete(cls, name=None, ns='LORD'):
  228. return {
  229. 'method': 'DELETE',
  230. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONE, ns=ns, id=cls._pdns_zone_id_heuristic(name)),
  231. 'status': 200,
  232. 'body': None,
  233. }
  234. @classmethod
  235. def request_pdns_zone_update(cls, name=None):
  236. return {
  237. 'method': 'PATCH',
  238. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONE, id=cls._pdns_zone_id_heuristic(name)),
  239. 'status': 200,
  240. 'body': None,
  241. }
  242. @classmethod
  243. def request_pdns_zone_update_unknown_type(cls, name=None, unknown_types=None):
  244. def request_callback(r, _, response_headers):
  245. body = json.loads(r.parsed_body)
  246. if not unknown_types or body['rrsets'][0]['type'] in unknown_types:
  247. return [
  248. 422, response_headers,
  249. json.dumps({'error': 'Mocked error. Unknown RR type %s.' % body['rrsets'][0]['type']})
  250. ]
  251. else:
  252. return [200, response_headers, None]
  253. request = cls.request_pdns_zone_update(name)
  254. request['body'] = request_callback
  255. request.pop('status')
  256. return request
  257. @classmethod
  258. def request_pdns_zone_retrieve(cls, name=None):
  259. return {
  260. 'method': 'GET',
  261. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONE, id=cls._pdns_zone_id_heuristic(name)),
  262. 'status': 200,
  263. 'body': json.dumps({
  264. 'rrsets': [{
  265. 'comments': [],
  266. 'name': cls._normalize_name(name) if name else 'test.mock.',
  267. 'ttl': 60,
  268. 'type': 'NS',
  269. 'records': [{'content': ns} for ns in settings.DEFAULT_NS],
  270. }]
  271. }),
  272. }
  273. @classmethod
  274. def request_pdns_zone_retrieve_crypto_keys(cls, name=None):
  275. return {
  276. 'method': 'GET',
  277. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONE_CRYPTO_KEYS, id=cls._pdns_zone_id_heuristic(name)),
  278. 'status': 200,
  279. 'body': json.dumps([
  280. {
  281. 'active': True,
  282. 'algorithm': 'ECDSAP256SHA256',
  283. 'bits': 256,
  284. 'dnskey': '257 3 13 EVBcsqrnOp6RGWtsrr9QW8cUtt/'
  285. 'WI5C81RcCZDTGNI9elAiMQlxRdnic+7V+b7jJDE2vgY08qAbxiNh5NdzkzA==',
  286. 'ds': [
  287. '62745 13 1 642d70d9bb84903ca4c4ca08a6e4f1e9465aeaa6',
  288. '62745 13 2 5cddaeaa383e2ea7de49bd1212bf520228f0e3b334626517e5f6a68eb85b48f6',
  289. '62745 13 4 b3f2565901ddcb0b78337301cf863d1045774377bca05c7ad69e17a167734b92'
  290. '9f0a49b7edcca913eb6f5dfeac4645b8'
  291. ],
  292. 'flags': 257,
  293. 'id': 179425943,
  294. 'keytype': key_type,
  295. 'type': 'Cryptokey',
  296. }
  297. for key_type in ['csk', 'ksk', 'zsk']
  298. ])
  299. }
  300. @classmethod
  301. def request_pdns_zone_notify(cls, name=None):
  302. return {
  303. 'method': 'PUT',
  304. 'uri': cls.get_full_pdns_url(cls.PDNS_ZONE_NOTIFY, id=cls._pdns_zone_id_heuristic(name)),
  305. 'status': 200,
  306. 'body': None,
  307. }
  308. def assertPdnsRequests(self, *expected_requests, expect_order=True):
  309. """
  310. Assert the given requests are made. To build requests, use the `MockPDNSTestCase.request_*` functions.
  311. Unmet expectations will fail the test.
  312. Args:
  313. *expected_requests: List of expected requests.
  314. expect_order: If True (default), the order of observed requests is checked.
  315. """
  316. return AssertRequestsContextManager(
  317. test_case=self,
  318. expected_requests=expected_requests,
  319. expect_order=expect_order,
  320. )
  321. def assertPdnsNoRequestsBut(self, *expected_requests):
  322. """
  323. Assert no requests other than the given ones are made. Each request can be matched more than once, unmatched
  324. expectations WILL NOT fail the test.
  325. Args:
  326. *expected_requests: List of acceptable requests to be made.
  327. """
  328. return AssertRequestsContextManager(
  329. test_case=self,
  330. expected_requests=expected_requests,
  331. single_expectation_single_request=False,
  332. expect_order=False,
  333. )
  334. def assertPdnsZoneCreation(self):
  335. """
  336. Asserts that nslord is contact and a zone is created.
  337. """
  338. return AssertRequestsContextManager(
  339. test_case=self,
  340. expected_requests=[
  341. self.request_pdns_zone_create()
  342. ],
  343. )
  344. def assertPdnsZoneDeletion(self, name=None):
  345. """
  346. Asserts that nslord and nsmaster are contacted to delete a zone.
  347. Args:
  348. name: If given, the test is restricted to the name of this zone.
  349. """
  350. return AssertRequestsContextManager(
  351. test_case=self,
  352. expected_requests=[
  353. self.request_pdns_zone_delete(ns='LORD', name=name),
  354. self.request_pdns_zone_delete(ns='MASTER', name=name),
  355. ],
  356. )
  357. def assertStatus(self, response, status):
  358. if response.status_code != status:
  359. self.fail((
  360. 'Expected a response with status %i, but saw response with status %i. ' +
  361. (
  362. '\n@@@@@ THE REQUEST CAUSING THIS RESPONSE WAS UNEXPECTED BY THE TEST @@@@@\n'
  363. if response.status_code == 599 else ''
  364. ) +
  365. 'The response was %s.\n'
  366. 'The response body was\n\n%s') % (
  367. status,
  368. response.status_code,
  369. response,
  370. str(response.data).replace('\\n', '\n'),
  371. ))
  372. @classmethod
  373. def setUpTestData(cls):
  374. httpretty.enable(allow_net_connect=False)
  375. httpretty.reset()
  376. hr_core.POTENTIAL_HTTP_PORTS.add(8081) # FIXME static dependency on settings variable
  377. for request in [
  378. cls.request_pdns_zone_create(),
  379. cls.request_pdns_zone_notify(),
  380. cls.request_pdns_zone_update(),
  381. cls.request_pdns_zone_retrieve_crypto_keys(),
  382. cls.request_pdns_zone_retrieve()
  383. ]:
  384. httpretty.register_uri(**request)
  385. cls.setUpTestDataWithPdns()
  386. httpretty.reset()
  387. @classmethod
  388. def setUpTestDataWithPdns(cls):
  389. """
  390. Override this method to set up test data. During the run of this method, httpretty is configured to accept
  391. all pdns API requests.
  392. """
  393. pass
  394. @classmethod
  395. def tearDownClass(cls):
  396. super().tearDownClass()
  397. httpretty.disable()
  398. def setUp(self):
  399. def request_callback(r, _, response_headers):
  400. return [
  401. 599,
  402. response_headers,
  403. json.dumps(
  404. {
  405. 'MockPDNSTestCase': 'This response was generated upon an unexpected request.',
  406. 'request': str(r),
  407. 'method': str(r.method),
  408. 'requestline': str(r.raw_requestline),
  409. 'host': str(r.headers['Host']) if 'Host' in r.headers else None,
  410. 'headers': {str(key): str(value) for key, value in r.headers.items()},
  411. },
  412. indent=4
  413. )
  414. ]
  415. super().setUp()
  416. httpretty.reset()
  417. hr_core.POTENTIAL_HTTP_PORTS.add(8081) # FIXME should depend on self.expected_requests
  418. for method in [
  419. httpretty.GET, httpretty.PUT, httpretty.POST, httpretty.DELETE, httpretty.HEAD, httpretty.PATCH,
  420. httpretty.OPTIONS, httpretty.CONNECT
  421. ]:
  422. for ns in ['LORD', 'MASTER']:
  423. httpretty.register_uri(
  424. method,
  425. self.get_full_pdns_url('.*', ns),
  426. body=request_callback,
  427. status=599,
  428. priority=-100,
  429. )
  430. class DesecTestCase(MockPDNSTestCase):
  431. """
  432. This test case is run in the "standard" deSEC e.V. setting, i.e. with an API that is aware of the public suffix
  433. domains AUTO_DELEGATION_DOMAINS.
  434. The test case aims to be as close to the deployment as possible and may be extended as the deployment evolves.
  435. The test case provides an admin user and a regular user for testing.
  436. """
  437. client_class = DesecAPIClient
  438. AUTO_DELEGATION_DOMAINS = ['dedyn.io'] # TODO replace with project wide settings
  439. PUBLIC_SUFFIXES = ['de', 'com', 'io', 'gov.cd', 'edu.ec', 'xxx', 'pinb.gov.pl', 'valer.ostfold.no', 'kota.aichi.jp']
  440. @classmethod
  441. def reverse(cls, view_name, **kwargs):
  442. return reverse(view_name, kwargs=kwargs)
  443. @classmethod
  444. def setUpTestDataWithPdns(cls):
  445. super().setUpTestDataWithPdns()
  446. random.seed(0xde5ec)
  447. cls.admin = cls.create_user(is_admin=True)
  448. cls.add_domains = [cls.create_domain(name=name) for name in cls.AUTO_DELEGATION_DOMAINS]
  449. cls.user = cls.create_user()
  450. @classmethod
  451. def random_string(cls, length=6, chars=string.ascii_letters + string.digits):
  452. return ''.join(random.choice(chars) for _ in range(length))
  453. @classmethod
  454. def random_password(cls, length=12):
  455. return cls.random_string(
  456. length,
  457. chars=string.ascii_letters + string.digits + string.punctuation +
  458. 'some 💩🐬 UTF-8: “红色联合”对“四·二八兵团”总部大楼的攻击已持续了两天"'
  459. )
  460. @classmethod
  461. def random_ip(cls, proto=None):
  462. proto = proto or random.choice([4, 6])
  463. if proto == 4:
  464. return '.'.join([str(random.randrange(256)) for _ in range(4)])
  465. elif proto == 6:
  466. return '2001:' + ':'.join(['%x' % random.randrange(16**4) for _ in range(7)])
  467. else:
  468. raise ValueError('Unknown IP protocol version %s. Expected int 4 or int 6.' % str(proto))
  469. @classmethod
  470. def random_username(cls, host=None):
  471. host = host or cls.random_domain_name(suffix=random.choice(cls.PUBLIC_SUFFIXES))
  472. return cls.random_string() + '+test@' + host.lower()
  473. @classmethod
  474. def random_domain_name(cls, suffix=None):
  475. if not suffix:
  476. suffix = random.choice(cls.PUBLIC_SUFFIXES)
  477. return (random.choice(string.ascii_letters) + cls.random_string() + '--test' + '.' + suffix).lower()
  478. @classmethod
  479. def create_token(cls, user):
  480. token = Token.objects.create(user=user)
  481. token.save()
  482. return token
  483. @classmethod
  484. def create_user(cls, **kwargs):
  485. kwargs.setdefault('email', cls.random_username())
  486. user = User(**kwargs)
  487. user.plain_password = cls.random_string(length=12)
  488. user.set_password(user.plain_password)
  489. user.save()
  490. return user
  491. @classmethod
  492. def create_domain(cls, suffix=None, **kwargs):
  493. kwargs.setdefault('owner', cls.create_user())
  494. kwargs.setdefault('name', cls.random_domain_name(suffix=suffix))
  495. domain = Domain(**kwargs)
  496. domain.save()
  497. return domain
  498. @classmethod
  499. def create_rr_set(cls, domain, records, **kwargs):
  500. if isinstance(domain, str):
  501. domain = Domain.objects.get_or_create(name=domain)
  502. domain.save()
  503. rr_set = RRset(domain=domain, **kwargs)
  504. rr_set.save()
  505. for r in records:
  506. RR(content=r, rrset=rr_set).save()
  507. return rr_set
  508. @classmethod
  509. def _find_auto_delegation_zone(cls, name):
  510. if not name:
  511. return None
  512. parents = [parent for parent in cls.AUTO_DELEGATION_DOMAINS if name.endswith('.' + parent)]
  513. if not parents:
  514. raise ValueError('Could not find auto delegation zone for zone %s; searched in %s' % (
  515. name,
  516. cls.AUTO_DELEGATION_DOMAINS
  517. ))
  518. return parents[0]
  519. @classmethod
  520. def requests_desec_domain_creation(cls, name=None):
  521. return [
  522. cls.request_pdns_zone_create(),
  523. cls.request_pdns_zone_notify(name=name),
  524. cls.request_pdns_zone_retrieve(name=name),
  525. cls.request_pdns_zone_retrieve_crypto_keys(name=name),
  526. ]
  527. @classmethod
  528. def requests_desec_domain_deletion(cls, name=None):
  529. return [
  530. cls.request_pdns_zone_delete(name=name, ns='LORD'),
  531. cls.request_pdns_zone_delete(name=name, ns='MASTER'),
  532. ]
  533. @classmethod
  534. def requests_desec_domain_creation_auto_delegation(cls, name=None):
  535. delegate_at = cls._find_auto_delegation_zone(name)
  536. return cls.requests_desec_domain_creation(name=name) + [
  537. cls.request_pdns_zone_update(name=delegate_at),
  538. cls.request_pdns_zone_notify(name=delegate_at),
  539. cls.request_pdns_zone_retrieve_crypto_keys(name=name),
  540. ]
  541. @classmethod
  542. def requests_desec_domain_deletion_auto_delegation(cls, name=None):
  543. delegate_at = cls._find_auto_delegation_zone(name)
  544. return [
  545. cls.request_pdns_zone_update(name=delegate_at),
  546. cls.request_pdns_zone_notify(name=delegate_at),
  547. cls.request_pdns_zone_delete(name=name, ns='LORD'),
  548. cls.request_pdns_zone_delete(name=name, ns='MASTER'),
  549. ]
  550. @classmethod
  551. def requests_desec_rr_sets_update(cls, name=None):
  552. return [
  553. cls.request_pdns_zone_update(name=name),
  554. cls.request_pdns_zone_notify(name=name),
  555. ]
  556. class DomainOwnerTestCase(DesecTestCase):
  557. """
  558. This test case creates a domain owner, some domains for her and some domains that are owned by other users.
  559. DomainOwnerTestCase.client is authenticated with the owner's token.
  560. """
  561. DYN = False
  562. NUM_OWNED_DOMAINS = 2
  563. NUM_OTHER_DOMAINS = 20
  564. owner = None
  565. my_domains = None
  566. other_domains = None
  567. my_domain = None
  568. other_domain = None
  569. token = None
  570. @classmethod
  571. def setUpTestDataWithPdns(cls):
  572. super().setUpTestDataWithPdns()
  573. cls.owner = cls.create_user(dyn=cls.DYN)
  574. cls.my_domains = [
  575. cls.create_domain(suffix=random.choice(cls.AUTO_DELEGATION_DOMAINS) if cls.DYN else '', owner=cls.owner)
  576. for _ in range(cls.NUM_OWNED_DOMAINS)
  577. ]
  578. cls.other_domains = [
  579. cls.create_domain(suffix=random.choice(cls.AUTO_DELEGATION_DOMAINS) if cls.DYN else '')
  580. for _ in range(cls.NUM_OTHER_DOMAINS)
  581. ]
  582. cls.my_domain = cls.my_domains[0]
  583. cls.other_domain = cls.other_domains[0]
  584. cls.create_rr_set(cls.my_domain, ['127.0.0.1', '127.0.1.1'], type='A', ttl=123)
  585. cls.create_rr_set(cls.other_domain, ['40.1.1.1', '40.2.2.2'], type='A', ttl=456)
  586. cls.token = cls.create_token(user=cls.owner)
  587. def setUp(self):
  588. super().setUp()
  589. self.client.credentials(HTTP_AUTHORIZATION='Token ' + self.token.key)
  590. class LockedDomainOwnerTestCase(DomainOwnerTestCase):
  591. @classmethod
  592. def setUpTestData(cls):
  593. super().setUpTestData()
  594. cls.owner.locked = timezone.now()
  595. cls.owner.save()
  596. class DynDomainOwnerTestCase(DomainOwnerTestCase):
  597. DYN = True
  598. @classmethod
  599. def request_pdns_zone_notify(cls, name=None):
  600. return super().request_pdns_zone_notify(name.lower() if name else None)
  601. @classmethod
  602. def request_pdns_zone_update(cls, name=None):
  603. return super().request_pdns_zone_update(name.lower() if name else None)
  604. def _assertDynDNS12Update(self, requests, mock_remote_addr='', **kwargs):
  605. with self.assertPdnsRequests(requests):
  606. if mock_remote_addr:
  607. return self.client.get(self.reverse('v1:dyndns12update'), kwargs, REMOTE_ADDR=mock_remote_addr)
  608. else:
  609. return self.client.get(self.reverse('v1:dyndns12update'), kwargs)
  610. def assertDynDNS12Update(self, domain_name=None, mock_remote_addr='', **kwargs):
  611. pdns_name = self._normalize_name(domain_name).lower() if domain_name else None
  612. return self._assertDynDNS12Update(
  613. [self.request_pdns_zone_update(name=pdns_name), self.request_pdns_zone_notify(name=pdns_name)],
  614. mock_remote_addr,
  615. **kwargs
  616. )
  617. def assertDynDNS12NoUpdate(self, mock_remote_addr='', **kwargs):
  618. return self._assertDynDNS12Update([], mock_remote_addr, **kwargs)
  619. def setUp(self):
  620. super().setUp()
  621. self.client_token_authorized = self.client_class()
  622. self.client.set_credentials_basic_auth(self.my_domain.name, self.token.key)
  623. self.client_token_authorized.set_credentials_token_auth(self.token.key)