Skip to content

feat: specify a custom "terms of service" link #13068

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

Merged
merged 9 commits into from
Apr 25, 2024
Merged

feat: specify a custom "terms of service" link #13068

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
331f8a4
feat: specify a custom terms of service link
aslilac Apr 24, 2024
8f03a45
require check
aslilac Apr 24, 2024
0b8ae10
noreferrer
aslilac Apr 24, 2024
d3ec782
bep
aslilac Apr 25, 2024
107d355
tweaks
aslilac Apr 25, 2024
1d3c010
`make gen`
aslilac Apr 25, 2024
e8550dc
url
aslilac Apr 25, 2024
43f20ea
i like
aslilac Apr 25, 2024
a06ddc2
`make update-golden-files`
aslilac Apr 25, 2024
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
3 changes: 2 additions & 1 deletion coderd/userauth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,7 @@ func (api *API) userAuthMethods(rw http.ResponseWriter, r *http.Request) {
}

httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.AuthMethods{
TermsOfServiceLink: api.DeploymentValues.TermsOfServiceLink.Value(),
Password: codersdk.AuthMethod{
Enabled: !api.DeploymentValues.DisablePasswordAuth.Value(),
},
Expand All @@ -486,7 +487,7 @@ func (api *API) userAuthMethods(rw http.ResponseWriter, r *http.Request) {

// @Summary OAuth 2.0 GitHub Callback
// @ID oauth-20-github-callback
// @Security CoderSessionToken
// @Security CoderSessionTokens
// @Tags Users
// @Success 307
// @Router /users/oauth2/github/callback [get]
Expand Down
9 changes: 9 additions & 0 deletions codersdk/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ type DeploymentValues struct {
AllowWorkspaceRenames serpent.Bool `json:"allow_workspace_renames,omitempty" typescript:",notnull"`
Healthcheck HealthcheckConfig `json:"healthcheck,omitempty" typescript:",notnull"`
CLIUpgradeMessage serpent.String `json:"cli_upgrade_message,omitempty" typescript:",notnull"`
TermsOfServiceLink serpent.String `json:"terms_of_service_link,omitempty" typescript:",notnull"`

Config serpent.YAMLConfigPath `json:"config,omitempty" typescript:",notnull"`
WriteConfig serpent.Bool `json:"write_config,omitempty" typescript:",notnull"`
Expand Down Expand Up @@ -1683,6 +1684,14 @@ when required by your organization's security policy.`,
YAML: "secureAuthCookie",
Annotations: serpent.Annotations{}.Mark(annotationExternalProxies, "true"),
},
{
Name: "Terms of Service Link",
Description: "A link to an external Terms of Service that must be accepted by users when logging in.",
Flag: "terms-of-service-link",
Env: "CODER_TERMS_OF_SERVICE_LINK",
YAML: "termsOfServiceLink",
Value: &c.TermsOfServiceLink,
},
{
Name: "Strict-Transport-Security",
Description: "Controls if the 'Strict-Transport-Security' header is set on all static file responses. " +
Expand Down
7 changes: 4 additions & 3 deletions codersdk/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,10 @@ type CreateOrganizationRequest struct {

// AuthMethods contains authentication method information like whether they are enabled or not or custom text, etc.
type AuthMethods struct {
Password AuthMethod `json:"password"`
Github AuthMethod `json:"github"`
OIDC OIDCAuthMethod `json:"oidc"`
TermsOfServiceLink string `json:"terms_of_service_link,omitempty"`
Password AuthMethod `json:"password"`
Github AuthMethod `json:"github"`
OIDC OIDCAuthMethod `json:"oidc"`
}

type AuthMethod struct {
Expand Down
2 changes: 2 additions & 0 deletions site/src/api/typesGenerated.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions site/src/pages/LoginPage/LoginPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
MockAuthMethodsAll,
MockAuthMethodsExternal,
MockAuthMethodsPasswordOnly,
MockAuthMethodsPasswordTermsOfService,
mockApiError,
} from "testHelpers/entities";
import { LoginPageView } from "./LoginPageView";
Expand Down Expand Up @@ -33,6 +34,12 @@ export const WithAllAuthMethods: Story = {
},
};

export const WithTermsOfService: Story = {
args: {
authMethods: MockAuthMethodsPasswordTermsOfService,
},
};

export const AuthError: Story = {
args: {
error: mockApiError({
Expand All @@ -53,6 +60,7 @@ export const ExternalAuthError: Story = {

export const LoadingAuthMethods: Story = {
args: {
isLoading: true,
authMethods: undefined,
},
};
Expand Down
67 changes: 47 additions & 20 deletions site/src/pages/LoginPage/SignInForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import type { Interpolation, Theme } from "@emotion/react";
import type { FC, ReactNode } from "react";
import Checkbox from "@mui/material/Checkbox";

Check failure on line 2 in site/src/pages/LoginPage/SignInForm.tsx

View workflow job for this annotation

GitHub Actions / fmt 

'@mui/material' import is restricted from being used. Use path imports to avoid pulling in unused modules. See: https://material-ui.com/guides/minimizing-bundle-size/
import { type FC, type ReactNode, useState } from "react";
import type { AuthMethods } from "api/typesGenerated";
import { Alert } from "components/Alert/Alert";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { getApplicationName } from "utils/appearance";
import { OAuthSignInForm } from "./OAuthSignInForm";
import { PasswordSignInForm } from "./PasswordSignInForm";
import { Link } from "@mui/material";

Check failure on line 10 in site/src/pages/LoginPage/SignInForm.tsx

View workflow job for this annotation

GitHub Actions / lint 

'@mui/material' import is restricted from being used. Use path imports to avoid pulling in unused modules. See: https://material-ui.com/guides/minimizing-bundle-size/

Check failure on line 10 in site/src/pages/LoginPage/SignInForm.tsx

View workflow job for this annotation

GitHub Actions / lint 

`@mui/material` import should occur before import of `@mui/material/Checkbox`

Check failure on line 10 in site/src/pages/LoginPage/SignInForm.tsx

View workflow job for this annotation

GitHub Actions / lint 

'@mui/material' import is restricted from being used. Use path imports to avoid pulling in unused modules. See: https://material-ui.com/guides/minimizing-bundle-size/

Check failure on line 10 in site/src/pages/LoginPage/SignInForm.tsx

View workflow job for this annotation

GitHub Actions / lint 

`@mui/material` import should occur before import of `@mui/material/Checkbox`

export const Language = {
emailLabel: "Email",
Expand Down Expand Up @@ -83,6 +85,10 @@
const passwordEnabled = authMethods?.password.enabled ?? true;
const applicationName = getApplicationName();

const [tosAccepted, setTosAccepted] = useState(false);
const termsOfServiceAcceptanceRequired =
authMethods?.terms_of_service_link && !tosAccepted;

return (
<div css={styles.root}>
<h1 css={styles.title}>{applicationName}</h1>
Expand All @@ -99,28 +105,49 @@
</div>
)}

{oAuthEnabled && (
<OAuthSignInForm
isSigningIn={isSigningIn}
redirectTo={redirectTo}
authMethods={authMethods}
/>
)}
{!termsOfServiceAcceptanceRequired && (
<>
{oAuthEnabled && (
<OAuthSignInForm
isSigningIn={isSigningIn}
redirectTo={redirectTo}
authMethods={authMethods}
/>
)}

{passwordEnabled && oAuthEnabled && (
<div css={styles.divider}>
<div css={styles.dividerLine} />
<div css={styles.dividerLabel}>Or</div>
<div css={styles.dividerLine} />
</div>
{passwordEnabled && oAuthEnabled && (
<div css={styles.divider}>
<div css={styles.dividerLine} />
<div css={styles.dividerLabel}>or</div>
<div css={styles.dividerLine} />
</div>
)}

{passwordEnabled && (
<PasswordSignInForm
onSubmit={onSubmit}
autoFocus={!oAuthEnabled}
isSigningIn={isSigningIn}
/>
)}
</>
)}

{passwordEnabled && (
<PasswordSignInForm
onSubmit={onSubmit}
autoFocus={!oAuthEnabled}
isSigningIn={isSigningIn}
/>
{authMethods?.terms_of_service_link && (
<div css={{ paddingTop: 8, fontSize: 14 }}>
<label>
<Checkbox
size="small"
checked={tosAccepted}
onChange={(event) => setTosAccepted(event.target.checked)}
/>
I agree to the{" "}
<Link href={authMethods.terms_of_service_link} target="_blank">
Terms of Service
</Link>
.
</label>
</div>
)}

{!passwordEnabled && !oAuthEnabled && (
Expand Down
5 changes: 1 addition & 4 deletions site/src/pages/UserSettingsPage/SecurityPage/SingleSignOnSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,7 @@ export const SingleSignOnSection: FC<SingleSignOnSectionProps> = ({
}) => {
const theme = useTheme();

const authList = Object.values(
authMethods,
) as (typeof authMethods)[keyof typeof authMethods][];
const noSsoEnabled = !authList.some((method) => method.enabled);
const noSsoEnabled = !authMethods.github.enabled && !authMethods.oidc.enabled;

return (
<>
Expand Down
7 changes: 7 additions & 0 deletions site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1373,6 +1373,13 @@ export const MockAuthMethodsPasswordOnly: TypesGen.AuthMethods = {
oidc: { enabled: false, signInText: "", iconUrl: "" },
};

export const MockAuthMethodsPasswordTermsOfService: TypesGen.AuthMethods = {
terms_of_service_link: "https://www.youtube.com/watch?v=C2f37Vb2NAE",
password: { enabled: true },
github: { enabled: false },
oidc: { enabled: false, signInText: "", iconUrl: "" },
};

export const MockAuthMethodsExternal: TypesGen.AuthMethods = {
password: { enabled: false },
github: { enabled: true },
Expand Down
Loading