Skip to content

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

Security definer materialized view (#40800)

Marouane Souda0e35cbf4a46e
diff --git a/apps/studio/components/interfaces/TableGridEditor/ExposedMaterializedViewDialog.tsx b/apps/studio/components/interfaces/TableGridEditor/ExposedMaterializedViewDialog.tsx
new file mode 100644
index 00000000000..5971e1f37a5
--- /dev/null
+++ b/apps/studio/components/interfaces/TableGridEditor/ExposedMaterializedViewDialog.tsx
@@ -0,0 +1,83 @@
+import {
+ Button,
+ Dialog,
+ DialogContent,
+ DialogFooter,
+ DialogHeader,
+ DialogSection,
+ DialogSectionSeparator,
+ DialogTitle,
+ DialogTrigger,
+} from 'ui'
+import { SimpleCodeBlock } from 'ui-patterns/SimpleCodeBlock'
+
+import { Entity } from '@/data/table-editor/table-editor-types'
+
+interface ExposedMaterializedViewDialogProps {
+ table: Entity
+ isExposedMaterializedViewDialogOpen: boolean
+ setIsExposedMaterializedViewDialogOpen: (isExposedMaterializedViewDialogOpen: boolean) => void
+}
+
+export function ExposedMaterializedViewDialog({
+ table,
+ isExposedMaterializedViewDialogOpen,
+ setIsExposedMaterializedViewDialogOpen,
+}: ExposedMaterializedViewDialogProps) {
+ return (
+ <Dialog
+ open={isExposedMaterializedViewDialogOpen}
+ onOpenChange={setIsExposedMaterializedViewDialogOpen}
+ >
+ <DialogTrigger asChild>
+ <Button
+ variant="secondary"
+ size="tiny"
+ onClick={() => setIsExposedMaterializedViewDialogOpen(true)}
+ >
+ Check possible options
+ </Button>
+ </DialogTrigger>
+ <DialogContent>
+ <DialogHeader>
+ <DialogTitle>Materialized view exposed via Data API</DialogTitle>
+ </DialogHeader>
+ <DialogSectionSeparator />
+ <DialogSection className="text-sm text-foreground-light space-y-2 prose">
+ <p>
+ Revoking <code>select</code> access from API roles <code>anon</code> and{' '}
+ <code>authenticated</code> mitigates the risk of exposing sensitive data to all users.
+ </p>
+ <SimpleCodeBlock>
+ {`REVOKE SELECT on "${table.schema}"."${table.name}"
+FROM public, anon, authenticated;`}
+ </SimpleCodeBlock>
+ <p>
+ Note that this is a breaking change if you have code that depends on accessing the
+ materialized view using the Data API. To reexpose the materialized view in a safe way,
+ you can put a function in front of it and apply a security rule equivalent to RLS:
+ </p>
+ <SimpleCodeBlock>
+ {`CREATE OR REPLACE FUNCTION get_${table.name}_secure()
+RETURNS SETOF "${table.schema}"."${table.name}"
+LANGUAGE sql
+SECURITY DEFINER
+SET search_path = ''
+AS $$
+ SELECT * FROM "${table.schema}"."${table.name}"
+ WHERE user_id = (SELECT auth.uid());
+$$;`}
+ </SimpleCodeBlock>
+ </DialogSection>
+
+ <DialogFooter>
+ <div className="flex items-center justify-end space-x-2">
+ <Button variant="default" onClick={() => setIsExposedMaterializedViewDialogOpen(false)}>
+ Understood
+ </Button>
+ </div>
+ </DialogFooter>
+ </DialogContent>
+ </Dialog>
+ )
+}
diff --git a/apps/studio/components/interfaces/TableGridEditor/GridHeaderActions.tsx b/apps/studio/components/interfaces/TableGridEditor/GridHeaderActions.tsx
index 58b7588cab0..03662e9e1a1 100644
--- a/apps/studio/components/interfaces/TableGridEditor/GridHeaderActions.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/GridHeaderActions.tsx
@@ -1,4 +1,5 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
+import { useParams } from 'common'
import { Realtime } from 'icons'
import { BookOpenText, Lightbulb, Lock, MoreVertical, PlusCircle, Unlock } from 'lucide-react'
import Link from 'next/link'
@@ -23,6 +24,7 @@ import {
import { EnableIndexAdvisorDialog } from '../QueryPerformance/IndexAdvisor/EnableIndexAdvisorButton'
import { RoleImpersonationPopover } from '../RoleImpersonationSelector/RoleImpersonationPopover'
+import { ExposedMaterializedViewDialog } from './ExposedMaterializedViewDialog'
import { InsertButton } from './InsertButton'
import { RealtimeToggleDialog } from './RealtimeToggleDialog'
import { SecurityDefinerViewPopover } from './SecurityDefinerViewPopover'
@@ -60,6 +62,7 @@ export interface GridHeaderActionsProps {
isRefetching: boolean
}
export const GridHeaderActions = ({ table, isRefetching }: GridHeaderActionsProps) => {
+ const { ref } = useParams()
const track = useTrack()
const appSnap = useAppStateSnapshot()
const snap = useTableEditorTableStateSnapshot()
@@ -69,6 +72,8 @@ export const GridHeaderActions = ({ table, isRefetching }: GridHeaderActionsProp
const [realtimeDialogOpen, setRealtimeDialogOpen] = useState(false)
const [indexAdvisorDialogOpen, setIndexAdvisorDialogOpen] = useState(false)
const [isAutofixViewSecurityModalOpen, setIsAutofixViewSecurityModalOpen] = useState(false)
+ const [isExposedMaterializedViewDialogOpen, setIsExposedMaterializedViewDialogOpen] =
+ useState(false)
const [showWarning, setShowWarning] = useQueryState(
'showWarning',
@@ -293,7 +298,49 @@ export const GridHeaderActions = ({ table, isRefetching }: GridHeaderActionsProp
)}
{isMaterializedView && materializedViewHasLints && (
- <SecurityDefinerViewPopover lint={matchingMaterializedViewLint} />
+ <Popover modal={false}>
+ <PopoverTrigger asChild>
+ <Button variant="warning" icon={<Unlock strokeWidth={1.5} />}>
+ Materialized View in API
+ </Button>
+ </PopoverTrigger>
+ <PopoverContent className="min-w-[395px] text-sm" align="end">
+ <h3 className="flex items-center gap-2">
+ <Unlock size={16} /> Secure your Materialized View
+ </h3>
+ <div className="grid gap-2 mt-4 text-foreground-light text-sm">
+ <p>
+ Because materialized views do not automatically enforce RLS policies from their
+ source tables, exposing them through the API may reveal data that would
+ otherwise be protected.
+ </p>
+
+ <p>
+ Since this materialized view is in a schema accessible to API roles, it can be
+ queried through your project's APIs.
+ </p>
+
+ <div className="mt-2 flex items-center gap-2">
+ <ExposedMaterializedViewDialog
+ table={table}
+ isExposedMaterializedViewDialogOpen={isExposedMaterializedViewDialogOpen}
+ setIsExposedMaterializedViewDialogOpen={
+ setIsExposedMaterializedViewDialogOpen
+ }
+ />
+
+ <Button variant="default" asChild>
+ <Link
+ target="_blank"
+ href={`/project/${ref}/advisors/security?preset=${matchingMaterializedViewLint?.level}&id=${matchingMaterializedViewLint?.cache_key}`}
+ >
+ Learn more
+ </Link>
+ </Button>
+ </div>
+ </div>
+ </PopoverContent>
+ </Popover>
)}
{isForeignTable && table.schema === 'public' && (
diff --git a/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx b/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
index e3e000216d6..96a5db87d82 100644
--- a/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
+++ b/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
@@ -591,7 +591,7 @@ const EntityTooltipTrigger = ({
if (materializedViewHasLints) {
tooltipContent = (
<>
- {accessWarning} as this is a Security definer view {learnMoreCTA}.
+ {accessWarning} as materialized view is accessible via API. {learnMoreCTA}.
</>
)
}