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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
exec credential provider: add v1 struct #102890
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
28 changes: 28 additions & 0 deletions
28
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/v1/conversion.go
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,28 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1 | ||
|
||
import ( | ||
"k8s.io/apimachinery/pkg/conversion" | ||
"k8s.io/client-go/pkg/apis/clientauthentication" | ||
) | ||
|
||
func Convert_clientauthentication_ExecCredentialSpec_To_v1_ExecCredentialSpec(in *clientauthentication.ExecCredentialSpec, out *ExecCredentialSpec, s conversion.Scope) error { | ||
// This conversion intentionally omits the Response field, which were only | ||
// supported in v1alpha1. | ||
return autoConvert_clientauthentication_ExecCredentialSpec_To_v1_ExecCredentialSpec(in, out, s) | ||
} |
24 changes: 24 additions & 0 deletions
24
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/v1/doc.go
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,24 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
// +k8s:deepcopy-gen=package | ||
// +k8s:conversion-gen=k8s.io/client-go/pkg/apis/clientauthentication | ||
// +k8s:openapi-gen=true | ||
// +k8s:defaulter-gen=TypeMeta | ||
|
||
// +groupName=client.authentication.k8s.io | ||
|
||
package v1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1" |
55 changes: 55 additions & 0 deletions
55
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/v1/register.go
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,55 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1 | ||
|
||
import ( | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
"k8s.io/apimachinery/pkg/runtime/schema" | ||
) | ||
|
||
// GroupName is the group name use in this package | ||
const GroupName = "client.authentication.k8s.io" | ||
|
||
// SchemeGroupVersion is group version used to register these objects | ||
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} | ||
|
||
// Resource takes an unqualified resource and returns a Group qualified GroupResource | ||
func Resource(resource string) schema.GroupResource { | ||
return SchemeGroupVersion.WithResource(resource).GroupResource() | ||
} | ||
|
||
var ( | ||
SchemeBuilder runtime.SchemeBuilder | ||
localSchemeBuilder = &SchemeBuilder | ||
AddToScheme = localSchemeBuilder.AddToScheme | ||
) | ||
|
||
func init() { | ||
// We only register manually written functions here. The registration of the | ||
// generated functions takes place in the generated files. The separation | ||
// makes the code compile even when the generated files are missing. | ||
localSchemeBuilder.Register(addKnownTypes) | ||
} | ||
|
||
func addKnownTypes(scheme *runtime.Scheme) error { | ||
scheme.AddKnownTypes(SchemeGroupVersion, | ||
&ExecCredential{}, | ||
) | ||
metav1.AddToGroupVersion(scheme, SchemeGroupVersion) | ||
return nil | ||
} |
122 changes: 122 additions & 0 deletions
122
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/v1/types.go
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,122 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1 | ||
|
||
import ( | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
) | ||
|
||
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
|
||
// ExecCredential is used by exec-based plugins to communicate credentials to | ||
// HTTP transports. | ||
type ExecCredential struct { | ||
metav1.TypeMeta `json:",inline"` | ||
|
||
// Spec holds information passed to the plugin by the transport. | ||
Spec ExecCredentialSpec `json:"spec,omitempty"` | ||
|
||
// Status is filled in by the plugin and holds the credentials that the transport | ||
// should use to contact the API. | ||
// +optional | ||
Status *ExecCredentialStatus `json:"status,omitempty"` | ||
} | ||
|
||
// ExecCredentialSpec holds request and runtime specific information provided by | ||
// the transport. | ||
type ExecCredentialSpec struct { | ||
// Cluster contains information to allow an exec plugin to communicate with the | ||
// kubernetes cluster being authenticated to. Note that Cluster is non-nil only | ||
// when provideClusterInfo is set to true in the exec provider config (i.e., | ||
// ExecConfig.ProvideClusterInfo). | ||
// +optional | ||
Cluster *Cluster `json:"cluster,omitempty"` | ||
|
||
// Interactive declares whether stdin has been passed to this exec plugin. | ||
Interactive bool `json:"interactive"` | ||
} | ||
|
||
// ExecCredentialStatus holds credentials for the transport to use. | ||
// | ||
// Token and ClientKeyData are sensitive fields. This data should only be | ||
// transmitted in-memory between client and exec plugin process. Exec plugin | ||
// itself should at least be protected via file permissions. | ||
type ExecCredentialStatus struct { | ||
// ExpirationTimestamp indicates a time when the provided credentials expire. | ||
// +optional | ||
ExpirationTimestamp *metav1.Time `json:"expirationTimestamp,omitempty"` | ||
// Token is a bearer token used by the client for request authentication. | ||
Token string `json:"token,omitempty" datapolicy:"token"` | ||
// PEM-encoded client TLS certificates (including intermediates, if any). | ||
ClientCertificateData string `json:"clientCertificateData,omitempty"` | ||
// PEM-encoded private key for the above certificate. | ||
ClientKeyData string `json:"clientKeyData,omitempty" datapolicy:"security-key"` | ||
} | ||
|
||
// Cluster contains information to allow an exec plugin to communicate | ||
// with the kubernetes cluster being authenticated to. | ||
// | ||
// To ensure that this struct contains everything someone would need to communicate | ||
// with a kubernetes cluster (just like they would via a kubeconfig), the fields | ||
// should shadow "k8s.io/client-go/tools/clientcmd/api/v1".Cluster, with the exception | ||
// of CertificateAuthority, since CA data will always be passed to the plugin as bytes. | ||
type Cluster struct { | ||
// Server is the address of the kubernetes cluster (https://hostname:port). | ||
Server string `json:"server"` | ||
// TLSServerName is passed to the server for SNI and is used in the client to | ||
// check server certificates against. If ServerName is empty, the hostname | ||
// used to contact the server is used. | ||
// +optional | ||
TLSServerName string `json:"tls-server-name,omitempty"` | ||
// InsecureSkipTLSVerify skips the validity check for the server's certificate. | ||
// This will make your HTTPS connections insecure. | ||
// +optional | ||
InsecureSkipTLSVerify bool `json:"insecure-skip-tls-verify,omitempty"` | ||
// CAData contains PEM-encoded certificate authority certificates. | ||
// If empty, system roots should be used. | ||
// +listType=atomic | ||
// +optional | ||
CertificateAuthorityData []byte `json:"certificate-authority-data,omitempty"` | ||
// ProxyURL is the URL to the proxy to be used for all requests to this | ||
// cluster. | ||
// +optional | ||
ProxyURL string `json:"proxy-url,omitempty"` | ||
// Config holds additional config data that is specific to the exec | ||
// plugin with regards to the cluster being authenticated to. | ||
// | ||
// This data is sourced from the clientcmd Cluster object's | ||
// extensions[client.authentication.k8s.io/exec] field: | ||
// | ||
// clusters: | ||
// - name: my-cluster | ||
// cluster: | ||
// ... | ||
// extensions: | ||
// - name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config | ||
// extension: | ||
// audience: 06e3fbd18de8 # arbitrary config | ||
// | ||
// In some environments, the user config may be exactly the same across many clusters | ||
// (i.e. call this exec plugin) minus some details that are specific to each cluster | ||
// such as the audience. This field allows the per cluster config to be directly | ||
// specified with the cluster info. Using this field to store secret data is not | ||
// recommended as one of the prime benefits of exec plugins is that no secrets need | ||
// to be stored directly in the kubeconfig. | ||
// +optional | ||
Config runtime.RawExtension `json:"config,omitempty"` | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
when promoting an API version, it's usually helpful to have a single commit that is a straight
cp -fr
of the previous version's package, to make it easy to see what, if anything changedIn this case, not much (this is a diff against the v1beta1 package):
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.
30a6812 now only contains the v1 struct