Class UpstreamTlsContext
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,UpstreamTlsContextOrBuilder
,Serializable
public final class UpstreamTlsContext
extends com.google.protobuf.GeneratedMessage
implements UpstreamTlsContextOrBuilder
[#next-free-field: 6]Protobuf type
envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 6]Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private boolean
private int
static final int
private CommonTlsContext
private static final UpstreamTlsContext
static final int
private com.google.protobuf.BoolValue
static final int
private com.google.protobuf.UInt32Value
private byte
private static final com.google.protobuf.Parser
<UpstreamTlsContext> private static final long
private Object
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
UpstreamTlsContext
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
If true, server-initiated TLS renegotiation will be allowed.Common TLS context settings.Common TLS context settings.static UpstreamTlsContext
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.BoolValue
This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage.com.google.protobuf.BoolValueOrBuilder
This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage.com.google.protobuf.UInt32Value
Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption.com.google.protobuf.UInt32ValueOrBuilder
Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption.com.google.protobuf.Parser
<UpstreamTlsContext> int
getSni()
SNI string to use when creating TLS backend connections.com.google.protobuf.ByteString
SNI string to use when creating TLS backend connections.boolean
Common TLS context settings.boolean
This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage.int
hashCode()
boolean
Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static UpstreamTlsContext.Builder
static UpstreamTlsContext.Builder
newBuilder
(UpstreamTlsContext prototype) protected UpstreamTlsContext.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static UpstreamTlsContext
parseDelimitedFrom
(InputStream input) static UpstreamTlsContext
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContext
parseFrom
(byte[] data) static UpstreamTlsContext
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContext
parseFrom
(com.google.protobuf.ByteString data) static UpstreamTlsContext
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContext
parseFrom
(com.google.protobuf.CodedInputStream input) static UpstreamTlsContext
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContext
parseFrom
(InputStream input) static UpstreamTlsContext
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContext
parseFrom
(ByteBuffer data) static UpstreamTlsContext
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<UpstreamTlsContext> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
COMMON_TLS_CONTEXT_FIELD_NUMBER
public static final int COMMON_TLS_CONTEXT_FIELD_NUMBER- See Also:
-
commonTlsContext_
-
SNI_FIELD_NUMBER
public static final int SNI_FIELD_NUMBER- See Also:
-
sni_
-
ALLOW_RENEGOTIATION_FIELD_NUMBER
public static final int ALLOW_RENEGOTIATION_FIELD_NUMBER- See Also:
-
allowRenegotiation_
private boolean allowRenegotiation_ -
MAX_SESSION_KEYS_FIELD_NUMBER
public static final int MAX_SESSION_KEYS_FIELD_NUMBER- See Also:
-
maxSessionKeys_
private com.google.protobuf.UInt32Value maxSessionKeys_ -
ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER
public static final int ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER- See Also:
-
enforceRsaKeyUsage_
private com.google.protobuf.BoolValue enforceRsaKeyUsage_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
UpstreamTlsContext
private UpstreamTlsContext(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
UpstreamTlsContext
private UpstreamTlsContext()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
hasCommonTlsContext
public boolean hasCommonTlsContext()Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. Configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable verification.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;
- Specified by:
hasCommonTlsContext
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- Whether the commonTlsContext field is set.
-
getCommonTlsContext
Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. Configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable verification.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;
- Specified by:
getCommonTlsContext
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The commonTlsContext.
-
getCommonTlsContextOrBuilder
Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. Configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable verification.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;
- Specified by:
getCommonTlsContextOrBuilder
in interfaceUpstreamTlsContextOrBuilder
-
getSni
SNI string to use when creating TLS backend connections.
string sni = 2 [(.validate.rules) = { ... }
- Specified by:
getSni
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The sni.
-
getSniBytes
public com.google.protobuf.ByteString getSniBytes()SNI string to use when creating TLS backend connections.
string sni = 2 [(.validate.rules) = { ... }
- Specified by:
getSniBytes
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The bytes for sni.
-
getAllowRenegotiation
public boolean getAllowRenegotiation()If true, server-initiated TLS renegotiation will be allowed. .. attention:: TLS renegotiation is considered insecure and shouldn't be used unless absolutely necessary.
bool allow_renegotiation = 3;
- Specified by:
getAllowRenegotiation
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The allowRenegotiation.
-
hasMaxSessionKeys
public boolean hasMaxSessionKeys()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;
- Specified by:
hasMaxSessionKeys
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- Whether the maxSessionKeys field is set.
-
getMaxSessionKeys
public com.google.protobuf.UInt32Value getMaxSessionKeys()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;
- Specified by:
getMaxSessionKeys
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The maxSessionKeys.
-
getMaxSessionKeysOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getMaxSessionKeysOrBuilder()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to store for the purpose of session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;
- Specified by:
getMaxSessionKeysOrBuilder
in interfaceUpstreamTlsContextOrBuilder
-
hasEnforceRsaKeyUsage
public boolean hasEnforceRsaKeyUsage()This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off) but it is expected to be changed to true by default in a future release. ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate configurations that would fail if this option were set to true.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;
- Specified by:
hasEnforceRsaKeyUsage
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- Whether the enforceRsaKeyUsage field is set.
-
getEnforceRsaKeyUsage
public com.google.protobuf.BoolValue getEnforceRsaKeyUsage()This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off) but it is expected to be changed to true by default in a future release. ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate configurations that would fail if this option were set to true.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;
- Specified by:
getEnforceRsaKeyUsage
in interfaceUpstreamTlsContextOrBuilder
- Returns:
- The enforceRsaKeyUsage.
-
getEnforceRsaKeyUsageOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnforceRsaKeyUsageOrBuilder()This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off) but it is expected to be changed to true by default in a future release. ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate configurations that would fail if this option were set to true.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;
- Specified by:
getEnforceRsaKeyUsageOrBuilder
in interfaceUpstreamTlsContextOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static UpstreamTlsContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static UpstreamTlsContext parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected UpstreamTlsContext.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-