Auto update check, checks for updates to base system + packages and sends email alerts

MarinSNB

@wgstarks sounds good! That is what is am finding out here too! Thanks much!

Gertjan

@MarinSNB said in Auto update check, checks for updates to base system + packages and sends email alerts:

To clarify, if there are no updates to any of the packages, does this script still send an email at the times as specified in your cron job? Thanks!

It's 'open source' ;)

As the script language is somewhat backed up English, it says :

If the 'message' ($msg) is not empty (so there was a message ! == thing to update/upgrade) then
87) log a message in to system log ( here : StatusSystem LogsSystemGeneral )
88) show the message on the command line (visible if you executed the command yourself)
89) and... send/notify the message by mail.

I 'see' you thinking : is it really that simple ? Yes, it is.

stephenw10

@wgstarks It stores custom files base64 encoded in the config. So you could use it to store the pkg_check.php file and it would be restore into a system when you restore the config. Though you might need to do it in several steps or manually save since the first boot would install the Filer package.

wgstarks

@stephenw10 said in Auto update check, checks for updates to base system + packages and sends email alerts:

@wgstarks It stores custom files base64 encoded in the config. So you could use it to store the pkg_check.php file and it would be restore into a system when you restore the config. Though you might need to do it in several steps or manually save since the first boot would install the Filer package.

So if I use filer rather than my usual SFTP for installing custom files they are added to the config which gets backed up by Auto Config Backup correct? So I should delete the current files and re-add them using filer?

stephenw10

You don't have to delete them. Filer simply won't do anything if the files are already there. And identical.

wgstarks

@stephenw10 said in Auto update check, checks for updates to base system + packages and sends email alerts:

Filer simply won't do anything if the files are already there. And identical.

But the object would be for filer to add the file to the config database.

Gertjan

@wgstarks said in Auto update check, checks for updates to base system + packages and sends email alerts:

So if I use filer rather than my usual SFTP for installing custom files they are added to the config which gets backed up by Auto Config Backup correct? So I should delete the current files and re-add them using filer?

I never used 'filer' myself, but yes, that's the beauty of the package :
When you export your config, you export it with packages and package 'settings'.
The filer package settings are, amongst others, the files and the place where they are stored.

So, importing the config will import/install the package and will also import the config == settings of the package == big magic : all your private additions (files) are also restored.

For myself, I'm doing things the old fashioned way. Not that I stick dozens of Post-It's on my pfSense (I did that before) but I use the Notes package :

and I add, for every setting and change that I made a
Why / when / what to observe / where to get it, etc.
So, when I have to re-install pfSense, I also re install these Notes, and I have my road-book ready after a phenix event.
Hummmm. Maybe I should have a closer look at this filer package after all.

wgstarks

@Gertjan
Thanks for the Notes suggestion. I lost a few packages recently and been thinking about creating a pfsense logbook since it looks like some packages in Package Manager don’t get included in backups and I’m willing to bet custom packages that aren’t in package manager won’t be either. This looks like it’s perfect for that.

michmoor

@stephenw10
can we make it a package my good sir?

stephenw10

Mmm, I was just thinking that as I wrote it.

No developer time right now though, it would have to be a user PR. For now at least.

Gertjan

@michmoor

One tiny PHP file ?
( and a cron entry, which somewhat forces you also to install the Cron package)

The overhead of 'official' package maintenance will be way bigger as the 80 or so lines.
Let's keep this the 'read the forum and you'll find a nice hidden forum package ^^' suggestion.
Or : the official way : go here.
It already exists ....

edit : Can some one bake this into a System_patch ? I wonder if writing in cron file /etc/cron.d./ for a cron entry would do the trick ....

edit : but actually, it should be here :

Just a button or a set of buttons, one for each notification method, that says :

Do you want to receive a notification when a pfSense upgrade, a pfSense package or a 'core' FreeBSD update is available ?

As soon as one of the notification methods is selected, the cron gets inserted, etc.

edit :
Ok, just for the fun :

michmoor

@Gertjan in my mind , an official way of getting notifications of updates is/should be the required way.

This awesome script is only in the forums and not documented in any official capacity.
We shouldn’t expect admins to muck around in the filesystem

I’m glad there is a redmine. Maybe one day…..

Gertjan

@michmoor said in Auto update check, checks for updates to base system + packages and sends email alerts:

This awesome script is only in the forums and not documented in any official capacity.

True.
I'm feeling 'protected' as I'm pretty sure people like jimp would have posted : "don't do this" if these '80 lines' had the slightest effect on security or whatever

michmoor

@Gertjan said in Auto update check, checks for updates to base system + packages and sends email alerts:

I'm feeling 'protected' as I'm pretty sure people like jimp would have posted : "don't do this" if these '80 lines' had the slightest effect on security or whatever

I get the concern but then they should ack the redmine. Been noticing a troubling trend around unassigned/unack tickets....

tariqali

Fantastic script, and I had no idea about Filer, so easy to setup, just copied the raw code from the gist and used 0755 permissions.

This should definitely be part of the base pfsense configuration.

