RequestAuthentication
RequestAuthentication
RequestAuthentication defines what request authentication methods are supported by a workload. It will reject a request if the request contains invalid authentication information, based on the configured authentication rules. A request that does not contain any authentication credentials will be accepted but will not have any authenticated identity. To restrict access to authenticated requests only, this should be accompanied by an authorization rule. Examples:
- Require JWT for all request for workloads that have label
app:httpbin
apiVersion: security.istio.io/v1beta1kind: RequestAuthenticationmetadata:name: httpbinnamespace: foospec:selector:matchLabels:app: httpbinjwtRules:- issuer: "issuer-foo"jwksUri: https://example.com/.well-known/jwks.json---apiVersion: security.istio.io/v1beta1kind: AuthorizationPolicymetadata:name: httpbinnamespace: foospec:selector:matchLabels:app: httpbinrules:- from:- source:requestPrincipals: ["*"]
- A policy in the root namespace (“istio-system” by default) applies to workloads in all namespaces in a mesh. The following policy makes all workloads only accept requests that contain a valid JWT token.
apiVersion: security.istio.io/v1beta1kind: RequestAuthenticationmetadata:name: req-authn-for-allnamespace: istio-systemspec:jwtRules:- issuer: "issuer-foo"jwksUri: https://example.com/.well-known/jwks.json---apiVersion: security.istio.io/v1beta1kind: AuthorizationPolicymetadata:name: require-jwt-for-allnamespace: istio-systemspec:rules:- from:- source:requestPrincipals: ["*"]
- The next example shows how to set a different JWT requirement for a different
host. TheRequestAuthenticationdeclares it can accept JWTs issued by eitherissuer-fooorissuer-bar(the public key set is implicitly set from the OpenID Connect spec).
apiVersion: security.istio.io/v1beta1kind: RequestAuthenticationmetadata:name: httpbinnamespace: foospec:selector:matchLabels:app: httpbinjwtRules:- issuer: "issuer-foo"- issuer: "issuer-bar"---apiVersion: security.istio.io/v1beta1kind: AuthorizationPolicymetadata:name: httpbinnamespace: foospec:selector:matchLabels:app: httpbinrules:- from:- source:requestPrincipals: ["issuer-foo/*"]to:- operation:hosts: ["example.com"]- from:- source:requestPrincipals: ["issuer-bar/*"]to:- operation:hosts: ["another-host.com"]
- You can fine tune the authorization policy to set different requirement per path. For example, to require JWT on all paths, except /healthz, the same
RequestAuthenticationcan be used, but the authorization policy could be:
apiVersion: security.istio.io/v1beta1kind: AuthorizationPolicymetadata:name: httpbinnamespace: foospec:selector:matchLabels:app: httpbinrules:- from:- source:requestPrincipals: ["*"]- to:- operation:paths: ["/healthz"]
[Experimental] Routing based on derived metadata is now supported. A prefix ‘@’ is used to denote a match against internal metadata instead of the headers in the request. Currently this feature is only supported for the following metadata:
request.auth.claims.{claim-name}[.{sub-claim}]*which are extracted from validated JWT tokens. The claim name currently does not support the.character. Examples:request.auth.claims.subandrequest.auth.claims.name.givenName.
The use of matches against JWT claim metadata is only supported in Gateways. The following example shows:
- RequestAuthentication to decode and validate a JWT. This also makes the
@request.auth.claimsavailable for use in the VirtualService. - AuthorizationPolicy to check for valid principals in the request. This makes the JWT required for the request.
- VirtualService to route the request based on the “sub” claim.
apiVersion: security.istio.io/v1beta1kind: RequestAuthenticationmetadata:name: jwt-on-ingressnamespace: istio-systemspec:selector:matchLabels:app: istio-ingressgatewayjwtRules:- issuer: "example.com"jwksUri: https://example.com/.well-known/jwks.json---apiVersion: security.istio.io/v1beta1kind: AuthorizationPolicymetadata:name: require-jwtnamespace: istio-systemspec:selector:matchLabels:app: istio-ingressgatewayrules:- from:- source:requestPrincipals: ["*"]---apiVersion: networking.istio.io/v1alpha3kind: VirtualServicemetadata:name: route-jwtspec:hosts:- foo.prod.svc.cluster.localgateways:- istio-ingressgatewayhttp:- name: "v2"match:- headers:"@request.auth.claims.sub":exact: "dev"route:- destination:host: foo.prod.svc.cluster.localsubset: v2- name: "default"route:- destination:host: foo.prod.svc.cluster.localsubset: v1
| Field | Type | Description | Required |
|---|---|---|---|
selector | WorkloadSelector | Optional. The selector decides where to apply the request authentication policy. The selector will match with workloads in the same namespace as the request authentication policy. If the request authentication policy is in the root namespace, the selector will additionally match with workloads in all namespaces. If not set, the selector will match all workloads. | No |
jwtRules | JWTRule[] | Define the list of JWTs that can be validated at the selected workloads’ proxy. A valid token will be used to extract the authenticated identity. Each rule will be activated only when a token is presented at the location recognized by the rule. The token will be validated based on the JWT rule config. If validation fails, the request will be rejected. Note: Requests with multiple tokens (at different locations) are not supported, the output principal of such requests is undefined. | No |