Skip to content
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.

Sign up for GitHub

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

feat(sso): add support for identityProviderId in SAML flow #9411

Merged
merged 1 commit into from
Jan 7, 2025
+31 −30
Merged

feat(sso): add support for identityProviderId in SAML flow #9411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions ...nty-front/src/modules/settings/security/components/SettingsSSOIdentitiesProvidersForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { SettingsSSOSAMLForm } from '@/settings/security/components/SettingsSSOS
import { SettingSecurityNewSSOIdentityFormValues } from '@/settings/security/types/SSOIdentityProvider';
import { TextInput } from '@/ui/input/components/TextInput';
import styled from '@emotion/styled';
import { ReactElement } from 'react';
import { ReactElement, useMemo } from 'react';
import { Controller, useFormContext } from 'react-hook-form';
import { H2Title, IconComponent, IconKey, Section } from 'twenty-ui';
import { IdentityProviderType } from '~/generated/graphql';
Expand All @@ -27,7 +27,7 @@ const StyledInputsContainer = styled.div`
`;

export const SettingsSSOIdentitiesProvidersForm = () => {
const { control, getValues } =
const { control, watch } =
useFormContext<SettingSecurityNewSSOIdentityFormValues>();

const IdentitiesProvidersMap: Record<
Expand Down Expand Up @@ -62,16 +62,22 @@ export const SettingsSSOIdentitiesProvidersForm = () => {
},
};

const getFormByType = (type: Uppercase<IdentityProviderType> | undefined) => {
switch (type) {
const selectedType = watch('type');

const formByType = useMemo(() => {
switch (selectedType) {
case IdentityProviderType.Oidc:
return IdentitiesProvidersMap.OIDC.form;
case IdentityProviderType.Saml:
return IdentitiesProvidersMap.SAML.form;
default:
return null;
}
};
}, [
IdentitiesProvidersMap.OIDC.form,
IdentitiesProvidersMap.SAML.form,
selectedType,
]);

return (
<SettingsPageContainer>
Expand Down Expand Up @@ -115,7 +121,7 @@ export const SettingsSSOIdentitiesProvidersForm = () => {
/>
</StyledInputsContainer>
</Section>
{getFormByType(getValues().type)}
{formByType}
</SettingsPageContainer>
);
};
Expand Down
5 changes: 3 additions & 2 deletions packages/twenty-front/src/modules/settings/security/components/SettingsSSOSAMLForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const StyledButtonCopy = styled.div`
export const SettingsSSOSAMLForm = () => {
const { enqueueSnackBar } = useSnackBar();
const theme = useTheme();
const { setValue, getValues, watch } = useFormContext();
const { setValue, getValues, watch, trigger } = useFormContext();

const handleFileChange = async (e: ChangeEvent<HTMLInputElement>) => {
if (isDefined(e.target.files)) {
Expand All @@ -72,11 +72,12 @@ export const SettingsSSOSAMLForm = () => {
setValue('ssoURL', samlMetadataParsed.data.ssoUrl);
setValue('certificate', samlMetadataParsed.data.certificate);
setValue('issuer', samlMetadataParsed.data.entityID);
trigger();
}
};

const entityID = `${REACT_APP_SERVER_BASE_URL}/auth/saml/login/${getValues('id')}`;
const acsUrl = `${REACT_APP_SERVER_BASE_URL}/auth/saml/callback`;
const acsUrl = `${REACT_APP_SERVER_BASE_URL}/auth/saml/callback/${getValues('id')}`;

const inputFileRef = useRef<HTMLInputElement>(null);

Expand Down
25 changes: 12 additions & 13 deletions packages/twenty-front/src/pages/settings/security/SettingsSecuritySSOIdentifyProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/Snac
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
import { SubMenuTopBarContainer } from '@/ui/layout/page/components/SubMenuTopBarContainer';
import { zodResolver } from '@hookform/resolvers/zod';
import { useEffect } from 'react';
import pick from 'lodash.pick';
import { FormProvider, useForm } from 'react-hook-form';
import { useNavigate } from 'react-router-dom';

Expand All @@ -31,20 +31,19 @@ export const SettingsSecuritySSOIdentifyProvider = () => {
),
});

const selectedType = formConfig.watch('type');

useEffect(
() =>
formConfig.reset({
...sSOIdentityProviderDefaultValues[selectedType](),
name: formConfig.getValues('name'),
}),
[formConfig, selectedType],
);

const handleSave = async () => {
try {
await createSSOIdentityProvider(formConfig.getValues());
const type = formConfig.getValues('type');

await createSSOIdentityProvider(
SSOIdentitiesProvidersParamsSchema.parse(
pick(
formConfig.getValues(),
Object.keys(sSOIdentityProviderDefaultValues[type]()),
),
),
);
Comment on lines +38 to +45
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: This validation approach could allow invalid fields to be submitted if they were populated before switching SSO types. Consider clearing irrelevant fields when type changes.


navigate(getSettingsPagePath(SettingsPath.Security));
} catch (error) {
enqueueSnackBar((error as Error).message, {
Expand Down
3 changes: 2 additions & 1 deletion packages/twenty-server/src/engine/core-modules/auth/controllers/sso-auth.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export class SSOAuthController {
type: IdentityProviderType.SAML,
}),
callbackUrl: this.ssoService.buildCallbackUrl({
id: req.params.identityProviderId,
type: IdentityProviderType.SAML,
}),
});
Expand Down Expand Up @@ -104,7 +105,7 @@ export class SSOAuthController {
}
}

@Post('saml/callback')
@Post('saml/callback/:identityProviderId')
@UseGuards(SSOProviderEnabledGuard, SAMLAuthGuard)
async samlAuthCallback(@Req() req: any, @Res() res: Response) {
try {
Expand Down
6 changes: 0 additions & 6 deletions packages/twenty-server/src/engine/core-modules/auth/guards/saml-auth.guard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ export class SAMLAuthGuard extends AuthGuard('saml') {
try {
const request = context.switchToHttp().getRequest();

const RelayState =
'RelayState' in request.body ? JSON.parse(request.body.RelayState) : {};

request.params.identityProviderId =
request.params.identityProviderId ?? RelayState.identityProviderId;

if (!request.params.identityProviderId) {
throw new AuthException(
'Invalid SAML identity provider',
Expand Down
4 changes: 2 additions & 2 deletions packages/twenty-server/src/engine/core-modules/sso/services/sso.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,11 @@ export class SSOService {
}

buildCallbackUrl(
identityProvider: Pick<WorkspaceSSOIdentityProvider, 'type'>,
identityProvider: Pick<WorkspaceSSOIdentityProvider, 'type' | 'id'>,
) {
const callbackURL = new URL(this.environmentService.get('SERVER_URL'));

callbackURL.pathname = `/auth/${identityProvider.type.toLowerCase()}/callback`;
callbackURL.pathname = `/auth/${identityProvider.type.toLowerCase()}/callback/${identityProvider.id}`;

return callbackURL.toString();
}
Expand Down
Loading