From e8900d4c7bbd84f87202afd2e7c7a2a6017f4a18 Mon Sep 17 00:00:00 2001 From: Simon Ruderich Date: Tue, 6 Aug 2013 23:01:47 +0200 Subject: [PATCH] Add basic man pages. --- .gitignore | 5 +++++ Makefile.am | 2 +- NEWS | 1 + configure.ac | 2 +- man/Makefile.am | 17 ++++++++++++++ man/man.conf | 10 +++++++++ man/tlsproxy-add.txt | 49 +++++++++++++++++++++++++++++++++++++++++ man/tlsproxy-setup.txt | 50 ++++++++++++++++++++++++++++++++++++++++++ man/tlsproxy.txt | 48 ++++++++++++++++++++++++++++++++++++++++ 9 files changed, 182 insertions(+), 2 deletions(-) create mode 100644 man/Makefile.am create mode 100644 man/man.conf create mode 100644 man/tlsproxy-add.txt create mode 100644 man/tlsproxy-setup.txt create mode 100644 man/tlsproxy.txt diff --git a/.gitignore b/.gitignore index 2ea2489..5c6e87a 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ /config.h.in~ /configure /Makefile.in +/man/Makefile.in /src/Makefile.in /tests/Makefile.in # Created by ./configure. @@ -14,11 +15,15 @@ /config.log /config.status /Makefile +/man/Makefile /src/.deps/ /src/Makefile /stamp-h1 /tests/.deps/ /tests/Makefile # Created by make. +/man/tlsproxy.1 +/man/tlsproxy-add.1 +/man/tlsproxy-setup.1 /src/tlsproxy /tests/client diff --git a/Makefile.am b/Makefile.am index a459377..3592e53 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1 +1 @@ -SUBDIRS = src tests +SUBDIRS = man src tests diff --git a/NEWS b/NEWS index c865bc6..1d3d2fb 100644 --- a/NEWS +++ b/NEWS @@ -8,6 +8,7 @@ NEWS - Better error handling. - Fix compile with recent GnuTLS (e.g. 3.2.3). - Improve (error) logging; log to stderr. +- Add (basic) man pages. - Improve test suite. - tlsproxy-setup: Increase expiry-date and use larger private key. diff --git a/configure.ac b/configure.ac index 6ddf591..52ae461 100644 --- a/configure.ac +++ b/configure.ac @@ -54,5 +54,5 @@ AC_ARG_ENABLE([ipv6], AC_DEFINE([USE_IPV4_ONLY], 1, [Define to not use IPv6.]) fi]) -AC_CONFIG_FILES([Makefile src/Makefile tests/Makefile]) +AC_CONFIG_FILES([Makefile man/Makefile src/Makefile tests/Makefile]) AC_OUTPUT diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..548e898 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,17 @@ +dist_man1_MANS = tlsproxy.1 tlsproxy-setup.1 tlsproxy-add.1 +dist_noinst_DATA = tlsproxy.txt tlsproxy-setup.txt tlsproxy-add.txt + +MAINTAINERCLEANFILES = $(dist_man1_MANS) + + +ASCIIDOC = asciidoc +XMLTO = xmlto +RM = rm + +A2XML = $(ASCIIDOC) --backend=docbook --doctype=manpage --conf-file=man.conf +XML2MAN = $(XMLTO) man + +.txt.1: + $(A2XML) -o $@.xml $< + $(XML2MAN) $@.xml + $(RM) $@.xml diff --git a/man/man.conf b/man/man.conf new file mode 100644 index 0000000..a6d5079 --- /dev/null +++ b/man/man.conf @@ -0,0 +1,10 @@ +# Macro to display links to other man pages. Inspired by Git's linkgit:[] +# macro. +[macros] +(?su)[\\]?(?Pmanlink):(?P\S*?)\[(?P.*?)\]= + +[manlink-inlinemacro] + + {target} + {0} + diff --git a/man/tlsproxy-add.txt b/man/tlsproxy-add.txt new file mode 100644 index 0000000..a89cda4 --- /dev/null +++ b/man/tlsproxy-add.txt @@ -0,0 +1,49 @@ +tlsproxy-add(1) +=============== + +NAME +---- + +tlsproxy-add - add server certificate + + +SYNOPSIS +-------- + +*tlsproxy-add* 'hostname' ['server-certificate'] + + +DESCRIPTION +----------- + +Add the server certificate for 'hostname'. If 'server-certificate' is not +specified, the certificate is read from stdin. + +Importing creates the following files in the current directory ('hostname' is +the specified hostname). + +- certificate-'hostname'-proxy.pem +- certificate-'hostname'-server.pem + +Requires GnuTLS' *certtool*. + + +AUTHORS +------- + +Written by Simon Ruderich . + + +COPYRIGHT +--------- + +Copyright \(C) 2011-2013 Simon Ruderich. Free software licensed under GPL +version 3 or later. + + +SEE ALSO +-------- + +manlink:tlsproxy[1] + +// vim: ft=asciidoc diff --git a/man/tlsproxy-setup.txt b/man/tlsproxy-setup.txt new file mode 100644 index 0000000..e04e9f1 --- /dev/null +++ b/man/tlsproxy-setup.txt @@ -0,0 +1,50 @@ +tlsproxy-setup(1) +================= + +NAME +---- + +tlsproxy-setup - create necessary files for tlsproxy + + +SYNOPSIS +-------- + +*tlsproxy-setup* + + +DESCRIPTION +----------- + +*tlsproxy-setup* creates required files for *tlsproxy*, should be run in an +empty directory. + +It creates the following files in the current directory: + +- proxy-ca.pem +- proxy-ca-key.pem +- proxy-key.pem +- proxy-invalid.pem + +Requires GnuTLS' *certtool*. + + +AUTHORS +------- + +Written by Simon Ruderich . + + +COPYRIGHT +--------- + +Copyright \(C) 2011-2013 Simon Ruderich. Free software licensed under GPL +version 3 or later. + + +SEE ALSO +-------- + +manlink:tlsproxy[1] + +// vim: ft=asciidoc diff --git a/man/tlsproxy.txt b/man/tlsproxy.txt new file mode 100644 index 0000000..fc66fdb --- /dev/null +++ b/man/tlsproxy.txt @@ -0,0 +1,48 @@ +tlsproxy(1) +=========== + +NAME +---- + +tlsproxy - simple TLS proxy with server certificate validation + + +SYNOPSIS +-------- + +*tlsproxy* ['options'] 'port' + + +DESCRIPTION +----------- + +tlsproxy is a TLS proxy for HTTPS which intercepts the connections and ensures +the server certificate doesn't change. Normally this isn't detected if a +trusted CA for the new server certificate is installed. + + +BUGS +---- + +See the tlsproxy distribution README file. + + +AUTHORS +------- + +Written by Simon Ruderich . + + +COPYRIGHT +--------- + +Copyright \(C) 2011-2013 Simon Ruderich. Free software licensed under GPL +version 3 or later. + + +SEE ALSO +-------- + +manlink:tlsproxy-add[1], manlink:tlsproxy-setup[1] + +// vim: ft=asciidoc -- 2.45.2