views.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771
  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 SerialListView(APIView):
  136. permission_classes = (IsVPNClient,)
  137. throttle_classes = [] # don't break slaves when they ask too often (our cached responses are cheap)
  138. def get(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 DynDNS12UpdateView(generics.GenericAPIView):
  223. authentication_classes = (auth.TokenAuthentication, auth.BasicTokenAuthentication, auth.URLParamAuthentication,)
  224. renderer_classes = [PlainTextRenderer]
  225. serializer_class = serializers.RRsetSerializer
  226. throttle_scope = 'dyndns'
  227. def _find_ip(self, params, version):
  228. if version == 4:
  229. look_for = '.'
  230. elif version == 6:
  231. look_for = ':'
  232. else:
  233. raise Exception
  234. # Check URL parameters
  235. for p in params:
  236. if p in self.request.query_params:
  237. if not len(self.request.query_params[p]):
  238. return None
  239. if look_for in self.request.query_params[p]:
  240. return self.request.query_params[p]
  241. # Check remote IP address
  242. client_ip = self.request.META.get('REMOTE_ADDR')
  243. if look_for in client_ip:
  244. return client_ip
  245. # give up
  246. return None
  247. @cached_property
  248. def qname(self):
  249. # hostname parameter
  250. try:
  251. if self.request.query_params['hostname'] != 'YES':
  252. return self.request.query_params['hostname'].lower()
  253. except KeyError:
  254. pass
  255. # host_id parameter
  256. try:
  257. return self.request.query_params['host_id'].lower()
  258. except KeyError:
  259. pass
  260. # http basic auth username
  261. try:
  262. domain_name = base64.b64decode(
  263. get_authorization_header(self.request).decode().split(' ')[1].encode()).decode().split(':')[0]
  264. if domain_name and '@' not in domain_name:
  265. return domain_name.lower()
  266. except (binascii.Error, IndexError, UnicodeDecodeError):
  267. pass
  268. # username parameter
  269. try:
  270. return self.request.query_params['username'].lower()
  271. except KeyError:
  272. pass
  273. # only domain associated with this user account
  274. try:
  275. return self.request.user.domains.get().name
  276. except models.Domain.MultipleObjectsReturned:
  277. raise ValidationError(detail={
  278. "detail": "Request does not properly specify domain for update.",
  279. "code": "domain-unspecified"
  280. })
  281. except models.Domain.DoesNotExist:
  282. metrics.get('desecapi_dynDNS12_domain_not_found').inc()
  283. raise NotFound('nohost')
  284. @cached_property
  285. def domain(self):
  286. try:
  287. return models.Domain.objects.filter_qname(self.qname, owner=self.request.user).order_by('-name_length')[0]
  288. except (IndexError, ValueError):
  289. raise NotFound('nohost')
  290. @property
  291. def subname(self):
  292. return self.qname.rpartition(f'.{self.domain.name}')[0]
  293. def get_serializer_context(self):
  294. return {**super().get_serializer_context(), 'domain': self.domain, 'minimum_ttl': 60}
  295. def get_queryset(self):
  296. return self.domain.rrset_set.filter(subname=self.subname, type__in=['A', 'AAAA'])
  297. def get(self, request, *_):
  298. instances = self.get_queryset().all()
  299. ipv4 = self._find_ip(['myip', 'myipv4', 'ip'], version=4)
  300. ipv6 = self._find_ip(['myipv6', 'ipv6', 'myip', 'ip'], version=6)
  301. data = [
  302. {'type': 'A', 'subname': self.subname, 'ttl': 60, 'records': [ipv4] if ipv4 else []},
  303. {'type': 'AAAA', 'subname': self.subname, 'ttl': 60, 'records': [ipv6] if ipv6 else []},
  304. ]
  305. serializer = self.get_serializer(instances, data=data, many=True, partial=True)
  306. try:
  307. serializer.is_valid(raise_exception=True)
  308. except ValidationError as e:
  309. if any(
  310. any(
  311. getattr(non_field_error, 'code', '') == 'unique'
  312. for non_field_error
  313. in err.get('non_field_errors', [])
  314. )
  315. for err in e.detail
  316. ):
  317. raise ConcurrencyException from e
  318. raise e
  319. with PDNSChangeTracker():
  320. serializer.save()
  321. return Response('good', content_type='text/plain')
  322. class DonationList(generics.CreateAPIView):
  323. serializer_class = serializers.DonationSerializer
  324. def perform_create(self, serializer):
  325. instance = serializer.save()
  326. context = {
  327. 'donation': instance,
  328. 'creditoridentifier': settings.SEPA['CREDITOR_ID'],
  329. 'creditorname': settings.SEPA['CREDITOR_NAME'],
  330. }
  331. # internal desec notification
  332. content_tmpl = get_template('emails/donation/desec-content.txt')
  333. subject_tmpl = get_template('emails/donation/desec-subject.txt')
  334. attachment_tmpl = get_template('emails/donation/desec-attachment-jameica.txt')
  335. from_tmpl = get_template('emails/from.txt')
  336. email = EmailMessage(subject_tmpl.render(context),
  337. content_tmpl.render(context),
  338. from_tmpl.render(context),
  339. ['donation@desec.io'],
  340. attachments=[
  341. ('jameica-directdebit.xml',
  342. attachment_tmpl.render(context),
  343. 'text/xml')
  344. ])
  345. email.send()
  346. # donor notification
  347. if instance.email:
  348. content_tmpl = get_template('emails/donation/donor-content.txt')
  349. subject_tmpl = get_template('emails/donation/donor-subject.txt')
  350. footer_tmpl = get_template('emails/footer.txt')
  351. email = EmailMessage(subject_tmpl.render(context),
  352. content_tmpl.render(context) + footer_tmpl.render(),
  353. from_tmpl.render(context),
  354. [instance.email])
  355. email.send()
  356. class AccountCreateView(generics.CreateAPIView):
  357. serializer_class = serializers.RegisterAccountSerializer
  358. throttle_scope = 'account_management_active'
  359. def create(self, request, *args, **kwargs):
  360. # Create user and send trigger email verification.
  361. # Alternative would be to create user once email is verified, but this could be abused for bulk email.
  362. serializer = self.get_serializer(data=request.data)
  363. activation_required = settings.USER_ACTIVATION_REQUIRED
  364. try:
  365. serializer.is_valid(raise_exception=True)
  366. except ValidationError as e:
  367. # Hide existing users
  368. email_detail = e.detail.pop('email', [])
  369. email_detail = [detail for detail in email_detail if detail.code != 'unique']
  370. if email_detail:
  371. e.detail['email'] = email_detail
  372. if e.detail:
  373. raise e
  374. else:
  375. # create user
  376. user = serializer.save(is_active=(not activation_required))
  377. # send email if needed
  378. domain = serializer.validated_data.get('domain')
  379. if domain or activation_required:
  380. link, validity_period = generate_confirmation_link(request,
  381. serializers.AuthenticatedActivateUserActionSerializer,
  382. 'confirm-activate-account', user=user, domain=domain)
  383. user.send_email('activate-with-domain' if domain else 'activate', context={
  384. 'confirmation_link': link,
  385. 'link_expiration_hours': validity_period // timedelta(hours=1),
  386. 'domain': domain,
  387. })
  388. # This request is unauthenticated, so don't expose whether we did anything.
  389. message = 'Welcome! Please check your mailbox.' if activation_required else 'Welcome!'
  390. return Response(data={'detail': message}, status=status.HTTP_202_ACCEPTED)
  391. class AccountView(generics.RetrieveAPIView):
  392. permission_classes = (IsAuthenticated,)
  393. serializer_class = serializers.UserSerializer
  394. throttle_scope = 'account_management_passive'
  395. def get_object(self):
  396. return self.request.user
  397. class AccountDeleteView(APIView):
  398. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  399. permission_classes = (IsAuthenticated,)
  400. response_still_has_domains = Response(
  401. data={'detail': 'To delete your user account, first delete all of your domains.'},
  402. status=status.HTTP_409_CONFLICT,
  403. )
  404. throttle_scope = 'account_management_active'
  405. def post(self, request, *args, **kwargs):
  406. if self.request.user.domains.exists():
  407. return self.response_still_has_domains
  408. link, validity_period = generate_confirmation_link(request,
  409. serializers.AuthenticatedDeleteUserActionSerializer,
  410. 'confirm-delete-account', user=self.request.user)
  411. request.user.send_email('delete-user', context={
  412. 'confirmation_link': link,
  413. 'link_expiration_hours': validity_period // timedelta(hours=1),
  414. })
  415. return Response(data={'detail': 'Please check your mailbox for further account deletion instructions.'},
  416. status=status.HTTP_202_ACCEPTED)
  417. class AccountLoginView(generics.GenericAPIView):
  418. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  419. permission_classes = (IsAuthenticated,)
  420. serializer_class = serializers.TokenSerializer
  421. throttle_scope = 'account_management_passive'
  422. def post(self, request, *args, **kwargs):
  423. user = self.request.user
  424. token = models.Token.objects.create(user=user, name="login", perm_manage_tokens=True,
  425. max_age=timedelta(days=7), max_unused_period=timedelta(hours=1))
  426. user_logged_in.send(sender=user.__class__, request=self.request, user=user)
  427. data = self.get_serializer(token, include_plain=True).data
  428. return Response(data)
  429. class AccountLogoutView(APIView, mixins.DestroyModelMixin):
  430. authentication_classes = (auth.TokenAuthentication,)
  431. permission_classes = (IsAuthenticated,)
  432. throttle_classes = [] # always allow people to log out
  433. def get_object(self):
  434. # self.request.auth contains the hashed key as it is stored in the database
  435. return models.Token.objects.get(key=self.request.auth)
  436. def post(self, request, *args, **kwargs):
  437. return self.destroy(request, *args, **kwargs)
  438. class AccountChangeEmailView(generics.GenericAPIView):
  439. authentication_classes = (auth.EmailPasswordPayloadAuthentication,)
  440. permission_classes = (IsAuthenticated,)
  441. serializer_class = serializers.ChangeEmailSerializer
  442. throttle_scope = 'account_management_active'
  443. def post(self, request, *args, **kwargs):
  444. # Check password and extract email
  445. serializer = self.get_serializer(data=request.data)
  446. serializer.is_valid(raise_exception=True)
  447. new_email = serializer.validated_data['new_email']
  448. link, validity_period = generate_confirmation_link(request,
  449. serializers.AuthenticatedChangeEmailUserActionSerializer,
  450. 'confirm-change-email', user=request.user, new_email=new_email)
  451. request.user.send_email('change-email', recipient=new_email, context={
  452. 'confirmation_link': link,
  453. 'link_expiration_hours': validity_period // timedelta(hours=1),
  454. 'old_email': request.user.email,
  455. 'new_email': new_email,
  456. })
  457. # At this point, we know that we are talking to the user, so we can tell that we sent an email.
  458. return Response(data={'detail': 'Please check your mailbox to confirm email address change.'},
  459. status=status.HTTP_202_ACCEPTED)
  460. class AccountResetPasswordView(generics.GenericAPIView):
  461. serializer_class = serializers.ResetPasswordSerializer
  462. throttle_scope = 'account_management_active'
  463. def post(self, request, *args, **kwargs):
  464. serializer = self.get_serializer(data=request.data)
  465. serializer.is_valid(raise_exception=True)
  466. try:
  467. email = serializer.validated_data['email']
  468. user = models.User.objects.get(email=email, is_active=True)
  469. except models.User.DoesNotExist:
  470. pass
  471. else:
  472. self.send_reset_token(user, request)
  473. # This request is unauthenticated, so don't expose whether we did anything.
  474. return Response(data={'detail': 'Please check your mailbox for further password reset instructions. '
  475. 'If you did not receive an email, please contact support.'},
  476. status=status.HTTP_202_ACCEPTED)
  477. @staticmethod
  478. def send_reset_token(user, request):
  479. link, validity_period = generate_confirmation_link(request,
  480. serializers.AuthenticatedResetPasswordUserActionSerializer,
  481. 'confirm-reset-password', user=user)
  482. user.send_email('reset-password', context={
  483. 'confirmation_link': link,
  484. 'link_expiration_hours': validity_period // timedelta(hours=1),
  485. })
  486. class AuthenticatedActionView(generics.GenericAPIView):
  487. """
  488. Abstract class. Deserializes the given payload according the serializers specified by the view extending
  489. this class. If the `serializer.is_valid`, `act` is called on the action object.
  490. Summary of the behavior depending on HTTP method and Accept: header:
  491. GET POST other method
  492. Accept: text/html forward to `self.html_url` if any perform action 405 Method Not Allowed
  493. else HTTP 406 Not Acceptable perform action 405 Method Not Allowed
  494. """
  495. authenticated_action = None
  496. html_url = None # Redirect GET requests to this webapp GUI URL
  497. http_method_names = ['get', 'post'] # GET is for redirect only
  498. renderer_classes = [JSONRenderer, StaticHTMLRenderer]
  499. @property
  500. def authentication_classes(self):
  501. # This prevents both code evaluation and user-specific throttling when we only want a redirect
  502. return () if self.request.method in SAFE_METHODS else (auth.AuthenticatedBasicUserActionAuthentication,)
  503. @property
  504. def throttle_scope(self):
  505. return 'account_management_passive' if self.request.method in SAFE_METHODS else 'account_management_active'
  506. def get_serializer_context(self):
  507. return {
  508. **super().get_serializer_context(),
  509. 'code': self.kwargs['code'],
  510. 'validity_period': self.get_serializer_class().validity_period,
  511. }
  512. def get(self, request, *args, **kwargs):
  513. # Redirect browsers to frontend if available
  514. is_redirect = (request.accepted_renderer.format == 'html') and self.html_url is not None
  515. if is_redirect:
  516. # Careful: This can generally lead to an open redirect if values contain slashes!
  517. # However, it cannot happen for Django view kwargs.
  518. return redirect(self.html_url.format(**kwargs))
  519. else:
  520. raise NotAcceptable
  521. def post(self, request, *args, **kwargs):
  522. super().perform_authentication(request)
  523. serializer = self.get_serializer(data=request.data)
  524. serializer.is_valid(raise_exception=True)
  525. try:
  526. self.authenticated_action = serializer.Meta.model(**serializer.validated_data)
  527. except ValueError: # this happens when state cannot be verified
  528. ex = ValidationError('This action cannot be carried out because another operation has been performed, '
  529. 'invalidating this one. (Are you trying to perform this action twice?)')
  530. ex.status_code = status.HTTP_409_CONFLICT
  531. raise ex
  532. self.authenticated_action.act()
  533. return self.finalize()
  534. def finalize(self):
  535. raise NotImplementedError
  536. class AuthenticatedActivateUserActionView(AuthenticatedActionView):
  537. html_url = '/confirm/activate-account/{code}/'
  538. serializer_class = serializers.AuthenticatedActivateUserActionSerializer
  539. def finalize(self):
  540. if not self.authenticated_action.domain:
  541. return self._finalize_without_domain()
  542. else:
  543. domain = self._create_domain()
  544. return self._finalize_with_domain(domain)
  545. def _create_domain(self):
  546. serializer = serializers.DomainSerializer(
  547. data={'name': self.authenticated_action.domain},
  548. context=self.get_serializer_context()
  549. )
  550. try:
  551. serializer.is_valid(raise_exception=True)
  552. except ValidationError as e: # e.g. domain name unavailable
  553. self.authenticated_action.user.delete()
  554. reasons = ', '.join([detail.code for detail in e.detail.get('name', [])])
  555. raise ValidationError(
  556. f'The requested domain {self.authenticated_action.domain} could not be registered (reason: {reasons}). '
  557. f'Please start over and sign up again.'
  558. )
  559. # TODO the following line is subject to race condition and can fail, as for the domain name, we have that
  560. # time-of-check != time-of-action
  561. return PDNSChangeTracker.track(lambda: serializer.save(owner=self.authenticated_action.user))
  562. def _finalize_without_domain(self):
  563. if not is_password_usable(self.authenticated_action.user.password):
  564. AccountResetPasswordView.send_reset_token(self.authenticated_action.user, self.request)
  565. return Response({
  566. 'detail': 'Success! We sent you instructions on how to set your password.'
  567. })
  568. login_url = self.request.build_absolute_uri(reverse('v1:login'))
  569. return Response({
  570. 'detail': f'Success! Please log in at {login_url}.'
  571. })
  572. def _finalize_with_domain(self, domain):
  573. if domain.is_locally_registrable:
  574. # TODO the following line raises Domain.DoesNotExist under unknown conditions
  575. PDNSChangeTracker.track(lambda: DomainViewSet.auto_delegate(domain))
  576. token = models.Token.objects.create(user=domain.owner, name='dyndns')
  577. return Response({
  578. 'detail': 'Success! Here is the password ("token") to configure your router (or any other dynDNS '
  579. 'client). This password is different from your account password for security reasons.',
  580. 'domain': serializers.DomainSerializer(domain).data,
  581. **serializers.TokenSerializer(token, include_plain=True).data,
  582. })
  583. else:
  584. return Response({
  585. 'detail': 'Success! Please check the docs for the next steps, https://desec.readthedocs.io/.',
  586. 'domain': serializers.DomainSerializer(domain, include_keys=True).data,
  587. })
  588. class AuthenticatedChangeEmailUserActionView(AuthenticatedActionView):
  589. html_url = '/confirm/change-email/{code}/'
  590. serializer_class = serializers.AuthenticatedChangeEmailUserActionSerializer
  591. def finalize(self):
  592. return Response({
  593. 'detail': f'Success! Your email address has been changed to {self.authenticated_action.user.email}.'
  594. })
  595. class AuthenticatedResetPasswordUserActionView(AuthenticatedActionView):
  596. html_url = '/confirm/reset-password/{code}/'
  597. serializer_class = serializers.AuthenticatedResetPasswordUserActionSerializer
  598. def finalize(self):
  599. login_url = self.request.build_absolute_uri(reverse('v1:login'))
  600. return Response({'detail': f'Success! Your password has been changed. Log in at {login_url}.'})
  601. class AuthenticatedDeleteUserActionView(AuthenticatedActionView):
  602. html_url = '/confirm/delete-account/{code}/'
  603. serializer_class = serializers.AuthenticatedDeleteUserActionSerializer
  604. def post(self, request, *args, **kwargs):
  605. if self.request.user.domains.exists():
  606. return AccountDeleteView.response_still_has_domains
  607. return super().post(request, *args, **kwargs)
  608. def finalize(self):
  609. return Response({'detail': 'All your data has been deleted. Bye bye, see you soon! <3'})
  610. class AuthenticatedRenewDomainBasicUserActionView(AuthenticatedActionView):
  611. html_url = '/confirm/renew-domain/{code}/'
  612. serializer_class = serializers.AuthenticatedRenewDomainBasicUserActionSerializer
  613. def finalize(self):
  614. return Response({'detail': f'We recorded that your domain {self.authenticated_action.domain} is still in use.'})
  615. class CaptchaView(generics.CreateAPIView):
  616. serializer_class = serializers.CaptchaSerializer
  617. throttle_scope = 'account_management_passive'