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

Jump to bottom

[server] Fix domain scope for session cookie #1903

Merged
merged 1 commit into from Oct 16, 2020
Merged

[server] Fix domain scope for session cookie #1903

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 19 additions & 10 deletions components/server/src/session-handler.ts
View file
Open in desktop
Expand Up @@ -43,11 +43,25 @@ export class SessionHandlerProvider {
}

protected getCookieOptions(env: Env): express.CookieOptions {
const hostParts = env.hostUrl.url.host.split('.');
const baseDomain = hostParts.slice(hostParts.length - 2).join('.');
let domain = `.${baseDomain}`;
const hostName = env.hostUrl.url.host;

let domain = hostName;
if (env.devBranch) {
// Use cookie for base domain to allow cookies being sent via ingress proxy in preview environments
//
// Otherwise, clients (in this case Chrome) may ignore (as in: save it, but don't send it on consequent requests) the 'Set-Cookie:...' send with a redirect (302, to github oauth)
// For details, see:
// - RFC draft sameSite: http://httpwg.org/http-extensions/draft-ietf-httpbis-cookie-same-site.html
// - https://bugs.chromium.org/p/chromium/issues/detail?id=150066
// - google: chromium not sending cookies set with redirect

const hostParts = hostName.split('.');
const baseDomain = hostParts.slice(hostParts.length - 2).join('.');
Copy link
Member

Choose a reason for hiding this comment

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

I wonder why the slicing and special handling is necessary here. Also in dev staging all the requests should go to the hostname URL. Is that not the case?

Copy link
Member Author

Choose a reason for hiding this comment

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

exactly. I recall, why this is actually needed. in dev staging preview environments we have the ingress proxy which terminates https connections, which is a crucial part in the login process, right? the URL of the ingress proxy has no namespace prefix at all, that's why we've chosen the sliced version of it. this allows those cookies to be present on ingress proxy requests, which are then forwarded to the services.

domain = `.${baseDomain}`;
Copy link
Member

Choose a reason for hiding this comment

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

I think we need the dot prefixing in all cases, as we want tosend the cookie with requests to subdomains as well, no?

Copy link
Member Author

Choose a reason for hiding this comment

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

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie

cf. Domain

Contrary to earlier specifications, leading dots in domain names (.example.com) are ignored.

Copy link
Member

Choose a reason for hiding this comment

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

then let's remove the dot here as well.

}

if (this.env.insecureNoDomain) {
domain = baseDomain.split(":")[0];
domain = hostName.split(":")[0];
}

return {
Expand All @@ -56,12 +70,7 @@ export class SessionHandlerProvider {
secure: false, // default, TODO SSL! Config proxy
maxAge: env.sessionMaxAgeMs, // configured in Helm chart, defaults to 3 days.
sameSite: "lax", // default: true. "Lax" needed for OAuth.
domain: `${domain}` // Use cookie for base domain (works for *.staging.gitpod.io because of the name, see below)
// Otherwise, clients (in this case Chrome) may ignore (as in: save it, but don't send it on consequent requests) the 'Set-Cookie:...' send with a redirect (302, to github oauth)
// For details, see:
// - RFC draft sameSite: http://httpwg.org/http-extensions/draft-ietf-httpbis-cookie-same-site.html
// - https://bugs.chromium.org/p/chromium/issues/detail?id=150066
// - google: chromium not sending cookies set with redirect
domain: `${domain}`
};
}

Expand Down