diff options
Diffstat (limited to 'lib/chef/resource/openssl_x509_certificate.rb')
| -rw-r--r-- | lib/chef/resource/openssl_x509_certificate.rb | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/lib/chef/resource/openssl_x509_certificate.rb b/lib/chef/resource/openssl_x509_certificate.rb index 96a0ec3d6d..8353f5ad09 100644 --- a/lib/chef/resource/openssl_x509_certificate.rb +++ b/lib/chef/resource/openssl_x509_certificate.rb @@ -31,83 +31,83 @@ class Chef introduced "14.4" property :path, String, - description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.", - name_property: true + description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.", + name_property: true property :owner, [String, Integer], - description: "The owner applied to all files created by the resource." + description: "The owner applied to all files created by the resource." property :group, [String, Integer], - description: "The group ownership applied to all files created by the resource." + description: "The group ownership applied to all files created by the resource." property :expire, Integer, - description: "Value representing the number of days from now through which the issued certificate cert will remain valid. The certificate will expire after this period.", - default: 365 + description: "Value representing the number of days from now through which the issued certificate cert will remain valid. The certificate will expire after this period.", + default: 365 property :mode, [Integer, String], - description: "The permission mode applied to all files created by the resource." + description: "The permission mode applied to all files created by the resource." property :country, String, - description: "Value for the C certificate field." + description: "Value for the C certificate field." property :state, String, - description: "Value for the ST certificate field." + description: "Value for the ST certificate field." property :city, String, - description: "Value for the L certificate field." + description: "Value for the L certificate field." property :org, String, - description: "Value for the O certificate field." + description: "Value for the O certificate field." property :org_unit, String, - description: "Value for the OU certificate field." + description: "Value for the OU certificate field." property :common_name, String, - description: "Value for the CN certificate field." + description: "Value for the CN certificate field." property :email, String, - description: "Value for the email certificate field." + description: "Value for the email certificate field." property :extensions, Hash, - description: "Hash of X509 Extensions entries, in format { 'keyUsage' => { 'values' => %w( keyEncipherment digitalSignature), 'critical' => true } }.", - default: lazy { Hash.new } + description: "Hash of X509 Extensions entries, in format { 'keyUsage' => { 'values' => %w( keyEncipherment digitalSignature), 'critical' => true } }.", + default: lazy { Hash.new } property :subject_alt_name, Array, - description: "Array of Subject Alternative Name entries, in format DNS:example.com or IP:1.2.3.4.", - default: lazy { [] } + description: "Array of Subject Alternative Name entries, in format DNS:example.com or IP:1.2.3.4.", + default: lazy { [] } property :key_file, String, - description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." + description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." property :key_pass, String, - description: "The passphrase for an existing key's passphrase." + description: "The passphrase for an existing key's passphrase." property :key_type, String, - equal_to: %w{rsa ec}, - description: "The desired type of the generated key (rsa or ec).", - default: "rsa" + equal_to: %w{rsa ec}, + description: "The desired type of the generated key (rsa or ec).", + default: "rsa" property :key_length, Integer, - equal_to: [1024, 2048, 4096, 8192], - description: "The desired bit length of the generated key (if key_type is equal to 'rsa').", - default: 2048 + equal_to: [1024, 2048, 4096, 8192], + description: "The desired bit length of the generated key (if key_type is equal to 'rsa').", + default: 2048 property :key_curve, String, - description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.", - equal_to: %w{secp384r1 secp521r1 prime256v1}, - default: "prime256v1" + description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.", + equal_to: %w{secp384r1 secp521r1 prime256v1}, + default: "prime256v1" property :csr_file, String, - description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file property is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)." + description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file property is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)." property :ca_cert_file, String, - description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the certificate will be signed with them." + description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the certificate will be signed with them." property :ca_key_file, String, - description: "The path to the CA private key on the filesystem. If the ca_key_file property is specified, the 'ca_cert_file' property must also be specified, the certificate will be signed with them." + description: "The path to the CA private key on the filesystem. If the ca_key_file property is specified, the 'ca_cert_file' property must also be specified, the certificate will be signed with them." property :ca_key_pass, String, - description: "The passphrase for CA private key's passphrase." + description: "The passphrase for CA private key's passphrase." action :create do description "Generate a certificate" |