Smokeping_probes_passwordchecker(3)

1Smokeping_probes_passwordchecker(3)SmokePingSmokeping_probes_passwordchecker(3)
2
3
4

NAME

6       Smokeping::probes::passwordchecker - A Base Class for implementing
7       SmokePing Probes
8

OVERVIEW

10       Like Smokeping::probes::basefork, but supports a probe-specific
11       configuration file for storing passwords and a method for accessing
12       them.
13

SYNOPSIS

15        *** Probes ***
16
17        +passwordchecker
18
19        forks = 5
20        offset = 50%
21        passwordfile = /some/place/secret
22        step = 300
23        timeout = 15
24
25        # The following variables can be overridden in each target section
26        /^influx_.+/ = influx_location = In the basement
27        pings = 5
28
29        # [...]
30
31        *** Targets ***
32
33        probe = passwordchecker # if this should be the default probe
34
35        # [...]
36
37        + mytarget
38        # probe = passwordchecker # if the default probe is something else
39        host = my.host
40        /^influx_.+/ = influx_location = In the basement
41        pings = 5
42

DESCRIPTION

44   synopsis with more detail
45       SmokePing main configuration file:
46
47        *** Probes ***
48        + MyPasswordChecker
49        # location of the file containing usernames and passwords
50        passwordfile = /usr/share/smokeping/etc/passwords
51
52       The specified password file:
53
54        # host:username:password
55        host1:joe:hardlyasecret
56         # comments and whitespace lines are allowed
57
58        host2:sue:notasecreteither
59
60   Actual description
61       In implementing authentication probes, it might not be desirable to
62       store the necessary cleartext passwords in the SmokePing main
63       configuration file, since the latter must be readable both by the
64       SmokePing daemon performing the probes and the CGI that displays the
65       results. If the passwords are stored in a different file, this file can
66       be made readable by only the user the daemon runs as. This way we can
67       be sure that nobody can trick the CGI into displaying the passwords on
68       the Web.
69
70       This module reads the passwords in at startup from the file specified
71       in the probe-specific variable `passwordfile'. The passwords can later
72       be accessed and modified by the password method, that needs the
73       corresponding host and username as arguments.
74
75   Password file format
76       The password file format is simply one line for each triplet of host,
77       username and password, separated from each other by colons (:).
78
79       Comment lines, starting with the `#' sign, are ignored, as well as
80       empty lines.
81

VARIABLES

83       Supported probe-specific variables:
84
85       forks
86           Run this many concurrent processes at maximum
87
88           Example value: 5
89
90           Default value: 5
91
92       offset
93           If you run many probes concurrently you may want to prevent them
94           from hitting your network all at the same time. Using the probe-
95           specific offset parameter you can change the point in time when
96           each probe will be run. Offset is specified in % of total interval,
97           or alternatively as 'random', and the offset from the 'General'
98           section is used if nothing is specified here. Note that this does
99           NOT influence the rrds itself, it is just a matter of when data
100           acquisition is initiated.  (This variable is only applicable if the
101           variable 'concurrentprobes' is set in the 'General' section.)
102
103           Example value: 50%
104
105       passwordfile
106           Location of the file containing usernames and passwords.
107
108           Example value: /some/place/secret
109
110       step
111           Duration of the base interval that this probe should use, if
112           different from the one specified in the 'Database' section. Note
113           that the step in the RRD files is fixed when they are originally
114           generated, and if you change the step parameter afterwards, you'll
115           have to delete the old RRD files or somehow convert them. (This
116           variable is only applicable if the variable 'concurrentprobes' is
117           set in the 'General' section.)
118
119           Example value: 300
120
121       timeout
122           How long a single 'ping' takes at maximum
123
124           Example value: 15
125
126           Default value: 5
127
128       Supported target-specific variables:
129
130       /^influx_.+/
131           This is a tag that will be sent to influxdb and has no impact on
132           the probe measurement. The tag name will be sent without the
133           "influx_" prefix, which will be replaced with "tag_" instead. Tags
134           can be used for filtering.
135
136           Example value: influx_location = In the basement
137
138       pings
139           How many pings should be sent to each target, if different from the
140           global value specified in the Database section. Note that the
141           number of pings in the RRD files is fixed when they are originally
142           generated, and if you change this parameter afterwards, you'll have
143           to delete the old RRD files or somehow convert them.
144
145           Example value: 5
146

AUTHORS

148       Niko Tyni <ntyni@iki.fi>
149

BUGS

151       The need for storing cleartext passwords can be considered a bug in
152       itself.
153