path: root/contrib
diff options
authorkpfleming <kpfleming@f38db490-d61c-443f-a65b-d21fe96a405b>2005-06-24 03:02:55 +0000
committerkpfleming <kpfleming@f38db490-d61c-443f-a65b-d21fe96a405b>2005-06-24 03:02:55 +0000
commit2b300ae23960287f26e3d8c3a9b652b3c6de4991 (patch)
tree0acf5cae1f07cd687d2cd8dc65b2e483d4d7615c /contrib
parent4fc21f5b06c1fbc3302e23989742a3913da8a79e (diff)
add man pages (bug #4515)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@5999 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'contrib')
1 files changed, 129 insertions, 0 deletions
diff --git a/contrib/scripts/astgenkey.8 b/contrib/scripts/astgenkey.8
new file mode 100755
index 000000000..6dc793eb1
--- /dev/null
+++ b/contrib/scripts/astgenkey.8
@@ -0,0 +1,129 @@
+.\" $Header$
+.\" transcript compatibility for postscript use.
+.\" synopsis: .P! <file.ps>
+.de P!
+\!!1 setgray
+\!!0 setgray
+.fl \" force out current output buffer
+\!!save /psv exch def currentpoint translate 0 0 moveto
+.fl \" prolog
+.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
+\!!psv restore
+.de pF
+.ie \\*(f1 .ds f1 \\n(.f
+.el .ie \\*(f2 .ds f2 \\n(.f
+.el .ie \\*(f3 .ds f3 \\n(.f
+.el .ie \\*(f4 .ds f4 \\n(.f
+.el .tm ? font overflow
+.ft \\$1
+.de fP
+.ie !\\*(f4 \{\
+. ft \\*(f4
+. ds f4\"
+' br \}
+.el .ie !\\*(f3 \{\
+. ft \\*(f3
+. ds f3\"
+' br \}
+.el .ie !\\*(f2 \{\
+. ft \\*(f2
+. ds f2\"
+' br \}
+.el .ie !\\*(f1 \{\
+. ft \\*(f1
+. ds f1\"
+' br \}
+.el .tm ? font underflow
+.ds f1\"
+.ds f2\"
+.ds f3\"
+.ds f4\"
+'\" t
+.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
+.TH ASTGENKEY 8 "May 14th, 2005" "Asterisk" "Linux Programmer's Manual"
+.B astgenkey
+-- generates keys for for Asterisk IAX2 RSA authentication
+.B astgenkey
+[ -q ] [ -n ] [ \fIkeyname\fP ]
+.B genzaptelconf
+This script generates an RSA private and public key pair in PEM format
+for use by Asterisk. The private key should be kept a secret, as it can
+be used to fake your system's identity. Thus by default (without the
+.I -n
+) the script will create a passphrase-encrypted copy of your secret key:
+without entering the passphrase you won't be able to use it.
+However if you want to use such a key with Asterisk, you'll have to start
+it interactively, because the scripts that start asterisk can't use that
+encrypted key.
+The key is identified by a name. If you don't write the name on the
+command-line you'll be prompted for one. The outputs of the script are:
+.I name\fB.pub
+The public key: not secret. Send this to the other side.
+.I name\fB.key
+The private key: secret.
+Those files should be copied to
+.I /var/lib/asterisk/keys
+(The private key: on your system. The public key: on other systems)
+To see the currently-installed keys from the asterisk CLI, use the command
+show keys
+.B -q
+Run quietly.
+.B -n
+Don't encrypt the private key.
+.I /var/lib/asterisk/keys
+asterisk(8), genrsa(1), rsa(1),
+This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com>
+Permission is granted to copy, distribute and/or modify this document under
+the terms of the GNU General Public License, Version 2 any
+later version published by the Free Software Foundation.
+On Debian systems, the complete text of the GNU General Public
+License can be found in /usr/share/common-licenses/GPL.