* Added error checking (suggested from Sven Mueller)
[manu/sslexpire.git] / sslexpire / README
1 This tool provides remote check for ssl certificate expiration date.
2 It connects to hosts:port, retrieve the expiration date and show you if it's
3 going to expire or if it's expired, regarding the alert parameter (how many
4 days before to alert)
5
6 It is released under the GNU GPL (see copyright for more details).
7
8 Requirements:
9 ------------
10 You need to have perl installed with at least the following modules:
11
12 IO::Socket
13 Net::SSLeay
14 Getopt::Long
15 Date::Parse
16
17 You also need the following commands:
18
19 - openssl
20 - sendmail
21 (see the beginning of the script for command paths customization)
22
23 Installation:
24 ------------
25
26 Put sslexpire in your PATH (/usr/local/bin for example).
27 The default location for the configuration file is /etc/sslexpire/sslexpire.conf.
28
29 You can install a manpage by running:
30
31 pod2man --section=1 /path/to/sslexpire | gzip -c > /usr/share/man/man1/sslexpire.1.gz
32
33 Usage:
34 -----
35
36 Just run "sslexpire --help" to get command options and have a look at
37 "/etc/sslexpire/sslexpire.conf" to understand config file options.
38
39 If you wan't to check automatically hosts specified in config file, put a line
40 like this in your /etc/crontab:
41
42 # This will check all hosts in sslexpire config file evry day at 01h01 and send
43 # mail if the expiration date is going to be expired.
44 #
45 1 1  * * * nobody [ -x /usr/bin/sslexpire ] && sslexpire -m
46
47
48 I suggest that you run your cron as a non-privileged user like the nobody user
49 used above (root isn't necessary so...).