-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.step-cli.json
11922 lines (11922 loc) · 696 KB
/
.step-cli.json
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"__subcommands__": {
"help": "display help for the specified command or command group",
"version": "display the current version of the cli",
"base64": "encodes and decodes using base64 representation",
"ca": "initialize and manage a certificate authority",
"beta": "commands that are being tested; these APIs are likely to change",
"certificate": "create, revoke, validate, bundle, and otherwise manage certificates",
"completion": "print the shell completion script",
"context": "manage certificate authority contexts",
"crl": "initialize and manage a certificate revocation list",
"crypto": "useful cryptographic plumbing",
"oauth": "authorization and single sign-on using OAuth & OIDC",
"path": "print the configured step path and exit",
"ssh": "create and manage ssh certificates"
},
"__arguments__": {
"help": {
"description": "show help",
"alt_form": "h",
"type": "option"
},
"h": {
"description": "show help",
"alt_form": "help",
"type": "option"
},
"config": {
"description": "path to the config file to use for CLI flags",
"param": "value",
"type": "optional argument"
},
"version": {
"description": "print the version",
"alt_form": "v",
"type": "option"
},
"v": {
"description": "print the version",
"alt_form": "version",
"type": "option"
}
},
"__cli_version__": "0.24.4 (darwin/arm64)",
"help": {
"__arguments__": {
"http": {
"description": "HTTP service address (e.g., ':8080')",
"param": "value",
"type": "optional argument"
},
"html": {
"description": "The export directory for HTML docs.",
"param": "directory",
"type": "optional argument"
},
"markdown": {
"description": "The export directory for Markdown docs.",
"param": "directory",
"type": "optional argument"
},
"report": {
"description": "Writes a JSON report to the HTML docs directory.",
"type": "option"
}
}
},
"version": {},
"base64": {
"__arguments__": {
"d": {
"description": "decode base64 input",
"alt_form": "decode",
"type": "option"
},
"decode": {
"description": "decode base64 input",
"alt_form": "d",
"type": "option"
},
"r": {
"description": "use the unpadded base64 encoding",
"alt_form": "raw",
"type": "option"
},
"raw": {
"description": "use the unpadded base64 encoding",
"alt_form": "r",
"type": "option"
},
"u": {
"description": "use the encoding format typically used in URLs and file names",
"alt_form": "url",
"type": "option"
},
"url": {
"description": "use the encoding format typically used in URLs and file names",
"alt_form": "u",
"type": "option"
}
}
},
"ca": {
"__subcommands__": {
"health": "get the status of the CA",
"init": "initialize the CA PKI",
"bootstrap": "initialize the environment to use the CA commands",
"token": "generate an OTT granting access to the CA",
"certificate": "generate a new private key and certificate signed by the root certificate",
"rekey": "rekey a certificate",
"renew": "renew a certificate",
"revoke": "revoke a certificate",
"provisioner": "create and manage the certificate authority provisioners",
"sign": "generate a new certificate signing a certificate request",
"root": "download and validate the root certificate",
"roots": "download all the root certificates",
"federation": "download all the federated certificates",
"acme": "manage ACME settings",
"policy": "manage certificate issuance policies",
"admin": "create and manage the certificate authority admins"
},
"__arguments__": {
"help": {
"description": "show help",
"alt_form": "h",
"type": "option"
},
"h": {
"description": "show help",
"alt_form": "help",
"type": "option"
}
},
"health": {
"__arguments__": {
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"root": {
"description": "The path to the PEM file used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"context": {
"description": "The context name to apply for the given command.",
"param": "name",
"type": "optional argument"
}
}
},
"init": {
"__arguments__": {
"root": {
"description": "The path of an existing PEM file to be used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"key": {
"description": "The path of an existing key file of the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"pki": {
"description": "Generate only the PKI without the CA configuration.",
"type": "option"
},
"ssh": {
"description": "Create keys to sign SSH certificates.",
"type": "option"
},
"helm": {
"description": "Generates a Helm values YAML to be used with step-certificates chart.",
"type": "option"
},
"deployment-type": {
"description": "The name of the deployment type to use. Options are: standalone An instance of step-ca that does not connect to any cloud services. You manage authority keys and configuration yourself. Choose standalone if you'd like to run step-ca yourself and do not want cloud services or commercial support. linked An instance of step-ca with locally managed keys that connects to your Certificate Manager account for provisioner management, alerting, reporting, revocation, and other managed services. Choose linked if you'd like cloud services and support, but need to control your authority's signing keys. hosted A highly available, fully-managed instance of step-ca run by smallstep just for you. Choose hosted if you'd like cloud services and support. More information and pricing at: https://u.step.sm/cm",
"param": "name",
"type": "optional argument"
},
"name": {
"description": "The name of the new PKI.",
"param": "name",
"type": "optional argument"
},
"dns": {
"description": "The DNS name or IP address of the new CA. Use the '--dns' flag multiple times to configure multiple DNS names.",
"param": "name",
"type": "optional argument"
},
"address": {
"description": "The address that the new CA will listen at.",
"param": "address",
"type": "optional argument"
},
"provisioner": {
"description": "The name of the first provisioner.",
"param": "name",
"type": "optional argument"
},
"password-file": {
"description": "The path to the file containing the password to encrypt the keys.",
"param": "file",
"type": "optional argument"
},
"provisioner-password-file": {
"description": "The path to the file containing the password to encrypt the provisioner key.",
"param": "file",
"type": "optional argument"
},
"with-ca-url": {
"description": "URI of the Step Certificate Authority to write in defaults.json",
"param": "URI",
"type": "optional argument"
},
"ra": {
"description": "The registration authority type to use. Currently \"StepCAS\" and \"CloudCAS\" are supported.",
"param": "type",
"type": "optional argument"
},
"kms": {
"description": "The key manager service type to use to manage keys. Options are: azurekms Use Azure Key Vault to manage X.509 and SSH keys. The key URIs have the following format azurekms:name=key-name;vault=vault-name.",
"param": "type",
"type": "optional argument"
},
"kms-root": {
"description": "The kms URI used to generate the root certificate key. Examples are: azurekms azurekms:name=my-root-key;vault=my-vault",
"param": "URI",
"type": "optional argument"
},
"kms-intermediate": {
"description": "The kms URI used to generate the intermediate certificate key. Examples are: azurekms azurekms:name=my-intermediate-key;vault=my-vault",
"param": "URI",
"type": "optional argument"
},
"kms-ssh-host": {
"description": "The kms URI used to generate the key used to sign SSH host certificates. Examples are: azurekms azurekms:name=my-host-key;vault=my-vault",
"param": "URI",
"type": "optional argument"
},
"kms-ssh-user": {
"description": "The kms URI used to generate the key used to sign SSH user certificates. Examples are: azurekms azurekms:name=my-user-key;vault=my-vault",
"param": "URI",
"type": "optional argument"
},
"issuer": {
"description": "The registration authority issuer url to use. If StepCAS is used, this flag should be the URL of the CA to connect to, e.g https://ca.smallstep.com:9000 If CloudCAS is used, this flag should be the resource name of the intermediate certificate to use. This has the format 'projects/*/locations/*/caPools/*/certificateAuthorities/*'.",
"param": "url",
"type": "optional argument"
},
"issuer-fingerprint": {
"description": "The root certificate fingerprint of the issuer CA. This flag is supported in \"StepCAS\", and it should be the result of running: $ step certificate fingerprint root_ca.crt 4fe5f5ef09e95c803fdcb80b8cf511e2a885eb86f3ce74e3e90e62fa3faf1531",
"param": "fingerprint",
"type": "optional argument"
},
"issuer-provisioner": {
"description": "The name of an existing provisioner in the issuer CA. This flag is supported in \"StepCAS\".",
"param": "name",
"type": "optional argument"
},
"credentials-file": {
"description": "The registration authority credentials file to use. If CloudCAS is used, this flag should be the path to a service account key. It can also be set using the 'GOOGLE_APPLICATION_CREDENTIALS=path' environment variable or the default service account in an instance in Google Cloud.",
"param": "file",
"type": "optional argument"
},
"no-db": {
"description": "Generate a CA configuration without the DB stanza. No persistence layer.",
"type": "option"
},
"context": {
"description": "The name of the context for the new authority.",
"param": "name",
"type": "optional argument"
},
"remote-management": {
"description": "Enable Remote Management. Defaults to false.",
"type": "option"
},
"acme": {
"description": "Create a default ACME provisioner. Defaults to false.",
"type": "option"
},
"admin-subject": {
"description": "The admin subject to use for generating admin credentials.",
"param": "subject",
"alt_form": "admin-name",
"type": "optional argument"
},
"admin-name": {
"description": "The admin subject to use for generating admin credentials.",
"param": "subject",
"alt_form": "admin-subject",
"type": "optional argument"
},
"profile": {
"description": "The name that will serve as the profile name for the context.",
"param": "name",
"type": "optional argument"
},
"authority": {
"description": "The name that will serve as the authority name for the context.",
"param": "name",
"type": "optional argument"
}
}
},
"bootstrap": {
"__arguments__": {
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"fingerprint": {
"description": "The fingerprint of the targeted root certificate.",
"param": "fingerprint",
"type": "optional argument"
},
"install": {
"description": "Install the root certificate into the system truststore.",
"type": "option"
},
"team": {
"description": "The team ID used to bootstrap the environment.",
"param": "ID",
"type": "optional argument"
},
"team-authority": {
"description": "The sub-domain of the certificate authority to bootstrap. E.g., for an authority with domain name 'certs.example-team.ca.smallstep.com' the value would be 'certs'.",
"param": "sub-domain",
"type": "optional argument"
},
"team-url": {
"description": "The url step queries to retrieve initial team configuration. Only used with the --team option. If the url contains <> placeholders, they are replaced with the team ID. Replacing the authority-id section of the url is not supported with placeholders.",
"param": "url",
"type": "optional argument"
},
"redirect-url": {
"description": "The url to open in the system browser when the OAuth flow is successful.",
"param": "url",
"type": "optional argument"
},
"f": {
"description": "Force the overwrite of files without asking.",
"alt_form": "force",
"type": "option"
},
"force": {
"description": "Force the overwrite of files without asking.",
"alt_form": "f",
"type": "option"
},
"context": {
"description": "The context name to apply for the given command.",
"param": "name",
"type": "optional argument"
},
"profile": {
"description": "The name that will serve as the profile name for the context.",
"param": "name",
"type": "optional argument"
},
"authority": {
"description": "The name that will serve as the authority name for the context.",
"param": "name",
"type": "optional argument"
}
}
},
"token": {
"__arguments__": {
"subject": {
"description": "The Common Name, DNS Name, or IP address that will be set by the certificate authority. When there are no additional Subject Alternative Names configured (via the --san flag), the subject will be added as the only element of the 'sans' claim on the token.",
"type": "positional argument"
},
"kid": {
"description": "The provisioner kid to use.",
"param": "kid",
"type": "optional argument"
},
"san": {
"description": "Add dns|ip|email|uri Subject Alternative Name(s) (SANs) that should be authorized. A certificate signing request using this token must match the complete set of SANs in the token 1:1. Use the '--san' flag multiple times to configure multiple SANs.",
"param": "dns|ip|email|uri",
"type": "optional argument"
},
"principal": {
"description": "Add the principals (user or host names) that the token is authorized to request. The signing request using this token won't be able to add extra names. Use the '--principal' flag multiple times to configure multiple principals.",
"param": "name",
"alt_form": "n",
"type": "optional argument"
},
"n": {
"description": "Add the principals (user or host names) that the token is authorized to request. The signing request using this token won't be able to add extra names. Use the '--principal' flag multiple times to configure multiple principals.",
"param": "name",
"alt_form": "principal",
"type": "optional argument"
},
"host": {
"description": "Create a host certificate instead of a user certificate.",
"type": "option"
},
"ca-config": {
"description": "The certificate authority configuration file. Defaults to $(step path)/config/ca.json",
"param": "file",
"type": "optional argument"
},
"f": {
"description": "Force the overwrite of files without asking.",
"alt_form": "force",
"type": "option"
},
"force": {
"description": "Force the overwrite of files without asking.",
"alt_form": "f",
"type": "option"
},
"not-after": {
"description": "The time|duration when the certificate validity period ends. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "time|duration",
"type": "optional argument"
},
"not-before": {
"description": "The time|duration when the certificate validity period starts. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "time|duration",
"type": "optional argument"
},
"cert-not-after": {
"description": "The time|duration when the certificate validity period ends. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\". This flag is only supported on SSH certificates.",
"param": "time|duration",
"type": "optional argument"
},
"cert-not-before": {
"description": "The time|duration when the certificate validity period starts. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\". This flag is only supported on SSH certificates.",
"param": "time|duration",
"type": "optional argument"
},
"provisioner": {
"description": "The provisioner name to use.",
"param": "name",
"alt_form": "issuer",
"type": "optional argument"
},
"issuer": {
"description": "The provisioner name to use.",
"param": "name",
"alt_form": "provisioner",
"type": "optional argument"
},
"password-file": {
"description": "The path to the file containing the password to encrypt or decrypt the private key.",
"param": "file",
"type": "optional argument"
},
"provisioner-password-file": {
"description": "The path to the file containing the password to decrypt the one-time token generating key.",
"param": "file",
"type": "optional argument"
},
"kms": {
"description": "The uri to configure a Cloud KMS or an HSM.",
"param": "uri",
"type": "optional argument"
},
"x5c-cert": {
"description": "Certificate (chain) in PEM format to store in the 'x5c' header of a JWT.",
"param": "chain",
"type": "optional argument"
},
"x5c-key": {
"description": "Private key file, used to sign a JWT, corresponding to the certificate that will be stored in the 'x5c' header.",
"param": "file",
"type": "optional argument"
},
"x5c-insecure": {
"description": "Use the JWT header 'x5cInsecure' instead of 'x5c'.",
"type": "option"
},
"sshpop-cert": {
"description": "Certificate (chain) in PEM format to store in the 'sshpop' header of a JWT.",
"param": "chain",
"type": "optional argument"
},
"sshpop-key": {
"description": "Private key file, used to sign a JWT, corresponding to the certificate that will be stored in the 'sshpop' header.",
"param": "file",
"type": "optional argument"
},
"nebula-cert": {
"description": "Certificate file in PEM format to store in the 'nebula' header of a JWT.",
"param": "file",
"type": "optional argument"
},
"nebula-key": {
"description": "Private key file, used to sign a JWT, corresponding to the certificate that will be stored in the 'nebula' header.",
"param": "file",
"type": "optional argument"
},
"key": {
"description": "The private key file used to sign the JWT. This is usually downloaded from the certificate authority.",
"param": "file",
"type": "optional argument"
},
"output-file": {
"description": "The destination file of the generated one-time token.",
"param": "file",
"type": "optional argument"
},
"revoke": {
"description": "Create a token for authorizing 'Revoke' requests. The audience will be invalid for any other API request.",
"type": "option"
},
"renew": {
"description": "Create a token for authorizing 'renew' requests. The audience will be invalid for any other API request.",
"type": "option"
},
"rekey": {
"description": "Create a token for authorizing 'rekey' requests. The audience will be invalid for any other API request.",
"type": "option"
},
"ssh": {
"description": "Create a token for authorizing an SSH certificate signing request.",
"type": "option"
},
"k8ssa-token-path": {
"description": "Configure the file from which to read the kubernetes service account token.",
"param": "file",
"type": "optional argument"
},
"offline": {
"description": "Creates a certificate without contacting the certificate authority. Offline mode uses the configuration, certificates, and keys created with step ca init, but can accept a different configuration file using --ca-config flag.",
"type": "option"
},
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"root": {
"description": "The path to the PEM file used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"context": {
"description": "The context name to apply for the given command.",
"param": "name",
"type": "optional argument"
}
}
},
"certificate": {
"__arguments__": {
"subject": {
"description": "The Common Name, DNS Name, or IP address that will be set as the Subject Common Name for the certificate. If no Subject Alternative Names (SANs) are configured (via the --san flag) then the subject will be set as the only SAN.",
"type": "positional argument"
},
"crt-file": {
"description": "File to write the certificate (PEM format)",
"type": "positional argument"
},
"key-file": {
"description": "File to write the private key (PEM format)",
"type": "positional argument"
},
"san": {
"description": "Add dns|ip|email|uri Subject Alternative Name(s) (SANs) that should be authorized. Use the '--san' flag multiple times to configure multiple SANs. The '--san' flag and the '--token' flag are mutually exclusive.",
"param": "dns|ip|email|uri",
"type": "optional argument"
},
"attestation-ca-url": {
"description": "The base url of the Attestation CA to use",
"param": "value",
"type": "optional argument"
},
"attestation-ca-root": {
"description": "The path to the PEM file with trusted roots when connecting to the Attestation CA",
"param": "file",
"type": "optional argument"
},
"tpm-storage-directory": {
"description": "The directory where TPM keys and certificates will be stored",
"param": "value",
"type": "optional argument"
},
"set": {
"description": "The key=value pair with template data variables. Use the --set flag multiple times to add multiple variables.",
"param": "key",
"type": "optional argument"
},
"set-file": {
"description": "The JSON file with the template data variables.",
"param": "file",
"type": "optional argument"
},
"ca-config": {
"description": "The certificate authority configuration file. Defaults to $(step path)/config/ca.json",
"param": "file",
"type": "optional argument"
},
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"root": {
"description": "The path to the PEM file used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"token": {
"description": "The one-time token used to authenticate with the CA in order to create the certificate.",
"param": "token",
"type": "optional argument"
},
"context": {
"description": "The context name to apply for the given command.",
"param": "name",
"type": "optional argument"
},
"provisioner": {
"description": "The provisioner name to use.",
"param": "name",
"alt_form": "issuer",
"type": "optional argument"
},
"issuer": {
"description": "The provisioner name to use.",
"param": "name",
"alt_form": "provisioner",
"type": "optional argument"
},
"provisioner-password-file": {
"description": "The path to the file containing the password to decrypt the one-time token generating key.",
"param": "file",
"type": "optional argument"
},
"kty": {
"description": "The kty to build the certificate upon. If unset, default is EC. kty is a case-sensitive string and must be one of: EC Create an elliptic curve keypair OKP Create an octet key pair (for \"Ed25519\" curve) RSA Create an RSA keypair",
"param": "kty",
"type": "optional argument"
},
"crv": {
"description": "The elliptic curve to use for EC and OKP key types. Corresponds to the \"crv\" JWK parameter. Valid curves are defined in JWA [RFC7518]. If unset, default is P-256 for EC keys and Ed25519 for OKP keys. curve is a case-sensitive string and must be one of: P-256 NIST P-256 Curve P-384 NIST P-384 Curve P-521 NIST P-521 Curve Ed25519 Ed25519 Curve",
"param": "curve",
"alt_form": "curve",
"type": "optional argument"
},
"curve": {
"description": "The elliptic curve to use for EC and OKP key types. Corresponds to the \"crv\" JWK parameter. Valid curves are defined in JWA [RFC7518]. If unset, default is P-256 for EC keys and Ed25519 for OKP keys. curve is a case-sensitive string and must be one of: P-256 NIST P-256 Curve P-384 NIST P-384 Curve P-521 NIST P-521 Curve Ed25519 Ed25519 Curve",
"param": "curve",
"alt_form": "crv",
"type": "optional argument"
},
"size": {
"description": "The size (in bits) of the key for RSA and oct key types. RSA keys require a minimum key size of 2048 bits. If unset, default is 2048 bits for RSA keys and 128 bits for oct keys.",
"param": "size",
"type": "optional argument"
},
"not-after": {
"description": "The time|duration when the certificate validity period ends. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "time|duration",
"type": "optional argument"
},
"not-before": {
"description": "The time|duration when the certificate validity period starts. If a time is used it is expected to be in RFC 3339 format. If a duration is used, it is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "time|duration",
"type": "optional argument"
},
"attestation-uri": {
"description": "The KMS uri used for attestation.",
"param": "uri",
"type": "optional argument"
},
"f": {
"description": "Force the overwrite of files without asking.",
"alt_form": "force",
"type": "option"
},
"force": {
"description": "Force the overwrite of files without asking.",
"alt_form": "f",
"type": "option"
},
"offline": {
"description": "Creates a certificate without contacting the certificate authority. Offline mode uses the configuration, certificates, and keys created with step ca init, but can accept a different configuration file using --ca-config flag.",
"type": "option"
},
"password-file": {
"description": "The path to the file containing the password to encrypt or decrypt the private key.",
"param": "file",
"type": "optional argument"
},
"console": {
"description": "Complete the flow while remaining inside the terminal",
"type": "option"
},
"kms": {
"description": "The uri to configure a Cloud KMS or an HSM.",
"param": "uri",
"type": "optional argument"
},
"x5c-cert": {
"description": "Certificate (chain) in PEM format to store in the 'x5c' header of a JWT.",
"param": "chain",
"type": "optional argument"
},
"x5c-key": {
"description": "Private key file, used to sign a JWT, corresponding to the certificate that will be stored in the 'x5c' header.",
"param": "file",
"type": "optional argument"
},
"x5c-chain": {
"description": "Certificate file, in PEM format",
"param": "file",
"type": "optional argument"
},
"nebula-cert": {
"description": "Certificate file in PEM format to store in the 'nebula' header of a JWT.",
"param": "file",
"type": "optional argument"
},
"nebula-key": {
"description": "Private key file, used to sign a JWT, corresponding to the certificate that will be stored in the 'nebula' header.",
"param": "file",
"type": "optional argument"
},
"acme": {
"description": "ACME directory url to be used for requesting certificates via the ACME protocol. Use this flag to define an ACME server other than the Step CA. If this flag is absent and an ACME provisioner has been selected then the '--ca-url' flag must be defined.",
"param": "url",
"type": "optional argument"
},
"standalone": {
"description": "Get a certificate using the ACME protocol and standalone mode for validation. Standalone is a mode in which the step process will run a server that will will respond to ACME challenge validation requests. Standalone is the default mode for serving challenge validation requests.",
"type": "option"
},
"webroot": {
"description": "Specify a file to use as a 'web root' for validation in the ACME protocol. Webroot is a mode in which the step process will write a challenge file to a location being served by an existing fileserver in order to respond to ACME challenge validation requests.",
"param": "file",
"type": "optional argument"
},
"contact": {
"description": "The email-address used for contact as part of the ACME protocol. These contacts may be used to warn of certificate expiration or other certificate lifetime events. Use the '--contact' flag multiple times to configure multiple contacts.",
"param": "email-address",
"type": "optional argument"
},
"http-listen": {
"description": "Use a non-standard http address, behind a reverse proxy or load balancer, for serving ACME challenges. The default address is :80, which requires super user (sudo) privileges. This flag must be used in conjunction with the '--standalone' flag.",
"param": "address",
"type": "optional argument"
},
"k8ssa-token-path": {
"description": "Configure the file from which to read the kubernetes service account token.",
"param": "file",
"type": "optional argument"
}
}
},
"rekey": {
"__arguments__": {
"crt-file": {
"description": "The certificate in PEM format that we want to rekey.",
"type": "positional argument"
},
"key-file": {
"description": "They key file of the certificate.",
"type": "positional argument"
},
"out-cert": {
"description": "The file where the new certificate will be saved to. Defaults to overwriting the crt-file positional argument.",
"param": "file",
"type": "optional argument"
},
"out-key": {
"description": "The file to store the new private key. Defaults to overwriting the key-file positional argument.",
"param": "file",
"type": "optional argument"
},
"private-key": {
"description": "The file containing the private key for rekey-ing the certificate. By default, a new random key pair will be generated.",
"param": "file",
"type": "optional argument"
},
"expires-in": {
"description": "The amount of time remaining before certificate expiration, at which point a rekey should be attempted. The certificate rekey will not be performed if the time to expiration is greater than the --expires-in value. A random jitter (duration/20) will be added to avoid multiple services hitting the rekey endpoint at the same time. The duration is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "duration",
"type": "optional argument"
},
"pid": {
"description": "The process id to signal after the certificate has been rekeyed. By default the the SIGHUP (1) signal will be used, but this can be configured with the --signal flag.",
"param": "value",
"type": "optional argument"
},
"pid-file": {
"description": "The file from which to read the process id that will be signaled after the certificate has been rekeyed. By default the SIGHUP (1) signal will be used, but this can be configured with the --signal flag.",
"param": "file",
"type": "optional argument"
},
"signal": {
"description": "The signal number to send to the selected PID, so it can reload the configuration and load the new certificate. Default value is SIGHUP (1)",
"param": "number",
"type": "optional argument"
},
"exec": {
"description": "The command to run after the certificate has been rekeyed.",
"param": "command",
"type": "optional argument"
},
"daemon": {
"description": "Run the rekey command as a daemon, rekeying and overwriting the certificate periodically. By default the daemon will rekey a certificate before 2/3 of the time to expiration has elapsed. The period can be configured using the --rekey-period or --expires-in flags.",
"type": "option"
},
"rekey-period": {
"description": "The period with which to schedule rekeying of the certificate in daemon mode. Requires the --daemon flag. The duration is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"1.5h\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "duration",
"type": "optional argument"
},
"kty": {
"description": "The kty to build the certificate upon. If unset, default is EC. kty is a case-sensitive string and must be one of: EC Create an elliptic curve keypair OKP Create an octet key pair (for \"Ed25519\" curve) RSA Create an RSA keypair",
"param": "kty",
"type": "optional argument"
},
"crv": {
"description": "The elliptic curve to use for EC and OKP key types. Corresponds to the \"crv\" JWK parameter. Valid curves are defined in JWA [RFC7518]. If unset, default is P-256 for EC keys and Ed25519 for OKP keys. curve is a case-sensitive string and must be one of: P-256 NIST P-256 Curve P-384 NIST P-384 Curve P-521 NIST P-521 Curve Ed25519 Ed25519 Curve",
"param": "curve",
"alt_form": "curve",
"type": "optional argument"
},
"curve": {
"description": "The elliptic curve to use for EC and OKP key types. Corresponds to the \"crv\" JWK parameter. Valid curves are defined in JWA [RFC7518]. If unset, default is P-256 for EC keys and Ed25519 for OKP keys. curve is a case-sensitive string and must be one of: P-256 NIST P-256 Curve P-384 NIST P-384 Curve P-521 NIST P-521 Curve Ed25519 Ed25519 Curve",
"param": "curve",
"alt_form": "crv",
"type": "optional argument"
},
"size": {
"description": "The size (in bits) of the key for RSA and oct key types. RSA keys require a minimum key size of 2048 bits. If unset, default is 2048 bits for RSA keys and 128 bits for oct keys.",
"param": "size",
"type": "optional argument"
},
"f": {
"description": "Force the overwrite of files without asking.",
"alt_form": "force",
"type": "option"
},
"force": {
"description": "Force the overwrite of files without asking.",
"alt_form": "f",
"type": "option"
},
"offline": {
"description": "Creates a certificate without contacting the certificate authority. Offline mode uses the configuration, certificates, and keys created with step ca init, but can accept a different configuration file using --ca-config flag.",
"type": "option"
},
"password-file": {
"description": "The path to the file containing the password to encrypt or decrypt the private key.",
"param": "file",
"type": "optional argument"
},
"root": {
"description": "The path to the PEM file used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"ca-config": {
"description": "The certificate authority configuration file. Defaults to $(step path)/config/ca.json",
"param": "file",
"type": "optional argument"
}
}
},
"renew": {
"__arguments__": {
"crt-file": {
"description": "The certificate in PEM format that we want to renew.",
"type": "positional argument"
},
"key-file": {
"description": "They key file of the certificate.",
"type": "positional argument"
},
"mtls": {
"description": "Use mTLS to renew a certificate. Use --mtls=false to force the token authorization flow instead.",
"type": "option"
},
"ca-config": {
"description": "The certificate authority configuration file. Defaults to $(step path)/config/ca.json",
"param": "file",
"type": "optional argument"
},
"f": {
"description": "Force the overwrite of files without asking.",
"alt_form": "force",
"type": "option"
},
"force": {
"description": "Force the overwrite of files without asking.",
"alt_form": "f",
"type": "option"
},
"offline": {
"description": "Creates a certificate without contacting the certificate authority. Offline mode uses the configuration, certificates, and keys created with step ca init, but can accept a different configuration file using --ca-config flag.",
"type": "option"
},
"password-file": {
"description": "The path to the file containing the password to encrypt or decrypt the private key.",
"param": "file",
"type": "optional argument"
},
"out": {
"description": "The new certificate file path. Defaults to overwriting the crt-file positional argument",
"param": "file",
"alt_form": "output-file",
"type": "optional argument"
},
"output-file": {
"description": "The new certificate file path. Defaults to overwriting the crt-file positional argument",
"param": "file",
"alt_form": "out",
"type": "optional argument"
},
"expires-in": {
"description": "The amount of time remaining before certificate expiration, at which point a renewal should be attempted. The certificate renewal will not be performed if the time to expiration is greater than the --expires-in value. A random jitter (duration/20) will be added to avoid multiple services hitting the renew endpoint at the same time. The duration is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"-1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "duration",
"type": "optional argument"
},
"pid": {
"description": "The process id to signal after the certificate has been renewed. By default the the SIGHUP (1) signal will be used, but this can be configured with the --signal flag.",
"param": "value",
"type": "optional argument"
},
"pid-file": {
"description": "The file from which to read the process id that will be signaled after the certificate has been renewed. By default the SIGHUP (1) signal will be used, but this can be configured with the --signal flag.",
"param": "file",
"type": "optional argument"
},
"signal": {
"description": "The signal number to send to the selected PID, so it can reload the configuration and load the new certificate. Default value is SIGHUP (1)",
"param": "number",
"type": "optional argument"
},
"exec": {
"description": "The command to run after the certificate has been renewed.",
"param": "command",
"type": "optional argument"
},
"daemon": {
"description": "Run the renew command as a daemon, renewing and overwriting the certificate periodically. By default the daemon will renew a certificate before 2/3 of the time to expiration has elapsed. The period can be configured using the --renew-period or --expires-in flags.",
"type": "option"
},
"renew-period": {
"description": "The period with which to schedule renewals of the certificate in daemon mode. Requires the --daemon flag. The duration is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", \"1.5h\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"s\"), \"ms\", \"s\", \"m\", \"h\".",
"param": "duration",
"type": "optional argument"
},
"ca-url": {
"description": "URI of the targeted Step Certificate Authority.",
"param": "URI",
"type": "optional argument"
},
"root": {
"description": "The path to the PEM file used as the root certificate authority.",
"param": "file",
"type": "optional argument"
},
"context": {
"description": "The context name to apply for the given command.",
"param": "name",
"type": "optional argument"
}
}
},
"revoke": {
"__arguments__": {
"serial-number": {
"description": "The serial number of the certificate that should be revoked. Can be left blank, either to be supplied by prompt, or when using the --cert and --key flags for revocation over mTLS.",
"type": "positional argument"
},
"cert": {
"description": "The file containing the cert that should be revoked.",
"param": "file",
"type": "optional argument"
},
"key": {
"description": "The file containing the key corresponding to the cert that should be revoked.",
"param": "file",
"type": "optional argument"
},
"reason": {
"description": "The string representing the reason for which the cert is being revoked.",
"param": "string",
"type": "optional argument"
},
"reasonCode": {
"description": "The reasonCode specifies the reason for revocation - chose from a list of common revocation reasons. If unset, the default is Unspecified. reasonCode can be a number from 0-9 or a case insensitive string matching one of the following options: Unspecified No reason given (Default -- reasonCode=0). KeyCompromise The key is believed to have been compromised (reasonCode=1). CACompromise The issuing Certificate Authority itself has been compromised (reasonCode=2). AffiliationChanged The certificate contained affiliation information, for example, it may have been an EV certificate and the associated business is no longer owned by the same entity (reasonCode=3). Superseded The certificate is being replaced (reasonCode=4). CessationOfOperation If a CA is decommissioned, no longer to be used, the CA's certificate should be revoked with this reason code. Do not revoke the CA's certificate if the CA no longer issues new certificates, yet still publishes CRLs for the currently issued certificates (reasonCode=5). CertificateHold A temporary revocation that indicates that a CA will not vouch for a certificate at a specific point in time. Once a certificate is revoked with a CertificateHold reason code, the certificate can then be revoked with another Reason Code, or unrevoked and returned to use (reasonCode=6). RemoveFromCRL If a certificate is revoked with the CertificateHold reason code, it is possible to \"unrevoke\" a certificate. The unrevoking process still lists the certificate in the CRL, but with the reason code set to RemoveFromCRL. Note: This is specific to the CertificateHold reason and is only used in DeltaCRLs (reasonCode=8). PrivilegeWithdrawn The right to represent the given entity was revoked for some reason (reasonCode=9). AACompromise It is known or suspected that aspects of the AA validated in the attribute certificate have been compromised (reasonCode=10).",
"param": "reasonCode",
"type": "optional argument"