From: Nikos Mavrogiannopoulos Date: Fri, 20 Jul 2012 20:21:33 +0000 (+0200) Subject: Added tpmtool manpage. X-Git-Tag: gnutls_3_1_0pre0~33 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=895aadfdb883572590189950f8aae25bf590724d;p=thirdparty%2Fgnutls.git Added tpmtool manpage. --- diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am index 694bb4d49b..b025eae64e 100644 --- a/doc/manpages/Makefile.am +++ b/doc/manpages/Makefile.am @@ -20,7 +20,7 @@ # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. dist_man_MANS = gnutls-cli.1 gnutls-cli-debug.1 gnutls-serv.1 \ - certtool.1 psktool.1 p11tool.1 ocsptool.1 + certtool.1 psktool.1 p11tool.1 ocsptool.1 tpmtool.1 if ENABLE_SRP dist_man_MANS += srptool.1 @@ -67,6 +67,11 @@ p11tool.1: ../../src/p11tool-args.def autogen -DMAN_SECTION=1 -Tagman-cmd.tpl "$<".tmp && \ rm -f "$<".tmp +tpmtool.1: ../../src/tpmtool-args.def + -sed 's/@subheading \(.*\)/@*\n@var{\1}\n@*/' $< > "$<".tmp && \ + autogen -DMAN_SECTION=1 -Tagman-cmd.tpl "$<".tmp && \ + rm -f "$<".tmp + psktool.1: ../../src/psk-args.def -sed 's/@subheading \(.*\)/@*\n@var{\1}\n@*/' $< > "$<".tmp && \ autogen -DMAN_SECTION=1 -Tagman-cmd.tpl "$<".tmp && \ diff --git a/doc/manpages/tpmtool.1 b/doc/manpages/tpmtool.1 new file mode 100644 index 0000000000..771b72fd0c --- /dev/null +++ b/doc/manpages/tpmtool.1 @@ -0,0 +1,182 @@ +.TH tpmtool 1 "20 Jul 2012" "@VERSION@" "User Commands" +.\" +.\" DO NOT EDIT THIS FILE (tpmtool-args.man) +.\" +.\" It has been AutoGen-ed July 20, 2012 at 10:20:00 PM by AutoGen 5.16 +.\" From the definitions ../../src/tpmtool-args.def.tmp +.\" and the template file agman-cmd.tpl +.\" +.SH NAME +tpmtool \- GnuTLS TPM tool +.SH SYNOPSIS +.B tpmtool +.\" Mixture of short (flag) options and long options +.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \-\-\fIopt\-name\fP " [[=| ]\fIvalue\fP]]..." +.PP +All arguments must be options. +.PP +.SH "DESCRIPTION" +Program that allows handling cryptographic data from the TPM chip. +.SH "OPTIONS" +.TP +.BR \-d " \fInumber\fP, " \-\-debug "=" \fInumber\fP +Enable debugging.. +This option takes an integer number as its argument. +The value of \fInumber\fP is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.BR \-\-infile "=\fIfile\fP" +Input file. +.sp +.TP +.BR \-\-outfile "=\fIstring\fP" +Output file. +.sp +.TP +.BR \-\-generate\-rsa +Generate an RSA private-public key pair. +.sp +Generates an RSA private-public key pair in the TPM chip. +The key may be stored in filesystem and protected by a PIN, or stored (registered) +in the TPM chip flash. +.TP +.BR \-\-register +Any generated key will be registered in the TPM. +This option must appear in combination with the following options: +generate-rsa. +.sp +.TP +.BR \-\-signing +Any generated key will be a signing key. +This option must appear in combination with the following options: +generate-rsa. +This option must not appear in combination with any of the following options: +legacy. +.sp +.TP +.BR \-\-legacy +Any generated key will be a legacy key. +This option must appear in combination with the following options: +generate-rsa. +This option must not appear in combination with any of the following options: +signing. +.sp +.TP +.BR \-\-user +Any registered key will be a user key. +This option must appear in combination with the following options: +register. +This option must not appear in combination with any of the following options: +system. +.sp +The generated key will be stored in a user specific persistent storage. +.TP +.BR \-\-system +Any registred key will be a system key. +This option must appear in combination with the following options: +register. +This option must not appear in combination with any of the following options: +user. +.sp +The generated key will be stored in system persistent storage. +.TP +.BR \-\-pubkey "=\fIurl\fP" +Prints the public key of the provided key. +.sp +.TP +.BR \-\-list +Lists all stored keys in the TPM. +.sp +.TP +.BR \-\-delete "=\fIurl\fP" +Delete the key identified by the given URL (UUID).. +.sp +.TP +.BR \-\-sec\-param "=\fIsecurity parameter\fP" +Specify the security level [low, legacy, normal, high, ultra].. +.sp +This is alternative to the bits option. +.TP +.BR \-\-bits "=\fInumber\fP" +Specify the number of bits for key generate. +This option takes an integer number as its argument. +.sp +.TP +.BR \-h , " \-\-help" +Display usage information and exit. +.TP +.BR \-! , " \-\-more-help" +Pass the extended usage information through a pager. +.TP +.BR \-v " [{\fIv|c|n\fP}]," " \-\-version" "[=\fI{v|c|n}\fP]" +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.SH EXAMPLES +To generate a key that is to be stored in filesystem use: +.br +.in +4 +.nf +$ tpmtool \-\-generate\-rsa \-\-bits 2048 \-\-outfile tpmkey.pem +.in -4 +.fi +.sp +To generate a key that is to be stored in TPM's flash use: +.br +.in +4 +.nf +$ tpmtool \-\-generate\-rsa \-\-bits 2048 \-\-register \-\-user +.in -4 +.fi +.sp +To get the public key of a TPM key use: +.br +.in +4 +.nf +$ tpmtool \-\-pubkey tpmkey:uuid=58ad734b\-bde6\-45c7\-89d8\-756a55ad1891;storage=user \ + \-\-outfile pubkey.pem +.in -4 +.fi +.sp +or if the key is stored in the filesystem: +.br +.in +4 +.nf +$ tpmtool \-\-pubkey tpmkey:file=tmpkey.pem \-\-outfile pubkey.pem +.in -4 +.fi +.sp +To list all keys stored in TPM use: +.br +.in +4 +.nf +$ tpmtool \-\-list +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.BR 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.BR 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.SH "SEE ALSO" + p11tool (1), certtool (1) +.SH "AUTHORS" +Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls-bin/AUTHORS for a complete list. +.SH "COPYRIGHT" +Copyright (C) 2000-2012 Free Software Foundation all rights reserved. +This program is released under the terms of the GNU General Public License, version 3 or later. +.SH "BUGS" +Please send bug reports to: bug-gnutls@gnu.org +.SH "NOTES" +This manual page was \fIAutoGen\fP-erated from the \fBtpmtool\fP +option definitions.