__package__ = 'archivebox.api' import secrets from datetime import timedelta from django.conf import settings from django.db import models from django.utils import timezone from signal_webhooks.models import WebhookBase from django_stubs_ext.db.models import TypedModelMeta from abid_utils.models import ABIDModel, ABIDField, AutoDateTimeField def generate_secret_token() -> str: # returns cryptographically secure string with len() == 32 return secrets.token_hex(16) class APIToken(ABIDModel): """ A secret key generated by a User that's used to authenticate REST API requests to ArchiveBox. """ # ABID: apt____ abid_prefix = 'apt_' abid_ts_src = 'self.created_at' abid_uri_src = 'self.created_by_id' abid_subtype_src = '"01"' abid_rand_src = 'self.id' abid_drift_allowed = True id = models.UUIDField(primary_key=True, default=None, null=False, editable=False, unique=True, verbose_name='ID') abid = ABIDField(prefix=abid_prefix) created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, default=None, null=False) created_at = AutoDateTimeField(default=None, null=False, db_index=True) modified_at = models.DateTimeField(auto_now=True) token = models.CharField(max_length=32, default=generate_secret_token, unique=True) expires = models.DateTimeField(null=True, blank=True) class Meta(TypedModelMeta): verbose_name = "API Key" verbose_name_plural = "API Keys" def __str__(self) -> str: return self.token def __repr__(self) -> str: return f'' def __json__(self) -> dict: return { "TYPE": "APIToken", "id": str(self.pk), "abid": str(self.ABID), "created_by_id": str(self.created_by_id), "token": self.token, "created_at": self.created_at.isoformat(), "expires": self.expires_as_iso8601, } @property def expires_as_iso8601(self): """Returns the expiry date of the token in ISO 8601 format or a date 100 years in the future if none.""" expiry_date = self.expires or (timezone.now() + timedelta(days=365 * 100)) return expiry_date.isoformat() @property def token_redacted(self): return f'************{self.token[-4:]}' def is_valid(self, for_date=None): for_date = for_date or timezone.now() if self.expires and self.expires < for_date: return False return True # monkey patch django-signals-webhooks to change how it shows up in Admin UI class OutboundWebhook(ABIDModel, WebhookBase): """ Model used in place of (extending) signals_webhooks.models.WebhookModel. Swapped using: settings.SIGNAL_WEBHOOKS_CUSTOM_MODEL = 'api.models.OutboundWebhook' """ abid_prefix = 'whk_' abid_ts_src = 'self.created_at' abid_uri_src = 'self.endpoint' abid_subtype_src = 'self.ref' abid_rand_src = 'self.id' abid_drift_allowed = True id = models.UUIDField(primary_key=True, default=None, null=False, editable=False, unique=True, verbose_name='ID') abid = ABIDField(prefix=abid_prefix) created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, default=None, null=False) created_at = AutoDateTimeField(default=None, null=False, db_index=True) modified_at = models.DateTimeField(auto_now=True) # More fields here: WebhookBase... WebhookBase._meta.get_field('name').help_text = ( 'Give your webhook a descriptive name (e.g. Notify ACME Slack channel of any new ArchiveResults).') WebhookBase._meta.get_field('signal').help_text = ( 'The type of event the webhook should fire for (e.g. Create, Update, Delete).') WebhookBase._meta.get_field('ref').help_text = ( 'Dot import notation of the model the webhook should fire for (e.g. core.models.Snapshot or core.models.ArchiveResult).') WebhookBase._meta.get_field('endpoint').help_text = ( 'External URL to POST the webhook notification to (e.g. https://someapp.example.com/webhook/some-webhook-receiver).') class Meta(WebhookBase.Meta): verbose_name = 'API Outbound Webhook' def __str__(self) -> str: return f'[{self.abid}] {self.ref} -> {self.endpoint}'