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
@Generated 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:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • configTypeCase_

      private int configTypeCase_

    • configType_

      private Object configType_

    • PROVIDER_NAME_FIELD_NUMBER

      public static final int PROVIDER_NAME_FIELD_NUMBER
      See Also:

    • providerName_

      private volatile Object 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

      private static final PrivateKeyProvider DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<PrivateKeyProvider> 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()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • 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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(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

      public static PrivateKeyProvider parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PrivateKeyProvider parseDelimitedFrom(InputStream input) throws IOException
      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

      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