From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tim FitzGeorge To: development@lists.ipfire.org Subject: [PATCH 04/12] statusmail: Supporting files Date: Fri, 05 Apr 2019 18:29:32 +0100 Message-ID: <20190405172940.13168-5-ipfr@tfitzgeorge.me.uk> In-Reply-To: <20190405172940.13168-1-ipfr@tfitzgeorge.me.uk> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============1717225976360733961==" List-Id: --===============1717225976360733961== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable generate_signature.sh Generate a PGP key pair for signing emails stylesheet.css Stylesheet for HTML format emails test_plugin.pl Aid for testing plugins statusmail.sh Simple shell script for running statusmail.pl statusmailctrl.c Add/Remove statusmail from fcron.hourly Signed-off-by: Tim FitzGeorge --- src/misc-progs/statusmailctrl.c | 36 +++ src/statusmail/generate_signature.sh | 51 ++++ src/statusmail/statusmail.sh | 3 + src/statusmail/stylesheet.css | 30 ++ src/statusmail/test_plugin.pl | 541 +++++++++++++++++++++++++++++++++= ++ 5 files changed, 661 insertions(+) create mode 100644 src/misc-progs/statusmailctrl.c create mode 100755 src/statusmail/generate_signature.sh create mode 100755 src/statusmail/statusmail.sh create mode 100755 src/statusmail/stylesheet.css create mode 100755 src/statusmail/test_plugin.pl diff --git a/src/misc-progs/statusmailctrl.c b/src/misc-progs/statusmailctrl.c new file mode 100644 index 000000000..828aaf223 --- /dev/null +++ b/src/misc-progs/statusmailctrl.c @@ -0,0 +1,36 @@ +/* This file is part of the IPFire Firewall. + * + * This program is distributed under the terms of the GNU General Public + * Licence. See the file COPYING for details. + * + */ + +#include +#include +#include +#include +#include +#include +#include "setuid.h" + +int main(int argc, char *argv[]) { + + if (!(initsetuid())) + exit(1); + + if (argc < 2) { + fprintf(stderr, "\nNo argument given.\n\nstatusmailctrl (enable|disable)\n= \n"); + exit(1); + } + + if (strcmp(argv[1], "enable") =3D=3D 0) { + safe_system("ln -fs /usr/lib/statusmail/statusmail.sh /etc/fcron.hourly/st= atusmail >/dev/null 2>&1"); + } else if (strcmp(argv[1], "disable") =3D=3D 0) { + safe_system("rm -f /etc/fcron.hourly/statusmail >/dev/null 2>&1"); + } else { + fprintf(stderr, "\nBad argument given.\n\nstatusmailctrl (enable|disable)\= n\n"); + exit(1); + } + + return 0; +} diff --git a/src/statusmail/generate_signature.sh b/src/statusmail/generate_s= ignature.sh new file mode 100755 index 000000000..267d6a302 --- /dev/null +++ b/src/statusmail/generate_signature.sh @@ -0,0 +1,51 @@ +#!/bin/sh + +############################################################################ +# # +# Send log and status emails for IPFire # +# # +# This is free software; you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation; either version 3 of the License, or # +# (at your option) any later version. # +# # +# This is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with IPFire; if not, write to the Free Software # +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # +# # +# Copyright (C) 2018 - 2019 The IPFire Team # +# # +############################################################################ +# Generates a PGP key that is used to sign email messages # +############################################################################ + +source /var/ipfire/dma/mail.conf + +# Find the old key if there is one so we can delete it later + +OLDKEY=3D`gpg --homedir /var/ipfire/statusmail/keys --with-colons --fingerpr= int --list-keys IPFire | sed -ne '/^fpr/{s/fpr//;s/://g;p}'` 2>/dev/null + +echo Generate new keys + +/usr/bin/gpg --homedir /var/ipfire/statusmail/keys --batch --gen-key < $format, stylesheet =3D> $st= ylesheet, subject =3D> 'Test email' ); + +get_period ( $message ); + +$message->{'max_lines_per_item'} =3D integer( 'Maximum lines per item', 1, 1= 000 ); + +# Loop through the various items + +foreach my $section ( sort keys %items ) +{ + $message->add_section( $section ); + + foreach my $subsection ( sort keys %{ $items{$section} } ) + { + $message->add_subsection( $subsection ); + + foreach my $item ( sort keys %{ $items{$section}{$subsection} } ) + { + next unless ($items{$section}{$subsection}{$item}{'format'} eq 'both' = or + $items{$section}{$subsection}{$item}{'format'} eq $format= ); + + if (yesno( "Add item $section : $subsection : $item ? " )) + { + $message->add_title( $item ); + + my $function =3D $items{$section}{$subsection}{$item}{'function'}; + + if (exists $items{$section}{$subsection}{$item}{'option'}) + { + if ($items{$section}{$subsection}{$item}{'option'}{'type'} eq 'sel= ect') + { + my $option =3D choices( $items{$section}{$subsection}{$item}{'op= tion'}{'name'}, + @{$items{$section}{$subsection}{$item}{'op= tion'}{'values'} } ); + + &$function( $message, $option ); + } + else + { + my $value =3D integer( $items{$section}{$subsection}{$item}{'opt= ion'}{'name'}, + $items{$section}{$subsection}{$item}{'optio= n'}{'min'}, + $items{$section}{$subsection}{$item}{'optio= n'}{'max'} ); + + &$function( $message, $value ); + } + } + else + { + &$function( $message ); + } + } + } + } +} + +$message->print( $testdir ); + +exit; + + +#---------------------------------------------------------------------------= --- +# sub choices( text, options ) +# +# Asks the user for an option from the provided list. +# +# Parameters: +# text the question to ask the user +# options list of options +# +# Returns: +# the selected option +#---------------------------------------------------------------------------= --- + +sub choices( $@ ) +{ + my ($text, @options) =3D @_; + + my $selection =3D ''; + my %options; + my @display; + + foreach my $option (@options) + { + my ($name, $value) =3D split /:/, $option; + + $value ||=3D $name; + + $options{$name} =3D $value; + push @display, $name; + } + + while (not $selection) + { + print "Select $text from the following options: " . join( ', ', @display= ) . ": "; + + my $line =3D ; + + chomp $line; + + ($selection) =3D grep /^$line/i, @display; + } + + return $options{$selection}; +} + + +#---------------------------------------------------------------------------= --- +# sub yesno( text ) +# +# Asks the user for a yes or no option. +# +# Parameters: +# text the question to ask the user +# +# Returns: +# true for yes, false for no +#---------------------------------------------------------------------------= --- + +sub yesno( $) +{ + my ($text) =3D @_; + + my $selection =3D ''; + + while (not $selection) + { + print "$text"; + + my $line =3D ; + + chomp $line; + + ($selection) =3D grep /$line/i, ( 'yes', 'no' ); + } + + return $selection eq 'yes'; +} + + +#---------------------------------------------------------------------------= --- +# sub integer( text, min, max ) +# +# Asks the user for an integer within the specified limits. +# +# Parameters: +# text the question to ask the user +# min minimum value of input +# max maximum value of input +# +# Returns: +# the selected value +#---------------------------------------------------------------------------= --- + +sub integer( $$$ ) +{ + my ($text, $min, $max) =3D @_; + + my $value; + + while (not defined $value) + { + print "Select $text ($min..$max):"; + + my $line =3D ; + + chomp $line; + + next if ($line =3D~ m/\D+/); + next unless ($line =3D~ m/\d/); + next if ($line < $min); + next if ($line > $max); + + $value =3D $line; + } + + return $value; +} + + +#---------------------------------------------------------------------------= --- +# sub add_mail_item( params ) +# +# Adds a possible status item to the section and subsection specified. +# +# Parameters: +# params hash containing details of the item to be added: +# section name of the section containing this item +# subsection name of the subsection containing this item +# item name of the item +# function function called to add item to message +# format available formats for the item 'html', 'text' or 'both' +# option hash specifying option parameter (optional) +# +# option can specify either a selection or an integer. For a selection it +# contains: +# type must be 'option' +# values array of strings representing the possible options +# +# For an integer option contains: +# type must be 'integer' +# min minimum valid value of parameter +# max maximum valid value of parameter +#---------------------------------------------------------------------------= --- + +sub add_mail_item( @ ) +{ + my %params =3D @_; + + if (not exists $params{'section'}) + { + print "Plugin $plugin has no section specified\n"; + return; + } + + if (not exists $params{'subsection'}) + { + print "Plugin $plugin has no subsection specified\n"; + return; + } + + if (not exists $params{'item'}) + { + print "Plugin $plugin has no item specified\n"; + return; + } + + if (not exists $params{'function'}) + { + print "Plugin $plugin has no function specified\n"; + return; + } + + if ($params{'option'}) + { + unless (ref $params{'option'} eq 'HASH') + { + print "Plugin $plugin option incorrectly specified - should be hash\n"; + } + + unless ($params{'option'}{'type'}) + { + print "Plugin $plugin has no option type specified\n"; + return; + } + + unless ($params{'option'}{'name'}) + { + print "Plugin $plugin has no option name specified\n"; + return; + } + + if ($params{'option'}{'type'} eq 'select') + { + unless (ref $params{'option'}{'values'} eq 'ARRAY' and @{ $params{'opt= ion'}{'values'} } > 1) + { + print "Plugin $plugin select option values incorrectly specified\n"; + return; + } + } + elsif ($params{'option'}{'type'} eq 'integer') + { + unless (exists $params{'option'}{'min'} and exists $params{'option'}{'= max'} and $params{'option'}{'min'} < $params{'option'}{'max'}) + { + print "Plugin $plugin integer option limits not correctly specified\= n"; + print "No minimum value specified\n" unless (exists $params{'o= ption'}{'min'}); + print "No maximum value specified\n" unless (exists $params{'o= ption'}{'max'}); + print "Maximum not greater than minimum\n" unless (exists $params{'o= ption'}{'min'} and + exists $params{'o= ption'}{'min'} and + $params{'option'}= {'min'} < $params{'option'}{'max'}); + } + } + else + { + print "Plugin $plugin has invalid option $params{'option'}{'type'}\n"; + return; + } + } + + if ($params{'format'} and $params{'format'} ne 'html' and $params{'format'= } ne 'text' and $params{'format'} ne 'both') + { + print "Plugin $plugin has invalid format\n"; + } + + $params{'format'} =3D 'both' unless (exists $params{'format'}); + + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}} =3D { '= function' =3D> $params{'function'}, + 'fo= rmat' =3D> $params{'format'} }; + + if ($params{'option'}) + { + if ($params{'option'}{'type'} eq 'select') + { + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'type'} =3D $params{'option'}{'type'}; + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'values'} =3D $params{'option'}{'values'}; + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'name'} =3D $params{'option'}{'name'}; + } + elsif ($params{'option'}{'type'} eq 'integer') + { + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'type'} =3D $params{'option'}{'type'}; + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'min'} =3D $params{'option'}{'min'}; + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'max'} =3D $params{'option'}{'max'}; + $items{$params{'section'}}{$params{'subsection'}}{$params{'item'}}{'op= tion'}{'name'} =3D $params{'option'}{'name'}; + } + } +} + + +#---------------------------------------------------------------------------= --- +# sub get_period +# +# Gets the period covered by a report +#---------------------------------------------------------------------------= --- + +sub get_period +{ + my $self =3D shift; + + my @monthnames =3D ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug'= , 'Sep', 'Oct', 'Nov', 'Dec' ); + + my $unit =3D choices( 'Period covered by report', 'hours', 'days', 'weeks= ', 'months' ); + my $value =3D integer( "$unit covered by report", 1, 365 ); + + $self->calculate_period( $value, $unit ); +} + +#---------------------------------------------------------------------------= --- +#---------------------------------------------------------------------------= --- +# Package TestStatusMail +# +# This package is used to override some of the functionality of the StatusMa= il +# and EncryptedMail packages. +#---------------------------------------------------------------------------= --- +#---------------------------------------------------------------------------= --- + + +package TestStatusMail; + +use base qw/StatusMail/; + +#---------------------------------------------------------------------------= --- +# sub print( directory ) +# +# Prints the plugin(s) output to the specified directory. +#---------------------------------------------------------------------------= --- + +sub print( $$ ) +{ + my $self =3D shift; + my $dir =3D shift; + my $file =3D "$dir/test.txt"; + + if ($self->{'empty'}) + { + print "No output produced\n"; + return; + } + + if ($self->{format} eq 'html') + { + $self->{message} .=3D "\n" if ($self->{in_item}); + $self->{message} .=3D "\n" if ($self->{in_subsection}); + $self->{message} .=3D "\n" if ($self->{in_section}); + + $self->{message} .=3D "\n\n\n"; + $file =3D "$dir/test.html"; + } + + open OUT, '>', $file or die "Can't open test output file $file: $!"; + + print OUT $self->{message}; + + close OUT; + + print "Output is in $file\n"; +} + + +#---------------------------------------------------------------------------= --- +# sub add_image( params ) +# +# Outputs an image as a file. +#---------------------------------------------------------------------------= --- + +sub add_image +{ + my ($self, %params) =3D @_; + + if ($self->{section}) + { + $self->{message} .=3D $self->{section}; + $self->{section} =3D ''; + $self->{in_section} =3D 1; + $self->{in_subsection} =3D 0; + $self->{in_item} =3D 0; + } + + if ($self->{subsection}) + { + $self->{message} .=3D $self->{subsection}; + $self->{subsection} =3D ''; + $self->{in_subsection} =3D 1; + $self->{in_item} =3D 0; + } + + if ($self->{item}) + { + $self->{message} .=3D $self->{item}; + $self->{item} =3D ''; + $self->{in_item} =3D 1; + } + + $self->{'image_file'}++; + + my $image_name =3D $self->{'image_file'}; + + $image_name .=3D '.jpg' if ($params{'type'} eq 'image/jpeg'); + $image_name .=3D '.gif' if ($params{'type'} eq 'image/gif'); + $image_name .=3D '.png' if ($params{'type'} eq 'image/png'); + + open OUT, '>', "test/$image_name" or die "Can't open image file $image_nam= e: $!"; + binmode( OUT ); + + if (exists $params{fh}) + { + my $buffer; + binmode $params{fh}; + + while (read $params{fh}, $buffer, 1024) + { + print OUT $buffer; + } + } + elsif (exists $params{data}) + { + print OUT $params{data}; + } + + close OUT; + + $self->{message} .=3D "{message} .=3D " alt=3D'$params{alt}'" if (exists $params{alt}); + $self->{message} .=3D ">\n"; + + $self->{empty} =3D 0; +} + +1; --=20 2.16.4 --===============1717225976360733961==--