Skip to content

Commit

Permalink
Moved management tools to SAML2Auth class for use outside of CLI, add…
Browse files Browse the repository at this point in the history 
…ed /saml2_auth/update/ page to update the package via UI, upgrades to make_package.py script, minor fixes
  • Loading branch information
@jaredhendrickson13
jaredhendrickson13 committed Dec 30, 2021
1 parent 51eff25 commit 6395514
Show file tree
Hide file tree
Showing 6 changed files with 462 additions and 113 deletions.
187 changes: 179 additions & 8 deletions pfSense-pkg-saml2-auth/files/etc/inc/saml2_auth/SAML2Auth.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,25 @@ require_once("config.inc");

class SAML2Auth {
public $auth;
public $file_path;
private $config;

# Constructs the saml2_auth object by loading SAML2 settings and creating the OneLogin_Saml2_Auth object
public function __construct() {
public function __construct($no_auth=false) {
session_start();
global $config;
$this->config = $config;
$this->file_path = "/usr/local/share/pfSense-pkg-saml2-auth";

# Try to start SAML2 authentication, handle errors accordingly
try {
$this->auth = new OneLogin\Saml2\Auth($this::get_saml_settings());
} catch (OneLogin\Saml2\Error $error) {
echo $error->getMessage().PHP_EOL;
exit();
# Only try to start authentication if the object wasn't requested without authentication
if (!$no_auth) {
# Try to start SAML2 authentication, handle errors accordingly
try {
$this->auth = new OneLogin\Saml2\Auth($this::get_saml_settings());
} catch (OneLogin\Saml2\Error $error) {
echo $error->getMessage().PHP_EOL;
exit();
}
}
}

Expand Down Expand Up @@ -101,6 +106,14 @@ class SAML2Auth {
}
}

# Writes log data
private function __log($msg, $console=false) {
# Print our log message to the console if requested
if ($console) {
echo $msg;
}
}

public function get_saml2_errors() {
# Print SAML errors if they exist
if (!empty($this->auth->getErrors())) {
Expand Down Expand Up @@ -159,5 +172,163 @@ class SAML2Auth {
return $php_saml_config;
}

# Fetches the current version of pfSense
public static function get_pfsense_version($full=false) {
# Only display the full release name if requested, Otherwise only provide the major and minor.
return ($full) ? file_get_contents("/etc/version") : substr(file_get_contents("/etc/version"), 0, 3);
}

public static function get_pkg_version() {
# Pull the raw pkg info for the SAML2 auth package into an array for each line
$pkg_info = explode(PHP_EOL, shell_exec("pkg info pfSense-pkg-saml2-auth"));

# Loop through each line and check the version
foreach ($pkg_info as $pkg_line) {
if (substr($pkg_line, 0, 7 ) === "Version") {
# Locate the version and format it to a standard semantic version format (x.x.x)
$version = str_replace(" ", "", $pkg_line);
$version = explode(":", $version)[1];
$version = (strlen($version) === 3) ? $version.".0" : $version;
$version = str_replace("_", ".", $version);
return $version;
}
}
}

public static function get_latest_pkg_version() {
# Fetch our latest version and format it semantically (x.x.x)
$latest_version = array_key_first(self::get_all_pkg_versions());
$latest_version = str_replace("v", "", $latest_version);
return $latest_version;
}

public static function get_latest_pkg_release_date() {
# Loop through each release and locate the latest available releases creation date
foreach (self::get_pkg_releases()["releases"] as $release) {
# Check if this releases is latest available for our platform
if ($release["tag_name"] === "v".self::get_latest_pkg_version()) {
return $release["created_at"];
}
}
}

public static function is_update_available() {
# Check if the current version is less than the latest version
$curr_ver_num = intval(str_replace(".", "", self::get_pkg_version()));
$latest_ver_num = intval(str_replace(".", "", self::get_latest_pkg_version()));
return $curr_ver_num < $latest_ver_num;
}

public static function get_pkg_releases() {
# Variables
$releases_file = "/usr/local/share/pfSense-pkg-saml2-auth/releases.json";
$releases = json_decode(file_get_contents($releases_file), true);
$fetch_releases_cmd = "curl -s https://api.github.com/repos/jaredhendrickson13/pfsense-saml2-auth/releases -m 10";

# Check if our previous releases data is older than 120 seconds
if ($releases["last_updated"] + 120 < time()) {
# Pull the releases data from Github and rewrite the releases file
$api_resp = shell_exec($fetch_releases_cmd);
$api_resp = json_decode($api_resp, true);
$releases = ["last_updated" => time(), "releases" => $api_resp];
file_put_contents($releases_file, json_encode($releases));
}
return $releases;
}

public static function get_all_pkg_versions() {
# Variables
$pf_version = substr(self::get_pfsense_version(), 0, 3);
$versions = [];
$count = 0;
$releases = self::get_pkg_releases()["releases"];

# Loop through each version and populate our version data
foreach ($releases as $release) {
# Loop through the assets of each release and check if our version of pfSense is supported
foreach ($release["assets"] as $asset) {
if ($asset["name"] === "pfSense-".$pf_version."-pkg-saml2-auth.txz") {
# The first item of our list is the latest release, mark it as such.
if ($count === 0) {
$versions[$release["tag_name"]] = $release["name"]." - Latest";
$count++;
} else {
$versions[$release["tag_name"]] = $release["name"];
}
}
}
}
return $versions;
}

# Pulls our current pfSense SAML2 configuration and saves to a non-volatile location.
public function backup_config($console=false) {
# Local variables
$path = $this->file_path."/backup.json";
$config_data = $this->get_package_config()[1];

# Print status message
$this->__log("Backing up configuration...", $console);

# Save a JSON file containing the data
file_put_contents($path, json_encode($config_data));
$this->__log("done." . PHP_EOL, $console);
return true;
}

# Restores the pfSense SAML2 configuration from a specified backup file
public function restore_config($console=false) {
# Local variables
global $config;
$path = $this->file_path."/backup.json";
$config_id = $this->get_package_config()[0];
$config_json = file_get_contents($path);
$config_data = json_decode($config_json, true);

# Print status message
$this->__log("Restoring configuration...", $console);

# Save the backup configuration to the pfSense master configuration if found
if (file_exists($path)) {
$config["installedpackages"]["package"][$config_id]["conf"] = $config_data;
write_config("Restoring SAML2 configuration");
$this->__log("done." . PHP_EOL, $console);
return true;
}
else {
$this->__log("no backup found.".PHP_EOL, $console);
return false;
}
}

# Update to the latest version of the package
public function update_pkg($version="latest", $console=false) {
# Local variables
$base_url = "https://github.com/jaredhendrickson13/pfsense-saml2-auth/releases";

# Format the package URL based on the requested version
if ($version === "latest") {
$url = $base_url."/latest/download/pfSense-".$this->get_pfsense_version()."-pkg-saml2-auth.txz";
} else {
$url = $base_url."/download/".$version."/pfSense-".$this->get_pfsense_version()."-pkg-saml2-auth.txz";
}

# Backup the package configuration before updating
$this->backup_config();

# Remove the existing package and add the new one, then og the results
exec("pkg delete -y pfSense-pkg-saml2-auth", $del_cmd_out, $del_cmd_rc);
exec("pkg add ".$url, $add_cmd_out, $add_cmd_rc);
$this->__log(implode("\n", $del_cmd_out), $console);
$this->__log(implode("\n", $add_cmd_out), $console);

# Check if the update was successful
if ($del_cmd_rc === 0 and $add_cmd_rc === 0) {
return true;
} else {
return false;
}
}


}
}
86 changes: 26 additions & 60 deletions pfSense-pkg-saml2-auth/files/usr/local/share/pfSense-pkg-saml2-auth/manage.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,66 +2,12 @@
<?php
require_once("saml2_auth/SAML2Auth.inc");

# Fetches the current version of pfSense
function pfsense_version($full=false) {
# Only display the full release name if requested, Otherwise only provide the major and minor.
return ($full) ? file_get_contents("/etc/version") : substr(file_get_contents("/etc/version"), 0, 3);
}

# Pulls our current pfSense SAML2 configuration and saves to a non-volatile location.
function backup($path="/usr/local/share/pfSense-pkg-saml2-auth/backup.json") {
# Local variables
$config_data = SAML2Auth::get_package_config()[1];

# Print status message
echo "Backing up configuration...";

# Save a JSON file containing the data
file_put_contents($path, json_encode($config_data));
echo "done." . PHP_EOL;
}

# Restores the pfSense SAML2 configuration from a specified backup file
function restore($path="/usr/local/share/pfSense-pkg-saml2-auth/backup.json") {
# Local variables
global $config;
$config_id = SAML2Auth::get_package_config()[0];
$config_json = file_get_contents($path);
$config_data = json_decode($config_json, true);

# Print status message
echo "Restoring configuration...";

# Save the backup configuration to the pfSense master configuration if found
if (file_exists($path)) {
$config["installedpackages"]["package"][$config_id]["conf"] = $config_data;
write_config("Restoring SAML2 configuration");
echo "done." . PHP_EOL;
}
else {
echo "no backup found.".PHP_EOL;
}
}

# Update to the latest version of the package
function update() {
# Local variables
$url = "https://github.com/jaredhendrickson13/pfsense-saml2-auth/releases/latest/download/pfSense-".pfsense_version()."-pkg-saml2-auth.txz";

# Backup the package configuration before updating
backup();

# Remove the existing package and add the latest
echo shell_exec("pkg delete -y pfSense-pkg-saml2-auth");
echo shell_exec("pkg add ".$url);
}

# Display the current version of pfSense and pfSense-pkg-saml2-auth
function version() {
# Local variables
$pkg_info = shell_exec("pkg info pfSense-pkg-saml2-auth").PHP_EOL;
$pkg_info = explode(PHP_EOL, $pkg_info);
$pf_ver_line = [str_replace(PHP_EOL, "", "pfSense Version: ".pfsense_version(true))];
$pf_ver_line = [str_replace(PHP_EOL, "", "pfSense Version: ".SAML2Auth::get_pfsense_version(true))];
array_splice($pkg_info, 3, 0, $pf_ver_line);

echo implode(PHP_EOL, $pkg_info);
Expand All @@ -81,19 +27,39 @@ function help() {
echo " help : Displays the help page (this page)".PHP_EOL.PHP_EOL;
}

function runtime()
{
function runtime() {
# Variables
$saml2 = new SAML2Auth(true);

# Run backup command if requested
if ($_SERVER["argv"][1] === "backup") {
backup();
$saml2->backup_config(true);
}
# Run the restore command if requested
elseif ($_SERVER["argv"][1] === "restore") {
restore();
$saml2->restore_config(true);
}
# Run the update command if requested
elseif ($_SERVER["argv"][1] === "update") {
update();
# Local variables
$version = "latest";

# Update/revert to the requested version if present
if ($_SERVER["argv"][2]) {
# Add the starting 'v' if it is missing
if (substr($_SERVER["argv"][2], 0, 1) !== "v") {
$_SERVER["argv"][2] = "v".$_SERVER["argv"][2];
}

# Ensure version exists
if (array_key_exists($_SERVER["argv"][2], $saml2->get_all_pkg_versions())) {
$version = $_SERVER["argv"][2];
} else {
echo "Could not locate package version '".$_SERVER["argv"][2]."'.".PHP_EOL;
exit(1);
}
}
$this->update_pkg($version, true);
}
# Run the version command if requested
elseif ($_SERVER["argv"][1] === "version") {
Expand Down
8 changes: 7 additions & 1 deletion pfSense-pkg-saml2-auth/files/usr/local/www/saml2_auth/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,16 @@
// limitations under the License.

# Imports and inits
$pgtitle = array(gettext("System"), gettext("SAML2"));
require_once("guiconfig.inc");
require_once("saml2_auth/SAML2Auth.inc");
require_once("saml2_auth/SAML2AuthTools.inc");

# Initialize the pfSense UI page (note: $pgtitle must be defined before including head.inc)
$pgtitle = array(gettext("System"), gettext("SAML2"), gettext("Settings"));
include('head.inc');
$update_tab = (is_update_available()) ? "Update (New Release Available)" : "Update";
$tab_array = [[gettext("Settings"), true, "/saml2_auth/"], [gettext("$update_tab"), false, "/saml2_auth/update/"]];
display_top_tabs($tab_array, true); # Ensures the tabs are written to the top of page
global $config;

# Variables
Expand Down
Loading

0 comments on commit 6395514

Please sign in to comment.