Reference documentation and code samples for the Google Certificate Authority Service V1 Client class KeyUsageOptions.
KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
Generated from protobuf message google.cloud.security.privateca.v1.KeyUsage.KeyUsageOptions
Namespace
Google \ Cloud \ Security \ PrivateCA \ V1 \ KeyUsageMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ digital_signature |
bool
The key may be used for digital signatures. |
↳ content_commitment |
bool
The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
↳ key_encipherment |
bool
The key may be used to encipher other keys. |
↳ data_encipherment |
bool
The key may be used to encipher data. |
↳ key_agreement |
bool
The key may be used in a key agreement protocol. |
↳ cert_sign |
bool
The key may be used to sign certificates. |
↳ crl_sign |
bool
The key may be used sign certificate revocation lists. |
↳ encipher_only |
bool
The key may be used to encipher only. |
↳ decipher_only |
bool
The key may be used to decipher only. |
getDigitalSignature
The key may be used for digital signatures.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDigitalSignature
The key may be used for digital signatures.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContentCommitment
The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
| Returns | |
|---|---|
| Type | Description |
bool | |
setContentCommitment
The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKeyEncipherment
The key may be used to encipher other keys.
| Returns | |
|---|---|
| Type | Description |
bool | |
setKeyEncipherment
The key may be used to encipher other keys.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataEncipherment
The key may be used to encipher data.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDataEncipherment
The key may be used to encipher data.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKeyAgreement
The key may be used in a key agreement protocol.
| Returns | |
|---|---|
| Type | Description |
bool | |
setKeyAgreement
The key may be used in a key agreement protocol.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCertSign
The key may be used to sign certificates.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCertSign
The key may be used to sign certificates.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCrlSign
The key may be used sign certificate revocation lists.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCrlSign
The key may be used sign certificate revocation lists.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncipherOnly
The key may be used to encipher only.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEncipherOnly
The key may be used to encipher only.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDecipherOnly
The key may be used to decipher only.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDecipherOnly
The key may be used to decipher only.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |