-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #102890 from ankeesler/exec-plugin-v1
exec credential provider: add v1 struct Kubernetes-commit: 3392f16908a84dd96a29d52d2edee159fcb6711f
- Loading branch information
Showing
15 changed files
with
750 additions
and
30 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
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
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:https://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) | ||
} |
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:https://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" |
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:https://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 | ||
} |
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:https://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.