.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "doc::Smokeping::probes::passwordchecker 3"
.TH doc::Smokeping::probes::passwordchecker 3 "2008-07-24" "2.4.2" "SmokePing"
.SH "NAME"
Smokeping::probes::passwordchecker \- A Base Class for implementing SmokePing Probes
.SH "OVERVIEW"
.IX Header "OVERVIEW"
Like Smokeping::probes::basefork, but supports a probe-specific configuration file
for storing passwords and a method for accessing them.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
.Ve
.PP
.Vb 1
\& +passwordchecker
.Ve
.PP
.Vb 5
\& forks = 5
\& offset = 50%
\& passwordfile = /some/place/secret
\& step = 300
\& timeout = 15
.Ve
.PP
.Vb 2
\& # The following variables can be overridden in each target section
\& pings = 5
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 1
\& *** Targets ***
.Ve
.PP
.Vb 1
\& probe = passwordchecker # if this should be the default probe
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 4
\& + mytarget
\& # probe = passwordchecker # if the default probe is something else
\& host = my.host
\& pings = 5
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Sh "synopsis with more detail"
.IX Subsection "synopsis with more detail"
SmokePing main configuration file:
.PP
.Vb 4
\& *** Probes ***
\& + MyPasswordChecker
\& # location of the file containing usernames and passwords
\& passwordfile = /usr/share/smokeping/etc/passwords
.Ve
.PP
The specified password file:
.PP
.Vb 3
\& # host:username:password
\& host1:joe:hardlyasecret
\&  # comments and whitespace lines are allowed
.Ve
.PP
.Vb 1
\& host2:sue:notasecreteither
.Ve
.Sh "Actual description"
.IX Subsection "Actual description"
In implementing authentication probes, it might not be desirable to store
the necessary cleartext passwords in the SmokePing main configuration
file, since the latter must be readable both by the SmokePing daemon
performing the probes and the \s-1CGI\s0 that displays the results. If the
passwords are stored in a different file, this file can be made readable
by only the user the daemon runs as. This way we can be sure that nobody
can trick the \s-1CGI\s0 into displaying the passwords on the Web.
.PP
This module reads the passwords in at startup from the file specified
in the probe-specific variable `passwordfile'. The passwords can later
be accessed and modified by the \fBpassword\fR method, that needs the corresponding
host and username as arguments.
.Sh "Password file format"
.IX Subsection "Password file format"
The password file format is simply one line for each triplet of host,
username and password, separated from each other by colons (:).
.PP
Comment lines, starting with the `#' sign, are ignored, as well as
empty lines.
.SH "VARIABLES"
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP "forks" 4
.IX Item "forks"
Run this many concurrent processes at maximum
.Sp
Example value: 5
.Sp
Default value: 5
.IP "offset" 4
.IX Item "offset"
If you run many probes concurrently you may want to prevent them from
hitting your network all at the same time. Using the probe-specific
offset parameter you can change the point in time when each probe will
be run. Offset is specified in % of total interval, or alternatively as
\&'random', and the offset from the 'General' section is used if nothing
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
it is just a matter of when data acqusition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)
.Sp
Example value: 50%
.IP "passwordfile" 4
.IX Item "passwordfile"
Location of the file containing usernames and passwords.
.Sp
Example value: /some/place/secret
.IP "step" 4
.IX Item "step"
Duration of the base interval that this probe should use, if different
from the one specified in the 'Database' section. Note that the step in
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)
.Sp
Example value: 300
.IP "timeout" 4
.IX Item "timeout"
How long a single 'ping' takes at maximum
.Sp
Example value: 15
.Sp
Default value: 5
.PP
Supported target-specific variables:
.IP "pings" 4
.IX Item "pings"
How many pings should be sent to each target, if different from the global
value specified in the Database section. Note that the number of pings in
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them.
.Sp
Example value: 5
.SH "AUTHORS"
.IX Header "AUTHORS"
Niko Tyni <ntyni@iki.fi>
.SH "BUGS"
.IX Header "BUGS"
The need for storing cleartext passwords can be considered a bug in itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Smokeping::probes::basefork, Smokeping::probes::Radius, Smokeping::probes::LDAP