Config.JwtRule (api 0.1.4 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - envoy.config.filter.http.jwt_authn.v2alpha.Config.JwtRule

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.JwtRuleOrBuilder, Serializable

Enclosing class:: Config

public static final class Config.JwtRule
extends com.google.protobuf.GeneratedMessageV3
implements Config.JwtRuleOrBuilder

 This message specifies how a JSON Web Token (JWT) can be verified. JWT format is defined
 `here <https://tools.ietf.org/html/rfc7519>`_. Please see `OAuth2.0
  <https://tools.ietf.org/html/rfc6749>`_ and `OIDC1.0  <http://openid.net/connect>`_ for
 the authentication flow.
 Example:
 .. code-block:: yaml
     issuer: https://example.com
     audiences:
     - bookstore_android.apps.googleusercontent.com
       bookstore_web.apps.googleusercontent.com
     remote_jwks:
     - http_uri:
       - uri: https://example.com/.well-known/jwks.json
         cluster: example_jwks_cluster
       cache_duration:
       - seconds: 300
 [#not-implemented-hide:]

Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.JwtRule

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Config.JwtRule.Builder` This message specifies how a JSON Web Token (JWT) can be verified.
`static class`	`Config.JwtRule.JwksSourceSpecifierCase`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUDIENCES_FIELD_NUMBER`
`static int`	`FORWARD_FIELD_NUMBER`
`static int`	`FORWARD_PAYLOAD_HEADER_FIELD_NUMBER`
`static int`	`FROM_HEADERS_FIELD_NUMBER`
`static int`	`FROM_PARAMS_FIELD_NUMBER`
`static int`	`ISSUER_FIELD_NUMBER`
`static int`	`LOCAL_JWKS_FIELD_NUMBER`
`static int`	`REMOTE_JWKS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAudiences(int index)` The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are allowed to access.
`com.google.protobuf.ByteString`	`getAudiencesBytes(int index)` The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are allowed to access.
`int`	`getAudiencesCount()` The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are allowed to access.
`com.google.protobuf.ProtocolStringList`	`getAudiencesList()` The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are allowed to access.
`static Config.JwtRule`	`getDefaultInstance()`
`Config.JwtRule`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`boolean`	`getForward()` If false, the JWT is removed in the request after a success verification.
`String`	`getForwardPayloadHeader()` This field specifies the header name to forward a successfully verified JWT payload to the backend.
`com.google.protobuf.ByteString`	`getForwardPayloadHeaderBytes()` This field specifies the header name to forward a successfully verified JWT payload to the backend.
`Config.JwtHeader`	`getFromHeaders(int index)` Specify the HTTP headers to extract JWT token.
`int`	`getFromHeadersCount()` Specify the HTTP headers to extract JWT token.
`List<Config.JwtHeader>`	`getFromHeadersList()` Specify the HTTP headers to extract JWT token.
`Config.JwtHeaderOrBuilder`	`getFromHeadersOrBuilder(int index)` Specify the HTTP headers to extract JWT token.
`List<? extends Config.JwtHeaderOrBuilder>`	`getFromHeadersOrBuilderList()` Specify the HTTP headers to extract JWT token.
`String`	`getFromParams(int index)` JWT is sent in a query parameter.
`com.google.protobuf.ByteString`	`getFromParamsBytes(int index)` JWT is sent in a query parameter.
`int`	`getFromParamsCount()` JWT is sent in a query parameter.
`com.google.protobuf.ProtocolStringList`	`getFromParamsList()` JWT is sent in a query parameter.
`String`	`getIssuer()` Identifies the principal that issued the JWT.
`com.google.protobuf.ByteString`	`getIssuerBytes()` Identifies the principal that issued the JWT.
`Config.JwtRule.JwksSourceSpecifierCase`	`getJwksSourceSpecifierCase()`
`Base.DataSource`	`getLocalJwks()` JWKS is in local data source.
`Base.DataSourceOrBuilder`	`getLocalJwksOrBuilder()` JWKS is in local data source.
`com.google.protobuf.Parser<Config.JwtRule>`	`getParserForType()`
`Config.RemoteJwks`	`getRemoteJwks()` JWKS can be fetched from remote server via HTTP/HTTPS.
`Config.RemoteJwksOrBuilder`	`getRemoteJwksOrBuilder()` JWKS can be fetched from remote server via HTTP/HTTPS.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasLocalJwks()` JWKS is in local data source.
`boolean`	`hasRemoteJwks()` JWKS can be fetched from remote server via HTTP/HTTPS.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Config.JwtRule.Builder`	`newBuilder()`
`static Config.JwtRule.Builder`	`newBuilder(Config.JwtRule prototype)`
`Config.JwtRule.Builder`	`newBuilderForType()`
`protected Config.JwtRule.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static Config.JwtRule`	`parseDelimitedFrom(InputStream input)`
`static Config.JwtRule`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Config.JwtRule`	`parseFrom(byte[] data)`
`static Config.JwtRule`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Config.JwtRule`	`parseFrom(ByteBuffer data)`
`static Config.JwtRule`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Config.JwtRule`	`parseFrom(com.google.protobuf.ByteString data)`
`static Config.JwtRule`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Config.JwtRule`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Config.JwtRule`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Config.JwtRule`	`parseFrom(InputStream input)`
`static Config.JwtRule`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Config.JwtRule>`	`parser()`
`Config.JwtRule.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- ISSUER_FIELD_NUMBER
```
public static final int ISSUER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUDIENCES_FIELD_NUMBER
```
public static final int AUDIENCES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REMOTE_JWKS_FIELD_NUMBER
```
public static final int REMOTE_JWKS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCAL_JWKS_FIELD_NUMBER
```
public static final int LOCAL_JWKS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FORWARD_FIELD_NUMBER
```
public static final int FORWARD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FROM_HEADERS_FIELD_NUMBER
```
public static final int FROM_HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FROM_PARAMS_FIELD_NUMBER
```
public static final int FROM_PARAMS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FORWARD_PAYLOAD_HEADER_FIELD_NUMBER
```
public static final int FORWARD_PAYLOAD_HEADER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getJwksSourceSpecifierCase
```
public Config.JwtRule.JwksSourceSpecifierCase getJwksSourceSpecifierCase()
```
Specified by:

getJwksSourceSpecifierCase in interface Config.JwtRuleOrBuilder

getIssuer

public String getIssuer()

 Identifies the principal that issued the JWT. See `here
  <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_. Usually a URL or an email address.
 Example: https://securetoken.google.com
 Example: 1234567-compute@developer.gserviceaccount.com

string issuer = 1 [(.validate.rules) = { ... }

Specified by:: getIssuer in interface Config.JwtRuleOrBuilder

getIssuerBytes

public com.google.protobuf.ByteString getIssuerBytes()

 Identifies the principal that issued the JWT. See `here
  <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_. Usually a URL or an email address.
 Example: https://securetoken.google.com
 Example: 1234567-compute@developer.gserviceaccount.com

string issuer = 1 [(.validate.rules) = { ... }

Specified by:: getIssuerBytes in interface Config.JwtRuleOrBuilder

getAudiencesList

public com.google.protobuf.ProtocolStringList getAudiencesList()

 The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are
 allowed to access. A JWT containing any of these audiences will be accepted. If not specified,
 will not check audiences in the token.
 Example:
 .. code-block:: yaml
     audiences:
     - bookstore_android.apps.googleusercontent.com
       bookstore_web.apps.googleusercontent.com

repeated string audiences = 2;

Specified by:: getAudiencesList in interface Config.JwtRuleOrBuilder

getAudiencesCount

public int getAudiencesCount()

 The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are
 allowed to access. A JWT containing any of these audiences will be accepted. If not specified,
 will not check audiences in the token.
 Example:
 .. code-block:: yaml
     audiences:
     - bookstore_android.apps.googleusercontent.com
       bookstore_web.apps.googleusercontent.com

repeated string audiences = 2;

Specified by:: getAudiencesCount in interface Config.JwtRuleOrBuilder

getAudiences

public String getAudiences(int index)

 The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are
 allowed to access. A JWT containing any of these audiences will be accepted. If not specified,
 will not check audiences in the token.
 Example:
 .. code-block:: yaml
     audiences:
     - bookstore_android.apps.googleusercontent.com
       bookstore_web.apps.googleusercontent.com

repeated string audiences = 2;

Specified by:: getAudiences in interface Config.JwtRuleOrBuilder

getAudiencesBytes

public com.google.protobuf.ByteString getAudiencesBytes(int index)

 The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are
 allowed to access. A JWT containing any of these audiences will be accepted. If not specified,
 will not check audiences in the token.
 Example:
 .. code-block:: yaml
     audiences:
     - bookstore_android.apps.googleusercontent.com
       bookstore_web.apps.googleusercontent.com

repeated string audiences = 2;

Specified by:: getAudiencesBytes in interface Config.JwtRuleOrBuilder

hasRemoteJwks

public boolean hasRemoteJwks()

 JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP
 URI and how the fetched JWKS should be cached.
 Example:
 .. code-block:: yaml
    remote_jwks:
    - http_uri:
      - uri: https://www.googleapis.com/oauth2/v1/certs
        cluster: jwt.www.googleapis.com|443
      cache_duration:
      - seconds: 300

.envoy.config.filter.http.jwt_authn.v2alpha.RemoteJwks remote_jwks = 3;

Specified by:: hasRemoteJwks in interface Config.JwtRuleOrBuilder

getRemoteJwks

public Config.RemoteJwks getRemoteJwks()

 JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP
 URI and how the fetched JWKS should be cached.
 Example:
 .. code-block:: yaml
    remote_jwks:
    - http_uri:
      - uri: https://www.googleapis.com/oauth2/v1/certs
        cluster: jwt.www.googleapis.com|443
      cache_duration:
      - seconds: 300

.envoy.config.filter.http.jwt_authn.v2alpha.RemoteJwks remote_jwks = 3;

Specified by:: getRemoteJwks in interface Config.JwtRuleOrBuilder

getRemoteJwksOrBuilder

public Config.RemoteJwksOrBuilder getRemoteJwksOrBuilder()

 JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP
 URI and how the fetched JWKS should be cached.
 Example:
 .. code-block:: yaml
    remote_jwks:
    - http_uri:
      - uri: https://www.googleapis.com/oauth2/v1/certs
        cluster: jwt.www.googleapis.com|443
      cache_duration:
      - seconds: 300

.envoy.config.filter.http.jwt_authn.v2alpha.RemoteJwks remote_jwks = 3;

Specified by:: getRemoteJwksOrBuilder in interface Config.JwtRuleOrBuilder

hasLocalJwks

public boolean hasLocalJwks()

 JWKS is in local data source. It could be either in a local file or embedded in the
 inline_string.
 Example: local file
 .. code-block:: yaml
    local_jwks:
    - filename: /etc/envoy/jwks/jwks1.txt
 Example: inline_string
 .. code-block:: yaml
    local_jwks:
    - inline_string: "ACADADADADA"

.envoy.api.v2.core.DataSource local_jwks = 4;

Specified by:: hasLocalJwks in interface Config.JwtRuleOrBuilder

getLocalJwks

public Base.DataSource getLocalJwks()

 JWKS is in local data source. It could be either in a local file or embedded in the
 inline_string.
 Example: local file
 .. code-block:: yaml
    local_jwks:
    - filename: /etc/envoy/jwks/jwks1.txt
 Example: inline_string
 .. code-block:: yaml
    local_jwks:
    - inline_string: "ACADADADADA"

.envoy.api.v2.core.DataSource local_jwks = 4;

Specified by:: getLocalJwks in interface Config.JwtRuleOrBuilder

getLocalJwksOrBuilder

public Base.DataSourceOrBuilder getLocalJwksOrBuilder()

 JWKS is in local data source. It could be either in a local file or embedded in the
 inline_string.
 Example: local file
 .. code-block:: yaml
    local_jwks:
    - filename: /etc/envoy/jwks/jwks1.txt
 Example: inline_string
 .. code-block:: yaml
    local_jwks:
    - inline_string: "ACADADADADA"

.envoy.api.v2.core.DataSource local_jwks = 4;

Specified by:: getLocalJwksOrBuilder in interface Config.JwtRuleOrBuilder

getForward

public boolean getForward()

 If false, the JWT is removed in the request after a success verification. If true, the JWT is
 not removed in the request. Default value is false.

bool forward = 5;

Specified by:: getForward in interface Config.JwtRuleOrBuilder