#! /usr/bin/env perl use warnings; use strict; # sysinfo # Author: R. W. Rodolico # Primary client portion of sysinfo system. Will collect information about its current # host and create a report containing the information. This report can then be processed # by process_sysinfo.pl on the collection computer. # output file consists of a YAML file of the form: # # # ext3 # /home # 51606140 # 331472 # # #
192.168.1.3
# fe80::216:3eff:fefb:4e10 # 64 # 00:16:3e:fb:4e:10 # 1500 # 255.255.255.0 # # # squeeze # Debian GNU/Linux 6.0.4 (squeeze) # Debian # 2.6.32-5-xen-686 # Linux # Linux version 2.6.32-5-xen-686 (Debian 2.6.32-41) (ben@decadent.org.uk) (gcc version 4.3.5 (Debian 4.3.5-4) ) #1 SMP Mon Jan 16 19:46:09 UTC 2012 # 6.0.4 # # # RAM memory # MCP55 Memory Controller # a2 # Device cb84 # 0000:00:00.0 # nVidia Corporation # nVidia Corporation # # # Staffmasters # 2012-05-01 03:00 # 2.0.0 # # # terminal-based package manager (terminal interface only) # 0.6.3-3.2+squeeze1 # # # 1800.103 # i686 # GenuineIntel # backup.staffmasters.local # 1333259809 # 520852 # 1 # # # # Version 1.3 20071104 # added capability of e-mailing the results by itself and external configuration file # Version 1.3.1 20071110 # added du -sk to explicitly do directory sizes in 'k'. Also, fixed some documentation # Version 1.3.3 20081104 # modified hostname to hostname -f, and allowed user to place custom value in configuration file # also, modified to go with Debian standards in preparation to creating a debian package. # Version 2.0 20081208 # Modified to use different libraries for different OS's in preparation to porting to Windows # Uses different packages based on which OS it is on. # Version 3.0 20120923 # Major revision. Most internal intelligence pulled out and put into modules and data transfer format has been changed to YAML # # Base system only pulls client name, machine name and machine number, all of which can be set in the configuration file # if the value is not set, it attempts various means to determine the values and, if it fails, aborts with an error message # client name -- REQUIRED, must come from configuration file # machine name -- REQUIRED, if not set via conf file, attempts hostname command (hostname -f) or module getHostName # machine number -- REQUIRED, if not set via conf file, attempts "echo `hostname -f`-clientname | md5sum" or module getSerial # modules are stored in "configuration directory/modules" (/etc/sysinfo/modules on most Linux systems) and are processed in # standard sort order (case sensitive). # Module filenames may contain alpha-numeric, underscore and the period only (files containing other characters are ignored). # Modules should set their exit code to 0 for success, and non-zero for failure # Modules should return 0 or more tab delimited, newline terminated strings, processed as one record per line # A module return string line is processed as follows: # category \t [category \t ...] \t key \t value # example: # System \t num_cpu \t 1 # System \t Users \t root \t /root/ # (note, if non-zero exit code returned, return value is assumed to be error message and is printed to STDERR) # sysinfo stores the result in a hash, using categories as the keys (case sensitive), thus, the above results in # $store{'System'}{'num_cpu'} = '1'; # $store{'System'}{'Users'}{'root'} = '/root'; # upon completion, sysinfo converts the $store hash into an XML or YAML string for transfer # It then sends it to the main server as defined in the conf file. # NOTE: YAML is hand crafted to kill any requirements for external libraries # see sub hashToYAML for details # Version 3.0.1 20160321 # Renamed to sysinfo-client to not conflict with Linux package sysinfo # created installer in Perl to not rely on package managers # default path for configuration file changed to /etc/camp/sysinfo-client.conf # $VERSION changed to $DATA_VERSION to not conflict with $main::VERSION (script version vs data format version) # # Version 3.1.0 20160401 # module and script dirs now arrays to be searched. Idea is that default # modules/scripts are in installdir/modules or installdir/scripts, and # user supplied are in /etc/scripts and /etc/modules # Tightened up the file systems checks, requiring all scripts and modules # be set 0700 at least, and owned by root # Transport layers now an array, and if one fails to send the report, the others # are tried in turn # Worked on logic for sendReport to give better error checking. # Doing a search for the configuration file matching cwd, then /etc/camp, then /usr/local/etc/camp # Self documenting, ie a key for software\tsysinfo-client\version\current version is inserted # # Version 3.1.1 20160915 RWR # set use strict and use warnings, then fixed errors # # Version 3.1.2 20160922 RWR # $exitCode 1 (not applicable to this machine) does not throw warning # # Version 3.1.3 20161010 RWR # Removed extra use warnings # # Version 3.1.4 20161023 RWR # Would error out if moduledir does not exist, added a return # # Version 3.1.5 20170327 RWR # On freeBSD systems, was looking in wrong place for configuration file # # Version 3.2.0 20180320 RWR # Major change in the configuration file format; All entries are loaded into # hash %configuration, so clientname is no longer $clientname, but is now # $configuration{'clientname'} # NOT backwards compatible # changed configuration to be loaded into hash (vs directly loaded into variables) # added UUID to configuration file # # Version 3.2.1 20180424 RWR # Finally got a semi-stable version of this running. Fixed a bunch of bugs # and appears to be working correctly. # # Version 3.3.0 20190419 RWR # Converted to use YAML config file # # Version 3.4.0 20191111 RWR # adding logging with priority. logging is a hash inside of %cvonfiguration which contains the following # $configuration{ 'logging' } = { # 'log type' => 'string', # 'log level' => #, # 'other params' => something, # }; # # The default log type is cache, which builds an array of all messages passed. When the log type is changed, the cache is # checked for values and, if they exist, they are dumped to the log, then removed. # # Currently, the only log type is 'file', which has one other additional parameter, 'log path' which # points to the actual log to be created. The log is NOT limited in size, so use something else to # do that. # log level is an integer which is compared the a priority passed to the logging function. The # higher log level is set, the more verbose the log. # 0 - Normal, basically logs when the program starts and ends, and any warnings. # 1 - a little more information about flow # 2 - Gives ending information on structures # 3 - Gives a lot of info about structures when they are initialized and at the end # 4 - Crazy. Dumps just about every structure every time they are changed # # $TESTING has been set to a binary. If true, the report is not sent via the transports, but is dumped to /tmp/sysinfo.testing.yaml # # Version 3.4.1 20191117 RWR # Added syslog as a possible option for logging. # # Version 3.5.4 20200317 RWR # changed so report->version will show the version of sysinfo, not the data version # # Version 3.5.5 20200317 RWR # bug fix for bsd/opnsense # # Version 3.6.0 20220607 RWR # Changed the way upload works. It automatically now passes an additional parameter, upload_type, which with the new upload # script will choose a directory, allowing one script to handle various uploads # additionally, if the key 'postRunScript' is in the config, it is assumed to be the name of a script to be run after sysinfo # completes it's task. This can be used to download/update the program, add new modules, etc.. # find our location and use it for searching for libraries BEGIN { use FindBin; use File::Spec; use lib File::Spec->catdir($FindBin::Bin); eval( 'use YAML::Tiny;' ); eval( 'use Data::Dumper;' ); } # contains the directory our script is in my $sourceDir = File::Spec->catdir($FindBin::Bin); # define the version number # see https://metacpan.org/pod/release/JPEACOCK/version-0.97/lib/version.pod use version; our $VERSION = version->declare("v3.6.0"); our $DATA_VERSION = version->declare( 'v3.0.0' ); # used in sending the data file. sets version of XML/YAML data file # see https://perldoc.perl.org/Getopt/Long.html use Getopt::Long; # allow -vvn (ie, --verbose --verbose --dryrun) Getopt::Long::Configure ("bundling"); use sysinfoconf; # Following are global variables overridden if configuration file exists my $TESTING = 0; # if set to 1, will do everything, but will dump output to /tmp/sysinfo.testing.yaml my $indentLevel = 2; # number of spaces to indent per level in XML or YAML my $reportDate = &timeStamp(); # set report date my $interactive = 0; # if set to 1, will go into interactive mode and output to local file my $periodicOverrideFile = '/tmp/sysinfo.firstrun'; # if this file exists, library.pm will tell all periodic modules to run anyway my $periodic = 0; # if set to 1, will do modules which are only supposed to run weekly, monthly, etc... my $version; my $help; my %configuration = ( 'logging' => { 'log type' => 'cache', 'log level' => 0 }, # if set, will point to logging 'moduleDirs' => ["$sourceDir/modules"], # search paths for modules 'scriptDirs' => ["$sourceDir/scripts"], # search paths for scripts 'clientName' => '', # Required!! Must be set in conf file (no defaults) 'serialNumber' => '', # serial number of machine 'UUID' => '', # UUID of machine 'transports' => {'3' => { '-name-' => 'saveLocal', 'sendScript' => 'save_local', 'output directory' => "$sourceDir/reports" } }, # hash with various transports 'hostname' => &getHostName() # fully qualified host name of machine ); ####################################################### # # sendResults( $parameters, $message, $scriptDirectory ) # # Sends results of run to server using external script. If external # script not defined, just print to STDOUT # # Parameters # $parameters - a hash containing the information necessary to make the transfer # $message - the message to be sent # $scriptDirectory - path (not filename) of script to be executed # # $parameters contains different key/value pairs depending on the script used # for example, a stand-alone SMTP script may need a username/password, # smtp server name, port number, from and to address # while an http transfer may only need a script name # See the individual scripts to determine what parameters need to be # filled in. # The only required parameter is 'sendScript' which must contain the # name of the script to execute (and it must be located in $scriptDirectory) # SCRIPT must contain one sub named doit, that accepts three parameters, the hash, # the message, and, optionally, the script directory # # If script not defined, just dump to STDOUT. With a properly set up cron job, the output # would then be sent via e-mail to an administrative account, possibly root # ####################################################### sub sendResults { my ( $globals, $transports, $message, $scriptDirectory ) = @_; &logIt( 3, "Entering sendResults" ); foreach my $key ( sort { $a <=> $b } %$transports ) { if ( $transports->{$key}->{'sendScript'} ) { &logIt( 3, "Trying to find file " . $transports->{$key}->{'sendScript'} . " in " . join( "\n\t", @{$scriptDirectory} ) ); my $sendScript = &findFile( $transports->{$key}->{'sendScript'}, $scriptDirectory ); if ( $sendScript ) { # load the chosen script into memory require $sendScript; # merge the globals in while ( my ( $gkey, $value ) = each %$globals ) { $transports->{$key}->{$gkey} = $value; } # do variable substitution for any values which need it foreach my $thisOne ( keys %{$transports->{$key}} ) { &logIt( 4, "$thisOne" ); if ( $transports->{$key}->{$thisOne} =~ m/(\$configuration\{'hostname'\})|(\$reportDate)|(\$configuration\{'clientName'\})|(\$configuration\{'serialNumber'\})/ ) { $transports->{$key}->{$thisOne} = eval "\"$transports->{$key}->{$thisOne}\""; } } #%$transports{$key}{keys %$globals} = values %$globals; #print Dumper( $$transports[$key] ); #next; # execute the "doit" sub from that script &logIt( 3, $message ); my $return = &doit( $transports->{$key}, $message ); return $return if ( $return == 1 ); } else { &logIt( 0,"Could not find " . $$transports[$key]{'sendScript'} . ", trying next transport" ); } # if..else } # if } # foreach # if we made it here, we have not sent the report, so just return it to the user # if called from a cron job, it will (hopefully) be sent to root &logIt( 0, 'Error, reached ' . __LINE__ . " which should not happen, message was\n$message" ); print $message; return 1; } ####################################################### # # getHostName # # return hostname from hostname -f # ####################################################### sub getHostName { &logIt( 3, "Entering getHostName" ); my $hostname = `hostname -f`; chomp $hostname; return $hostname; } ####################################################### # # escapeForYAML # # Escapes values put into YAML report # # DEPRECATED AS OF VERSION 3.3.0 # uses YAML::Tiny # ####################################################### #sub escapeForYAML { # my $value = shift; # $value =~ s/'/\\'/gi; # escape single quotes # $value =~ s/"/\\"/gi; # escape double quotes # # pound sign indicates start of a comment and thus loses part # # of strings. Surrounding it by double quotes in next statement # # allows # $value = '"' . $value . '"' if ( $value =~ m/[#:]/ ); # return $value; #} ####################################################### # # hashToYAML( $hashRef, $indent ) # # Converts a hash to a YAML string # # NOTE: This routine recursively calls itself for every level # in the hash # # Parameters # $hashref - reference (address) of a hash # $indent - current indent level, defaults to 0 # # Even though there are some very good libraries that do this # I chose to hand-code it so sysinfo can be run with no libraries # loaded. I chose to NOT do a full implementation, so special chars # that would normally be escaped are not in here. # However, I followed all the RFC for the values that were given, so # assume any YAML reader can parse this # NOTE: YAML appears to give a resulting file 1/3 smaller than the above # XML, and compresses down in like manner # # DEPRECATED AS OF VERSION 3.3.0 # uses YAML::Tiny # ####################################################### #sub hashToYAML { # my ($hashRef, $indent) = @_; # $indent = 0 unless $indent; # default to 0 if not defined # # my $output; # where the output is stored # foreach my $key ( keys %$hashRef ) { # for each key in the current reference # print "Looking at $key\n" if $TESTING > 3; # # see http://www.perlmonks.org/?node_id=175651 for isa function # if ( UNIVERSAL::isa( $$hashRef{$key}, 'HASH' ) ) { # is the value another hash? # # NOTE: unlike xml, indentation is NOT optional in YAML, so the following line verifies $indentlevel is non-zero # # and, if it is, uses a default 3 character indentation # $output .= (' ' x $indent ) . &escapeForYAML($key) . ":\n" . # key, plus colon, plus newline # &hashToYAML( $$hashRef{$key}, $indent+($indentLevel ? $indentLevel : 3) ) . # add results of recursive call # "\n"; # } elsif ( UNIVERSAL::isa( $$hashRef{$key}, 'ARRAY' ) ) { # is it an array? ignore it # } else { # it is a scalar, so just do value # $output .= (' ' x $indent ) . &escapeForYAML($key) . ': ' . &escapeForYAML($$hashRef{$key}) . "\n"; # } # } # return $output; #} ####################################################### # # tabDelimitedToHash ($hashRef, $tabdelim) # # Takes a tab delimited multi line string and adds it # to a hash. The final field in each line is considered to # be the value, and all prior fields are considered to be # hierachial keys. # # Parameters # $hashref - reference (address) of a hash # $tabdelim - A tab delimited, newline terminated set of records # # ####################################################### sub tabDelimitedToHash { my ($hashRef, $tabdelim) = @_; &logIt( 3, "Entering tabDelimitedToHash" ); foreach my $line ( split( "\n", $tabdelim ) ) { # split on newlines, then process each line in turn $line =~ s/'/\\'/gi; # escape single quotes my @fields = split( / *\t */, $line ); # get all the field values into array my $theValue = pop @fields; # the last one is the value, so save it # now, we build a Perl statement that would create the assignment. The goal is # to have a string that says something like $$hashRef{'key'}{'key'} = $value; # then, eval that. my $command = '$$hashRef'; # start with the name of the dereferenced hash (parameter 1) while (my $key = shift @fields) { # while we have a key, from left to right $command .= '{' . "'$key'" . '}'; # build it as {'key'} concated to string } $command .= "='$theValue';"; # add the assignment #print STDERR "$command\n"; eval $command; # eval the string to make the actual assignment } } ####################################################### # # validatePermission ( $file ) # # Checks that file is owned by root, and has permission # 0700 or less # # Returns empty string on success, error message # on failure # ####################################################### sub validatePermission { my $file = shift; &logIt( 3, "Entering validatePermission with $file" ); my $return; # must be owned by root my $owner = (stat($file))[4]; $return .= " - Bad Owner [$owner]" if $owner; # must not have any permissions for group or world # ie, 0700 or less my $mode = (stat($file))[2]; $mode = sprintf( '%04o', $mode & 07777 ); $return .= " - Bad Permission [$mode]" unless $mode =~ m/0.00/; return $return ? $file . $return : ''; } ####################################################### # # ProcessModules ( $system, $moduleDir ) # # Processes all modules in $moduleDir, adding result to $system hash # # Parameters # $system - reference (address) of a hash # $moduleDir - full path to a directory containing executable scripts # # Each file in the $moduleDir directory that matches the regex in the grep # and is executable is run. It is assumed the script will return 0 on success # or a non-zero on failure # The output of the script is assumed to be a tab delimited, newline separated # list of records that should be added to the hash $system. This is done by calling # &parseModule above. # on failure, the returned output of the script is assumed to be an error message # and is displayed on STDERR ####################################################### sub ProcessModules { my ( $system, $moduleDir ) = @_; &logIt( 3, "Entering processModules" ); # open the module directory return unless -d $moduleDir; opendir( my $dh, $moduleDir ) || die "Module Directory $moduleDir can not be opened: $!\n"; # and get all files which are executable and contain nothing but alpha-numerics and underscores (must begin with alpha-numeric) my @modules = grep { /^[a-zA-Z0-9][a-zA-Z0-9_]+$/ && -x "$moduleDir/$_" } readdir( $dh ); closedir $dh; foreach my $modFile ( sort @modules ) { # for each valid script if ( my $error = &validatePermission( "$moduleDir$modFile" ) ) { print STDERR "Not Processed: $error\n"; next; } &logIt( 3, "Processing module $moduleDir$modFile"); my $output = qx/$moduleDir$modFile $moduleDir/; # execute it and grab the output my $exitCode = $? >> 8; # process the exitCode # exitCode 0 - processed normally # exitCode 1 - not applicable to this machine if ( $exitCode && $exitCode > 1) { # if non-zero, error, so show an error message warn "Error in $moduleDir$modFile, [$output]\n"; &logIt( 0, "Error in $moduleDir$modFile, [$output]" ); } else { # otherwise, call tabDelimitedToHash to save the data &tabDelimitedToHash( $system, $output ); } # if } # foreach # add sysinfo-client (me) to the software list, since we're obviously installed &tabDelimitedToHash( $system, "software\tsysinfo-client\tversion\t$main::VERSION\n" ); } sub getDMIDecode { my ( $key, $type ) = @_; my $command = 'dmidecode '; $command .= "-t $type " if $type; $command .= " | grep -i '$key'"; my $value = `$command`; chomp $value; if ( $value =~ m/:\s*(.*)\s*$/ ) { return $1; } else { return ''; } } sub interactiveConfig { my $config = shift; $config->{'moduleDirs'} = $config->{'moduleDirs'}[0]; $config->{'scriptDirs'} = $config->{'scriptDirs'}[0]; $config->{'UUID'} = getDMIDecode( 'uuid', 'system' ) unless $config->{'UUID'}; $config->{'serialNumber'} = getDMIDecode( 'serial number', 'system' ) unless $config->{'serialNumber'}; my %menu = ( 1 => {'prompt' => 'Host Name', 'key' => 'hostname' }, 2 => {'prompt' => 'Client Name', 'key' => 'clientName' }, 3 => {'prompt' => 'Serial Number', 'key' => 'serialNumber' }, 4 => {'prompt' => 'UUID', 'key' => 'UUID' }, 5 => {'prompt' => 'Modules Directory', 'key' => 'moduleDirs' }, 6 => {'prompt' => 'Scripts Directory', 'key' => 'scriptDirs' } ); my $choice = 'quit'; while ( $choice ) { foreach my $menuItem ( sort keys %menu ) { print "$menuItem\. " . $menu{$menuItem}{'prompt'} . ': ' . $config->{$menu{$menuItem}{'key'}} . "\n"; } print "Enter Menu Item to change, or press Enter to proceed "; $choice = <>; chomp $choice; last unless $choice; print $menu{$choice}{'prompt'} . ' [' . $config->{$menu{$choice}{'key'}} . '] : '; my $value = <>; chomp $value; $config->{$menu{$choice}{'key'}} = $value if ($value); } $config->{'moduleDirs'} = [ $config->{'moduleDirs'} ]; $config->{'scriptDirs'} = [ $config->{'scriptDirs'} ]; return $config; } # simple display if --help is passed sub help { use File::Basename; print basename($0) . " $VERSION\n"; print < \$interactive, # ask questions instead of using config file 'periodic|p' => \$periodic, # will do modules which are marked as periodic 'help|h' => \$help, 'version' => \$version, 'client|c=s' => \$configuration{clientName}, 'serial|s=s' => \$configuration{serialNumber}, 'hostname=s' => \$configuration{hostname}, 'modules|m=s' => \$configuration{moduleDirs}, 'scripts=s' => \$configuration{scriptDirs}, ) or die "Error parsing command line\n"; if ( $help ) { &help() ; exit; } if ( $version ) { use File::Basename; print basename($0) . " $VERSION\n"; exit; } if ( $interactive ) { %configuration = %{ &interactiveConfig( \%configuration ) }; } else { # load the configuration file %configuration = %{ &loadConfigurationFile( \$configurationFile, @confFileSearchPath) }; } `touch $periodicOverrideFile` if $periodic; # tells periodic modules to run #die Dumper (\%configuration ); # user did not define a serial number, so make something up $configuration{'serialNumber'} = '' unless $configuration{'serialNumber'}; # oops, no client name (required) so tell them and exit die "No client name defined in $configurationFile" unless $configuration{'clientName'}; &logIt( 0, 'Starting sysinfo Run' ); &logIt( 3, "Configuration is\n" . Data::Dumper->Dump( [\%configuration], [ qw($configuration) ] ) ); $TESTING = $configuration{'TESTING'} if defined $configuration{'TESTING'}; &logIt( 0, "Testing => $TESTING" ) if $TESTING; my $System; # hash reference that will store all info we are going to send to the server # some defaults. $System->{'report'}->{'version'} = $VERSION->normal; $System->{'report'}->{'date'} = $reportDate; $System->{'report'}->{'client'} = $configuration{'clientName'}; $System->{'system'}->{'hostname'} = $configuration{'hostname'}; $System->{'system'}->{'serial'} = $configuration{'serialNumber'}; $System->{'system'}->{'UUID'} = $configuration{'UUID'}; &logIt( 3, "Initial System\n" . Data::Dumper->Dump( [$System], [qw( $System )] ) ); # process any modules in the system foreach my $moduleDir ( @{$configuration{'moduleDirs'}} ) { &logIt( 3, "Processing modules from $moduleDir" ); &ProcessModules( $System, "$moduleDir/" ); } &logIt( 4, "After processing modules\n" . Data::Dumper->Dump( [$System], [qw( $System )] ) ); my $out = sprintf( "#sysinfo: %s YAML\n", $VERSION->normal ) . &Dump( $System ); &logIt( 4, 'At line number ' . __LINE__ . "\n" . Data::Dumper->Dump([$System],[qw($System)]) ); # load some global values for use in the script, if required my $globals = { 'upload_type' => 'sysinfo', 'data version' => $DATA_VERSION->normal, 'report date' => $reportDate, 'client name' => $configuration{'clientName'}, 'host name' => $configuration{'hostname'}, 'serial number'=> $configuration{'serialNumber'}, 'UUID' => $configuration{'UUID'} }; &logIt( 4, "Globals initialized\n" . Data::Dumper->Dump([$globals],[qw($globals)]) ); if ( $TESTING ) { open DATA, ">/tmp/sysinfo.testing.yaml" or die "Could not write to /tmp/sysinfo.testing.yaml: $!\n"; print DATA $out; close DATA; } else { # and send the results to the server if ( my $success = &sendResults( $globals, $configuration{'transports'}, $out, $configuration{'scriptDirs'} ) != 1 ) { &logIt( 0, "Error $success while sending report from $configuration{'hostname'}" ); } } unlink ( $periodicOverrideFile ) if -e $periodicOverrideFile; &logIt( 0, 'Ending sysinfo Run' ); if ( $configuration{'postRunScript'}{'script name'} ) { my $script = $sourceDir . '/' . $configuration{'postRunScript'}{'script name'}; exec ( "$script $configurationFile" ) if -x $script; } 1;