tss2_getrandom.1 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_getrandom" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_getrandom\f[](1) \- # SYNOPSIS
  8. .PP
  9. \f[B]tss2_getrandom\f[] [\f[I]OPTIONS\f[]]
  10. .SH SEE ALSO
  11. .PP
  12. \f[B]fapi\-config(5)\f[] to adjust Fapi parameters like the used
  13. cryptographic profile and TCTI or directories for the Fapi metadata
  14. storages.
  15. .PP
  16. \f[B]fapi\-profile(5)\f[] to determine the cryptographic algorithms and
  17. parameters for all keys and operations of a specific TPM interaction
  18. like the name hash algorithm, the asymmetric signature algorithm, scheme
  19. and parameters and PCR bank selection.
  20. .SH DESCRIPTION
  21. .PP
  22. \f[B]tss2_getrandom\f[](1) \- This command uses the TPM to create an
  23. array of random bytes.
  24. .SH OPTIONS
  25. .PP
  26. These are the available options:
  27. .IP \[bu] 2
  28. \f[B]\-n\f[], \f[B]\-\-numBytes\f[]=\f[I]INTEGER\f[]:
  29. .RS 2
  30. .PP
  31. The number of bytes requested by the caller.
  32. .RE
  33. .IP \[bu] 2
  34. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  35. .RS 2
  36. .PP
  37. Force overwriting the output file.
  38. .RE
  39. .IP \[bu] 2
  40. \f[B]\-o\f[], \f[B]\-\-data\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  41. stdout):
  42. .RS 2
  43. .PP
  44. The returned random bytes.
  45. .RE
  46. .IP \[bu] 2
  47. \f[B]\-\-hex\f[]
  48. .RS 2
  49. .PP
  50. Convert the output data to hex format without a leading "0x".
  51. .RE
  52. .SH COMMON OPTIONS
  53. .PP
  54. This collection of options are common to all tss2 programs and provide
  55. information that many users may expect.
  56. .IP \[bu] 2
  57. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  58. manpage.
  59. By default, it attempts to invoke the manpager for the tool, however, on
  60. failure will output a short tool summary.
  61. This is the same behavior if the "man" option argument is specified,
  62. however if explicit "man" is requested, the tool will provide errors
  63. from man on stderr.
  64. If the "no\-man" option if specified, or the manpager fails, the short
  65. options will be output to stdout.
  66. .RS 2
  67. .PP
  68. To successfully use the manpages feature requires the manpages to be
  69. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  70. .RE
  71. .IP \[bu] 2
  72. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  73. tool, supported tctis and exit.
  74. .SH EXAMPLE
  75. .IP
  76. .nf
  77. \f[C]
  78. \ \ \ \ tss2_getrandom\ \-\-numBytes=20\ \-data=\-\ |\ hexdump\ \-C
  79. \f[]
  80. .fi
  81. .SH RETURNS
  82. .PP
  83. 0 on success or 1 on failure.
  84. .SH BUGS
  85. .PP
  86. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  87. .SH HELP
  88. .PP
  89. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)