6
6
7
7
### Classes
8
8
9
- * [ ` java_ks::config ` ] ( #java_ksconfig ) : java_ks configuration
9
+ * [ ` java_ks::config ` ] ( #java_ks--config ) : java_ks configuration
10
10
11
11
### Resource types
12
12
13
13
* [ ` java_ks ` ] ( #java_ks ) : Manages the entries in a java keystore, and uses composite namevars to accomplish the same alias spread across multiple target keystores.
14
14
15
15
## Classes
16
16
17
- ### <a name =" java_ksconfig " ></a >` java_ks::config `
17
+ ### <a name =" java_ks--config " ></a >` java_ks::config `
18
18
19
19
java_ks configuration
20
20
21
21
#### Parameters
22
22
23
23
The following parameters are available in the ` java_ks::config ` class:
24
24
25
- * [ ` params ` ] ( #params )
25
+ * [ ` params ` ] ( #-java_ks--config-- params )
26
26
27
- ##### <a name =" params " ></a >` params `
27
+ ##### <a name =" -java_ks--config-- params" ></a >` params `
28
28
29
29
Data type: ` Any `
30
30
@@ -65,93 +65,93 @@ together with :password_file, but you must pass at least one of these parameters
65
65
66
66
The following parameters are available in the ` java_ks ` type.
67
67
68
- * [ ` certificate ` ] ( #certificate )
69
- * [ ` certificate_content ` ] ( #certificate_content )
70
- * [ ` chain ` ] ( #chain )
71
- * [ ` destkeypass ` ] ( #destkeypass )
72
- * [ ` keytool_timeout ` ] ( #keytool_timeout )
73
- * [ ` name ` ] ( #name )
74
- * [ ` password_fail_reset ` ] ( #password_fail_reset )
75
- * [ ` password_file ` ] ( #password_file )
76
- * [ ` path ` ] ( #path )
77
- * [ ` private_key ` ] ( #private_key )
78
- * [ ` private_key_content ` ] ( #private_key_content )
79
- * [ ` private_key_type ` ] ( #private_key_type )
80
- * [ ` provider ` ] ( #provider )
81
- * [ ` source_alias ` ] ( #source_alias )
82
- * [ ` source_password ` ] ( #source_password )
83
- * [ ` storetype ` ] ( #storetype )
84
- * [ ` target ` ] ( #target )
85
- * [ ` trustcacerts ` ] ( #trustcacerts )
86
-
87
- ##### <a name =" certificate " ></a >` certificate `
68
+ * [ ` certificate ` ] ( #-java_ks-- certificate )
69
+ * [ ` certificate_content ` ] ( #-java_ks-- certificate_content )
70
+ * [ ` chain ` ] ( #-java_ks-- chain )
71
+ * [ ` destkeypass ` ] ( #-java_ks-- destkeypass )
72
+ * [ ` keytool_timeout ` ] ( #-java_ks-- keytool_timeout )
73
+ * [ ` name ` ] ( #-java_ks-- name )
74
+ * [ ` password_fail_reset ` ] ( #-java_ks-- password_fail_reset )
75
+ * [ ` password_file ` ] ( #-java_ks-- password_file )
76
+ * [ ` path ` ] ( #-java_ks-- path )
77
+ * [ ` private_key ` ] ( #-java_ks-- private_key )
78
+ * [ ` private_key_content ` ] ( #-java_ks-- private_key_content )
79
+ * [ ` private_key_type ` ] ( #-java_ks-- private_key_type )
80
+ * [ ` provider ` ] ( #-java_ks-- provider )
81
+ * [ ` source_alias ` ] ( #-java_ks-- source_alias )
82
+ * [ ` source_password ` ] ( #-java_ks-- source_password )
83
+ * [ ` storetype ` ] ( #-java_ks-- storetype )
84
+ * [ ` target ` ] ( #-java_ks-- target )
85
+ * [ ` trustcacerts ` ] ( #-java_ks-- trustcacerts )
86
+
87
+ ##### <a name =" -java_ks-- certificate" ></a >` certificate `
88
88
89
89
A file containing a server certificate, followed by zero or more intermediate certificate authorities.
90
90
All certificates will be placed in the keystore. This will autorequire the specified file.
91
91
92
- ##### <a name =" certificate_content " ></a >` certificate_content `
92
+ ##### <a name =" -java_ks-- certificate_content" ></a >` certificate_content `
93
93
94
94
A string containing a server certificate, followed by zero or more intermediate certificate authorities.
95
95
All certificates will be placed in the keystore.
96
96
97
- ##### <a name =" chain " ></a >` chain `
97
+ ##### <a name =" -java_ks-- chain" ></a >` chain `
98
98
99
99
The intermediate certificate authorities, if they are to be taken
100
100
from a file separate from the server certificate. This will autorequire the specified file.
101
101
102
- ##### <a name =" destkeypass " ></a >` destkeypass `
102
+ ##### <a name =" -java_ks-- destkeypass" ></a >` destkeypass `
103
103
104
104
The password used to protect the key in keystore.
105
105
106
- ##### <a name =" keytool_timeout " ></a >` keytool_timeout `
106
+ ##### <a name =" -java_ks-- keytool_timeout" ></a >` keytool_timeout `
107
107
108
108
Timeout for the keytool command in seconds.
109
109
110
110
Default value: ` 120 `
111
111
112
- ##### <a name =" name " ></a >` name `
112
+ ##### <a name =" -java_ks-- name" ></a >` name `
113
113
114
114
namevar
115
115
116
116
The alias that is used to identify the entry in the keystore. This will be
117
117
converted to lowercase.
118
118
119
- ##### <a name =" password_fail_reset " ></a >` password_fail_reset `
119
+ ##### <a name =" -java_ks-- password_fail_reset" ></a >` password_fail_reset `
120
120
121
- Valid values: `` true `` , `` false ` `
121
+ Valid values: ` true ` , ` false `
122
122
123
123
If the supplied password does not succeed in unlocking the
124
124
keystore file, then delete the keystore file and create a new one.
125
125
Default: false.
126
126
127
- Default value: `` false ` `
127
+ Default value: ` false `
128
128
129
- ##### <a name =" password_file " ></a >` password_file `
129
+ ##### <a name =" -java_ks-- password_file" ></a >` password_file `
130
130
131
131
The path to a file containing the password used to protect the
132
132
keystore. This cannot be used together with : password , but you must pass at least one of these parameters.
133
133
134
- ##### <a name =" path " ></a >` path `
134
+ ##### <a name =" -java_ks-- path" ></a >` path `
135
135
136
136
The search path used for command (keytool, openssl) execution.
137
137
Paths can be specified as an array or as a '
138
138
139
- ##### <a name =" private_key " ></a >` private_key `
139
+ ##### <a name =" -java_ks-- private_key" ></a >` private_key `
140
140
141
141
If you want an application to be a server and encrypt traffic,
142
142
you will need a private key. Private key entries in a keystore must be
143
143
accompanied by a signed certificate for the keytool provider. This parameter
144
144
allows you to specify the file name containing the private key. This will autorequire
145
145
the specified file.
146
146
147
- ##### <a name =" private_key_content " ></a >` private_key_content `
147
+ ##### <a name =" -java_ks-- private_key_content" ></a >` private_key_content `
148
148
149
149
If you want an application to be a server and encrypt traffic,
150
150
you will need a private key. Private key entries in a keystore must be
151
151
accompanied by a signed certificate for the keytool provider. This parameter allows you to specify the content
152
152
of the private key.
153
153
154
- ##### <a name =" private_key_type " ></a >` private_key_type `
154
+ ##### <a name =" -java_ks-- private_key_type" ></a >` private_key_type `
155
155
156
156
Valid values: ` rsa ` , ` dsa ` , ` ec `
157
157
@@ -161,38 +161,38 @@ Valid options: <rsa>, <dsa>, <ec>. Defaults to <rsa>
161
161
162
162
Default value: ` rsa `
163
163
164
- ##### <a name =" provider " ></a >` provider `
164
+ ##### <a name =" -java_ks-- provider" ></a >` provider `
165
165
166
166
The specific backend to use for this ` java_ks ` resource. You will seldom need to specify this --- Puppet will usually
167
167
discover the appropriate provider for your platform.
168
168
169
- ##### <a name =" source_alias " ></a >` source_alias `
169
+ ##### <a name =" -java_ks-- source_alias" ></a >` source_alias `
170
170
171
171
The source certificate alias
172
172
173
- ##### <a name =" source_password " ></a >` source_password `
173
+ ##### <a name =" -java_ks-- source_password" ></a >` source_password `
174
174
175
175
The source keystore password
176
176
177
- ##### <a name =" storetype " ></a >` storetype `
177
+ ##### <a name =" -java_ks-- storetype" ></a >` storetype `
178
178
179
179
Valid values: ` jceks ` , ` pkcs12 ` , ` jks `
180
180
181
181
Optional storetype
182
182
Valid options: <jceks >, <pkcs12 >, <jks >
183
183
184
- ##### <a name =" target " ></a >` target `
184
+ ##### <a name =" -java_ks-- target" ></a >` target `
185
185
186
186
namevar
187
187
188
188
Destination file for the keystore. This will autorequire the parent directory of the file.
189
189
190
- ##### <a name =" trustcacerts " ></a >` trustcacerts `
190
+ ##### <a name =" -java_ks-- trustcacerts" ></a >` trustcacerts `
191
191
192
- Valid values: `` true `` , `` false ` `
192
+ Valid values: ` true ` , ` false `
193
193
194
194
Certificate authorities aren't by default trusted so if you are adding a CA you need to set this to true.
195
195
Defaults to : false .
196
196
197
- Default value: `` false ` `
197
+ Default value: ` false `
198
198
0 commit comments