views.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. import base64
  2. import binascii
  3. import django.core.exceptions
  4. from django.conf import settings
  5. from django.contrib.auth import user_logged_in
  6. from django.core.mail import EmailMessage
  7. from django.http import Http404
  8. from django.template.loader import get_template
  9. from rest_framework import generics
  10. from rest_framework import mixins
  11. from rest_framework import status
  12. from rest_framework.authentication import get_authorization_header, BaseAuthentication
  13. from rest_framework.exceptions import (NotFound, PermissionDenied, ValidationError)
  14. from rest_framework.permissions import IsAuthenticated
  15. from rest_framework.response import Response
  16. from rest_framework.reverse import reverse
  17. from rest_framework.views import APIView
  18. from rest_framework.viewsets import GenericViewSet
  19. import desecapi.authentication as auth
  20. from desecapi import serializers, models
  21. from desecapi.pdns_change_tracker import PDNSChangeTracker
  22. from desecapi.permissions import IsOwner, IsDomainOwner
  23. from desecapi.renderers import PlainTextRenderer
  24. class IdempotentDestroy:
  25. def destroy(self, request, *args, **kwargs):
  26. try:
  27. # noinspection PyUnresolvedReferences
  28. super().destroy(request, *args, **kwargs)
  29. except Http404:
  30. pass
  31. return Response(status=status.HTTP_204_NO_CONTENT)
  32. class DomainView:
  33. def initial(self, request, *args, **kwargs):
  34. # noinspection PyUnresolvedReferences
  35. super().initial(request, *args, **kwargs)
  36. try:
  37. # noinspection PyAttributeOutsideInit, PyUnresolvedReferences
  38. self.domain = self.request.user.domains.get(name=self.kwargs['name'])
  39. except models.Domain.DoesNotExist:
  40. raise Http404
  41. class TokenViewSet(IdempotentDestroy,
  42. mixins.CreateModelMixin,
  43. mixins.DestroyModelMixin,
  44. mixins.ListModelMixin,
  45. GenericViewSet):
  46. serializer_class = serializers.TokenSerializer
  47. permission_classes = (IsAuthenticated, )
  48. lookup_field = 'user_specific_id'
  49. def get_queryset(self):
  50. return self.request.user.auth_tokens.all()
  51. def perform_create(self, serializer):
  52. serializer.save(user=self.request.user)
  53. class DomainList(generics.ListCreateAPIView):
  54. serializer_class = serializers.DomainSerializer
  55. permission_classes = (IsAuthenticated, IsOwner,)
  56. def get_queryset(self):
  57. return models.Domain.objects.filter(owner=self.request.user.pk)
  58. def perform_create(self, serializer):
  59. _, parent_domain_name = models.Domain.partition_name(serializer.validated_data['name'])
  60. domain_is_local = parent_domain_name in settings.LOCAL_PUBLIC_SUFFIXES
  61. domain_kwargs = {'owner': self.request.user}
  62. if domain_is_local:
  63. domain_kwargs['minimum_ttl'] = 60
  64. with PDNSChangeTracker():
  65. domain = serializer.save(**domain_kwargs)
  66. PDNSChangeTracker.track(lambda: self.auto_delegate(domain))
  67. # Send dyn email
  68. if domain.name.endswith('.dedyn.io'):
  69. content_tmpl = get_template('emails/domain-dyndns/content.txt')
  70. subject_tmpl = get_template('emails/domain-dyndns/subject.txt')
  71. from_tmpl = get_template('emails/from.txt')
  72. context = {
  73. 'domain': domain.name,
  74. 'url': 'https://update.dedyn.io/',
  75. 'username': domain.name,
  76. 'password': self.request.auth.key
  77. }
  78. email = EmailMessage(subject_tmpl.render(context),
  79. content_tmpl.render(context),
  80. from_tmpl.render(context),
  81. [self.request.user.email])
  82. email.send()
  83. @staticmethod
  84. def auto_delegate(domain: models.Domain):
  85. parent_domain_name = domain.partition_name()[1]
  86. if parent_domain_name in settings.LOCAL_PUBLIC_SUFFIXES:
  87. parent_domain = models.Domain.objects.get(name=parent_domain_name)
  88. parent_domain.update_delegation(domain)
  89. class DomainDetail(IdempotentDestroy, generics.RetrieveUpdateDestroyAPIView):
  90. serializer_class = serializers.DomainSerializer
  91. permission_classes = (IsAuthenticated, IsOwner,)
  92. lookup_field = 'name'
  93. def perform_destroy(self, instance: models.Domain):
  94. with PDNSChangeTracker():
  95. instance.delete()
  96. if instance.has_local_public_suffix():
  97. parent_domain = models.Domain.objects.get(name=instance.parent_domain_name())
  98. with PDNSChangeTracker():
  99. parent_domain.update_delegation(instance)
  100. def get_queryset(self):
  101. return models.Domain.objects.filter(owner=self.request.user.pk)
  102. def update(self, request, *args, **kwargs):
  103. try:
  104. return super().update(request, *args, **kwargs)
  105. except django.core.exceptions.ValidationError as e:
  106. raise ValidationError(detail={"detail": e.message})
  107. class RRsetDetail(IdempotentDestroy, DomainView, generics.RetrieveUpdateDestroyAPIView):
  108. serializer_class = serializers.RRsetSerializer
  109. permission_classes = (IsAuthenticated, IsDomainOwner,)
  110. def get_queryset(self):
  111. return self.domain.rrset_set
  112. def get_object(self):
  113. queryset = self.filter_queryset(self.get_queryset())
  114. filter_kwargs = {k: self.kwargs[k] for k in ['subname', 'type']}
  115. obj = generics.get_object_or_404(queryset, **filter_kwargs)
  116. # May raise a permission denied
  117. self.check_object_permissions(self.request, obj)
  118. return obj
  119. def get_serializer(self, *args, **kwargs):
  120. kwargs['domain'] = self.domain
  121. return super().get_serializer(*args, **kwargs)
  122. def update(self, request, *args, **kwargs):
  123. response = super().update(request, *args, **kwargs)
  124. if response.data is None:
  125. response.status_code = 204
  126. return response
  127. def perform_update(self, serializer):
  128. with PDNSChangeTracker():
  129. super().perform_update(serializer)
  130. def perform_destroy(self, instance):
  131. with PDNSChangeTracker():
  132. super().perform_destroy(instance)
  133. class RRsetList(DomainView, generics.ListCreateAPIView, generics.UpdateAPIView):
  134. serializer_class = serializers.RRsetSerializer
  135. permission_classes = (IsAuthenticated, IsDomainOwner,)
  136. def get_queryset(self):
  137. rrsets = models.RRset.objects.filter(domain=self.domain)
  138. for filter_field in ('subname', 'type'):
  139. value = self.request.query_params.get(filter_field)
  140. if value is not None:
  141. # TODO consider moving this
  142. if filter_field == 'type' and value in models.RRset.RESTRICTED_TYPES:
  143. raise PermissionDenied("You cannot tinker with the %s RRset." % value)
  144. rrsets = rrsets.filter(**{'%s__exact' % filter_field: value})
  145. return rrsets
  146. def get_object(self):
  147. # For this view, the object we're operating on is the queryset that one can also GET. Serializing a queryset
  148. # is fine as per https://www.django-rest-framework.org/api-guide/serializers/#serializing-multiple-objects.
  149. # We skip checking object permissions here to avoid evaluating the queryset. The user can access all his RRsets
  150. # anyways.
  151. return self.filter_queryset(self.get_queryset())
  152. def get_serializer(self, *args, **kwargs):
  153. data = kwargs.get('data')
  154. if data and 'many' not in kwargs:
  155. if self.request.method == 'POST':
  156. kwargs['many'] = isinstance(data, list)
  157. elif self.request.method in ['PATCH', 'PUT']:
  158. kwargs['many'] = True
  159. return super().get_serializer(domain=self.domain, *args, **kwargs)
  160. def perform_create(self, serializer):
  161. with PDNSChangeTracker():
  162. serializer.save(domain=self.domain)
  163. def perform_update(self, serializer):
  164. with PDNSChangeTracker():
  165. serializer.save(domain=self.domain)
  166. class Root(APIView):
  167. def get(self, request, *_):
  168. if self.request.user.is_authenticated:
  169. routes = {
  170. 'account': {
  171. 'show': reverse('account', request=request),
  172. 'delete': reverse('account-delete', request=request),
  173. 'change-email': reverse('account-change-email', request=request),
  174. 'reset-password': reverse('account-reset-password', request=request),
  175. },
  176. 'tokens': reverse('token-list', request=request),
  177. 'domains': reverse('domain-list', request=request),
  178. }
  179. else:
  180. routes = {
  181. 'register': reverse('register', request=request),
  182. 'login': reverse('login', request=request),
  183. 'reset-password': reverse('account-reset-password', request=request),
  184. }
  185. return Response(routes)
  186. class DynDNS12Update(APIView):
  187. authentication_classes = (auth.TokenAuthentication, auth.BasicTokenAuthentication, auth.URLParamAuthentication,)
  188. renderer_classes = [PlainTextRenderer]
  189. def _find_domain(self, request):
  190. def find_domain_name(r):
  191. # 1. hostname parameter
  192. if 'hostname' in r.query_params and r.query_params['hostname'] != 'YES':
  193. return r.query_params['hostname']
  194. # 2. host_id parameter
  195. if 'host_id' in r.query_params:
  196. return r.query_params['host_id']
  197. # 3. http basic auth username
  198. try:
  199. domain_name = base64.b64decode(
  200. get_authorization_header(r).decode().split(' ')[1].encode()).decode().split(':')[0]
  201. if domain_name and '@' not in domain_name:
  202. return domain_name
  203. except IndexError:
  204. pass
  205. except UnicodeDecodeError:
  206. pass
  207. except binascii.Error:
  208. pass
  209. # 4. username parameter
  210. if 'username' in r.query_params:
  211. return r.query_params['username']
  212. # 5. only domain associated with this user account
  213. if len(r.user.domains.all()) == 1:
  214. return r.user.domains.all()[0].name
  215. if len(r.user.domains.all()) > 1:
  216. ex = ValidationError(detail={
  217. "detail": "Request does not specify domain unambiguously.",
  218. "code": "domain-ambiguous"
  219. })
  220. ex.status_code = status.HTTP_409_CONFLICT
  221. raise ex
  222. return None
  223. name = find_domain_name(request).lower()
  224. try:
  225. return self.request.user.domains.get(name=name)
  226. except models.Domain.DoesNotExist:
  227. return None
  228. @staticmethod
  229. def find_ip(request, params, version=4):
  230. if version == 4:
  231. look_for = '.'
  232. elif version == 6:
  233. look_for = ':'
  234. else:
  235. raise Exception
  236. # Check URL parameters
  237. for p in params:
  238. if p in request.query_params:
  239. if not len(request.query_params[p]):
  240. return None
  241. if look_for in request.query_params[p]:
  242. return request.query_params[p]
  243. # Check remote IP address
  244. client_ip = request.META.get('REMOTE_ADDR')
  245. if look_for in client_ip:
  246. return client_ip
  247. # give up
  248. return None
  249. def _find_ip_v4(self, request):
  250. return self.find_ip(request, ['myip', 'myipv4', 'ip'])
  251. def _find_ip_v6(self, request):
  252. return self.find_ip(request, ['myipv6', 'ipv6', 'myip', 'ip'], version=6)
  253. def get(self, request, *_):
  254. domain = self._find_domain(request)
  255. if domain is None:
  256. raise NotFound('nohost')
  257. ipv4 = self._find_ip_v4(request)
  258. ipv6 = self._find_ip_v6(request)
  259. data = [
  260. {'type': 'A', 'subname': '', 'ttl': 60, 'records': [ipv4] if ipv4 else []},
  261. {'type': 'AAAA', 'subname': '', 'ttl': 60, 'records': [ipv6] if ipv6 else []},
  262. ]
  263. instances = domain.rrset_set.filter(subname='', type__in=['A', 'AAAA']).all()
  264. serializer = serializers.RRsetSerializer(instances, domain=domain, data=data, many=True, partial=True)
  265. try:
  266. serializer.is_valid(raise_exception=True)
  267. except ValidationError as e:
  268. raise e
  269. with PDNSChangeTracker():
  270. serializer.save(domain=domain)
  271. return Response('good', content_type='text/plain')
  272. class DonationList(generics.CreateAPIView):
  273. serializer_class = serializers.DonationSerializer
  274. def perform_create(self, serializer):
  275. iban = serializer.validated_data['iban']
  276. obj = serializer.save()
  277. def send_donation_emails(donation):
  278. context = {
  279. 'donation': donation,
  280. 'creditoridentifier': settings.SEPA['CREDITOR_ID'],
  281. 'creditorname': settings.SEPA['CREDITOR_NAME'],
  282. 'complete_iban': iban
  283. }
  284. # internal desec notification
  285. content_tmpl = get_template('emails/donation/desec-content.txt')
  286. subject_tmpl = get_template('emails/donation/desec-subject.txt')
  287. attachment_tmpl = get_template('emails/donation/desec-attachment-jameica.txt')
  288. from_tmpl = get_template('emails/from.txt')
  289. email = EmailMessage(subject_tmpl.render(context),
  290. content_tmpl.render(context),
  291. from_tmpl.render(context),
  292. ['donation@desec.io'],
  293. attachments=[
  294. ('jameica-directdebit.xml',
  295. attachment_tmpl.render(context),
  296. 'text/xml')
  297. ])
  298. email.send()
  299. # donor notification
  300. if donation.email:
  301. content_tmpl = get_template('emails/donation/donor-content.txt')
  302. subject_tmpl = get_template('emails/donation/donor-subject.txt')
  303. email = EmailMessage(subject_tmpl.render(context),
  304. content_tmpl.render(context),
  305. from_tmpl.render(context),
  306. [donation.email])
  307. email.send()
  308. # send emails
  309. send_donation_emails(obj)
  310. class AccountCreateView(generics.CreateAPIView):
  311. serializer_class = serializers.RegisterAccountSerializer
  312. def create(self, request, *args, **kwargs):
  313. # Create user and send trigger email verification.
  314. # Alternative would be to create user once email is verified, but this could be abused for bulk email.
  315. serializer = self.get_serializer(data=request.data)
  316. activation_required = settings.USER_ACTIVATION_REQUIRED
  317. try:
  318. serializer.is_valid(raise_exception=True)
  319. except ValidationError as e:
  320. # Hide existing users
  321. email_detail = e.detail.pop('email', [])
  322. email_detail = [detail for detail in email_detail if detail.code != 'unique']
  323. if email_detail:
  324. e.detail['email'] = email_detail
  325. if e.detail:
  326. raise e
  327. else:
  328. user = serializer.save(is_active=(not activation_required))
  329. domain = serializer.validated_data.get('domain')
  330. if domain or activation_required:
  331. action = models.AuthenticatedActivateUserAction(user=user, domain=domain)
  332. verification_code = serializers.AuthenticatedActivateUserActionSerializer(action).data['code']
  333. user.send_email('activate-with-domain' if domain else 'activate', context={
  334. 'confirmation_link': reverse('confirm-activate-account', request=request, args=[verification_code])
  335. })
  336. # This request is unauthenticated, so don't expose whether we did anything.
  337. message = 'Welcome! Please check your mailbox.' if activation_required else 'Welcome!'
  338. return Response(data={'detail': message}, status=status.HTTP_202_ACCEPTED)
  339. class AccountView(generics.RetrieveAPIView):
  340. permission_classes = (IsAuthenticated,)
  341. serializer_class = serializers.UserSerializer
  342. def get_object(self):
  343. return self.request.user
  344. class AccountDeleteView(generics.GenericAPIView):
  345. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  346. permission_classes = (IsAuthenticated,)
  347. def post(self, request, *args, **kwargs):
  348. action = models.AuthenticatedDeleteUserAction(user=self.request.user)
  349. verification_code = serializers.AuthenticatedDeleteUserActionSerializer(action).data['code']
  350. request.user.send_email('delete-user', context={
  351. 'confirmation_link': reverse('confirm-delete-account', request=request, args=[verification_code])
  352. })
  353. return Response(data={'detail': 'Please check your mailbox for further account deletion instructions.'},
  354. status=status.HTTP_202_ACCEPTED)
  355. class AccountLoginView(generics.GenericAPIView):
  356. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  357. permission_classes = (IsAuthenticated,)
  358. def post(self, request, *args, **kwargs):
  359. user = self.request.user
  360. token = models.Token.objects.create(user=user, name="login")
  361. user_logged_in.send(sender=user.__class__, request=self.request, user=user)
  362. data = serializers.TokenSerializer(token).data
  363. return Response(data)
  364. class AccountChangeEmailView(generics.GenericAPIView):
  365. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  366. permission_classes = (IsAuthenticated,)
  367. serializer_class = serializers.ChangeEmailSerializer
  368. def post(self, request, *args, **kwargs):
  369. # Check password and extract email
  370. serializer = self.get_serializer(data=request.data)
  371. serializer.is_valid(raise_exception=True)
  372. new_email = serializer.validated_data['new_email']
  373. action = models.AuthenticatedChangeEmailUserAction(user=request.user, new_email=new_email)
  374. verification_code = serializers.AuthenticatedChangeEmailUserActionSerializer(action).data['code']
  375. request.user.send_email('change-email', recipient=new_email, context={
  376. 'confirmation_link': reverse('confirm-change-email', request=request, args=[verification_code]),
  377. 'old_email': request.user.email,
  378. 'new_email': new_email,
  379. })
  380. # At this point, we know that we are talking to the user, so we can tell that we sent an email.
  381. return Response(data={'detail': 'Please check your mailbox to confirm email address change.'},
  382. status=status.HTTP_202_ACCEPTED)
  383. class AccountResetPasswordView(generics.GenericAPIView):
  384. serializer_class = serializers.EmailSerializer
  385. def post(self, request, *args, **kwargs):
  386. serializer = self.get_serializer(data=request.data)
  387. serializer.is_valid(raise_exception=True)
  388. try:
  389. email = serializer.validated_data['email']
  390. user = models.User.objects.get(email=email, is_active=True)
  391. except models.User.DoesNotExist:
  392. pass
  393. else:
  394. action = models.AuthenticatedResetPasswordUserAction(user=user)
  395. verification_code = serializers.AuthenticatedResetPasswordUserActionSerializer(action).data['code']
  396. user.send_email('reset-password', context={
  397. 'confirmation_link': reverse('confirm-reset-password', request=request, args=[verification_code])
  398. })
  399. # This request is unauthenticated, so don't expose whether we did anything.
  400. return Response(data={'detail': 'Please check your mailbox for further password reset instructions. '
  401. 'If you did not receive an email, please contact support.'},
  402. status=status.HTTP_202_ACCEPTED)
  403. class AuthenticatedActionView(generics.GenericAPIView):
  404. """
  405. Abstract class. Deserializes the given payload according the serializers specified by the view extending
  406. this class. If the `serializer.is_valid`, `act` is called on the action object.
  407. """
  408. class AuthenticatedActionAuthenticator(BaseAuthentication):
  409. """
  410. Authenticates a request based on whether the serializer determines the validity of the given verification code
  411. and additional data (using `serializer.is_valid()`). The serializer's input data will be determined by (a) the
  412. view's 'code' kwarg and (b) the request payload for POST requests. Request methods other than GET and POST will
  413. fail authentication regardless of other conditions.
  414. If the request is valid, the AuthenticatedAction instance will be attached to the view as `authenticated_action`
  415. attribute.
  416. Note that this class will raise ValidationError instead of AuthenticationFailed, usually resulting in status
  417. 400 instead of 403.
  418. """
  419. def __init__(self, view):
  420. super().__init__()
  421. self.view = view
  422. def authenticate(self, request):
  423. data = {**request.data, 'code': self.view.kwargs['code']} # order crucial to avoid override from payload!
  424. serializer = self.view.serializer_class(data=data, context=self.view.get_serializer_context())
  425. serializer.is_valid(raise_exception=True)
  426. self.view.authenticated_action = serializer.instance
  427. return self.view.authenticated_action.user, None
  428. def __init__(self, *args, **kwargs):
  429. super().__init__(*args, **kwargs)
  430. self.authenticated_action = None
  431. def get_authenticators(self):
  432. return [self.AuthenticatedActionAuthenticator(self)]
  433. def get(self, request, *args, **kwargs):
  434. return self.take_action()
  435. def post(self, request, *args, **kwargs):
  436. return self.take_action()
  437. def finalize(self):
  438. raise NotImplementedError
  439. def take_action(self):
  440. # execute the action
  441. self.authenticated_action.act()
  442. return self.finalize()
  443. class AuthenticatedActivateUserActionView(AuthenticatedActionView):
  444. http_method_names = ['get']
  445. serializer_class = serializers.AuthenticatedActivateUserActionSerializer
  446. def finalize(self):
  447. action = self.authenticated_action
  448. if not action.domain:
  449. return Response({
  450. 'detail': 'Success! Please log in at {}.'.format(self.request.build_absolute_uri(reverse('v1:login')))
  451. })
  452. serializer = serializers.DomainSerializer(
  453. data={'name': action.domain},
  454. context=self.get_serializer_context()
  455. )
  456. try:
  457. serializer.is_valid(raise_exception=True)
  458. except ValidationError as e: # e.g. domain name unavailable
  459. action.user.delete()
  460. reasons = ', '.join([detail.code for detail in e.detail.get('name', [])])
  461. raise ValidationError(
  462. f'The requested domain {action.domain} could not be registered (reason: {reasons}). '
  463. f'Please start over and sign up again.'
  464. )
  465. domain = PDNSChangeTracker.track(lambda: serializer.save(owner=action.user))
  466. if domain.parent_domain_name() in settings.LOCAL_PUBLIC_SUFFIXES:
  467. PDNSChangeTracker.track(lambda: DomainList.auto_delegate(domain))
  468. token = models.Token.objects.create(user=action.user, name='dyndns')
  469. return Response({
  470. 'detail': 'Success! Here is the password ("auth_token") to configure your router (or any other dynDNS '
  471. 'client). This password is different from your account password for security reasons.',
  472. **serializers.TokenSerializer(token).data,
  473. })
  474. else:
  475. return Response({
  476. 'detail': 'Success! Please check the docs for the next steps, https://desec.readthedocs.io/.'
  477. })
  478. class AuthenticatedChangeEmailUserActionView(AuthenticatedActionView):
  479. http_method_names = ['get']
  480. serializer_class = serializers.AuthenticatedChangeEmailUserActionSerializer
  481. def finalize(self):
  482. return Response({
  483. 'detail': f'Success! Your email address has been changed to {self.authenticated_action.user.email}.'
  484. })
  485. class AuthenticatedResetPasswordUserActionView(AuthenticatedActionView):
  486. http_method_names = ['post']
  487. serializer_class = serializers.AuthenticatedResetPasswordUserActionSerializer
  488. def finalize(self):
  489. return Response({'detail': 'Success! Your password has been changed.'})
  490. class AuthenticatedDeleteUserActionView(AuthenticatedActionView):
  491. http_method_names = ['get']
  492. serializer_class = serializers.AuthenticatedDeleteUserActionSerializer
  493. def finalize(self):
  494. return Response({'detail': 'All your data has been deleted. Bye bye, see you soon! <3'})