tpm2_certifyX509certutil.1 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tpm2_certifyX509certutil" "1" "" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tpm2_certifyX509certutil\f[](1) \- Generate partial X509
  8. certificate.
  9. .SH SYNOPSIS
  10. .PP
  11. \f[B]tpm2_certifyX509certutil\f[] [\f[I]OPTIONS\f[]]
  12. .SH DESCRIPTION
  13. .PP
  14. \f[B]tpm2_certifyX509certutil\f[](1) \- Generates a partial certificate
  15. that is suitable as the third input parameter for TPM2_certifyX509
  16. command.
  17. The certificate data is written into a file in DER format and can be
  18. examined using openssl asn1parse tool as follows:
  19. .IP
  20. .nf
  21. \f[C]
  22. openssl\ asn1parse\ \-in\ partial_cert.der\ \-inform\ DER
  23. \f[]
  24. .fi
  25. .SH OPTIONS
  26. .PP
  27. These are the available options:
  28. .IP \[bu] 2
  29. \f[B]\-o\f[], \f[B]\-\-outcert\f[]=\f[I]STRING\f[]: The output file
  30. where the certificate will be written to.
  31. The default is partial_cert.der Optional parameter.
  32. .IP \[bu] 2
  33. \f[B]\-d\f[], \f[B]\-\-days\f[]=\f[I]NUMBER\f[]: The number of days the
  34. certificate will be valid starting from today.
  35. The default is 3560 (10 years) Optional parameter.
  36. .IP \[bu] 2
  37. \f[B]\-i\f[], \f[B]\-\-issuer\f[]=\f[I]STRING\f[]: The ISSUER entry for
  38. the cert in the following format: \-\-issuer="C=US;O=org;OU=Org
  39. unit;CN=cname" Supported fields are:
  40. .RS 2
  41. .IP \[bu] 2
  42. C \- "Country", max size = 2
  43. .IP \[bu] 2
  44. O \- "Org", max size = 8
  45. .IP \[bu] 2
  46. OU \- "Org Unit", max size = 8
  47. .IP \[bu] 2
  48. CN \- "Common Name", max size = 8 The files need to be separated with
  49. semicolon.
  50. At list one supported field is required for the option to be valid.
  51. Optional parameter.
  52. .RE
  53. .IP \[bu] 2
  54. \f[B]\-s\f[], \f[B]\-\-subject\f[]=\f[I]STRING\f[]: The SUBJECT for the
  55. cert in the following format: \-\-subject="C=US;O=org;OU=Org
  56. unit;CN=cname" Supported fields are:
  57. .RS 2
  58. .IP \[bu] 2
  59. C \- "Country", max size = 2
  60. .IP \[bu] 2
  61. O \- "Org", max size = 8
  62. .IP \[bu] 2
  63. OU \- "Org Unit", max size = 8
  64. .IP \[bu] 2
  65. CN \- "Common Name", max size = 8 The files need to be separated with
  66. semicolon.
  67. At list one supported field is required for the option to be valid.
  68. Optional parameter.
  69. .RE
  70. .IP \[bu] 2
  71. \f[B]ARGUMENT\f[] No arguments required.
  72. .SS References
  73. .SH COMMON OPTIONS
  74. .PP
  75. This collection of options are common to many programs and provide
  76. information that many users may expect.
  77. .IP \[bu] 2
  78. \f[B]\-h\f[], \f[B]\-\-help=[man|no\-man]\f[]: Display the tools
  79. manpage.
  80. By default, it attempts to invoke the manpager for the tool, however, on
  81. failure will output a short tool summary.
  82. This is the same behavior if the "man" option argument is specified,
  83. however if explicit "man" is requested, the tool will provide errors
  84. from man on stderr.
  85. If the "no\-man" option if specified, or the manpager fails, the short
  86. options will be output to stdout.
  87. .RS 2
  88. .PP
  89. To successfully use the manpages feature requires the manpages to be
  90. installed or on \f[I]MANPATH\f[], See man(1) for more details.
  91. .RE
  92. .IP \[bu] 2
  93. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  94. tool, supported tctis and exit.
  95. .IP \[bu] 2
  96. \f[B]\-V\f[], \f[B]\-\-verbose\f[]: Increase the information that the
  97. tool prints to the console during its execution.
  98. When using this option the file and line number are printed.
  99. .IP \[bu] 2
  100. \f[B]\-Q\f[], \f[B]\-\-quiet\f[]: Silence normal tool output to stdout.
  101. .IP \[bu] 2
  102. \f[B]\-Z\f[], \f[B]\-\-enable\-errata\f[]: Enable the application of
  103. errata fixups.
  104. Useful if an errata fixup needs to be applied to commands sent to the
  105. TPM.
  106. Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
  107. information many users may expect.
  108. .SH EXAMPLES
  109. .IP
  110. .nf
  111. \f[C]
  112. tpm2\ certifyX509certutil\ \-o\ partial_cert.der\ \-d\ 356
  113. \f[]
  114. .fi
  115. .SH Returns
  116. .PP
  117. Tools can return any of the following codes:
  118. .IP \[bu] 2
  119. 0 \- Success.
  120. .IP \[bu] 2
  121. 1 \- General non\-specific error.
  122. .IP \[bu] 2
  123. 2 \- Options handling error.
  124. .IP \[bu] 2
  125. 3 \- Authentication error.
  126. .IP \[bu] 2
  127. 4 \- TCTI related error.
  128. .IP \[bu] 2
  129. 5 \- Non supported scheme.
  130. Applicable to tpm2_testparams.
  131. .SH BUGS
  132. .PP
  133. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  134. .SH HELP
  135. .PP
  136. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)