forked from kubernetes/kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Add handlers for service account issuer metadata. - Add option to manually override JWKS URI. - Add unit and integration tests. - Add a separate ServiceAccountIssuerDiscovery feature gate. Additional notes: - If not explicitly overridden, the JWKS URI will be based on the API server's external address and port. - The metadata server is configured with the validating key set rather than the signing key set. This allows for key rotation because tokens can still be validated by the keys exposed in the JWKs URL, even if the signing key has been rotated (note this may still be a short window if tokens have short lifetimes). - The trust model of OIDC discovery requires that the relying party fetch the issuer metadata via HTTPS; the trust of the issuer metadata comes from the server presenting a TLS certificate with a trust chain back to the from the relying party's root(s) of trust. For tests, we use a local issuer (https://kubernetes.default.svc) for the certificate so that workloads within the cluster can authenticate it when fetching OIDC metadata. An API server cannot validly claim https://kubernetes.io, but within the cluster, it is the authority for kubernetes.default.svc, according to the in-cluster config. Co-authored-by: Michael Taufen <[email protected]>
- Loading branch information
Showing
15 changed files
with
1,090 additions
and
5 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
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,114 @@ | ||
| /* | ||
| Copyright 2019 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 routes | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| restful "github.com/emicklei/go-restful" | ||
|
|
||
| "k8s.io/klog" | ||
| "k8s.io/kubernetes/pkg/serviceaccount" | ||
| ) | ||
|
|
||
| // This code is in package routes because many controllers import | ||
| // pkg/serviceaccount, but are not allowed by import-boss to depend on | ||
| // go-restful. All logic that deals with keys is kept in pkg/serviceaccount, | ||
| // and only the rendered JSON is passed into this server. | ||
|
|
||
| const ( | ||
| // cacheControl is the value of the Cache-Control header. Overrides the | ||
| // global `private, no-cache` setting. | ||
| headerCacheControl = "Cache-Control" | ||
| cacheControl = "public, max-age=3600" // 1 hour | ||
|
|
||
| // mimeJWKS is the content type of the keyset response | ||
| mimeJWKS = "application/jwk-set+json" | ||
| ) | ||
|
|
||
| // OpenIDMetadataServer is an HTTP server for metadata of the KSA token issuer. | ||
| type OpenIDMetadataServer struct { | ||
| configJSON []byte | ||
| keysetJSON []byte | ||
| } | ||
|
|
||
| // NewOpenIDMetadataServer creates a new OpenIDMetadataServer. | ||
| // The issuer is the OIDC issuer; keys are the keys that may be used to sign | ||
| // KSA tokens. | ||
| func NewOpenIDMetadataServer(configJSON, keysetJSON []byte) *OpenIDMetadataServer { | ||
| return &OpenIDMetadataServer{ | ||
| configJSON: configJSON, | ||
| keysetJSON: keysetJSON, | ||
| } | ||
| } | ||
|
|
||
| // Install adds this server to the request router c. | ||
| func (s *OpenIDMetadataServer) Install(c *restful.Container) { | ||
| // Configuration WebService | ||
| // Container.Add "will detect duplicate root paths and exit in that case", | ||
| // so we need a root for /.well-known/openid-configuration to avoid conflicts. | ||
| cfg := new(restful.WebService). | ||
| Produces(restful.MIME_JSON) | ||
|
|
||
| cfg.Path(serviceaccount.OpenIDConfigPath).Route( | ||
| cfg.GET(""). | ||
| To(fromStandard(s.serveConfiguration)). | ||
| Doc("get service account issuer OpenID configuration, also known as the 'OIDC discovery doc'"). | ||
| Operation("getServiceAccountIssuerOpenIDConfiguration"). | ||
| // Just include the OK, doesn't look like we include Internal Error in our openapi-spec. | ||
| Returns(http.StatusOK, "OK", "")) | ||
| c.Add(cfg) | ||
|
|
||
| // JWKS WebService | ||
| jwks := new(restful.WebService). | ||
| Produces(mimeJWKS) | ||
|
|
||
| jwks.Path(serviceaccount.JWKSPath).Route( | ||
| jwks.GET(""). | ||
| To(fromStandard(s.serveKeys)). | ||
| Doc("get service account issuer OpenID JSON Web Key Set (contains public token verification keys)"). | ||
| Operation("getServiceAccountIssuerOpenIDKeyset"). | ||
| // Just include the OK, doesn't look like we include Internal Error in our openapi-spec. | ||
| Returns(http.StatusOK, "OK", "")) | ||
| c.Add(jwks) | ||
| } | ||
|
|
||
| // fromStandard provides compatibility between the standard (net/http) handler signature and the restful signature. | ||
| func fromStandard(h http.HandlerFunc) restful.RouteFunction { | ||
| return func(req *restful.Request, resp *restful.Response) { | ||
| h(resp, req.Request) | ||
| } | ||
| } | ||
|
|
||
| func (s *OpenIDMetadataServer) serveConfiguration(w http.ResponseWriter, req *http.Request) { | ||
| w.Header().Set(restful.HEADER_ContentType, restful.MIME_JSON) | ||
| w.Header().Set(headerCacheControl, cacheControl) | ||
| if _, err := w.Write(s.configJSON); err != nil { | ||
| klog.Errorf("failed to write service account issuer metadata response: %v", err) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| func (s *OpenIDMetadataServer) serveKeys(w http.ResponseWriter, req *http.Request) { | ||
| // Per RFC7517 : https://tools.ietf.org/html/rfc7517#section-8.5.1 | ||
| w.Header().Set(restful.HEADER_ContentType, mimeJWKS) | ||
| w.Header().Set(headerCacheControl, cacheControl) | ||
| if _, err := w.Write(s.keysetJSON); err != nil { | ||
| klog.Errorf("failed to write service account issuer JWKS response: %v", err) | ||
| return | ||
| } | ||
| } |
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
Oops, something went wrong.