views.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  1. import base64
  2. import binascii
  3. from datetime import timedelta
  4. from functools import cached_property
  5. from django.conf import settings
  6. from django.contrib.auth import user_logged_in
  7. from django.contrib.auth.hashers import is_password_usable
  8. from django.core.cache import cache
  9. from django.core.mail import EmailMessage
  10. from django.http import Http404
  11. from django.shortcuts import redirect
  12. from django.template.loader import get_template
  13. from rest_framework import generics, mixins, status, viewsets
  14. from rest_framework.authentication import get_authorization_header
  15. from rest_framework.exceptions import (NotAcceptable, NotFound, PermissionDenied, ValidationError)
  16. from rest_framework.permissions import IsAuthenticated, SAFE_METHODS
  17. from rest_framework.renderers import JSONRenderer, StaticHTMLRenderer
  18. from rest_framework.response import Response
  19. from rest_framework.reverse import reverse
  20. from rest_framework.settings import api_settings
  21. from rest_framework.views import APIView
  22. import desecapi.authentication as auth
  23. from desecapi import metrics, models, serializers
  24. from desecapi.exceptions import ConcurrencyException
  25. from desecapi.pdns import get_serials
  26. from desecapi.pdns_change_tracker import PDNSChangeTracker
  27. from desecapi.permissions import ManageTokensPermission, IsDomainOwner, IsOwner, IsVPNClient, WithinDomainLimitOnPOST
  28. from desecapi.renderers import PlainTextRenderer
  29. def generate_confirmation_link(request, action_serializer, viewname, **kwargs):
  30. action = action_serializer.Meta.model(**kwargs)
  31. action_data = action_serializer(action).data
  32. confirmation_link = reverse(viewname, request=request, args=[action_data['code']])
  33. return confirmation_link, action_serializer.validity_period
  34. class EmptyPayloadMixin:
  35. def initialize_request(self, request, *args, **kwargs):
  36. # noinspection PyUnresolvedReferences
  37. request = super().initialize_request(request, *args, **kwargs)
  38. try:
  39. no_data = request.stream is None
  40. except:
  41. no_data = True
  42. if no_data:
  43. # In this case, data and files are both empty, so we can set request.data=None (instead of the default {}).
  44. # This allows distinguishing missing payload from empty dict payload.
  45. # See https://github.com/encode/django-rest-framework/pull/7195
  46. request._full_data = None
  47. return request
  48. class IdempotentDestroyMixin:
  49. def destroy(self, request, *args, **kwargs):
  50. try:
  51. # noinspection PyUnresolvedReferences
  52. super().destroy(request, *args, **kwargs)
  53. except Http404:
  54. pass
  55. return Response(status=status.HTTP_204_NO_CONTENT)
  56. class DomainViewMixin:
  57. @property
  58. def throttle_scope(self):
  59. return 'dns_api_read' if self.request.method in SAFE_METHODS else 'dns_api_write_rrsets'
  60. @property
  61. def throttle_scope_bucket(self):
  62. # Note: bucket should remain constant even when domain is recreated
  63. return None if self.request.method in SAFE_METHODS else self.kwargs['name']
  64. def get_serializer_context(self):
  65. # noinspection PyUnresolvedReferences
  66. return {**super().get_serializer_context(), 'domain': self.domain}
  67. def initial(self, request, *args, **kwargs):
  68. # noinspection PyUnresolvedReferences
  69. super().initial(request, *args, **kwargs)
  70. try:
  71. # noinspection PyAttributeOutsideInit, PyUnresolvedReferences
  72. self.domain = self.request.user.domains.get(name=self.kwargs['name'])
  73. except models.Domain.DoesNotExist:
  74. raise Http404
  75. class TokenViewSet(IdempotentDestroyMixin, viewsets.ModelViewSet):
  76. serializer_class = serializers.TokenSerializer
  77. permission_classes = (IsAuthenticated, ManageTokensPermission,)
  78. throttle_scope = 'account_management_passive'
  79. def get_queryset(self):
  80. return self.request.user.auth_tokens.all()
  81. def get_serializer(self, *args, **kwargs):
  82. # When creating a new token, return the plaintext representation
  83. if self.request.method == 'POST':
  84. kwargs.setdefault('include_plain', True)
  85. return super().get_serializer(*args, **kwargs)
  86. def perform_create(self, serializer):
  87. serializer.save(user=self.request.user)
  88. class DomainViewSet(IdempotentDestroyMixin,
  89. mixins.CreateModelMixin,
  90. mixins.RetrieveModelMixin,
  91. mixins.DestroyModelMixin,
  92. mixins.ListModelMixin,
  93. viewsets.GenericViewSet):
  94. serializer_class = serializers.DomainSerializer
  95. permission_classes = (IsAuthenticated, IsOwner, WithinDomainLimitOnPOST)
  96. lookup_field = 'name'
  97. lookup_value_regex = r'[^/]+'
  98. @property
  99. def throttle_scope(self):
  100. return 'dns_api_read' if self.request.method in SAFE_METHODS else 'dns_api_write_domains'
  101. @property
  102. def pagination_class(self):
  103. # Turn off pagination when filtering for covered qname, as pagination would re-order by `created` (not what we
  104. # want here) after taking a slice (that's forbidden anyway). But, we don't need pagination in this case anyways.
  105. if 'owns_qname' in self.request.query_params:
  106. return None
  107. else:
  108. return api_settings.DEFAULT_PAGINATION_CLASS
  109. def get_queryset(self):
  110. qs = self.request.user.domains
  111. owns_qname = self.request.query_params.get('owns_qname')
  112. if owns_qname is not None:
  113. qs = qs.filter_qname(owns_qname).order_by('-name_length')[:1]
  114. return qs
  115. def get_serializer(self, *args, **kwargs):
  116. include_keys = (self.action in ['create', 'retrieve'])
  117. return super().get_serializer(*args, include_keys=include_keys, **kwargs)
  118. def perform_create(self, serializer):
  119. with PDNSChangeTracker():
  120. domain = serializer.save(owner=self.request.user)
  121. # TODO this line raises if the local public suffix is not in our database!
  122. PDNSChangeTracker.track(lambda: self.auto_delegate(domain))
  123. @staticmethod
  124. def auto_delegate(domain: models.Domain):
  125. if domain.is_locally_registrable:
  126. parent_domain = models.Domain.objects.get(name=domain.parent_domain_name)
  127. parent_domain.update_delegation(domain)
  128. def perform_destroy(self, instance: models.Domain):
  129. with PDNSChangeTracker():
  130. instance.delete()
  131. if instance.is_locally_registrable:
  132. parent_domain = models.Domain.objects.get(name=instance.parent_domain_name)
  133. with PDNSChangeTracker():
  134. parent_domain.update_delegation(instance)
  135. class SerialList(generics.ListAPIView):
  136. permission_classes = (IsVPNClient,)
  137. throttle_classes = [] # don't break slaves when they ask too often (our cached responses are cheap)
  138. def list(self, request, *args, **kwargs):
  139. key = 'desecapi.views.serials'
  140. serials = cache.get(key)
  141. if serials is None:
  142. serials = get_serials()
  143. cache.get_or_set(key, serials, timeout=15)
  144. return Response(serials)
  145. class RRsetDetail(IdempotentDestroyMixin, DomainViewMixin, generics.RetrieveUpdateDestroyAPIView):
  146. serializer_class = serializers.RRsetSerializer
  147. permission_classes = (IsAuthenticated, IsDomainOwner,)
  148. def get_queryset(self):
  149. return self.domain.rrset_set
  150. def get_object(self):
  151. queryset = self.filter_queryset(self.get_queryset())
  152. filter_kwargs = {k: self.kwargs[k] for k in ['subname', 'type']}
  153. obj = generics.get_object_or_404(queryset, **filter_kwargs)
  154. # May raise a permission denied
  155. self.check_object_permissions(self.request, obj)
  156. return obj
  157. def update(self, request, *args, **kwargs):
  158. response = super().update(request, *args, **kwargs)
  159. if response.data is None:
  160. response.status_code = 204
  161. return response
  162. def perform_update(self, serializer):
  163. with PDNSChangeTracker():
  164. super().perform_update(serializer)
  165. def perform_destroy(self, instance):
  166. with PDNSChangeTracker():
  167. super().perform_destroy(instance)
  168. class RRsetList(EmptyPayloadMixin, DomainViewMixin, generics.ListCreateAPIView, generics.UpdateAPIView):
  169. serializer_class = serializers.RRsetSerializer
  170. permission_classes = (IsAuthenticated, IsDomainOwner,)
  171. def get_queryset(self):
  172. rrsets = models.RRset.objects.filter(domain=self.domain)
  173. for filter_field in ('subname', 'type'):
  174. value = self.request.query_params.get(filter_field)
  175. if value is not None:
  176. # TODO consider moving this
  177. if filter_field == 'type' and value in models.RR_SET_TYPES_AUTOMATIC:
  178. raise PermissionDenied("You cannot tinker with the %s RRset." % value)
  179. rrsets = rrsets.filter(**{'%s__exact' % filter_field: value})
  180. return rrsets
  181. def get_object(self):
  182. # For this view, the object we're operating on is the queryset that one can also GET. Serializing a queryset
  183. # is fine as per https://www.django-rest-framework.org/api-guide/serializers/#serializing-multiple-objects.
  184. # We skip checking object permissions here to avoid evaluating the queryset. The user can access all his RRsets
  185. # anyways.
  186. return self.filter_queryset(self.get_queryset())
  187. def get_serializer(self, *args, **kwargs):
  188. kwargs = kwargs.copy()
  189. if 'many' not in kwargs:
  190. if self.request.method in ['POST']:
  191. kwargs['many'] = isinstance(kwargs.get('data'), list)
  192. elif self.request.method in ['PATCH', 'PUT']:
  193. kwargs['many'] = True
  194. return super().get_serializer(*args, **kwargs)
  195. def perform_create(self, serializer):
  196. with PDNSChangeTracker():
  197. super().perform_create(serializer)
  198. def perform_update(self, serializer):
  199. with PDNSChangeTracker():
  200. super().perform_update(serializer)
  201. class Root(APIView):
  202. def get(self, request, *_):
  203. if self.request.user.is_authenticated:
  204. routes = {
  205. 'account': {
  206. 'show': reverse('account', request=request),
  207. 'delete': reverse('account-delete', request=request),
  208. 'change-email': reverse('account-change-email', request=request),
  209. 'reset-password': reverse('account-reset-password', request=request),
  210. },
  211. 'logout': reverse('logout', request=request),
  212. 'tokens': reverse('token-list', request=request),
  213. 'domains': reverse('domain-list', request=request),
  214. }
  215. else:
  216. routes = {
  217. 'register': reverse('register', request=request),
  218. 'login': reverse('login', request=request),
  219. 'reset-password': reverse('account-reset-password', request=request),
  220. }
  221. return Response(routes)
  222. class DynDNS12Update(generics.GenericAPIView):
  223. authentication_classes = (auth.TokenAuthentication, auth.BasicTokenAuthentication, auth.URLParamAuthentication,)
  224. renderer_classes = [PlainTextRenderer]
  225. throttle_scope = 'dyndns'
  226. def _find_ip(self, params, version):
  227. if version == 4:
  228. look_for = '.'
  229. elif version == 6:
  230. look_for = ':'
  231. else:
  232. raise Exception
  233. # Check URL parameters
  234. for p in params:
  235. if p in self.request.query_params:
  236. if not len(self.request.query_params[p]):
  237. return None
  238. if look_for in self.request.query_params[p]:
  239. return self.request.query_params[p]
  240. # Check remote IP address
  241. client_ip = self.request.META.get('REMOTE_ADDR')
  242. if look_for in client_ip:
  243. return client_ip
  244. # give up
  245. return None
  246. @cached_property
  247. def qname(self):
  248. # hostname parameter
  249. try:
  250. if self.request.query_params['hostname'] != 'YES':
  251. return self.request.query_params['hostname'].lower()
  252. except KeyError:
  253. pass
  254. # host_id parameter
  255. try:
  256. return self.request.query_params['host_id'].lower()
  257. except KeyError:
  258. pass
  259. # http basic auth username
  260. try:
  261. domain_name = base64.b64decode(
  262. get_authorization_header(self.request).decode().split(' ')[1].encode()).decode().split(':')[0]
  263. if domain_name and '@' not in domain_name:
  264. return domain_name.lower()
  265. except (binascii.Error, IndexError, UnicodeDecodeError):
  266. pass
  267. # username parameter
  268. try:
  269. return self.request.query_params['username'].lower()
  270. except KeyError:
  271. pass
  272. # only domain associated with this user account
  273. try:
  274. return self.request.user.domains.get().name
  275. except models.Domain.MultipleObjectsReturned:
  276. raise ValidationError(detail={
  277. "detail": "Request does not properly specify domain for update.",
  278. "code": "domain-unspecified"
  279. })
  280. except models.Domain.DoesNotExist:
  281. metrics.get('desecapi_dynDNS12_domain_not_found').inc()
  282. raise NotFound('nohost')
  283. @cached_property
  284. def domain(self):
  285. try:
  286. return models.Domain.objects.filter_qname(self.qname, owner=self.request.user).order_by('-name_length')[0]
  287. except (IndexError, ValueError):
  288. raise NotFound('nohost')
  289. @property
  290. def subname(self):
  291. return self.qname.rpartition(f'.{self.domain.name}')[0]
  292. def get_queryset(self):
  293. return self.domain.rrset_set.filter(subname=self.subname, type__in=['A', 'AAAA'])
  294. def get(self, request, *_):
  295. instances = self.get_queryset().all()
  296. ipv4 = self._find_ip(['myip', 'myipv4', 'ip'], version=4)
  297. ipv6 = self._find_ip(['myipv6', 'ipv6', 'myip', 'ip'], version=6)
  298. data = [
  299. {'type': 'A', 'subname': self.subname, 'ttl': 60, 'records': [ipv4] if ipv4 else []},
  300. {'type': 'AAAA', 'subname': self.subname, 'ttl': 60, 'records': [ipv6] if ipv6 else []},
  301. ]
  302. context = {'domain': self.domain, 'minimum_ttl': 60}
  303. serializer = serializers.RRsetSerializer(instances, data=data, many=True, partial=True, context=context)
  304. try:
  305. serializer.is_valid(raise_exception=True)
  306. except ValidationError as e:
  307. if any(
  308. any(
  309. getattr(non_field_error, 'code', '') == 'unique'
  310. for non_field_error
  311. in err.get('non_field_errors', [])
  312. )
  313. for err in e.detail
  314. ):
  315. raise ConcurrencyException from e
  316. raise e
  317. with PDNSChangeTracker():
  318. serializer.save()
  319. return Response('good', content_type='text/plain')
  320. class DonationList(generics.CreateAPIView):
  321. serializer_class = serializers.DonationSerializer
  322. def perform_create(self, serializer):
  323. instance = serializer.save()
  324. context = {
  325. 'donation': instance,
  326. 'creditoridentifier': settings.SEPA['CREDITOR_ID'],
  327. 'creditorname': settings.SEPA['CREDITOR_NAME'],
  328. }
  329. # internal desec notification
  330. content_tmpl = get_template('emails/donation/desec-content.txt')
  331. subject_tmpl = get_template('emails/donation/desec-subject.txt')
  332. attachment_tmpl = get_template('emails/donation/desec-attachment-jameica.txt')
  333. from_tmpl = get_template('emails/from.txt')
  334. email = EmailMessage(subject_tmpl.render(context),
  335. content_tmpl.render(context),
  336. from_tmpl.render(context),
  337. ['donation@desec.io'],
  338. attachments=[
  339. ('jameica-directdebit.xml',
  340. attachment_tmpl.render(context),
  341. 'text/xml')
  342. ])
  343. email.send()
  344. # donor notification
  345. if instance.email:
  346. content_tmpl = get_template('emails/donation/donor-content.txt')
  347. subject_tmpl = get_template('emails/donation/donor-subject.txt')
  348. footer_tmpl = get_template('emails/footer.txt')
  349. email = EmailMessage(subject_tmpl.render(context),
  350. content_tmpl.render(context) + footer_tmpl.render(),
  351. from_tmpl.render(context),
  352. [instance.email])
  353. email.send()
  354. class AccountCreateView(generics.CreateAPIView):
  355. serializer_class = serializers.RegisterAccountSerializer
  356. throttle_scope = 'account_management_active'
  357. def create(self, request, *args, **kwargs):
  358. # Create user and send trigger email verification.
  359. # Alternative would be to create user once email is verified, but this could be abused for bulk email.
  360. serializer = self.get_serializer(data=request.data)
  361. activation_required = settings.USER_ACTIVATION_REQUIRED
  362. try:
  363. serializer.is_valid(raise_exception=True)
  364. except ValidationError as e:
  365. # Hide existing users
  366. email_detail = e.detail.pop('email', [])
  367. email_detail = [detail for detail in email_detail if detail.code != 'unique']
  368. if email_detail:
  369. e.detail['email'] = email_detail
  370. if e.detail:
  371. raise e
  372. else:
  373. # create user
  374. user = serializer.save(is_active=(not activation_required))
  375. # send email if needed
  376. domain = serializer.validated_data.get('domain')
  377. if domain or activation_required:
  378. link, validity_period = generate_confirmation_link(request,
  379. serializers.AuthenticatedActivateUserActionSerializer,
  380. 'confirm-activate-account', user=user, domain=domain)
  381. user.send_email('activate-with-domain' if domain else 'activate', context={
  382. 'confirmation_link': link,
  383. 'link_expiration_hours': validity_period // timedelta(hours=1),
  384. 'domain': domain,
  385. })
  386. # This request is unauthenticated, so don't expose whether we did anything.
  387. message = 'Welcome! Please check your mailbox.' if activation_required else 'Welcome!'
  388. return Response(data={'detail': message}, status=status.HTTP_202_ACCEPTED)
  389. class AccountView(generics.RetrieveAPIView):
  390. permission_classes = (IsAuthenticated,)
  391. serializer_class = serializers.UserSerializer
  392. throttle_scope = 'account_management_passive'
  393. def get_object(self):
  394. return self.request.user
  395. class AccountDeleteView(generics.GenericAPIView):
  396. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  397. permission_classes = (IsAuthenticated,)
  398. response_still_has_domains = Response(
  399. data={'detail': 'To delete your user account, first delete all of your domains.'},
  400. status=status.HTTP_409_CONFLICT,
  401. )
  402. throttle_scope = 'account_management_active'
  403. def post(self, request, *args, **kwargs):
  404. if self.request.user.domains.exists():
  405. return self.response_still_has_domains
  406. link, validity_period = generate_confirmation_link(request,
  407. serializers.AuthenticatedDeleteUserActionSerializer,
  408. 'confirm-delete-account', user=self.request.user)
  409. request.user.send_email('delete-user', context={
  410. 'confirmation_link': link,
  411. 'link_expiration_hours': validity_period // timedelta(hours=1),
  412. })
  413. return Response(data={'detail': 'Please check your mailbox for further account deletion instructions.'},
  414. status=status.HTTP_202_ACCEPTED)
  415. class AccountLoginView(generics.GenericAPIView):
  416. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  417. permission_classes = (IsAuthenticated,)
  418. throttle_scope = 'account_management_passive'
  419. def post(self, request, *args, **kwargs):
  420. user = self.request.user
  421. token = models.Token.objects.create(user=user, name="login", perm_manage_tokens=True,
  422. max_age=timedelta(days=7), max_unused_period=timedelta(hours=1))
  423. user_logged_in.send(sender=user.__class__, request=self.request, user=user)
  424. data = serializers.TokenSerializer(token, include_plain=True).data
  425. return Response(data)
  426. class AccountLogoutView(generics.GenericAPIView, mixins.DestroyModelMixin):
  427. authentication_classes = (auth.TokenAuthentication,)
  428. permission_classes = (IsAuthenticated,)
  429. throttle_classes = [] # always allow people to log out
  430. def get_object(self):
  431. # self.request.auth contains the hashed key as it is stored in the database
  432. return models.Token.objects.get(key=self.request.auth)
  433. def post(self, request, *args, **kwargs):
  434. return self.destroy(request, *args, **kwargs)
  435. class AccountChangeEmailView(generics.GenericAPIView):
  436. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  437. permission_classes = (IsAuthenticated,)
  438. serializer_class = serializers.ChangeEmailSerializer
  439. throttle_scope = 'account_management_active'
  440. def post(self, request, *args, **kwargs):
  441. # Check password and extract email
  442. serializer = self.get_serializer(data=request.data)
  443. serializer.is_valid(raise_exception=True)
  444. new_email = serializer.validated_data['new_email']
  445. link, validity_period = generate_confirmation_link(request,
  446. serializers.AuthenticatedChangeEmailUserActionSerializer,
  447. 'confirm-change-email', user=request.user, new_email=new_email)
  448. request.user.send_email('change-email', recipient=new_email, context={
  449. 'confirmation_link': link,
  450. 'link_expiration_hours': validity_period // timedelta(hours=1),
  451. 'old_email': request.user.email,
  452. 'new_email': new_email,
  453. })
  454. # At this point, we know that we are talking to the user, so we can tell that we sent an email.
  455. return Response(data={'detail': 'Please check your mailbox to confirm email address change.'},
  456. status=status.HTTP_202_ACCEPTED)
  457. class AccountResetPasswordView(generics.GenericAPIView):
  458. serializer_class = serializers.ResetPasswordSerializer
  459. throttle_scope = 'account_management_active'
  460. def post(self, request, *args, **kwargs):
  461. serializer = self.get_serializer(data=request.data)
  462. serializer.is_valid(raise_exception=True)
  463. try:
  464. email = serializer.validated_data['email']
  465. user = models.User.objects.get(email=email, is_active=True)
  466. except models.User.DoesNotExist:
  467. pass
  468. else:
  469. self.send_reset_token(user, request)
  470. # This request is unauthenticated, so don't expose whether we did anything.
  471. return Response(data={'detail': 'Please check your mailbox for further password reset instructions. '
  472. 'If you did not receive an email, please contact support.'},
  473. status=status.HTTP_202_ACCEPTED)
  474. @staticmethod
  475. def send_reset_token(user, request):
  476. link, validity_period = generate_confirmation_link(request,
  477. serializers.AuthenticatedResetPasswordUserActionSerializer,
  478. 'confirm-reset-password', user=user)
  479. user.send_email('reset-password', context={
  480. 'confirmation_link': link,
  481. 'link_expiration_hours': validity_period // timedelta(hours=1),
  482. })
  483. class AuthenticatedActionView(generics.GenericAPIView):
  484. """
  485. Abstract class. Deserializes the given payload according the serializers specified by the view extending
  486. this class. If the `serializer.is_valid`, `act` is called on the action object.
  487. Summary of the behavior depending on HTTP method and Accept: header:
  488. GET POST other method
  489. Accept: text/html forward to `self.html_url` if any perform action 405 Method Not Allowed
  490. else HTTP 406 Not Acceptable perform action 405 Method Not Allowed
  491. """
  492. authenticated_action = None
  493. html_url = None # Redirect GET requests to this webapp GUI URL
  494. http_method_names = ['get', 'post'] # GET is for redirect only
  495. renderer_classes = [JSONRenderer, StaticHTMLRenderer]
  496. @property
  497. def authentication_classes(self):
  498. # This prevents both code evaluation and user-specific throttling when we only want a redirect
  499. return () if self.request.method in SAFE_METHODS else (auth.AuthenticatedBasicUserActionAuthentication,)
  500. @property
  501. def throttle_scope(self):
  502. return 'account_management_passive' if self.request.method in SAFE_METHODS else 'account_management_active'
  503. def get_serializer_context(self):
  504. return {
  505. **super().get_serializer_context(),
  506. 'code': self.kwargs['code'],
  507. 'validity_period': self.get_serializer_class().validity_period,
  508. }
  509. def get(self, request, *args, **kwargs):
  510. # Redirect browsers to frontend if available
  511. is_redirect = (request.accepted_renderer.format == 'html') and self.html_url is not None
  512. if is_redirect:
  513. # Careful: This can generally lead to an open redirect if values contain slashes!
  514. # However, it cannot happen for Django view kwargs.
  515. return redirect(self.html_url.format(**kwargs))
  516. else:
  517. raise NotAcceptable
  518. def post(self, request, *args, **kwargs):
  519. super().perform_authentication(request)
  520. serializer = self.get_serializer(data=request.data)
  521. serializer.is_valid(raise_exception=True)
  522. try:
  523. self.authenticated_action = serializer.Meta.model(**serializer.validated_data)
  524. except ValueError: # this happens when state cannot be verified
  525. ex = ValidationError('This action cannot be carried out because another operation has been performed, '
  526. 'invalidating this one. (Are you trying to perform this action twice?)')
  527. ex.status_code = status.HTTP_409_CONFLICT
  528. raise ex
  529. self.authenticated_action.act()
  530. return self.finalize()
  531. def finalize(self):
  532. raise NotImplementedError
  533. class AuthenticatedActivateUserActionView(AuthenticatedActionView):
  534. html_url = '/confirm/activate-account/{code}/'
  535. serializer_class = serializers.AuthenticatedActivateUserActionSerializer
  536. def finalize(self):
  537. if not self.authenticated_action.domain:
  538. return self._finalize_without_domain()
  539. else:
  540. domain = self._create_domain()
  541. return self._finalize_with_domain(domain)
  542. def _create_domain(self):
  543. serializer = serializers.DomainSerializer(
  544. data={'name': self.authenticated_action.domain},
  545. context=self.get_serializer_context()
  546. )
  547. try:
  548. serializer.is_valid(raise_exception=True)
  549. except ValidationError as e: # e.g. domain name unavailable
  550. self.authenticated_action.user.delete()
  551. reasons = ', '.join([detail.code for detail in e.detail.get('name', [])])
  552. raise ValidationError(
  553. f'The requested domain {self.authenticated_action.domain} could not be registered (reason: {reasons}). '
  554. f'Please start over and sign up again.'
  555. )
  556. # TODO the following line is subject to race condition and can fail, as for the domain name, we have that
  557. # time-of-check != time-of-action
  558. return PDNSChangeTracker.track(lambda: serializer.save(owner=self.authenticated_action.user))
  559. def _finalize_without_domain(self):
  560. if not is_password_usable(self.authenticated_action.user.password):
  561. AccountResetPasswordView.send_reset_token(self.authenticated_action.user, self.request)
  562. return Response({
  563. 'detail': 'Success! We sent you instructions on how to set your password.'
  564. })
  565. login_url = self.request.build_absolute_uri(reverse('v1:login'))
  566. return Response({
  567. 'detail': f'Success! Please log in at {login_url}.'
  568. })
  569. def _finalize_with_domain(self, domain):
  570. if domain.is_locally_registrable:
  571. # TODO the following line raises Domain.DoesNotExist under unknown conditions
  572. PDNSChangeTracker.track(lambda: DomainViewSet.auto_delegate(domain))
  573. token = models.Token.objects.create(user=domain.owner, name='dyndns')
  574. return Response({
  575. 'detail': 'Success! Here is the password ("token") to configure your router (or any other dynDNS '
  576. 'client). This password is different from your account password for security reasons.',
  577. 'domain': serializers.DomainSerializer(domain).data,
  578. **serializers.TokenSerializer(token, include_plain=True).data,
  579. })
  580. else:
  581. return Response({
  582. 'detail': 'Success! Please check the docs for the next steps, https://desec.readthedocs.io/.',
  583. 'domain': serializers.DomainSerializer(domain, include_keys=True).data,
  584. })
  585. class AuthenticatedChangeEmailUserActionView(AuthenticatedActionView):
  586. html_url = '/confirm/change-email/{code}/'
  587. serializer_class = serializers.AuthenticatedChangeEmailUserActionSerializer
  588. def finalize(self):
  589. return Response({
  590. 'detail': f'Success! Your email address has been changed to {self.authenticated_action.user.email}.'
  591. })
  592. class AuthenticatedResetPasswordUserActionView(AuthenticatedActionView):
  593. html_url = '/confirm/reset-password/{code}/'
  594. serializer_class = serializers.AuthenticatedResetPasswordUserActionSerializer
  595. def finalize(self):
  596. login_url = self.request.build_absolute_uri(reverse('v1:login'))
  597. return Response({'detail': f'Success! Your password has been changed. Log in at {login_url}.'})
  598. class AuthenticatedDeleteUserActionView(AuthenticatedActionView):
  599. html_url = '/confirm/delete-account/{code}/'
  600. serializer_class = serializers.AuthenticatedDeleteUserActionSerializer
  601. def post(self, request, *args, **kwargs):
  602. if self.request.user.domains.exists():
  603. return AccountDeleteView.response_still_has_domains
  604. return super().post(request, *args, **kwargs)
  605. def finalize(self):
  606. return Response({'detail': 'All your data has been deleted. Bye bye, see you soon! <3'})
  607. class AuthenticatedRenewDomainBasicUserActionView(AuthenticatedActionView):
  608. html_url = '/confirm/renew-domain/{code}/'
  609. serializer_class = serializers.AuthenticatedRenewDomainBasicUserActionSerializer
  610. def finalize(self):
  611. return Response({'detail': f'We recorded that your domain {self.authenticated_action.domain} is still in use.'})
  612. class CaptchaView(generics.CreateAPIView):
  613. serializer_class = serializers.CaptchaSerializer
  614. throttle_scope = 'account_management_passive'