Merge pull request #3609 from Infisical/ENG-2736

feat(org-settings): Option to hide certain products from the sidebar
This commit is contained in:
x032205
2025-05-15 23:24:14 -04:00
committed by GitHub
12 changed files with 320 additions and 83 deletions
@@ -0,0 +1,53 @@
import { Knex } from "knex";
import { TableName } from "../schemas";
export async function up(knex: Knex): Promise<void> {
const columns = await knex.table(TableName.Organization).columnInfo();
await knex.schema.alterTable(TableName.Organization, (t) => {
if (!columns.secretsProductEnabled) {
t.boolean("secretsProductEnabled").defaultTo(true);
}
if (!columns.pkiProductEnabled) {
t.boolean("pkiProductEnabled").defaultTo(true);
}
if (!columns.kmsProductEnabled) {
t.boolean("kmsProductEnabled").defaultTo(true);
}
if (!columns.sshProductEnabled) {
t.boolean("sshProductEnabled").defaultTo(true);
}
if (!columns.scannerProductEnabled) {
t.boolean("scannerProductEnabled").defaultTo(true);
}
if (!columns.shareSecretsProductEnabled) {
t.boolean("shareSecretsProductEnabled").defaultTo(true);
}
});
}
export async function down(knex: Knex): Promise<void> {
const columns = await knex.table(TableName.Organization).columnInfo();
await knex.schema.alterTable(TableName.Organization, (t) => {
if (columns.secretsProductEnabled) {
t.dropColumn("secretsProductEnabled");
}
if (columns.pkiProductEnabled) {
t.dropColumn("pkiProductEnabled");
}
if (columns.kmsProductEnabled) {
t.dropColumn("kmsProductEnabled");
}
if (columns.sshProductEnabled) {
t.dropColumn("sshProductEnabled");
}
if (columns.scannerProductEnabled) {
t.dropColumn("scannerProductEnabled");
}
if (columns.shareSecretsProductEnabled) {
t.dropColumn("shareSecretsProductEnabled");
}
});
}
+7 -1
View File
@@ -28,7 +28,13 @@ export const OrganizationsSchema = z.object({
privilegeUpgradeInitiatedByUsername: z.string().nullable().optional(), privilegeUpgradeInitiatedByUsername: z.string().nullable().optional(),
privilegeUpgradeInitiatedAt: z.date().nullable().optional(), privilegeUpgradeInitiatedAt: z.date().nullable().optional(),
bypassOrgAuthEnabled: z.boolean().default(false), bypassOrgAuthEnabled: z.boolean().default(false),
userTokenExpiration: z.string().nullable().optional() userTokenExpiration: z.string().nullable().optional(),
secretsProductEnabled: z.boolean().default(true).nullable().optional(),
pkiProductEnabled: z.boolean().default(true).nullable().optional(),
kmsProductEnabled: z.boolean().default(true).nullable().optional(),
sshProductEnabled: z.boolean().default(true).nullable().optional(),
scannerProductEnabled: z.boolean().default(true).nullable().optional(),
shareSecretsProductEnabled: z.boolean().default(true).nullable().optional()
}); });
export type TOrganizations = z.infer<typeof OrganizationsSchema>; export type TOrganizations = z.infer<typeof OrganizationsSchema>;
@@ -275,7 +275,13 @@ export const registerOrgRouter = async (server: FastifyZodProvider) => {
}, },
{ message: "Duration value must be at least 1" } { message: "Duration value must be at least 1" }
) )
.optional() .optional(),
secretsProductEnabled: z.boolean().optional(),
pkiProductEnabled: z.boolean().optional(),
kmsProductEnabled: z.boolean().optional(),
sshProductEnabled: z.boolean().optional(),
scannerProductEnabled: z.boolean().optional(),
shareSecretsProductEnabled: z.boolean().optional()
}), }),
response: { response: {
200: z.object({ 200: z.object({
+7 -1
View File
@@ -18,5 +18,11 @@ export const sanitizedOrganizationSchema = OrganizationsSchema.pick({
privilegeUpgradeInitiatedByUsername: true, privilegeUpgradeInitiatedByUsername: true,
privilegeUpgradeInitiatedAt: true, privilegeUpgradeInitiatedAt: true,
bypassOrgAuthEnabled: true, bypassOrgAuthEnabled: true,
userTokenExpiration: true userTokenExpiration: true,
secretsProductEnabled: true,
pkiProductEnabled: true,
kmsProductEnabled: true,
sshProductEnabled: true,
scannerProductEnabled: true,
shareSecretsProductEnabled: true
}); });
+14 -2
View File
@@ -355,7 +355,13 @@ export const orgServiceFactory = ({
selectedMfaMethod, selectedMfaMethod,
allowSecretSharingOutsideOrganization, allowSecretSharingOutsideOrganization,
bypassOrgAuthEnabled, bypassOrgAuthEnabled,
userTokenExpiration userTokenExpiration,
secretsProductEnabled,
pkiProductEnabled,
kmsProductEnabled,
sshProductEnabled,
scannerProductEnabled,
shareSecretsProductEnabled
} }
}: TUpdateOrgDTO) => { }: TUpdateOrgDTO) => {
const appCfg = getConfig(); const appCfg = getConfig();
@@ -457,7 +463,13 @@ export const orgServiceFactory = ({
selectedMfaMethod, selectedMfaMethod,
allowSecretSharingOutsideOrganization, allowSecretSharingOutsideOrganization,
bypassOrgAuthEnabled, bypassOrgAuthEnabled,
userTokenExpiration userTokenExpiration,
secretsProductEnabled,
pkiProductEnabled,
kmsProductEnabled,
sshProductEnabled,
scannerProductEnabled,
shareSecretsProductEnabled
}); });
if (!org) throw new NotFoundError({ message: `Organization with ID '${orgId}' not found` }); if (!org) throw new NotFoundError({ message: `Organization with ID '${orgId}' not found` });
return org; return org;
+6
View File
@@ -75,6 +75,12 @@ export type TUpdateOrgDTO = {
allowSecretSharingOutsideOrganization: boolean; allowSecretSharingOutsideOrganization: boolean;
bypassOrgAuthEnabled: boolean; bypassOrgAuthEnabled: boolean;
userTokenExpiration: string; userTokenExpiration: string;
secretsProductEnabled: boolean;
pkiProductEnabled: boolean;
kmsProductEnabled: boolean;
sshProductEnabled: boolean;
scannerProductEnabled: boolean;
shareSecretsProductEnabled: boolean;
}>; }>;
} & TOrgPermission; } & TOrgPermission;
@@ -112,7 +112,13 @@ export const useUpdateOrg = () => {
selectedMfaMethod, selectedMfaMethod,
allowSecretSharingOutsideOrganization, allowSecretSharingOutsideOrganization,
bypassOrgAuthEnabled, bypassOrgAuthEnabled,
userTokenExpiration userTokenExpiration,
secretsProductEnabled,
pkiProductEnabled,
kmsProductEnabled,
sshProductEnabled,
scannerProductEnabled,
shareSecretsProductEnabled
}) => { }) => {
return apiRequest.patch(`/api/v1/organization/${orgId}`, { return apiRequest.patch(`/api/v1/organization/${orgId}`, {
name, name,
@@ -124,7 +130,13 @@ export const useUpdateOrg = () => {
selectedMfaMethod, selectedMfaMethod,
allowSecretSharingOutsideOrganization, allowSecretSharingOutsideOrganization,
bypassOrgAuthEnabled, bypassOrgAuthEnabled,
userTokenExpiration userTokenExpiration,
secretsProductEnabled,
pkiProductEnabled,
kmsProductEnabled,
sshProductEnabled,
scannerProductEnabled,
shareSecretsProductEnabled
}); });
}, },
onSuccess: () => { onSuccess: () => {
@@ -20,6 +20,12 @@ export type Organization = {
allowSecretSharingOutsideOrganization?: boolean; allowSecretSharingOutsideOrganization?: boolean;
userTokenExpiration?: string; userTokenExpiration?: string;
userRole: string; userRole: string;
secretsProductEnabled: boolean;
pkiProductEnabled: boolean;
kmsProductEnabled: boolean;
sshProductEnabled: boolean;
scannerProductEnabled: boolean;
shareSecretsProductEnabled: boolean;
}; };
export type UpdateOrgDTO = { export type UpdateOrgDTO = {
@@ -34,6 +40,12 @@ export type UpdateOrgDTO = {
allowSecretSharingOutsideOrganization?: boolean; allowSecretSharingOutsideOrganization?: boolean;
bypassOrgAuthEnabled?: boolean; bypassOrgAuthEnabled?: boolean;
userTokenExpiration?: string; userTokenExpiration?: string;
secretsProductEnabled?: boolean;
pkiProductEnabled?: boolean;
kmsProductEnabled?: boolean;
sshProductEnabled?: boolean;
scannerProductEnabled?: boolean;
shareSecretsProductEnabled?: boolean;
}; };
export type BillingDetails = { export type BillingDetails = {
@@ -268,77 +268,91 @@ export const MinimizedOrgSidebar = () => {
</DropdownMenu> </DropdownMenu>
</div> </div>
<div className="space-y-1"> <div className="space-y-1">
<Link to="/organization/secret-manager/overview"> {currentOrg.secretsProductEnabled && (
{({ isActive }) => ( <Link to="/organization/secret-manager/overview">
<MenuIconButton {({ isActive }) => (
isSelected={ <MenuIconButton
isActive || isSelected={
window.location.pathname.startsWith( isActive ||
`/organization/${ProjectType.SecretManager}` window.location.pathname.startsWith(
) `/organization/${ProjectType.SecretManager}`
} )
icon="sliding-carousel" }
> icon="sliding-carousel"
Secrets >
</MenuIconButton> Secrets
)} </MenuIconButton>
</Link> )}
<Link to="/organization/cert-manager/overview"> </Link>
{({ isActive }) => ( )}
<MenuIconButton {currentOrg.pkiProductEnabled && (
isSelected={ <Link to="/organization/cert-manager/overview">
isActive || {({ isActive }) => (
window.location.pathname.startsWith( <MenuIconButton
`/organization/${ProjectType.CertificateManager}` isSelected={
) isActive ||
} window.location.pathname.startsWith(
icon="note" `/organization/${ProjectType.CertificateManager}`
> )
PKI }
</MenuIconButton> icon="note"
)} >
</Link> PKI
<Link to="/organization/kms/overview"> </MenuIconButton>
{({ isActive }) => ( )}
<MenuIconButton </Link>
isSelected={ )}
isActive || {currentOrg.kmsProductEnabled && (
window.location.pathname.startsWith(`/organization/${ProjectType.KMS}`) <Link to="/organization/kms/overview">
} {({ isActive }) => (
icon="unlock" <MenuIconButton
> isSelected={
KMS isActive ||
</MenuIconButton> window.location.pathname.startsWith(`/organization/${ProjectType.KMS}`)
)} }
</Link> icon="unlock"
<Link to="/organization/ssh/overview"> >
{({ isActive }) => ( KMS
<MenuIconButton </MenuIconButton>
isSelected={ )}
isActive || </Link>
window.location.pathname.startsWith(`/organization/${ProjectType.SSH}`) )}
} {currentOrg.sshProductEnabled && (
icon="verified" <Link to="/organization/ssh/overview">
> {({ isActive }) => (
SSH <MenuIconButton
</MenuIconButton> isSelected={
)} isActive ||
</Link> window.location.pathname.startsWith(`/organization/${ProjectType.SSH}`)
<div className="w-full bg-mineshaft-500" style={{ height: "1px" }} /> }
<Link to="/organization/secret-scanning"> icon="verified"
{({ isActive }) => ( >
<MenuIconButton isSelected={isActive} icon="secret-scan"> SSH
Scanner </MenuIconButton>
</MenuIconButton> )}
)} </Link>
</Link> )}
<Link to="/organization/secret-sharing"> {(currentOrg.scannerProductEnabled || currentOrg.shareSecretsProductEnabled) && (
{({ isActive }) => ( <div className="w-full bg-mineshaft-500" style={{ height: "1px" }} />
<MenuIconButton isSelected={isActive} icon="lock-closed"> )}
Share {currentOrg.scannerProductEnabled && (
</MenuIconButton> <Link to="/organization/secret-scanning">
)} {({ isActive }) => (
</Link> <MenuIconButton isSelected={isActive} icon="secret-scan">
Scanner
</MenuIconButton>
)}
</Link>
)}
{currentOrg.shareSecretsProductEnabled && (
<Link to="/organization/secret-sharing">
{({ isActive }) => (
<MenuIconButton isSelected={isActive} icon="lock-closed">
Share
</MenuIconButton>
)}
</Link>
)}
<div className="my-1 w-full bg-mineshaft-500" style={{ height: "1px" }} /> <div className="my-1 w-full bg-mineshaft-500" style={{ height: "1px" }} />
<DropdownMenu open={open} onOpenChange={setOpen} modal={false}> <DropdownMenu open={open} onOpenChange={setOpen} modal={false}>
<DropdownMenuTrigger <DropdownMenuTrigger
@@ -3,14 +3,18 @@ import { useOrgPermission } from "@app/context";
import { OrgDeleteSection } from "../OrgDeleteSection"; import { OrgDeleteSection } from "../OrgDeleteSection";
import { OrgIncidentContactsSection } from "../OrgIncidentContactsSection"; import { OrgIncidentContactsSection } from "../OrgIncidentContactsSection";
import { OrgNameChangeSection } from "../OrgNameChangeSection"; import { OrgNameChangeSection } from "../OrgNameChangeSection";
import { OrgProductSelectSection } from "../OrgProductSelectSection";
export const OrgGeneralTab = () => { export const OrgGeneralTab = () => {
const { membership } = useOrgPermission(); const { membership } = useOrgPermission();
return ( return (
<div className="rounded-lg border border-mineshaft-600 bg-mineshaft-900 p-6"> <>
<OrgNameChangeSection /> <div className="mb-6 rounded-lg border border-mineshaft-600 bg-mineshaft-900 p-6">
<OrgIncidentContactsSection /> <OrgNameChangeSection />
{membership && membership.role === "admin" && <OrgDeleteSection />} <OrgIncidentContactsSection />
</div> {membership && membership.role === "admin" && <OrgDeleteSection />}
</div>
{membership && membership.role === "admin" && <OrgProductSelectSection />}
</>
); );
}; };
@@ -0,0 +1,105 @@
import { useEffect, useState } from "react";
import { Switch } from "@app/components/v2";
import { useOrganization } from "@app/context";
import { useUpdateOrg } from "@app/hooks/api";
import axios from "axios";
import { createNotification } from "@app/components/notifications";
export const OrgProductSelectSection = () => {
const [toggledProducts, setToggledProducts] = useState<{
[key: string]: { name: string; enabled: boolean };
}>({
secretsProductEnabled: {
name: "Secret Management",
enabled: true
},
pkiProductEnabled: {
name: "Certificate Management",
enabled: true
},
kmsProductEnabled: {
name: "KMS",
enabled: true
},
sshProductEnabled: {
name: "SSH",
enabled: true
},
scannerProductEnabled: {
name: "Scanner",
enabled: true
},
shareSecretsProductEnabled: {
name: "Share Secrets",
enabled: true
}
});
const [isLoading, setIsLoading] = useState(false);
const { currentOrg } = useOrganization();
const { mutateAsync } = useUpdateOrg();
useEffect(() => {
Object.entries(currentOrg).forEach(([key, value]) => {
if (key in toggledProducts && typeof value === "boolean") {
setToggledProducts((products) => ({
...products,
[key]: { ...products[key], enabled: value }
}));
}
});
}, [currentOrg]);
const onProductToggle = async (value: boolean, key: string) => {
setIsLoading(true);
setToggledProducts((products) => ({
...products,
[key]: { ...products[key], enabled: value }
}));
try {
await mutateAsync({
orgId: currentOrg.id,
[key]: value
});
} catch (e) {
if (axios.isAxiosError(e)) {
const { message = "Something went wrong" } = e.response?.data as { message: string };
createNotification({
type: "error",
text: message
});
}
}
setIsLoading(false);
};
return (
<div className="mb-6 rounded-lg border border-mineshaft-600 bg-mineshaft-900 p-4">
<h2 className="text-xl font-semibold text-mineshaft-100">Organization Products</h2>
<p className="mb-4 text-gray-400">
Select which products are available for your organization.
</p>
<div className="grid grid-cols-2 gap-3">
{Object.entries(toggledProducts).map(([key, product]) => (
<Switch
key={key}
id={`enable-${key}`}
isDisabled={isLoading}
onCheckedChange={(value) => onProductToggle(value, key)}
isChecked={product.enabled}
className="ml-0"
containerClassName="flex-row-reverse gap-3 w-fit"
>
{product.name}
</Switch>
))}
</div>
</div>
);
};
@@ -0,0 +1 @@
export { OrgProductSelectSection } from "./OrgProductSelectSection";