Package io.envoyproxy.envoy.extensions.transport_sockets.tls.v3

Class PrivateKeyProvider

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.PrivateKeyProvider

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PrivateKeyProviderOrBuilder, java.io.Serializable

public final class PrivateKeyProvider
extends com.google.protobuf.GeneratedMessage
implements PrivateKeyProviderOrBuilder

 BoringSSL private key method configuration. The private key methods are used for external
 (potentially asynchronous) signing and decryption operations. Some use cases for private key
 methods would be TPM support and TLS acceleration.
 

Protobuf type envoy.extensions.transport_sockets.tls.v3.PrivateKeyProvider

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrivateKeyProvider.Builder	BoringSSL private key method configuration.
static class	PrivateKeyProvider.ConfigTypeCase

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 extends java.lang.Object>, 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

Fields

Modifier and Type	Field	Description
private java.lang.Object	configType_
private int	configTypeCase_
private static PrivateKeyProvider	DEFAULT_INSTANCE
private boolean	fallback_
static int	FALLBACK_FIELD_NUMBER
private byte	memoizedIsInitialized
private static com.google.protobuf.Parser<PrivateKeyProvider>	PARSER
static int	PROVIDER_NAME_FIELD_NUMBER
private java.lang.Object	providerName_
private static long	serialVersionUID
static int	TYPED_CONFIG_FIELD_NUMBER

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

Constructors

Modifier	Constructor	Description
private	PrivateKeyProvider()
private	PrivateKeyProvider(com.google.protobuf.GeneratedMessage.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
PrivateKeyProvider.ConfigTypeCase	getConfigTypeCase()
static PrivateKeyProvider	getDefaultInstance()
PrivateKeyProvider	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFallback()	If the private key provider isn't available (eg.
com.google.protobuf.Parser<PrivateKeyProvider>	getParserForType()
java.lang.String	getProviderName()	Private key method provider name.
com.google.protobuf.ByteString	getProviderNameBytes()	Private key method provider name.
int	getSerializedSize()
com.google.protobuf.Any	getTypedConfig()	.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
com.google.protobuf.AnyOrBuilder	getTypedConfigOrBuilder()	.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
int	hashCode()
boolean	hasTypedConfig()	.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PrivateKeyProvider.Builder	newBuilder()
static PrivateKeyProvider.Builder	newBuilder(PrivateKeyProvider prototype)
PrivateKeyProvider.Builder	newBuilderForType()
protected PrivateKeyProvider.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static PrivateKeyProvider	parseDelimitedFrom(java.io.InputStream input)
static PrivateKeyProvider	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrivateKeyProvider	parseFrom(byte[] data)
static PrivateKeyProvider	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrivateKeyProvider	parseFrom(com.google.protobuf.ByteString data)
static PrivateKeyProvider	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrivateKeyProvider	parseFrom(com.google.protobuf.CodedInputStream input)
static PrivateKeyProvider	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrivateKeyProvider	parseFrom(java.io.InputStream input)
static PrivateKeyProvider	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrivateKeyProvider	parseFrom(java.nio.ByteBuffer data)
static PrivateKeyProvider	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PrivateKeyProvider>	parser()
PrivateKeyProvider.Builder	toBuilder()
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 Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

configTypeCase_

private int configTypeCase_

configType_

private java.lang.Object configType_

PROVIDER_NAME_FIELD_NUMBER

public static final int PROVIDER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

providerName_

private volatile java.lang.Object providerName_

TYPED_CONFIG_FIELD_NUMBER

public static final int TYPED_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

FALLBACK_FIELD_NUMBER

public static final int FALLBACK_FIELD_NUMBER

See Also:

Constant Field Values

fallback_

private boolean fallback_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final PrivateKeyProvider DEFAULT_INSTANCE

PARSER

private static final com.google.protobuf.Parser<PrivateKeyProvider> PARSER

Constructor Detail

PrivateKeyProvider

private PrivateKeyProvider(com.google.protobuf.GeneratedMessage.Builder<?> builder)

PrivateKeyProvider

private PrivateKeyProvider()

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getConfigTypeCase

public PrivateKeyProvider.ConfigTypeCase getConfigTypeCase()

Specified by:

getConfigTypeCase in interface PrivateKeyProviderOrBuilder

getProviderName

public java.lang.String getProviderName()

 Private key method provider name. The name must match a
 supported private key method provider type.
 

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

Specified by:

getProviderName in interface PrivateKeyProviderOrBuilder

Returns:

The providerName.

getProviderNameBytes

public com.google.protobuf.ByteString getProviderNameBytes()

 Private key method provider name. The name must match a
 supported private key method provider type.
 

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

Specified by:

getProviderNameBytes in interface PrivateKeyProviderOrBuilder

Returns:

The bytes for providerName.

hasTypedConfig

public boolean hasTypedConfig()

.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

Specified by:

hasTypedConfig in interface PrivateKeyProviderOrBuilder

Returns:

Whether the typedConfig field is set.

getTypedConfig

public com.google.protobuf.Any getTypedConfig()

.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

Specified by:

getTypedConfig in interface PrivateKeyProviderOrBuilder

Returns:

The typedConfig.

getTypedConfigOrBuilder

public com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()

.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];

Specified by:

getTypedConfigOrBuilder in interface PrivateKeyProviderOrBuilder

getFallback

public boolean getFallback()

 If the private key provider isn't available (eg. the required hardware capability doesn't existed),
 Envoy will fallback to the BoringSSL default implementation when the ``fallback`` is true.
 The default value is ``false``.
 

bool fallback = 4;

Specified by:

getFallback in interface PrivateKeyProviderOrBuilder

Returns:

The fallback.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PrivateKeyProvider parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PrivateKeyProvider parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PrivateKeyProvider parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PrivateKeyProvider parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PrivateKeyProvider parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PrivateKeyProvider parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PrivateKeyProvider parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public PrivateKeyProvider.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PrivateKeyProvider.Builder newBuilder()

newBuilder

public static PrivateKeyProvider.Builder newBuilder(PrivateKeyProvider prototype)

toBuilder

public PrivateKeyProvider.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PrivateKeyProvider.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static PrivateKeyProvider getDefaultInstance()

parser

public static com.google.protobuf.Parser<PrivateKeyProvider> parser()

getParserForType

public com.google.protobuf.Parser<PrivateKeyProvider> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public PrivateKeyProvider getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder