Package io.envoyproxy.envoy.api.v2.auth

Class PrivateKeyProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.auth.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.GeneratedMessageV3 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.api.v2.auth.PrivateKeyProvider
See Also:

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONFIG_FIELD_NUMBER
     
    static final int
    PROVIDER_NAME_FIELD_NUMBER
     
    static final int
    TYPED_CONFIG_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

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Struct
    getConfig()
    Deprecated.
    envoy.api.v2.auth.PrivateKeyProvider.config is deprecated.
    com.google.protobuf.StructOrBuilder
    getConfigOrBuilder()
    Deprecated.
    PrivateKeyProvider.ConfigTypeCase
    getConfigTypeCase()
     
    static PrivateKeyProvider
    getDefaultInstance()
     
    PrivateKeyProvider
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<PrivateKeyProvider>
    getParserForType()
     
    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];
    boolean
    hasConfig()
    Deprecated.
    envoy.api.v2.auth.PrivateKeyProvider.config is deprecated.
    int
    hashCode()
     
    boolean
    hasTypedConfig()
    .google.protobuf.Any typed_config = 3 [(.udpa.annotations.sensitive) = true];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PrivateKeyProvider.Builder
    newBuilder()
     
    static PrivateKeyProvider.Builder
    newBuilder(PrivateKeyProvider prototype)
     
    PrivateKeyProvider.Builder
    newBuilderForType()
     
    protected PrivateKeyProvider.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    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()
     
    PrivateKeyProvider.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.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

    • PROVIDER_NAME_FIELD_NUMBER

      public static final int PROVIDER_NAME_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • TYPED_CONFIG_FIELD_NUMBER

      public static final int TYPED_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • 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.

    • hasConfig

      @Deprecated public boolean hasConfig()
      Deprecated.
      envoy.api.v2.auth.PrivateKeyProvider.config is deprecated. See envoy/api/v2/auth/common.proto;l=119
      .google.protobuf.Struct config = 2 [deprecated = true, (.udpa.annotations.sensitive) = true];
      Specified by:
      hasConfig in interface PrivateKeyProviderOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      @Deprecated public com.google.protobuf.Struct getConfig()
      Deprecated.
      envoy.api.v2.auth.PrivateKeyProvider.config is deprecated. See envoy/api/v2/auth/common.proto;l=119
      .google.protobuf.Struct config = 2 [deprecated = true, (.udpa.annotations.sensitive) = true];
      Specified by:
      getConfig in interface PrivateKeyProviderOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      @Deprecated public com.google.protobuf.StructOrBuilder getConfigOrBuilder()
      Deprecated.
      .google.protobuf.Struct config = 2 [deprecated = true, (.udpa.annotations.sensitive) = true];
      Specified by:
      getConfigOrBuilder in interface PrivateKeyProviderOrBuilder

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public PrivateKeyProvider getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder