From 745ba35ae39facb1f99f81297bb314c70ee265bd Mon Sep 17 00:00:00 2001 From: Klas Lindfors Date: Thu, 13 Feb 2014 20:17:55 +0100 Subject: [PATCH] add examples to the manpage and will remove from the README when we figure out how to publish manpages like these properly. --- Makefile.am | 3 ++- yubico-piv-tool.h2m | 62 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 yubico-piv-tool.h2m diff --git a/Makefile.am b/Makefile.am index 3c84934..65cad1b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -32,7 +32,7 @@ AM_CPPFLAGS = $(OPENSSL_CFLAGS) $(PCSC_CFLAGS) ACLOCAL_AMFLAGS = -I m4 bin_PROGRAMS = yubico-piv-tool -yubico_piv_tool_SOURCES = yubico-piv-tool.c +yubico_piv_tool_SOURCES = yubico-piv-tool.c yubico-piv-tool.h2m yubico_piv_tool_SOURCES += cmdline.ggo cmdline.c cmdline.h yubico_piv_tool_LDADD = $(OPENSSL_LIBS) $(PCSC_LIBS) yubico_piv_tool_LDADD += $(LTLIBWINSCARD) $(PCSC_MACOSX_LIBS) @@ -54,6 +54,7 @@ yubico-piv-tool.1: $(yubico_piv_tool_SOURCES) \ $(top_srcdir)/configure.ac $(HELP2MAN) --no-info \ --name="Yubico PIV tool" \ + --include=$(top_srcdir)/yubico-piv-tool.h2m \ --output=$@ $(top_builddir)/yubico-piv-tool$(EXEEXT) # Maintainer rules. diff --git a/yubico-piv-tool.h2m b/yubico-piv-tool.h2m new file mode 100644 index 0000000..5898c60 --- /dev/null +++ b/yubico-piv-tool.h2m @@ -0,0 +1,62 @@ +# Copyright (c) 2014 Yubico AB +# All rights reserved. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# Additional permission under GNU GPL version 3 section 7 +# +# If you modify this program, or any covered work, by linking or +# combining it with the OpenSSL project's OpenSSL library (or a +# modified version of that library), containing parts covered by the +# terms of the OpenSSL or SSLeay licenses, We grant you additional +# permission to convey the resulting work. Corresponding Source for a +# non-source form of such a combination shall include the source code +# for the parts of OpenSSL used as well as that of the covered work. + +[EXAMPLES] + +For more information about what's happening --verbose can be added +to any command. For much more information --verbose=2 may be used. + +Display what version of the applet is running on the YubiKey Neo: + + yubico-piv-tool -a version + +Generate a new ECC-P256 key on device in slot 9a, will print the public +key on stdout: + + yubico-piv-tool -s 9a -A ECCP256 -a generate + +Generate a certificate request with public key from stdin, will print +the resulting request on stdout: + + yubico-piv-tool -s 9a -S '/CN=foo/OU=test/O=example.com/' -P 123456 \\\n + -a verify -a request + +Generate a self-signed certificate with public key from stdin, will print +the certificate, for later import, on stdout: + + yubico-piv-tool -s 9a -S '/CN=bar/OU=test/O=example.com/' -P 123456 \\\n + -a verify -a selfsign + +Set a random chuid, import a key and import a certificate from a PKCS12 +file with password test, into slot 9c: + + yubico-piv-tool -s 9c -i test.pfx -K PKCS12 -p test -a set-chuid \\\n + -a import-key -a import-cert + +Change the management key used for administrative authentication: + + yubico-piv-tool -n 0807605403020108070605040302010807060504030201 \\\n + -a set-mgm-key