Class: Google::Cloud::Security::PrivateCA::V1::KeyUsage

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/security/privateca/v1/resources.rb

Overview

A KeyUsage describes key usage values that may appear in an X.509 certificate.

Defined Under Namespace

Classes: ExtendedKeyUsageOptions, KeyUsageOptions

Instance Attribute Summary collapse

Instance Attribute Details

#base_key_usage::Google::Cloud::Security::PrivateCA::V1::KeyUsage::KeyUsageOptions

Returns Describes high-level ways in which a key may be used.

Returns:



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 924

class KeyUsage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::KeyUsageOptions KeyUsage.KeyUsageOptions} corresponds to the key usage values
  # described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
  # @!attribute [rw] digital_signature
  #   @return [::Boolean]
  #     The key may be used for digital signatures.
  # @!attribute [rw] content_commitment
  #   @return [::Boolean]
  #     The key may be used for cryptographic commitments. Note that this may
  #     also be referred to as "non-repudiation".
  # @!attribute [rw] key_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher other keys.
  # @!attribute [rw] data_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher data.
  # @!attribute [rw] key_agreement
  #   @return [::Boolean]
  #     The key may be used in a key agreement protocol.
  # @!attribute [rw] cert_sign
  #   @return [::Boolean]
  #     The key may be used to sign certificates.
  # @!attribute [rw] crl_sign
  #   @return [::Boolean]
  #     The key may be used sign certificate revocation lists.
  # @!attribute [rw] encipher_only
  #   @return [::Boolean]
  #     The key may be used to encipher only.
  # @!attribute [rw] decipher_only
  #   @return [::Boolean]
  #     The key may be used to decipher only.
  class KeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::ExtendedKeyUsageOptions KeyUsage.ExtendedKeyUsageOptions} has fields that correspond to
  # certain common OIDs that could be specified as an extended key usage value.
  # @!attribute [rw] server_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW
  #     server authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] client_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW
  #     client authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] code_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of
  #     downloadable executable code client authentication".
  # @!attribute [rw] email_protection
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email
  #     protection".
  # @!attribute [rw] time_stamping
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding
  #     the hash of an object to a time".
  # @!attribute [rw] ocsp_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing
  #     OCSP responses".
  class ExtendedKeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#extended_key_usage::Google::Cloud::Security::PrivateCA::V1::KeyUsage::ExtendedKeyUsageOptions

Returns Detailed scenarios in which a key may be used.

Returns:



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 924

class KeyUsage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::KeyUsageOptions KeyUsage.KeyUsageOptions} corresponds to the key usage values
  # described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
  # @!attribute [rw] digital_signature
  #   @return [::Boolean]
  #     The key may be used for digital signatures.
  # @!attribute [rw] content_commitment
  #   @return [::Boolean]
  #     The key may be used for cryptographic commitments. Note that this may
  #     also be referred to as "non-repudiation".
  # @!attribute [rw] key_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher other keys.
  # @!attribute [rw] data_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher data.
  # @!attribute [rw] key_agreement
  #   @return [::Boolean]
  #     The key may be used in a key agreement protocol.
  # @!attribute [rw] cert_sign
  #   @return [::Boolean]
  #     The key may be used to sign certificates.
  # @!attribute [rw] crl_sign
  #   @return [::Boolean]
  #     The key may be used sign certificate revocation lists.
  # @!attribute [rw] encipher_only
  #   @return [::Boolean]
  #     The key may be used to encipher only.
  # @!attribute [rw] decipher_only
  #   @return [::Boolean]
  #     The key may be used to decipher only.
  class KeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::ExtendedKeyUsageOptions KeyUsage.ExtendedKeyUsageOptions} has fields that correspond to
  # certain common OIDs that could be specified as an extended key usage value.
  # @!attribute [rw] server_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW
  #     server authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] client_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW
  #     client authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] code_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of
  #     downloadable executable code client authentication".
  # @!attribute [rw] email_protection
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email
  #     protection".
  # @!attribute [rw] time_stamping
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding
  #     the hash of an object to a time".
  # @!attribute [rw] ocsp_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing
  #     OCSP responses".
  class ExtendedKeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unknown_extended_key_usages::Array<::Google::Cloud::Security::PrivateCA::V1::ObjectId>

Returns Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

Returns:



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 924

class KeyUsage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::KeyUsageOptions KeyUsage.KeyUsageOptions} corresponds to the key usage values
  # described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
  # @!attribute [rw] digital_signature
  #   @return [::Boolean]
  #     The key may be used for digital signatures.
  # @!attribute [rw] content_commitment
  #   @return [::Boolean]
  #     The key may be used for cryptographic commitments. Note that this may
  #     also be referred to as "non-repudiation".
  # @!attribute [rw] key_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher other keys.
  # @!attribute [rw] data_encipherment
  #   @return [::Boolean]
  #     The key may be used to encipher data.
  # @!attribute [rw] key_agreement
  #   @return [::Boolean]
  #     The key may be used in a key agreement protocol.
  # @!attribute [rw] cert_sign
  #   @return [::Boolean]
  #     The key may be used to sign certificates.
  # @!attribute [rw] crl_sign
  #   @return [::Boolean]
  #     The key may be used sign certificate revocation lists.
  # @!attribute [rw] encipher_only
  #   @return [::Boolean]
  #     The key may be used to encipher only.
  # @!attribute [rw] decipher_only
  #   @return [::Boolean]
  #     The key may be used to decipher only.
  class KeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # {::Google::Cloud::Security::PrivateCA::V1::KeyUsage::ExtendedKeyUsageOptions KeyUsage.ExtendedKeyUsageOptions} has fields that correspond to
  # certain common OIDs that could be specified as an extended key usage value.
  # @!attribute [rw] server_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW
  #     server authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] client_auth
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW
  #     client authentication", though regularly used for non-WWW TLS.
  # @!attribute [rw] code_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of
  #     downloadable executable code client authentication".
  # @!attribute [rw] email_protection
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email
  #     protection".
  # @!attribute [rw] time_stamping
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding
  #     the hash of an object to a time".
  # @!attribute [rw] ocsp_signing
  #   @return [::Boolean]
  #     Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing
  #     OCSP responses".
  class ExtendedKeyUsageOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end