Skip to content

fix(auth): derive SSO display name from email local-part #23

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

Open
hunzlahmalik wants to merge 1 commit into
base: foss-main
Choose a base branch
from
Open

fix(auth): derive SSO display name from email local-part #23

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
9 changes: 5 additions & 4 deletions server/env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,10 +520,11 @@ export class Environment {

/**
* The authentication type to use. When set to "SSO", the server will trust
* X-Auth-Request-Email and X-Auth-Request-User headers injected by a reverse
* proxy (e.g. oauth2-proxy, Authelia) for authentication and automatic user
* provisioning. Only enable this when Outline is deployed behind a trusted
* authenticating proxy on a self-hosted instance.
* the X-Auth-Request-Email header injected by a reverse proxy
* (e.g. oauth2-proxy, Authelia) for authentication and automatic user
* provisioning. The display name is derived from the email local-part.
* Only enable this when Outline is deployed behind a trusted authenticating
* proxy on a self-hosted instance.
*/
@Public
@IsOptional()
Expand Down
33 changes: 0 additions & 33 deletions server/middlewares/authentication.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,9 +436,6 @@ describe("Authentication middleware", () => {
if (header === "x-auth-request-email") {
return newEmail;
}
if (header === "x-auth-request-user") {
return "New User";
}
return "";
}),
},
Expand All @@ -455,36 +452,6 @@ describe("Authentication middleware", () => {
where: { email: newEmail.toLowerCase() },
});
expect(provisioned).not.toBeNull();
expect(state.auth.user.email).toEqual(newEmail.toLowerCase());
expect(state.auth.user.name).toEqual("New User");
});

it("should use email prefix as name when X-Auth-Request-User is absent", async () => {
await buildTeam();
const state = {} as DefaultState;
const authMiddleware = auth();
const newEmail = `prefix-${randomString(6)}@example.com`;

await authMiddleware(
{
// @ts-expect-error mock request
request: {
get: jest.fn((header: string) => {
if (header === "x-auth-request-email") {
return newEmail;
}
return "";
}),
},
// @ts-expect-error mock cookies
cookies: { get: jest.fn(() => undefined), set: jest.fn() },
state,
ip: "127.0.0.1",
cache: {},
},
jest.fn()
);

expect(state.auth.user.email).toEqual(newEmail.toLowerCase());
expect(state.auth.user.name).toEqual(
newEmail.toLowerCase().split("@")[0]
Expand Down
3 changes: 1 addition & 2 deletions server/middlewares/authentication.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,6 @@ async function validateAuthentication(

const email = normalizeProxyEmail(token.slice(4));
const localPart = email.split("@")[0];
const displayName = ctx.request.get("x-auth-request-user") || localPart;
const { domain } = parseEmail(email);

// Concurrent-creation race guard. The SPA on first-ever login fires
Expand Down Expand Up @@ -448,7 +447,7 @@ async function validateAuthentication(
});
const created = await User.create(
{
name: displayName,
name: localPart,
email,
teamId: team.id,
// First user into a brand-new team becomes admin.
Expand Down
Loading