Envoy jwt

api/v1alpha1/gateway_extensions_types.go

@@ -31,9 +31,10 @@ type GatewayExtension struct {
 // +kubebuilder:validation:XValidation:message="ExtAuth must not be set when type is not ExtAuth",rule="self.type == 'ExtAuth' || !has(self.extAuth)"
 // +kubebuilder:validation:XValidation:message="ExtProc must not be set when type is not ExtProc",rule="self.type == 'ExtProc' || !has(self.extProc)"
 // +kubebuilder:validation:XValidation:message="RateLimit must not be set when type is not RateLimit",rule="self.type == 'RateLimit' || !has(self.rateLimit)"
+// +kubebuilder:validation:XValidation:message="JwtProviders must not be set when type is not JWT",rule="self.type == 'JWTProviders' || !has(self.jwtProviders)"
 type GatewayExtensionSpec struct {
 	// Type indicates the type of the GatewayExtension to be used.
-	// +kubebuilder:validation:Enum=ExtAuth;ExtProc;RateLimit
+	// +kubebuilder:validation:Enum=ExtAuth;ExtProc;RateLimit;JWTProviders
 	// +required
 	Type GatewayExtensionType `json:"type"`
 
@@ -48,6 +49,11 @@ type GatewayExtensionSpec struct {
 	// RateLimit configuration for RateLimit extension type.
 	// +optional
 	RateLimit *RateLimitProvider `json:"rateLimit,omitempty"`
+
+	// JWTProviders configures a map of unique JWTProvider name to JWTProviders
+	// +optional
+	// +kubebuilder:validation:MaxProperties=32
+	JWTProviders map[string]JWTProvider `json:"jwtProviders,omitempty"`
 }
 
 // GatewayExtensionType indicates the type of the GatewayExtension.
@@ -60,6 +66,8 @@ const (
 	GatewayExtensionTypeExtProc GatewayExtensionType = "ExtProc"
 	// GatewayExtensionTypeRateLimit is the type for RateLimit extensions.
 	GatewayExtensionTypeRateLimit GatewayExtensionType = "RateLimit"
+	// GatewayExtensionTypeJWTProvider is the type for the JWT Provider extensions
+	GatewayExtensionTypeJWTProvider GatewayExtensionType = "JWTProviders"
 )
 
 // ExtGrpcService defines the GRPC service that will handle the processing.

api/v1alpha1/jwt.go

@@ -0,0 +1,132 @@
+package v1alpha1
+
+import corev1 "k8s.io/api/core/v1"
+
+// JWTValidation defines the providers used to configure JWT validation
+type JWTValidation struct {
+	// ExtensionRef references a GatewayExtension that provides the jwt providers
+	// +required
+	ExtensionRef *NamespacedObjectReference `json:"extensionRef"`
+
+	// TODO: add support for ValidationMode here (REQUIRE_VALID,ALLOW_MISSING,ALLOW_MISSING_OR_FAILED)
+
+	// TODO(npolshak): Add option to disable all jwt filters.
+}
+
+// JWTProvider configures the JWT Provider
+// If multiple providers are specified for a given JWT policy, the providers will be `OR`-ed together and will allow validation to any of the providers.
+type JWTProvider struct {
+	// Issuer of the JWT. the 'iss' claim of the JWT must match this.
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	// +optional
+	Issuer string `json:"issuer"`
+
+	// Audiences is the list of audiences to be used for the JWT provider.
+	// If specified an incoming JWT must have an 'aud' claim, and it must be in this list.
+	// If not specified, the audiences will not be checked in the token.
+	// +kubebuilder:validation:MinItems=1
+	// +kubebuilder:validation:MaxItems=100
+	// +optional
+	Audiences []string `json:"audiences,omitempty"`
+
+	// TokenSource configures where to find the JWT of the current provider.
+	// +optional
+	TokenSource *JWTTokenSource `json:"tokenSource,omitempty"`
+
+	// ClaimsToHeaders is the list of claims to headers to be used for the JWT provider.
+	// Optionally set the claims from the JWT payload that you want to extract and add as headers
+	// to the request before the request is forwarded to the upstream destination.
+	// +kubebuilder:validation:MinItems=1
+	// +kubebuilder:validation:MaxItems=100
+	// +optional
+	ClaimsToHeaders []JWTClaimToHeader `json:"claimsToHeaders,omitempty"`
+
+	// JWKS is the source for the JSON Web Keys to be used to validate the JWT.
+	JWKS JWKS `json:"jwks"`
+
+	// KeepToken configures if the token forwarded upstream. if false, the header containing the token will be removed.
+	// +kubebuilder:validation:Enum=Forward;Remove
+	// +kubebuilder:default=Remove
+	// +optional
+	KeepToken *KeepToken `json:"keepToken,omitempty"`
+}
+
+// KeepToken configures if the token forwarded behavior.
+type KeepToken string
+
+const (
+	TokenForward KeepToken = "Forward"
+	TokenRemove  KeepToken = "Remove"
+)
+
+// HeaderSource configures how to retrieve a JWT from a header
+type HeaderSource struct {
+	// Header is the name of the header. for example, "Authorization"
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	// +optional
+	Header *string `json:"header,omitempty"`
+	// Prefix before the token. for example, "Bearer "
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	// +optional
+	Prefix *string `json:"prefix,omitempty"`
+}
+
+// JWTTokenSource configures the source for the JWTToken
+type JWTTokenSource struct {
+	// HeaderSource configures retrieving token from the headers
+	// +kubebuilder:validation:MinItems=1
+	// +kubebuilder:validation:MaxItems=100
+	// +optional
+	HeaderSource []HeaderSource `json:"headers,omitempty"`
+	// QueryParams configures retrieving token from these query params
+	// +kubebuilder:validation:MinItems=1
+	// +kubebuilder:validation:MaxItems=100
+	// +optional
+	QueryParams []string `json:"queryParams,omitempty"`
+}
+
+// JWTClaimToHeader allows copying verified claims to headers sent upstream
+type JWTClaimToHeader struct {
+	// Name is the JWT claim name, for example, "sub".
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	Name string `json:"name"`
+
+	// Header is the header the claim will be copied to, for example, "x-sub".
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	Header string `json:"header"`
+}
+
+// JWKS (JSON Web Key Set) configures the source for the JWKS
+type JWKS struct {
+	// LocalJWKS configures provide a PEM-formatted public key or file to verify the JWT token.
+	// +optional
+	LocalJWKS *LocalJWKS `json:"local,omitempty"`
+
+	// TODO: Add support RemoteJWKs here in the future
+}
+
+// LocalJWKS configures getting the public keys to validate the JWT from a local source, such as a Kubernetes secret,
+// inline, raw string JWKS or file source.
+// +kubebuilder:validation:XValidation:message="exactly one of file, key, or secretRef must be set",rule="(has(self.file) && !has(self.key) && !has(self.secretRef)) || (!has(self.file) && has(self.key) && !has(self.secretRef)) || (!has(self.file) && !has(self.key) && has(self.secretRef))"
+type LocalJWKS struct {
+	// File is the path to the file containing the JWKS
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	// +optional
+	File *string `json:"file,omitempty"`
+
+	// InlineKey is the JWKS key as the raw, inline JWKS string
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=2048
+	// +optional
+	InlineKey *string `json:"key,omitempty"`
+
+	// SecretRef configures storing the JWK in a Kubernetes secret in the same namespace as the JWTValidationPolicy.
+	// +optional
+	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
+}

api/v1alpha1/traffic_policy_types.go

@@ -121,6 +121,11 @@ type TrafficPolicySpec struct {
 	// Agentgateway-based Gateway supports cumulative RBAC policies across different attachment points, such that
 	// an RBAC policy attached to a route augments policies applied to the gateway or listener without overriding them.
 	RBAC *Authorization `json:"rbac,omitempty"`
+
+	// JWT specifies the JWT validation configuration for the policy.
+	// This defines the JWT providers and their configurations.
+	// +optional
+	JWT *JWTValidation `json:"jwt,omitempty"`
 }
 
 // TransformationPolicy config is used to modify envoy behavior at a route level.