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:



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 1197

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:



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 1197

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:



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 1197

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