Screenshot 2024-09-06 at 10.41.39 PM.png

Screenshot 2024-09-06 at 10.41.58 PM.png

Gertjan

@tariqali

This :

will run the script .... when ... ones ?

You still have to :
Make sure your have the pfSense Cron Package.
Add a cron task that execute the script ones every - when ever you want - per day (week ? month ? hours ?).
And of course, test it and check up with it ones in a while.

stephenw10

Yes that will run it once but you shouldn't need that. The field allows Filer to run a command after it has added back a file which may be required. This script doesn't need it though. It's run by cron anyway.

tariqali

@Gertjan Yup I setup CRON to run every night.

wgstarks

I seem to be having problems with this update checker. I first noticed today that it wasn't working at all although there were updates available for pfsense+ as well as system patches. While checking I realized that I wasn't using the latest php from github so I updated it to-

?php

  require_once("pkg-utils.inc");
  require_once("notices.inc");
  require_once("util.inc");

  $msg = null;
  $pmsg = null;
  $p = 0;

  log_error("Starting update check");

  // pfSense base system check
  $system_version = get_system_pkg_version(false, false);
  if ($system_version === false) {
    printf("%s\n", 'Unable to check for updates');
    log_error("Unable to check for updates, exiting");
    exit;
  }

  if (!is_array($system_version) ||
    !isset($system_version['version']) ||
    !isset($system_version['installed_version'])) {
    printf("%s\n", 'Error in version information');
    log_error("Error in version information, exiting");
    exit;
  }

  switch ($system_version['pkg_version_compare']) {
    case '<':
      //printf("%s%s%s\n", "pfSense version ", $system_version['version'], " is available");
      $msg = "An update to pfSense version " . $system_version['version'] . " is available\n\n";
      break;
    case '=':
      //printf("%s%s%s\n", "pfSense version ", $system_version['version'], " (installed) is current");
      break;
    case '>':
      printf("%s%s%s\n", "pfSense version ", $system_version['installed_version'], " is NEWER than the latest available version ", $system_version['version']);
      $msg = "pfSense version " . $system_version['version'] . " is available (downgrade)\n\n";
      break;
    default:
      printf("%s\n", 'Error comparing installed with latest version available');
      log_error("Error comparing installed with latest version available");
      break;
  }

  // package check
  $package_list = get_pkg_info('all', true, true);
  $installed_packages = array_filter($package_list, function($v) {
    return (isset($v['installed']) && isset($v['name']));
  });

  if (empty($installed_packages)) {
    printf("%s\n", 'No packages installed');
    log_error("No packages installed, exiting");
    exit;
  }

  foreach ($installed_packages as $pkg) {
    if (isset($pkg['installed_version']) && isset($pkg['version'])) {
      //printf("%s%s%s\n", $pkg['shortname'], ': ', $pkg['installed_version']);
      $version_compare = pkg_version_compare($pkg['installed_version'], $pkg['version']);
      if ($version_compare != '=') {
        $p++;
        $pmsg .= "\n".$pkg['shortname'].': '.$pkg['installed_version'].' ==> '.$pkg['version'];
        if ($version_compare == '>') {
          $pmsg .= ' (downgrade)';
        }
        printf("%s%s%s%s%s\n", $pkg['shortname'], ': ', $pkg['installed_version'], ' ==> ', $pkg['version']);
      }
    }
  }

  if ($p > 0) {
    $msg = $msg . "The following updates are available and can be installed using System > Package Manager:\n" . $pmsg;
  }

  // check for updates to builtin packages
  exec("/usr/sbin/pkg upgrade -n | /usr/bin/sed -ne '/UPGRADED/,/^$/p'", $output, $retval);
  if (($retval == 0) && (count($output))) {
    $msg .= "\n\n" . "Some packages are part of the base system and will not show up in Package Manager. If any such updates are listed below, run `pkg upgrade` from the shell to install them:\n\n";
    array_shift($output);
    $msg .= implode("\n", array_map('ltrim', $output));
  }

  if (!empty($msg)) {
    log_error("Updates were found - sending email");
    notify_via_smtp($msg);
    // to send alerts to ALL configured targets (email, Pushover, Slack etc) use the line below instead:
    // notify_all_remote($msg);
  }

  log_error("Update check complete");

?>

This yielded a notification for updates available-

Notifications in this message: 1
================================

12:00:13 The following updates are available and can be installed using System > Package Manager:

System_Patches: 2.2.11_15 ==> 2.2.11_16

Some packages are part of the base system and will not show up in Package Manager. If any such updates are listed below, run `pkg upgrade` from the shell to install them:

pfSense-pkg-System_Patches: 2.2.11_15 -> 2.2.11_16 [pfSense]

This contains a notification for updated system patches but still nothing for the pfsense+ update.

Using this command in cron-

/usr/local/bin/php -q /root/pkg_check.php

Not sure why pfsense+ update notifications are missing???

dennypage

@wgstarks said in Auto update check, checks for updates to base system + packages and sends email alerts:

?php

This is missing the angle bracket. It should be:

<?php