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
,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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
BoringSSL private key method configuration.static enum
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 TypeFieldDescriptionprivate Object
private int
private static final PrivateKeyProvider
private boolean
static final int
private byte
private static final com.google.protobuf.Parser
<PrivateKeyProvider> static final int
private Object
private static final long
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
PrivateKeyProvider
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static PrivateKeyProvider
static final com.google.protobuf.Descriptors.Descriptor
boolean
If the private key provider isn't available (eg.com.google.protobuf.Parser
<PrivateKeyProvider> Private key method provider name.com.google.protobuf.ByteString
Private key method provider name.int
com.google.protobuf.Any
.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
com.google.protobuf.AnyOrBuilder
.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
int
hashCode()
boolean
.google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static PrivateKeyProvider.Builder
static PrivateKeyProvider.Builder
newBuilder
(PrivateKeyProvider prototype) protected PrivateKeyProvider.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static PrivateKeyProvider
parseDelimitedFrom
(InputStream input) static PrivateKeyProvider
parseDelimitedFrom
(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
(InputStream input) static PrivateKeyProvider
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PrivateKeyProvider
parseFrom
(ByteBuffer data) static PrivateKeyProvider
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<PrivateKeyProvider> 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:
-
configTypeCase_
private int configTypeCase_ -
configType_
-
PROVIDER_NAME_FIELD_NUMBER
public static final int PROVIDER_NAME_FIELD_NUMBER- See Also:
-
providerName_
-
TYPED_CONFIG_FIELD_NUMBER
public static final int TYPED_CONFIG_FIELD_NUMBER- See Also:
-
FALLBACK_FIELD_NUMBER
public static final int FALLBACK_FIELD_NUMBER- See Also:
-
fallback_
private boolean fallback_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
PrivateKeyProvider
private PrivateKeyProvider(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
PrivateKeyProvider
private PrivateKeyProvider()
-
-
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
-
getConfigTypeCase
- Specified by:
getConfigTypeCase
in interfacePrivateKeyProviderOrBuilder
-
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 interfacePrivateKeyProviderOrBuilder
- 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 interfacePrivateKeyProviderOrBuilder
- Returns:
- The bytes for providerName.
-
hasTypedConfig
public boolean hasTypedConfig().google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
- Specified by:
hasTypedConfig
in interfacePrivateKeyProviderOrBuilder
- 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 interfacePrivateKeyProviderOrBuilder
- Returns:
- The typedConfig.
-
getTypedConfigOrBuilder
public com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder().google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
- Specified by:
getTypedConfigOrBuilder
in interfacePrivateKeyProviderOrBuilder
-
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 interfacePrivateKeyProviderOrBuilder
- Returns:
- The fallback.
-
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 PrivateKeyProvider parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PrivateKeyProvider parseFrom(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
- Throws:
IOException
-
parseFrom
public static PrivateKeyProvider parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PrivateKeyProvider parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static PrivateKeyProvider parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static PrivateKeyProvider 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 PrivateKeyProvider.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
-