summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Kreuzer <andreas.kreuzer@open-infrastructure.net>2017-05-22 11:17:46 +0000
committerAndreas Kreuzer <andreas.kreuzer@open-infrastructure.net>2017-05-22 11:54:04 +0000
commit9bc33cf557fdaa78494f69d662fde87aea0739f5 (patch)
tree387e45a952892534bbd36fc68c31edec51dbc3ba
parentAdding share/doc/examples/config. (diff)
downloadadmin-tools-old-master.tar.xz
admin-tools-old-master.zip
Adding share/man.old-master
Signed-off-by: Andreas Kreuzer <andreas.kreuzer@open-infrastructure.net>
-rw-r--r--share/man/Makefile42
-rw-r--r--share/man/crypto-ssh-hostkey.1.txt81
-rw-r--r--share/man/crypto-tools.7.txt60
-rw-r--r--share/man/crypto.1.txt86
-rw-r--r--share/man/ssh-ca-config.1.txt59
-rw-r--r--share/man/ssh-ca-init.1.txt54
-rw-r--r--share/man/ssh-ca-install.1.txt46
-rw-r--r--share/man/ssh-ca-pull.1.txt52
-rw-r--r--share/man/ssh-ca-push.1.txt49
-rw-r--r--share/man/ssh-ca-trigger.1.txt42
-rw-r--r--share/man/ssh-ca.1.txt66
11 files changed, 637 insertions, 0 deletions
diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644
index 0000000..a55eaae
--- /dev/null
+++ b/share/man/Makefile
@@ -0,0 +1,42 @@
+# Makefile
+
+# Open Infrastructure: crypto-tools
+# Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+# Depends: asciidoc dblatex docbook-xsl libxml2-utils source-highlight
+
+A2X = a2x \
+ --asciidoc-opts "-a revdate=$(shell cat ../../VERSION)" \
+ --doctype=manpage
+
+SHELL := sh -e
+
+all: build
+
+clean:
+ rm -f *.[0-9]
+
+build: man
+
+rebuild: clean build
+
+man: *.txt
+ for FILE in *.txt; \
+ do \
+ $(A2X) --format=manpage $${FILE}; \
+ done
+
+.PHONY: all clean build rebuild man
diff --git a/share/man/crypto-ssh-hostkey.1.txt b/share/man/crypto-ssh-hostkey.1.txt
new file mode 100644
index 0000000..3a89af5
--- /dev/null
+++ b/share/man/crypto-ssh-hostkey.1.txt
@@ -0,0 +1,81 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+CRYPTO-SSH-HOSTKEY(1)
+=====================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+crypto-ssh-hostkey - Manage OpenSSH host key
+
+
+SYNOPSIS
+--------
+*crypto ssh-hostkey* ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+The crypto-ssh-hostkey command manages OpenSSH host keys.
+
+
+OPTIONS
+-------
+The following crypto-ssh-hostkey options are available:
+
+*-c, --create*::
+ Create a new host key.
+
+*-f, --filename='FILE'*:;
+ Specify host key filename.
+
+*-h, --hostname='FQDN[,HOSTNAME]'*:;
+ Specify host key hostname.
+
+*-i, --install*::
+ Install a new host key.
+
+
+EXAMPLES
+--------
+*Create example.net ssh hostkey:*::
+ sudo crypto ssh-hostkey --create --hostname example.net,example
+
+
+SEE ALSO
+--------
+crypto-tools(7),
+crypto(1).
+
+
+HOMEPAGE
+--------
+More information about crypto-tools and the Open Infrastructure project can be found on the homepage at http://open-infrastructure.net.
+
+
+BUGS
+----
+Bugs can be reported by opening an issue in the GitHub repository at http://github.com/open-infrastructure/crypto-tools.
+
+
+AUTHORS
+-------
+crypto-tools was written by Daniel Baumann <daniel.baumann@open-infrastructure.net>.
diff --git a/share/man/crypto-tools.7.txt b/share/man/crypto-tools.7.txt
new file mode 100644
index 0000000..b97d977
--- /dev/null
+++ b/share/man/crypto-tools.7.txt
@@ -0,0 +1,60 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+CRYPTO-TOOLS(7)
+===============
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+crypto-tools - FIXME
+
+
+DESCRIPTION
+-----------
+"Cryptography [...] is the practice and study of techniques for secure
+communication in the presence of third parties [...]."
+ -- Wikipedia (https://en.wikipedia.org/wiki/Cryptography)
+
+crypto-tools implements secure deployment of initial cryptographic assets to bootstrap systems using OpenSSH and DNSSEC.
+
+
+DOWNLOAD
+--------
+
+ * https://github.com/open-infrastructure/crypto-tools
+
+
+USAGE
+-----
+
+FIXME.
+
+
+LINKS
+-----
+
+FIXME.
+
+
+AUTHORS
+-------
+
+ * Daniel Baumann <daniel.baumann@open-infrastructure.net>
diff --git a/share/man/crypto.1.txt b/share/man/crypto.1.txt
new file mode 100644
index 0000000..18a8fb2
--- /dev/null
+++ b/share/man/crypto.1.txt
@@ -0,0 +1,86 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+CRYPTO(1)
+=========
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+crypto - FIXME
+
+
+SYNOPSIS
+--------
+*crypto* 'COMMAND' ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+crypto-tools implements secure deployment of initial cryptographic assets to bootstrap systems using OpenSSH and DNSSEC.
+
+
+OPTIONS
+-------
+The following crypto common options are available:
+
+FIXME.
+
+
+COMMANDS
+--------
+The following crypto commands are available:
+
+*ssh-hostkey*::
+ Manage OpenSSH host keys, see crypto-ssh-hostkey(1).
+
+
+FILES
+-----
+The following files are used:
+
+*/etc/crypto-tools*::
+ Crypto configuration files.
+
+*/usr/bin/crypto*, */usr/bin/cnt*::
+ Crypto program.
+
+*/usr/lib/crypto-tools*::
+ Crypto commands.
+
+
+SEE ALSO
+--------
+ssh(1),
+
+
+HOMEPAGE
+--------
+More information about crypto-tools and the Open Infrastructure project can be found on the homepage at http://open-infrastructure.net.
+
+
+BUGS
+----
+Bugs can be reported by opening an issue in the GitHub repository at http://github.com/open-infrastructure/crypto-tools.
+
+
+AUTHORS
+-------
+crypto-tools was written by Daniel Baumann <daniel.baumann@open-infrastructure.net>.
diff --git a/share/man/ssh-ca-config.1.txt b/share/man/ssh-ca-config.1.txt
new file mode 100644
index 0000000..646165c
--- /dev/null
+++ b/share/man/ssh-ca-config.1.txt
@@ -0,0 +1,59 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-CONFIG(1)
+================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-config - Get or set configuration items for crypto-tools
+
+
+SYNOPSIS
+--------
+*ssh-ca config* 'OPTION'[='VALUE']
+
+
+OPTIONS
+-------
+The following configuration options are available:
+
+*--server-address* | *--server-address*='ADDRESS'::
+ Hostname of server
+
+*--server-fqdn* | *--server-fqdn*='DOMAINNAME'::
+ FQDN domain name of server
+
+*--server-name* | *--server-name*='HOSTNAME'::
+ Hostname of server
+
+*--user* | *--user*='USERNAME'::
+ Username for ssh connections
+
+
+
+EXAMPLES
+--------
+*Get user name:*::
+ ssh-ca config --user
+
+*Set user name to 'foobar':*::
+ ssh-ca config --user=foobar
diff --git a/share/man/ssh-ca-init.1.txt b/share/man/ssh-ca-init.1.txt
new file mode 100644
index 0000000..e5b41af
--- /dev/null
+++ b/share/man/ssh-ca-init.1.txt
@@ -0,0 +1,54 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-INIT(1)
+==============
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-init - Interactive configuration of ssh-ca server or client
+
+
+SYNOPSIS
+--------
+*ssh-ca init* --server|--client
+
+
+OPTIONS
+-------
+The following common options are available:
+
+This command goes step by step trough essential configuration items. See more in *ssh-ca-config(1)* man page for a detailed description of all possible *ssh-ca(1)* configuration items.
+
+*-s, --server*::
+ Prepares host for a server Setup.
+
+*-c, --client*::
+ Prepares host for a client Setup.
+
+
+EXAMPLES
+--------
+*Initialize the configuration on a ssh-ca client:*::
+»·······ssh-ca init --client
+
+*Initialize the configuration on a ssh-ca server:*::
+»·······ssh-ca init --server
diff --git a/share/man/ssh-ca-install.1.txt b/share/man/ssh-ca-install.1.txt
new file mode 100644
index 0000000..23f4152
--- /dev/null
+++ b/share/man/ssh-ca-install.1.txt
@@ -0,0 +1,46 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-INSTALL(1)
+=================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-install - Install previously deployed keys
+
+
+SYNOPSIS
+--------
+*ssh-ca install* ['OPTIONS']
+
+
+CONFIGURATION
+-------------
+
+*ssh-ca install* can be configured trough options and configuration file. See *ssh-ca-init(1)* for a initial setup of your configuration files. Command options have a higher priority than configuration parameters.
+
+
+OPTIONS
+-------
+The following install options are available:
+
+*-u, --user='USERNAME'*::
+ Local user wich has the previously deployed keys in home directory.
diff --git a/share/man/ssh-ca-pull.1.txt b/share/man/ssh-ca-pull.1.txt
new file mode 100644
index 0000000..c3f46b9
--- /dev/null
+++ b/share/man/ssh-ca-pull.1.txt
@@ -0,0 +1,52 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-PULL(1)
+==============
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-pull - Request signed host keys from a ssh-ca server
+
+
+SYNOPSIS
+--------
+*ssh-ca pull* ['OPTIONS']
+
+
+CONFIGURATION
+-------------
+
+*ssh-ca pull* can be configured trough options and configuration files. See *ssh-ca-init(1)* for a initial setup of your configuration files. Command options have a higher priority than configuration parameters.
+
+
+OPTIONS
+-------
+The following pull options are available:
+
+*-s, --server-address='ADDRESS'*::
+ Specify the crypto server to connect to. An IP or DNS name entry can be used.
+
+*-k, --server-key='PATH'*::
+ Private ssh key wich is used to connect to crypto server.
+
+*-u, --user='USERNAME'*::
+ User for ssh connection on crypto server.
diff --git a/share/man/ssh-ca-push.1.txt b/share/man/ssh-ca-push.1.txt
new file mode 100644
index 0000000..a4d4cdc
--- /dev/null
+++ b/share/man/ssh-ca-push.1.txt
@@ -0,0 +1,49 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-PUSH(1)
+==============
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-push - Deploy signed host keys on a requesting client host
+
+
+SYNOPSIS
+--------
+*ssh-ca push* ['OPTIONS']
+
+
+CONFIGURATION
+-------------
+
+*ssh-ca push* can be configured trough options and configuration files. See *ssh-ca-init(1)* for a initial setup of your configuration files. Command options have a higher priority than configuration parameters.
+
+
+OPTIONS
+-------
+The following push options are available:
+
+*-h, --host='ADDRESS'*::
+ Specify the crypto client to deploy to. An IP or DNS name entry can be used.
+
+*-u, --user='USERNAME'*::
+ User for ssh connection on crypto server.
diff --git a/share/man/ssh-ca-trigger.1.txt b/share/man/ssh-ca-trigger.1.txt
new file mode 100644
index 0000000..30ef4e8
--- /dev/null
+++ b/share/man/ssh-ca-trigger.1.txt
@@ -0,0 +1,42 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA-TRIGGER(1)
+=================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca-trigger - Executed by a ssh trigger after a client host requested new host keys
+
+
+SYNOPSIS
+--------
+*ssh-ca trigger*
+
+
+DESCRIPTION
+-----------
+*ssh-ca trigger* has to be used by a ssh trigger only. The trigger is called from a previously *ssh-ca pull* request from a client.
+
+
+OPTIONS
+-------
+This command has no options.
diff --git a/share/man/ssh-ca.1.txt b/share/man/ssh-ca.1.txt
new file mode 100644
index 0000000..bdcafc6
--- /dev/null
+++ b/share/man/ssh-ca.1.txt
@@ -0,0 +1,66 @@
+// Open Infrastructure: crypto-tools
+// Copyright (C) 2015 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+SSH-CA(1)
+=========
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: crypto-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ssh-ca - Request and deploy ca signed ssh host keys
+
+
+SYNOPSIS
+--------
+*ssh-ca* 'command' ['OPTIONS']
+
+
+CONFIGURATION
+-------------
+
+*ssh-ca* can be configured through command parameters and configuration files. See *ssh-ca-init(1)* for a initial setup of your configuration. Individual configuration changes can be made with *ssh-ca-config(1)*. Command options have a higher priority than configuration files.
+
+
+OPTIONS
+-------
+See individual command man pages for options.
+
+
+COMMANDS
+--------
+The following commands are available:
+
+*config*::
+ Get or set configuration items.
+
+*init*::
+ Interactive configuration of ssh-ca server or client.
+
+*install*::
+ Install previously deployed keys.
+
+*pull*::
+ Request signed host keys from a ssh-ca server.
+
+*push*::
+ Deploy signed host keys on a client host.
+
+*trigger*::
+ Executed by a ssh trigger after a client host requested new host keys.