Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(studio): enforce expiry scoped pat (#48811)

kemal.earthe8f5120dc551
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.constants.ts b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.constants.ts
index e3df791f6ca..847b29fd213 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.constants.ts
+++ b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.constants.ts
@@ -4,7 +4,6 @@ import { components } from 'api-types'
export type ScopedAccessTokenPermission =
components['schemas']['CreateScopedAccessTokenBody']['permissions'][number]
-export const NON_EXPIRING_TOKEN_VALUE = 'never'
export const CUSTOM_EXPIRY_VALUE = 'custom'
export const EXPIRES_AT_OPTIONS = {
@@ -12,7 +11,6 @@ export const EXPIRES_AT_OPTIONS = {
day: { value: 'day', label: '1 day' },
week: { value: 'week', label: '7 days' },
month: { value: 'month', label: '30 days' },
- never: { value: NON_EXPIRING_TOKEN_VALUE, label: 'Never' },
custom: { value: CUSTOM_EXPIRY_VALUE, label: 'Custom' },
} as const
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.test.ts b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.test.ts
index d037f8f25a9..c33b5eac4c4 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.test.ts
+++ b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.test.ts
@@ -358,10 +358,6 @@ describe('getExpirationDate', () => {
expect(result).toBe(dayjs(FIXED_DATE).add(30, 'days').toISOString())
})
- it('should return undefined for "never"', () => {
- expect(getExpirationDate('never')).toBeUndefined()
- })
-
it('should return undefined for an unknown key', () => {
expect(getExpirationDate('unknown')).toBeUndefined()
})
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.ts b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.ts
index 2c9cb737a18..250d286c43d 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.ts
+++ b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.utils.ts
@@ -8,6 +8,9 @@ import {
BaseToken,
} from './AccessToken.types'
+/** Custom expiry dates are capped at one year from today, for classic and scoped tokens alike. */
+export const getMaxCustomExpiryDate = (): dayjs.Dayjs => dayjs().add(1, 'year').endOf('day')
+
export const handleSortChange = (
currentSort: AccessTokenSort,
column: AccessTokenSortColumn,
@@ -141,8 +144,6 @@ export const getExpirationDate = (key: string): string | undefined => {
return dayjs().add(7, 'days').toISOString()
case 'month':
return dayjs().add(30, 'days').toISOString()
- case 'never':
- return undefined
default:
return undefined
}
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Classic/NewTokenDialog.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Classic/NewTokenDialog.tsx
index b66bc48a412..6cb812ffa14 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/Classic/NewTokenDialog.tsx
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Classic/NewTokenDialog.tsx
@@ -22,18 +22,13 @@ import {
SelectItem,
SelectTrigger,
SelectValue,
- WarningIcon,
} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { z } from 'zod'
-import {
- CUSTOM_EXPIRY_VALUE,
- EXPIRES_AT_OPTIONS,
- NON_EXPIRING_TOKEN_VALUE,
-} from '../AccessToken.constants'
-import { getExpirationDate } from '../AccessToken.utils'
+import { CUSTOM_EXPIRY_VALUE, EXPIRES_AT_OPTIONS } from '../AccessToken.constants'
+import { getExpirationDate, getMaxCustomExpiryDate } from '../AccessToken.utils'
import { DatePicker } from '@/components/ui/DatePicker'
import {
useAccessTokenCreateMutation,
@@ -45,10 +40,7 @@ const formId = 'new-access-token-form'
const TokenSchema = z.object({
tokenName: z.string().min(1, 'Please enter a name for the token'),
- expiresAt: z.preprocess(
- (val) => (val === NON_EXPIRING_TOKEN_VALUE ? undefined : val),
- z.string().optional()
- ),
+ expiresAt: z.string().min(1, 'Please select an expiry'),
})
export interface NewAccessTokenDialogProps {
@@ -81,7 +73,7 @@ export const NewTokenDialog = ({
if (isCustomExpiry && customExpiryDate) {
expiresAt = customExpiryDate.date
} else {
- expiresAt = getExpirationDate(values.expiresAt || '')
+ expiresAt = getExpirationDate(values.expiresAt)
}
createAccessToken(
@@ -90,7 +82,7 @@ export const NewTokenDialog = ({
onSuccess: (data) => {
track('access_token_created', {
tokenType: 'classic',
- expiryPreset: values.expiresAt || 'never',
+ expiryPreset: values.expiresAt,
})
toast.success('Access token created successfully')
onCreateToken(data)
@@ -101,7 +93,7 @@ export const NewTokenDialog = ({
}
const handleClose = () => {
- form.reset({ tokenName: '' })
+ form.reset()
setCustomExpiryDate(undefined)
setIsCustomExpiry(false)
onOpenChange(false)
@@ -228,21 +220,13 @@ export const NewTokenDialog = ({
contentSide="top"
to={customExpiryDate?.date}
minDate={new Date()}
- maxDate={dayjs().add(1, 'year').toDate()}
+ maxDate={getMaxCustomExpiryDate().toDate()}
onChange={(date) => {
if (date.to) handleCustomDateChange({ date: date.to })
}}
/>
)}
</div>
- {field.value === NON_EXPIRING_TOKEN_VALUE && (
- <div className="w-full flex gap-x-2 items-center mt-3 mx-0.5">
- <WarningIcon />
- <span className="text-xs text-left text-foreground-lighter">
- Make sure to keep your non-expiring token safe and secure.
- </span>
- </div>
- )}
</FormItemLayout>
)}
/>
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.test.ts b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.test.ts
new file mode 100644
index 00000000000..ec481a840bb
--- /dev/null
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.test.ts
@@ -0,0 +1,37 @@
+import dayjs from 'dayjs'
+import { describe, expect, test } from 'vitest'
+
+import { TokenFormSchema } from './NewScopedTokenForm.utils'
+
+const BASE_VALUES = {
+ tokenName: 'test',
+ expiresAt: 'custom',
+ resourceAccess: 'account',
+ organizationSlugs: [],
+ projectRefs: [],
+ permissions: {},
+}
+
+describe('TokenFormSchema custom expiry', () => {
+ test('requires a date when the preset is custom', () => {
+ const result = TokenFormSchema.safeParse(BASE_VALUES)
+ expect(result.success).toBe(false)
+ })
+ test('accepts a date within one year from today', () => {
+ const result = TokenFormSchema.safeParse({
+ ...BASE_VALUES,
+ customExpiryDate: dayjs().add(1, 'year').startOf('day').toISOString(),
+ })
+ expect(result.success).toBe(true)
+ })
+ test('rejects a date more than one year from today', () => {
+ const result = TokenFormSchema.safeParse({
+ ...BASE_VALUES,
+ customExpiryDate: dayjs().add(1, 'year').add(1, 'day').endOf('day').toISOString(),
+ })
+ expect(result.success).toBe(false)
+ expect(result.error?.issues.map((issue) => issue.message)).toContain(
+ 'Expiry date must be within one year from today'
+ )
+ })
+})
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.ts b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.ts
index 5adb798be82..3a2f288352f 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.ts
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.utils.ts
@@ -2,6 +2,7 @@ import dayjs from 'dayjs'
import { z } from 'zod'
import type { PermissionMode } from '../../AccessToken.permissions'
+import { getMaxCustomExpiryDate } from '../../AccessToken.utils'
export const EXPIRY_PRESETS = ['24h', '7d', '30d', '90d', 'custom'] as const
export type ExpiryPreset = (typeof EXPIRY_PRESETS)[number]
@@ -69,6 +70,18 @@ export const TokenFormSchema = z
})
}
+ if (
+ data.expiresAt === 'custom' &&
+ data.customExpiryDate &&
+ dayjs(data.customExpiryDate).isAfter(getMaxCustomExpiryDate())
+ ) {
+ ctx.addIssue({
+ code: z.ZodIssueCode.custom,
+ message: 'Expiry date must be within one year from today',
+ path: ['customExpiryDate'],
+ })
+ }
+
if (data.resourceAccess === 'project') {
if (data.organizationSlugs.length === 0) {
ctx.addIssue({
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/TokenDetails.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/TokenDetails.tsx
index d4261710611..64a91e603df 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/TokenDetails.tsx
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/TokenDetails.tsx
@@ -22,6 +22,7 @@ import {
} from 'ui-patterns/DatePicker'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
+import { getMaxCustomExpiryDate } from '../../AccessToken.utils'
import {
EXPIRY_OPTIONS,
getDefaultCustomExpiryDate,
@@ -35,6 +36,7 @@ interface TokenDetailsProps {
export const TokenDetails = ({ control, setValue }: TokenDetailsProps) => {
const customExpiryDate = useWatch({ control, name: 'customExpiryDate' })
+ const maxExpiryDate = getMaxCustomExpiryDate().toDate()
const handleExpiryChange = (value: string) => {
setValue('expiresAt', value as TokenFormValues['expiresAt'], { shouldValidate: true })
@@ -115,7 +117,12 @@ export const TokenDetails = ({ control, setValue }: TokenDetailsProps) => {
)
}
initialFocus
- disabled={{ before: dayjs().startOf('day').toDate() }}
+ startMonth={dayjs().startOf('month').toDate()}
+ endMonth={maxExpiryDate}
+ disabled={{
+ before: dayjs().startOf('day').toDate(),
+ after: maxExpiryDate,
+ }}
/>
</DatePickerContent>
</DatePicker>
diff --git a/apps/studio/components/ui/DatePicker/index.tsx b/apps/studio/components/ui/DatePicker/index.tsx
index bcc24d54698..df04c8977dd 100644
--- a/apps/studio/components/ui/DatePicker/index.tsx
+++ b/apps/studio/components/ui/DatePicker/index.tsx
@@ -82,6 +82,9 @@ export function DatePicker({
const disabledDays = useMemo(() => calculateDisabledDays(minDate, maxDate), [minDate, maxDate])
+ const startMonth = minDate ? dayjs(minDate).startOf('month').toDate() : undefined
+ const endMonth = maxDate ? dayjs(maxDate).endOf('month').toDate() : undefined
+
const clampDateToRange = useCallback(
(date: Date | null) => {
if (!date) return date
@@ -286,6 +289,8 @@ export function DatePicker({
{selectsRange ? (
<CalendarPicker
mode="range"
+ startMonth={startMonth}
+ endMonth={endMonth}
disabled={disabledDays}
selected={{ from: startDate ?? undefined, to: endDate ?? undefined }}
onSelect={(range) => {
@@ -295,6 +300,8 @@ export function DatePicker({
) : (
<CalendarPicker
mode="single"
+ startMonth={startMonth}
+ endMonth={endMonth}
disabled={disabledDays}
selected={endDate ?? undefined}
onSelect={(date) => {