[Asterisk-cvs] asterisk/contrib/scripts astgenkey.8, NONE, 1.1.2.1 autosupport.8, NONE, 1.1.2.1 safe_asterisk.8, NONE, 1.1.2.1

Wed Jul 6 18:22:01 CDT 2005

Update of /usr/cvsroot/asterisk/contrib/scripts
In directory localhost.localdomain:/tmp/cvs-serv9848/contrib/scripts

Added Files:
      Tag: v1-0
	astgenkey.8 autosupport.8 safe_asterisk.8 
Log Message:
add man pages for astgenkey, autosupport, and safe_asterisk (bug #4645)

--- NEW FILE: astgenkey.8 ---
.\" $Header: /usr/cvsroot/asterisk/contrib/scripts/astgenkey.8,v 1.1.2.1 2005/07/06 22:30:44 russell Exp $
.\"
.\"	transcript compatibility for postscript use.
.\"
.\"	synopsis:  .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.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"
.SH NAME
.B astgenkey
-- generates keys for for Asterisk IAX2 RSA authentication
.SH SYNOPSIS
.PP 
.B astgenkey
[ -q ] [ -n ] [ \fIkeyname\fP ]

.SH DESCRIPTION
.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 
option 
.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
.RS
The public key: not secret. Send this to the other side.
.RE

.I name\fB.key
.RS
The private key: secret.
.RE

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

.RS
show keys
.RE

.SH OPTIONS
.B -q
.RS
Run quietly.
.RE

.B -n
.RS
Don't encrypt the private key.
.RE

.SH FILES
.I /var/lib/asterisk/keys
.RS
.RE

.SH "SEE ALSO" 
asterisk(8), genrsa(1), rsa(1), 

http://www.voip-info.org/wiki-Asterisk+iax+rsa+auth

.SH "AUTHOR" 
This manual page was written by Tzafrir Cohen <tzafrir.cohen at 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. 

--- NEW FILE: autosupport.8 ---
.TH AUTOSUPPORT 8 "Jul 5th, 2005" "Asterisk" "Linux Programmer's Manual"
.SH NAME
.B autosupport
\(em interactive script to provide Digium[tm]'s support with information
.SH SYNOPSIS
.PP 
.B autosupport

.SH DESCRIPTION
.B autoasupport
is a script that is normally run by a user contacting Digium's support 
to automate gathering support information.

It will probe the system for some configuration and run-time information, 
and will also prompt the user for some optional access information (IP 
address, login and password).

The information is written to /root/digiuminfo which the user is expected 
to attach to a support ticket to Digium.

The script must be run as root as it reads Asterisk's configuration and 
the disk information using hdparm(8).

.SH FILES
.B /root/digiuminfo
.RS
The output of the script goes there
.RE

.SH SEE ALSO
asterisk(8)

.SH "AUTHOR" 
autosupport was written by John Bigelow <support at digium.com>.
This manual page was written by Tzafrir Cohen <tzafrir.cohen at 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. 

--- NEW FILE: safe_asterisk.8 ---
.TH SAFE_ASTERISK 8 "Jun 30th, 2005" "Asterisk" "Linux Programmer's Manual"
.SH NAME
.B safe_asterisk
\(em A wrapper to run the asterisk executable in a loop
.SH SYNOPSIS
.PP 
.B safe_asterisk
.I [ asterisk_params ]

.SH DESCRIPTION
.B safe_asterisk 
is a script that runs asterisk in a loop, which can be useful if you 
fear asterisk may crash.

The script does not run in the background like a standard service. Rather, 
it runs in its own linux virtual console (9, by default).
It also uses the option '-c' of asterisk(8) to avoid detaching asterisk 
from that terminal.

safe_asterisk also runs asterisk with unlimited core file size, and thus 
asterisk will dump core in case of a crash.

To get a "picture" of console 9, from another terminal (e.g: from a 
remote shell session) you can use:

  screendump 9

The init script of the Debian package should be able to run safe_asterisk 
as the asterisk service, if so configured. See coments in 
/etc/default/asterisk

.SH FILES
.B /tmp
.RS
safe_asterisk runs in that directory, rather than in / as usual.
.RE

.B /tmp/core
.RS
If core files were generated there, they may be 
.RE

.SH BUGS
While showing the output on a console is useful, using screen(1) as 
the terminal may be better.

The script does not read configuration from standard location under /etc

It uses fixed locations under /tmp , and thus may be exposed to a 
symlink attacks.

.SH SEE ALSO
asterisk(8), screendump(9)

.SH "AUTHOR" 
This manual page was written by Tzafrir Cohen <tzafrir.cohen at 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. 