1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- .\" Automatically generated by Pandoc 1.19.2.4
- .\"
- .TH "tss2_encrypt" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
- .hy
- .SH NAME
- .PP
- \f[B]tss2_encrypt\f[](1) \- encrypts data
- .SH SYNOPSIS
- .PP
- \f[B]tss2_encrypt\f[] [\f[I]OPTIONS\f[]]
- .SH SEE ALSO
- .PP
- \f[B]fapi\-config(5)\f[] to adjust Fapi parameters like the used
- cryptographic profile and TCTI or directories for the Fapi metadata
- storages.
- .PP
- \f[B]fapi\-profile(5)\f[] to determine the cryptographic algorithms and
- parameters for all keys and operations of a specific TPM interaction
- like the name hash algorithm, the asymmetric signature algorithm, scheme
- and parameters and PCR bank selection.
- .SH DESCRIPTION
- .PP
- \f[B]tss2_encrypt\f[](1) \- This command encrypts the provided data for
- a target key using the TPM encryption schemes as specified in the
- cryptographic profile (cf., \f[B]fapi\-profile(5)\f[]).
- .SH OPTIONS
- .PP
- These are the available options:
- .IP \[bu] 2
- \f[B]\-p\f[], \f[B]\-\-keyPath\f[]=\f[I]STRING\f[]:
- .RS 2
- .PP
- Identifies the encryption key.
- .RE
- .IP \[bu] 2
- \f[B]\-f\f[], \f[B]\-\-force\f[]:
- .RS 2
- .PP
- Force overwriting the output file.
- .RE
- .IP \[bu] 2
- \f[B]\-i\f[], \f[B]\-\-plainText\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
- (for stdin):
- .RS 2
- .PP
- The data to be encrypted.
- .RE
- .IP \[bu] 2
- \f[B]\-o\f[], \f[B]\-\-cipherText\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
- (for stdout):
- .RS 2
- .PP
- Returns the JSON\-encoded ciphertext.
- .RE
- .SH COMMON OPTIONS
- .PP
- This collection of options are common to all tss2 programs and provide
- information that many users may expect.
- .IP \[bu] 2
- \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
- manpage.
- By default, it attempts to invoke the manpager for the tool, however, on
- failure will output a short tool summary.
- This is the same behavior if the "man" option argument is specified,
- however if explicit "man" is requested, the tool will provide errors
- from man on stderr.
- If the "no\-man" option if specified, or the manpager fails, the short
- options will be output to stdout.
- .RS 2
- .PP
- To successfully use the manpages feature requires the manpages to be
- installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
- .RE
- .IP \[bu] 2
- \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
- tool, supported tctis and exit.
- .SH EXAMPLE
- .IP
- .nf
- \f[C]
- \ \ tss2_encrypt\ \-\-keyPath=HS/SRK/myRSACrypt\ \-\-plainText=plainText.file\ \-\-cipherText=cipherText.file
- \f[]
- .fi
- .SH RETURNS
- .PP
- 0 on success or 1 on failure.
- .SH BUGS
- .PP
- Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
- .SH HELP
- .PP
- See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
|