Skip to content

feat: apitoken last characters option #59455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/sentry/backup/comparators.py
Original file line number Diff line number Diff line change
Expand Up @@ -666,9 +666,7 @@ def get_default_comparators():
default_comparators: ComparatorMap = defaultdict(
list,
{
"sentry.apitoken": [
HashObfuscatingComparator("refresh_token", "token", "token_last_characters")
],
"sentry.apitoken": [HashObfuscatingComparator("refresh_token", "token")],
"sentry.apiapplication": [HashObfuscatingComparator("client_id", "client_secret")],
"sentry.authidentity": [HashObfuscatingComparator("ident", "token")],
"sentry.alertrule": [DateUpdatedComparator("date_modified")],
Expand Down
16 changes: 7 additions & 9 deletions src/sentry/models/apitoken.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

import secrets
from datetime import timedelta
from typing import ClassVar, Collection, Optional, Tuple
from typing import Any, ClassVar, Collection, Optional, Tuple

from django.db import models, router, transaction
from django.utils import timezone
from django.utils.encoding import force_str

from sentry import options
from sentry.backup.dependencies import ImportKind
from sentry.backup.helpers import ImportFlags
from sentry.backup.scopes import ImportScope, RelocationScope
Expand Down Expand Up @@ -57,15 +58,12 @@ class Meta:
def __str__(self):
return force_str(self.token)

# TODO(mdtro): uncomment this function after 0583_apitoken_add_name_and_last_chars migration has been applied
# def save(self, *args: Any, **kwargs: Any) -> None:
# # when a new ApiToken is created we take the last four characters of the token
# # and save them in the `token_last_characters` field so users can identify
# # tokens in the UI where they're mostly obfuscated
# token_last_characters = self.token[-4:]
# self.token_last_characters = token_last_characters
def save(self, *args: Any, **kwargs: Any) -> None:
if options.get("apitoken.auto-add-last-chars"):
token_last_characters = self.token[-4:]
self.token_last_characters = token_last_characters

# return super().save(**kwargs)
return super().save(**kwargs)

def outbox_region_names(self) -> Collection[str]:
return list(find_all_region_names())
Expand Down
7 changes: 7 additions & 0 deletions src/sentry/options/defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,13 @@
flags=FLAG_ALLOW_EMPTY | FLAG_PRIORITIZE_DISK | FLAG_REQUIRED,
)

# API Tokens
register(
"apitoken.auto-add-last-chars",
default=True,
type=Bool,
flags=FLAG_ALLOW_EMPTY | FLAG_PRIORITIZE_DISK | FLAG_AUTOMATOR_MODIFIABLE,
)

register(
"api.rate-limit.org-create",
Expand Down
Loading