- Notifications
You must be signed in to change notification settings - Fork1k
feat: bypass built-in CORS handling for workspace apps#15669
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
return | ||
} | ||
// Use the passed in app middlewares before checking authentication and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Note to reviewers: this is the meat of the change.
I had to move some things around here since the token was only being createdafter CORS was handled, and the defined behavior is stored in the token.
I moved the CORS middleware invocation intodetermineCORSBehavior
because we needed to conditionally invoke it if behavior !=passthru
, only.
c5c74d1
toec3bac6
Compare4c6beb5
tof91f220
CompareSigned-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Signed-off-by: Danny Kopping <danny@coder.com>
Reopening; this has been deprioritized slightly but not forgotten. |
…8706)Solves#15096This is a slight rework/refactor of the earlier PRs from@dannykoppingand@Emyrk:-#15669-#15684-#17596Rather than having a per-app CORS behaviour setting and additionally atemplate level setting for ports, this PR adds a single template levelCORS behaviour setting that is then used by all apps/ports forworkspaces created from that template.The main changes are in `proxy.go` and `request.go` to:a) get the CORS behaviour setting from the templateb) have `HandleSubdomain` bypass the CORS middleware handler if theselected behaviour is `passthru`c) in `proxyWorkspaceApp`, do not modify the response if the selectedbehaviour is `passthru`<!-- This is an auto-generated comment: release notes by coderabbit.ai-->## Summary by CodeRabbit* **New Features*** Added support for configuring CORS behavior ("simple" or "passthru")at the template level for all shared ports.* Introduced a new "CORS Behavior" setting in the template creation andsettings forms.* API endpoints and responses now include the optional `cors_behavior`property for templates.* Workspace apps and proxy now honor the specified CORS behavior,enabling conditional CORS middleware application.* Enhanced workspace app tests with comprehensive scenarios coveringCORS behaviors and authentication states.* **Bug Fixes** * None.* **Documentation*** Updated API and admin documentation to describe the new`cors_behavior` property and its usage.* Added examples and schema references for CORS behavior in relevant APIdocs.* **Tests*** Extended automated tests to cover different CORS behavior scenariosfor templates and workspace apps.* **Chores*** Updated audit logging to track changes to the `cors_behavior` field ontemplates.<!-- end of auto-generated comment: release notes by coderabbit.ai -->---------Signed-off-by: Callum Styan <callumstyan@gmail.com>
Uh oh!
There was an error while loading.Please reload this page.
NOTE: this PR isblocked; we want to first introduce this feature to port shares, as it has transpired that that use-case is far more common. It would be awkward to get this PR into the next release but not for port shares, so we're keeping this one on hold.
This PR introduces a partial fix for#15096; it allows operators to specify the CORS behavior on a per-
coder_app
level.This change requires
cors_behavior
to be set on a givencoder_app
;coder/terraform-provider-coder#309 introduces that new attribute.coderd
currently handles CORS automatically by handling preflight requests and stripping CORS headers from upstreamcoder_app
responses.Two CORS behaviors are defined in this PR:
simple
: the current behavior of handling CORS withincoderd
passthru
:new behavior which transparently bypasses our CORS handling incoderd
so thecoder_app
service is then fully responsible for handling CORSWe plan to further add this behavior toport shares.
The sharing level (
owner
,authenticated
,public
) is still respected, regardless of CORS behavior.