1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# OpenbaoClient::PkiRootSignIntermediateRequest
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **alt_names** | **String** | The requested Subject Alternative Names, if any, in a comma-delimited list. May contain both DNS names and email addresses. | [optional] |
| **common_name** | **String** | The requested common name; if you want more than one, specify the alternative names in the alt_names map. If not specified when signing, the common name will be taken from the CSR; other names must still be specified in alt_names or ip_sans. | [optional] |
| **country** | **Array<String>** | If set, Country will be set to this value. | [optional] |
| **csr** | **String** | PEM-format CSR to be signed. | [optional][default to ''] |
| **exclude_cn_from_sans** | **Boolean** | If true, the Common Name will not be included in DNS or Email Subject Alternate Names. Defaults to false (CN is included). | [optional][default to false] |
| **ext_key_usage** | **Array<String>** | A comma-separated string or list of extended key usages. Valid values can be found at https://golang.org/pkg/crypto/x509/#ExtKeyUsage -- simply drop the \"ExtKeyUsage\" part of the name. To remove all key usages from being set, set this value to an empty list. | [optional] |
| **ext_key_usage_oids** | **Array<String>** | A comma-separated string or list of extended key usage oids. | [optional] |
| **format** | **String** | Format for returned data. Can be \"pem\", \"der\", or \"pem_bundle\". If \"pem_bundle\", any private key and issuing cert will be appended to the certificate pem. If \"der\", the value will be base64 encoded. Defaults to \"pem\". | [optional][default to 'pem'] |
| **ip_sans** | **Array<String>** | The requested IP SANs, if any, in a comma-delimited list | [optional] |
| **issuer_name** | **String** | Provide a name to the generated or existing issuer, the name must be unique across all issuers and not be the reserved value 'default' | [optional] |
| **issuer_ref** | **String** | Reference to a existing issuer; either \"default\" for the configured default issuer, an identifier or the name assigned to the issuer. | [optional][default to 'default'] |
| **key_usage** | **Array<String>** | A comma-separated string or list of key usages (not extended key usages). Valid values can be found at https://golang.org/pkg/crypto/x509/#KeyUsage -- simply drop the \"KeyUsage\" part of the name. To remove all key usages from being set, set this value to an empty list. | [optional] |
| **locality** | **Array<String>** | If set, Locality will be set to this value. | [optional] |
| **max_path_length** | **Integer** | The maximum allowable path length | [optional][default to -1] |
| **not_after** | **String** | Set the not after field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ | [optional] |
| **not_before_duration** | **Integer** | The duration before now which the certificate needs to be backdated by. | [optional][default to 30] |
| **organization** | **Array<String>** | If set, O (Organization) will be set to this value. | [optional] |
| **other_sans** | **Array<String>** | Requested other SANs, in an array with the format <oid>;UTF8:<utf8 string value> for each entry. | [optional] |
| **ou** | **Array<String>** | If set, OU (OrganizationalUnit) will be set to this value. | [optional] |
| **permitted_dns_domains** | **Array<String>** | Domains for which this certificate is allowed to sign or issue child certificates. If set, all DNS names (subject and alt) on child certs must be exact matches or subsets of the given domains (see https://tools.ietf.org/html/rfc5280#section-4.2.1.10). | [optional] |
| **postal_code** | **Array<String>** | If set, Postal Code will be set to this value. | [optional] |
| **private_key_format** | **String** | Format for the returned private key. Generally the default will be controlled by the \"format\" parameter as either base64-encoded DER or PEM-encoded DER. However, this can be set to \"pkcs8\" to have the returned private key contain base64-encoded pkcs8 or PEM-encoded pkcs8 instead. Defaults to \"der\". | [optional][default to 'der'] |
| **province** | **Array<String>** | If set, Province will be set to this value. | [optional] |
| **serial_number** | **String** | The Subject's requested serial number, if any. See RFC 4519 Section 2.31 'serialNumber' for a description of this field. If you want more than one, specify alternative names in the alt_names map using OID 2.5.4.5. This has no impact on the final certificate's Serial Number field. | [optional] |
| **signature_bits** | **Integer** | The number of bits to use in the signature algorithm; accepts 256 for SHA-2-256, 384 for SHA-2-384, and 512 for SHA-2-512. Defaults to 0 to automatically detect based on key length (SHA-2-256 for RSA keys, and matching the curve size for NIST P-Curves). | [optional][default to 0] |
| **skid** | **String** | Value for the Subject Key Identifier field (RFC 5280 Section 4.2.1.2). This value should ONLY be used when cross-signing to mimic the existing certificate's SKID value; this is necessary to allow certain TLS implementations (such as OpenSSL) which use SKID/AKID matches in chain building to restrict possible valid chains. Specified as a string in hex format. Default is empty, allowing OpenBao to automatically calculate the SKID according to method one in the above RFC section. | [optional][default to ''] |
| **street_address** | **Array<String>** | If set, Street Address will be set to this value. | [optional] |
| **ttl** | **Integer** | The requested Time To Live for the certificate; sets the expiration date. If not specified the role default, backend default, or system default TTL is used, in that order. Cannot be larger than the mount max TTL. Note: this only has an effect when generating a CA cert or signing a CA cert, not when generating a CSR for an intermediate CA. | [optional] |
| **uri_sans** | **Array<String>** | The requested URI SANs, if any, in a comma-delimited list. | [optional] |
| **use_csr_values** | **Boolean** | If true, then: 1) Subject information, including names and alternate names, will be preserved from the CSR rather than using values provided in the other parameters to this path; 2) Any key usages requested in the CSR will be added to the basic set of key usages used for CA certs signed by this path; for instance, the non-repudiation flag; 3) Extensions requested in the CSR will be copied into the issued certificate. | [optional][default to false] |
| **use_pss** | **Boolean** | Whether or not to use PSS signatures when using a RSA key-type issuer. Defaults to false. | [optional][default to false] |
## Example
```ruby
require 'openbao_client'
instance = OpenbaoClient::PkiRootSignIntermediateRequest.new(
alt_names: null,
common_name: null,
country: null,
csr: null,
exclude_cn_from_sans: null,
ext_key_usage: null,
ext_key_usage_oids: null,
format: null,
ip_sans: null,
issuer_name: null,
issuer_ref: null,
key_usage: null,
locality: null,
max_path_length: null,
not_after: null,
not_before_duration: null,
organization: null,
other_sans: null,
ou: null,
permitted_dns_domains: null,
postal_code: null,
private_key_format: null,
province: null,
serial_number: null,
signature_bits: null,
skid: null,
street_address: null,
ttl: null,
uri_sans: null,
use_csr_values: null,
use_pss: null
)
```
|
