summaryrefslogtreecommitdiff
path: root/op-mode-definitions/pki.xml.in
blob: a1c55dcf46fda80b5b6b8afcc7ec9a82eda8c5a6 (plain)
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="generate">
    <children>
      <node name="pki">
        <properties>
          <help>Generate PKI certificates and keys</help>
        </properties>
        <children>
          <node name="ca">
            <properties>
              <help>Generate CA certificate</help>
            </properties>
            <children>
              <tagNode name="sign">
                <properties>
                  <help>Sign generated CA certificate with another specified CA certificate</help>
                  <completionHelp>
                    <path>pki ca</path>
                  </completionHelp>
                </properties>
                <children>
                  <tagNode name="file">
                    <properties>
                      <help>Write generated CA certificate into the specified filename</help>
                      <completionHelp>
                        <list>&lt;filename&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "$7" --sign "$5" --file</command>
                  </tagNode>
                  <tagNode name="install">
                    <properties>
                      <help>Commands for installing generated CA certificate into running configuration</help>
                      <completionHelp>
                        <list>&lt;certificate name&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "$7" --sign "$5" --install</command>
                  </tagNode>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "noname" --sign "$5"</command>
              </tagNode>
              <tagNode name="file">
                <properties>
                  <help>Write generated CA certificate into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "$5" --file</command>
              </tagNode>
              <tagNode name="install">
                <properties>
                  <help>Commands for installing generated CA certificate into running configuration</help>
                  <completionHelp>
                    <list>&lt;CA name&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "$5" --install</command>
              </tagNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ca "noname"</command>
          </node>
          <node name="certificate">
            <properties>
              <help>Generate certificate request</help>
            </properties>
            <children>
              <node name="self-signed">
                <properties>
                  <help>Generate self-signed certificate</help>
                </properties>
                <children>
                  <tagNode name="file">
                    <properties>
                      <help>Write generated self-signed certificate into the specified filename</help>
                      <completionHelp>
                        <list>&lt;filename&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$6" --self-sign --file</command>
                  </tagNode>
                  <tagNode name="install">
                    <properties>
                      <help>Commands for installing generated self-signed certificate into running configuration</help>
                      <completionHelp>
                        <list>&lt;certificate name&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$6" --self-sign --install</command>
                  </tagNode>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "noname" --self-sign</command>
              </node>
              <tagNode name="sign">
                <properties>
                  <help>Sign generated certificate with specified CA certificate</help>
                  <completionHelp>
                    <path>pki ca</path>
                  </completionHelp>
                </properties>
                <children>
                  <tagNode name="file">
                    <properties>
                      <help>Write generated signed certificate into the specified filename</help>
                      <completionHelp>
                        <list>&lt;filename&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$7" --sign "$5" --file</command>
                  </tagNode>
                  <tagNode name="install">
                    <properties>
                      <help>Commands for installing generated signed certificate into running configuration</help>
                      <completionHelp>
                        <list>&lt;certificate name&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$7" --sign "$5" --install</command>
                  </tagNode>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "noname" --sign "$5"</command>
              </tagNode>
              <tagNode name="file">
                <properties>
                  <help>Write generated certificate request and key into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$5" --file</command>
              </tagNode>
              <tagNode name="install">
                <properties>
                  <help>Commands for installing generated certificate private key into running configuration</help>
                  <completionHelp>
                    <list>&lt;certificate name&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "$5" --install</command>
              </tagNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --certificate "noname"</command>
          </node>
          <tagNode name="crl">
            <properties>
              <help>Generate CRL for specified CA certificate</help>
              <completionHelp>
                <path>pki ca</path>
              </completionHelp>
            </properties>
            <children>
              <tagNode name="file">
                <properties>
                  <help>Write generated CRL into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --crl "$4" --file</command>
              </tagNode>
              <leafNode name="install">
                <properties>
                  <help>Commands for installing generated CRL into running configuration</help>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --crl "$4" --install</command>
              </leafNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --crl "$4"</command>
          </tagNode>
          <node name="dh">
            <properties>
              <help>Generate DH parameters</help>
            </properties>
            <children>
              <tagNode name="file">
                <properties>
                  <help>Write generated DH parameters into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --dh "$5" --file</command>
              </tagNode>
              <tagNode name="install">
                <properties>
                  <help>Commands for installing generated DH parameters into running configuration</help>
                  <completionHelp>
                    <list>&lt;DH name&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --dh "$5" --install</command>
              </tagNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --dh "noname"</command>
          </node>
          <node name="key-pair">
            <properties>
              <help>Generate a key pair</help>
            </properties>
            <children>
              <tagNode name="file">
                <properties>
                  <help>Write generated key pair into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --keypair "$5" --file</command>
              </tagNode>
              <tagNode name="install">
                <properties>
                  <help>Commands for installing generated key pair into running configuration</help>
                  <completionHelp>
                    <list>&lt;key name&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --keypair "$5" --install</command>
              </tagNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --keypair "noname"</command>
          </node>
          <node name="openvpn">
            <properties>
              <help>Generate OpenVPN keys</help>
            </properties>
            <children>
              <node name="shared-secret">
                <properties>
                  <help>Generate OpenVPN shared secret key</help>
                </properties>
                <children>
                  <tagNode name="file">
                    <properties>
                      <help>Write generated OpenVPN shared secret key into the specified filename</help>
                      <completionHelp>
                        <list>&lt;filename&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --openvpn "$6" --file</command>
                  </tagNode>
                  <tagNode name="install">
                    <properties>
                      <help>Commands for installing generated OpenVPN shared secret key into running configuration</help>
                      <completionHelp>
                        <list>&lt;key name&gt;</list>
                      </completionHelp>
                    </properties>
                    <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --openvpn "$6" --install</command>
                  </tagNode>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --openvpn "noname"</command>
              </node>
            </children>
          </node>
          <node name="ssh-key">
            <properties>
              <help>Generate SSH key</help>
            </properties>
            <children>
              <tagNode name="file">
                <properties>
                  <help>Write generated SSH keys into the specified filename</help>
                  <completionHelp>
                    <list>&lt;filename&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ssh "$5" --file</command>
              </tagNode>
              <tagNode name="install">
                <properties>
                  <help>Commands for installing generated SSH key into running configuration</help>
                  <completionHelp>
                    <list>&lt;key name&gt;</list>
                  </completionHelp>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ssh "$5" --install</command>
              </tagNode>
            </children>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --ssh "noname"</command>
          </node>
          <node name="wireguard">
            <properties>
              <help>Generate WireGuard keys</help>
            </properties>
            <children>
              <node name="key-pair">
                <properties>
                  <help>Generate WireGuard public/private key-pair</help>
                </properties>
                <children>
                  <node name="install">
                    <properties>
                      <help>Generate CLI commands to install WireGuard key to configuration</help>
                    </properties>
                    <children>
                      <tagNode name="interface">
                        <properties>
                          <help>WireGuard Interface used in install command</help>
                          <completionHelp>
                            <path>interfaces wireguard</path>
                          </completionHelp>
                        </properties>
                        <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --wireguard --key --interface "$7" --install</command>
                      </tagNode>
                    </children>
                  </node>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --wireguard --key</command>
              </node>
              <node name="preshared-key">
                <properties>
                  <help>Generate WireGuard pre-shared key</help>
                </properties>
                <children>
                  <node name="install">
                    <properties>
                      <help>Generate CLI commands to install WireGuard key to configuration</help>
                    </properties>
                    <children>
                      <tagNode name="interface">
                        <properties>
                          <help>WireGuard Interface used in install command</help>
                          <completionHelp>
                            <path>interfaces wireguard</path>
                          </completionHelp>
                        </properties>
                        <children>
                          <tagNode name="peer">
                            <properties>
                              <help>Interface used for install command</help>
                              <completionHelp>
                                <path>interfaces wireguard ${COMP_WORDS[COMP_CWORD-2]} peer</path>
                              </completionHelp>
                            </properties>
                            <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --wireguard --psk --interface "$7" --peer "$9" --install</command>
                          </tagNode>
                        </children>
                      </tagNode>
                    </children>
                  </node>
                </children>
                <command>sudo ${vyos_op_scripts_dir}/pki.py --action generate --wireguard --psk</command>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
  <node name="show">
    <children>
      <node name="pki">
        <properties>
          <help>Show PKI x509 certificates</help>
        </properties>
        <children>
          <leafNode name="ca">
            <properties>
              <help>Show x509 CA certificates</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action show --ca "all"</command>
          </leafNode>
          <tagNode name="ca">
            <properties>
              <help>Show x509 CA certificate by name</help>
              <completionHelp>
                <path>pki ca</path>
              </completionHelp>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action show --ca "$4"</command>
          </tagNode>
          <leafNode name="certificate">
            <properties>
              <help>Show x509 certificates</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action show --certificate "all"</command>
          </leafNode>
          <tagNode name="certificate">
            <properties>
              <help>Show x509 certificate by name</help>
              <completionHelp>
                <path>pki certificate</path>
              </completionHelp>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action show --certificate "$4"</command>
          </tagNode>
          <leafNode name="crl">
            <properties>
              <help>Show x509 certificate revocation lists</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/pki.py --action show --crl "all"</command>
          </leafNode>
        </children>
        <command>sudo ${vyos_op_scripts_dir}/pki.py --action show</command>
      </node>
    </children>
  </node>
</interfaceDefinition>