-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First draft of a GitHubIdentityProvider CRD
- Loading branch information
1 parent
4465810
commit 9af03e1
Showing
166 changed files
with
14,190 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
231 changes: 231 additions & 0 deletions
231
apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go.tmpl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,231 @@ | ||
| // Copyright 2024 the Pinniped contributors. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| type GitHubIdentityProviderPhase string | ||
|
|
||
| const ( | ||
| // GitHubPhasePending is the default phase for newly-created GitHubIdentityProvider resources. | ||
| GitHubPhasePending GitHubIdentityProviderPhase = "Pending" | ||
|
|
||
| // GitHubPhaseReady is the phase for an GitHubIdentityProvider resource in a healthy state. | ||
| GitHubPhaseReady GitHubIdentityProviderPhase = "Ready" | ||
|
|
||
| // GitHubPhaseError is the phase for an GitHubIdentityProvider in an unhealthy state. | ||
| GitHubPhaseError GitHubIdentityProviderPhase = "Error" | ||
| ) | ||
|
|
||
| type GitHubOrganizationLoginPolicy string | ||
|
|
||
| const ( | ||
| // GitHubOrganizationLoginPolicyAllOrgsAllowed means any GitHub user is allowed to log in using this identity | ||
| // provider, regardless of their organization membership or lack thereof. | ||
| GitHubOrganizationLoginPolicyAllOrgsAllowed GitHubOrganizationLoginPolicy = "AllOrganizationsAllowed" | ||
|
|
||
| // GitHubOrganizationLoginPolicyAllowedOrgsOnly means only those users with membership in the listed GitHub | ||
| // organizations are allowed to log in. | ||
| GitHubOrganizationLoginPolicyAllowedOrgsOnly GitHubOrganizationLoginPolicy = "AllowedOrganizationsOnly" | ||
| ) | ||
|
|
||
| // GitHubIdentityProviderStatus is the status of an GitHub identity provider. | ||
| type GitHubIdentityProviderStatus struct { | ||
| // Phase summarizes the overall status of the GitHubIdentityProvider. | ||
| // | ||
| // +kubebuilder:default=Pending | ||
| // +kubebuilder:validation:Enum=Pending;Ready;Error | ||
| Phase GitHubIdentityProviderPhase `json:"phase,omitempty"` | ||
|
|
||
| // Conditions represents the observations of an identity provider's current state. | ||
| // | ||
| // +patchMergeKey=type | ||
| // +patchStrategy=merge | ||
| // +listType=map | ||
| // +listMapKey=type | ||
| Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` | ||
| } | ||
|
|
||
| // GitHubAPIConfig allows configuration for GitHub Enterprise Server | ||
| type GitHubAPIConfig struct { | ||
| // Host is required only for GitHub Enterprise Server. | ||
| // Defaults to using GitHub's public API (github.com). | ||
| // | ||
| // +kubebuilder:default="github.com" | ||
| // +optional | ||
| Host string `json:"host"` | ||
|
|
||
| // TLS configuration for GitHub Enterprise Server. | ||
| // | ||
| // +optional | ||
| TLS *TLSSpec `json:"tls,omitempty"` | ||
| } | ||
|
|
||
| // GitHubUsernameAttribute allows the user to specify which attribute(s) from GitHub to use for the downstream username. | ||
| // See the response schema for | ||
| // [Get the authenticated user](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user). | ||
| type GitHubUsernameAttribute string | ||
|
|
||
| const ( | ||
| // GitHubUsernameID specifies using the `id` attribute from the GitHub user as the downstream username. | ||
| GitHubUsernameID GitHubUsernameAttribute = "id" | ||
|
|
||
| // GitHubUsernameLogin specifies using the `login` attribute from the GitHub user as the downstream username. | ||
| GitHubUsernameLogin GitHubUsernameAttribute = "login" | ||
|
|
||
| // GitHubUsernameLoginAndID specifies combining the `login` and `id` attributes from the GitHub user as the | ||
| // downstream username, separated by a colon. Example: "my-login:1234" | ||
| GitHubUsernameLoginAndID GitHubUsernameAttribute = "login:id" | ||
| ) | ||
|
|
||
| // GitHubGroupNameAttribute allows the user to specify which attribute from GitHub to use for the downstream group | ||
| // names. See the response schema for | ||
| // [List teams for the authenticated user](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user). | ||
| type GitHubGroupNameAttribute string | ||
|
|
||
| const ( | ||
| // GitHubUseTeamNameForGrouypName specifies using the GitHub team's `name` attribute as the downstream group name. | ||
| GitHubUseTeamNameForGrouypName GitHubGroupNameAttribute = "name" | ||
|
|
||
| // GitHubUseTeamSlugForGroupName specifies using the GitHub team's `slug` attribute as the downstream group name. | ||
| GitHubUseTeamSlugForGroupName GitHubGroupNameAttribute = "slug" | ||
| ) | ||
|
|
||
| // GitHubClaims allows customization of the username and groups claims | ||
| type GitHubClaims struct { | ||
| // Username configures which property of the GitHub user record shall determine the username in Kubernetes. | ||
| // | ||
| // Can be either "id", "login", or "login:id". Defaults to "login:id". | ||
| // | ||
| // GitHub's user login attributes can only contain alphanumeric characters and non-repeating hyphens, | ||
| // and may not start or end with hyphens. GitHub users are allowed to change their login name, | ||
| // although it is inconvenient. If a GitHub user changed their login name from "foo" to "bar", | ||
| // then a second user might change their name from "baz" to "foo" in order to take the old | ||
| // username of the first user. For this reason, it is not as safe to make authorization decisions | ||
| // based only on the user's login attribute. | ||
| // | ||
| // If desired, an admin could configure identity transformation expressions on the Pinniped Supervisor's | ||
| // FederationDomain to further customize how these usernames are presented to Kubernetes. | ||
| // | ||
| // Defaults to "login:id", which is the user login attribute, followed by a colon, followed by the unique and | ||
| // unchanging integer ID number attribute. This blends human-readable login names with the unchanging ID value | ||
| // from GitHub. Note that colons are not allowed in GitHub login attributes or ID numbers, so the colon in the | ||
| // "login:id" name will always be the login:id separator colon. | ||
| // | ||
| // See the response schema for | ||
| // [Get the authenticated user](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user). | ||
| // | ||
| // +kubebuilder:default="login:id" | ||
| // +kubebuilder:validation:Enum={"id","login","login:id"} | ||
| Username GitHubUsernameAttribute `json:"username"` | ||
|
|
||
| // Groups configures which property of the GitHub team record shall determine the group names in Kubernetes. | ||
| // | ||
| // Can be either "name" or "slug". Defaults to "slug". | ||
| // | ||
| // GitHub team names can contain upper and lower case characters, whitespace, and punctuation (e.g. "Kube admins!"). | ||
| // | ||
| // GitHub team slugs are lower case alphanumeric characters and may contain dashes and underscores (e.g. "kube-admins"). | ||
| // | ||
| // Group names as presented to Kubernetes will always be prefixed by the GitHub organization name followed by a | ||
| // forward slash (e.g. "my-org/my-team"). GitHub organization login names can only contain alphanumeric characters | ||
| // or single hyphens, so the first forward slash `/` will be the separator between the organization login name and | ||
| // the team name or slug. | ||
| // | ||
| // If desired, an admin could configure identity transformation expressions on the Pinniped Supervisor's | ||
| // FederationDomain to further customize how these group names are presented to Kubernetes. | ||
| // | ||
| // See the response schema for | ||
| // [List teams for the authenticated user](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user). | ||
| // | ||
| // +kubebuilder:default=slug | ||
| // +kubebuilder:validation:Enum=name;slug | ||
| Groups GitHubGroupNameAttribute `json:"groups"` | ||
| } | ||
|
|
||
| // GitHubClientSpec contains information about the GitHub client that this identity provider will use | ||
| // for web-based login flows. | ||
| type GitHubClientSpec struct { | ||
| // SecretName contains the name of a namespace-local Secret object that provides the clientID and | ||
| // clientSecret for an GitHub App or GitHub OAuth2 client. | ||
| // | ||
| // This secret must be of type "secrets.pinniped.dev/github-client" with keys "clientID" and "clientSecret". | ||
| SecretName string `json:"secretName"` | ||
| } | ||
|
|
||
| // GitHubIdentityProviderSpec is the spec for configuring an GitHub identity provider. | ||
| type GitHubIdentityProviderSpec struct { | ||
| // GitHubApi allows configuration for GitHub Enterprise Server | ||
| // | ||
| // +kubebuilder:default={} | ||
| GitHubApi GitHubAPIConfig `json:"gitHubAPI,omitempty"` | ||
|
|
||
| // Claims allows customization of the username and groups claims | ||
| // | ||
| // +optional | ||
| Claims GitHubClaims `json:"claims,omitempty"` | ||
|
|
||
| // AllowedOrganizations, when specified, indicates that only users with membership in at least one of the listed | ||
| // GitHub organizations may log in. In addition, the group membership presented to Kubernetes will only include | ||
| // teams within the listed GitHub organizations. Additional login rules or group filtering can optionally be | ||
| // provided as policy expression on any Pinniped Supervisor FederationDomain that includes this IDP. | ||
| // | ||
| // The configured GitHub App or GitHub OAuth App must be allowed to see membership in the listed organizations, | ||
| // otherwise Pinniped will not be aware that the user belongs to the listed organization or any teams | ||
| // within that organization. | ||
| // | ||
| // If no organizations are listed, you must set gitHubOrganizationLoginPolicy: AllOrganizationsAllowed | ||
| // | ||
| // +optional | ||
| AllowedOrganizations []string `json:"allowedOrganizations,omitempty"` | ||
|
|
||
| // GitHubOrganizationLoginPolicy must be set to "AllOrganizationsAllowed" if allowedOrganizations is empty. | ||
| // | ||
| // This field only exists to ensure that Pinniped administrators are aware that an empty list of | ||
| // allowedOrganizations means all GitHub users are allowed to log in. | ||
| // | ||
| // +kubebuilder:default=AllowedOrganizationsOnly | ||
| // +kubebuilder:validation:Enum=AllowedOrganizationsOnly;AllOrganizationsAllowed | ||
| // +optional | ||
| GitHubOrganizationLoginPolicy GitHubOrganizationLoginPolicy `json:"gitHubOrganizationLoginPolicy"` | ||
|
|
||
| // Client identifies the secret with credentials for a GitHub App or GitHub OAuth2 App (a GitHub client). | ||
| Client GitHubClientSpec `json:"client"` | ||
| } | ||
|
|
||
| // GitHubIdentityProvider describes the configuration of an upstream GitHub identity provider. | ||
| // This upstream provider can be configured with either a GitHub App or a GitHub OAuth2 App. | ||
| // | ||
| // Right now, only web-based logins are supported, for both the pinniped-cli client and clients configured | ||
| // as OIDCClients. | ||
| // | ||
| // +genclient | ||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
| // +kubebuilder:resource:categories=pinniped;pinniped-idp;pinniped-idps | ||
| // +kubebuilder:printcolumn:name="Host",type=string,JSONPath=`.spec.gitHubAPI.host` | ||
| // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.phase` | ||
| // +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp` | ||
| // +kubebuilder:subresource:status | ||
| type GitHubIdentityProvider struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| // Spec for configuring the identity provider. | ||
| Spec GitHubIdentityProviderSpec `json:"spec"` | ||
|
|
||
| // Status of the identity provider. | ||
| Status GitHubIdentityProviderStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| // GitHubIdentityProviderList lists GitHubIdentityProvider objects. | ||
| // | ||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
| type GitHubIdentityProviderList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
|
|
||
| Items []GitHubIdentityProvider `json:"items"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.