Skip to content

feat: allow external services to be authable #9996

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 21 commits into from
Oct 3, 2023
Merged

feat: allow external services to be authable #9996

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
a2ccfb0
feat: allow external services to be authable
kylecarbs Sep 30, 2023
614313b
Refactor external auth config structure for defaults
kylecarbs Oct 2, 2023
c4b0fa0
Add support for new config properties
kylecarbs Oct 2, 2023
e6c047c
Change the name of external auth
kylecarbs Oct 2, 2023
9ad24b6
Move externalauth -> external-auth
kylecarbs Oct 2, 2023
7937b0e
Run gen
kylecarbs Oct 2, 2023
ec7a7a0
Fix tests
kylecarbs Oct 2, 2023
c4a3dba
Fix MW tests
kylecarbs Oct 2, 2023
c4931b6
Fix git auth redirect
kylecarbs Oct 2, 2023
dbb1471
Fix lint
kylecarbs Oct 2, 2023
4fbc086
Fix name
kylecarbs Oct 2, 2023
02718dd
Allow any ID
kylecarbs Oct 2, 2023
6d75621
Fix invalid type test
kylecarbs Oct 2, 2023
291e61e
Fix e2e tests
kylecarbs Oct 2, 2023
386dc9c
Fix comments
kylecarbs Oct 2, 2023
0b409f3
Fix colors
kylecarbs Oct 2, 2023
0fd1f7a
Allow accepting any type as string
kylecarbs Oct 2, 2023
c1c4786
Run gen
kylecarbs Oct 2, 2023
edea1da
Merge branch 'main' into extauthprovider
kylecarbs Oct 2, 2023
0acc3a7
Fix href
kylecarbs Oct 2, 2023
4a101ea
Merge branch 'main' into extauthprovider
kylecarbs Oct 3, 2023
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
Prev Previous commit
Next Next commit
Allow any ID
  • Loading branch information
@kylecarbs
kylecarbs committed Oct 2, 2023
commit 02718dde935a7aab1e00854a9b7bef37e28a807f
16 changes: 8 additions & 8 deletions coderd/externalauth/externalauth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,6 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([

var typ codersdk.ExternalAuthProvider
switch codersdk.ExternalAuthProvider(entry.Type) {
case codersdk.ExternalAuthProviderOpenIDConnect:
typ = codersdk.ExternalAuthProviderOpenIDConnect
case codersdk.ExternalAuthProviderAzureDevops:
typ = codersdk.ExternalAuthProviderAzureDevops
case codersdk.ExternalAuthProviderBitBucket:
Expand All @@ -381,7 +379,7 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([
case codersdk.ExternalAuthProviderGitLab:
typ = codersdk.ExternalAuthProviderGitLab
default:
return nil, xerrors.Errorf("unknown external auth provider type: %q", entry.Type)
typ = codersdk.ExternalAuthProvider(entry.Type)
}

// Applies defaults to the config entry.
Expand Down Expand Up @@ -507,6 +505,13 @@ func applyDefaultsToConfig(typ codersdk.ExternalAuthProvider, config *codersdk.E
if config.ID == "" {
config.ID = string(typ)
}
if config.DisplayName == "" {
config.DisplayName = string(typ)
}
if config.DisplayIcon == "" {
// This is a key emoji.
config.DisplayIcon = "/emojis/1f511.png"
}
}

var defaults = map[codersdk.ExternalAuthProvider]codersdk.ExternalAuthConfig{
Expand Down Expand Up @@ -548,11 +553,6 @@ var defaults = map[codersdk.ExternalAuthProvider]codersdk.ExternalAuthConfig{
DeviceCodeURL: "https://github.com/login/device/code",
AppInstallationsURL: "https://api.github.com/user/installations",
},
codersdk.ExternalAuthProviderOpenIDConnect: {
DisplayName: "OpenID Connect",
// This is a key emoji.
DisplayIcon: "/emojis/1f511.png",
},
}

// jwtConfig is a new OAuth2 config that uses a custom
Expand Down
9 changes: 4 additions & 5 deletions codersdk/workspaceagents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,11 +749,10 @@ func (c *Client) WorkspaceAgentLogsAfter(ctx context.Context, agentID uuid.UUID,
type ExternalAuthProvider string

const (
ExternalAuthProviderAzureDevops ExternalAuthProvider = "azure-devops"
ExternalAuthProviderGitHub ExternalAuthProvider = "github"
ExternalAuthProviderGitLab ExternalAuthProvider = "gitlab"
ExternalAuthProviderBitBucket ExternalAuthProvider = "bitbucket"
ExternalAuthProviderOpenIDConnect ExternalAuthProvider = "oidc"
ExternalAuthProviderAzureDevops ExternalAuthProvider = "azure-devops"
ExternalAuthProviderGitHub ExternalAuthProvider = "github"
ExternalAuthProviderGitLab ExternalAuthProvider = "gitlab"
ExternalAuthProviderBitBucket ExternalAuthProvider = "bitbucket"
)

type WorkspaceAgentLog struct {
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/external-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Set the following environment variables to

```env
CODER_EXTERNAL_AUTH_0_ID="primary-github"
CODER_EXTERNAL_AUTH_0_TYPE=github|gitlab|azure-devops|bitbucket|oidc
CODER_EXTERNAL_AUTH_0_TYPE=github|gitlab|azure-devops|bitbucket|<name of service e.g. jfrog>
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx

Expand Down