feat: add models, endpoints and tests for IPsec statuses

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/StatusIPsecChildSAEndpoint.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with a single IPseChildcSAStatus Model object at
+ * /api/v2/status/ipsec/child_sa.
+ */
+class StatusIPsecChildSAEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/status/ipsec/child_sa';
+        $this->model_name = 'IPsecChildSAStatus';
+        $this->request_method_options = ['GET'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/StatusIPsecSAEndpoint.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with a single IPsecSAStatus Model object at
+ * /api/v2/status/ipsec/sa.
+ */
+class StatusIPsecSAEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/status/ipsec/sas';
+        $this->model_name = 'IPsecSAStatus';
+        $this->request_method_options = ['GET'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/StatusIPsecSAsEndpoint.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace RESTAPI\Endpoints;
+
+require_once 'RESTAPI/autoloader.inc';
+
+use RESTAPI\Core\Endpoint;
+
+/**
+ * Defines an Endpoint for interacting with multiple IPsecSAStatus Model objects at
+ * /api/v2/status/ipsec/sas.
+ */
+class StatusIPsecSAsEndpoint extends Endpoint {
+    public function __construct() {
+        # Set Endpoint attributes
+        $this->url = '/api/v2/status/ipsec/sas';
+        $this->model_name = 'IPsecSAStatus';
+        $this->many = true;
+        $this->request_method_options = ['GET'];
+
+        # Construct the parent Endpoint object
+        parent::__construct();
+    }
+}

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/IPsecChildSAStatus.inc

@@ -0,0 +1,184 @@
+<?php
+
+namespace RESTAPI\Models;
+
+use RESTAPI\Core\Model;
+use RESTAPI\Fields\BooleanField;
+use RESTAPI\Fields\IntegerField;
+use RESTAPI\Fields\NestedModelField;
+use RESTAPI\Fields\PortField;
+use RESTAPI\Fields\StringField;
+
+/**
+ * A Model that provides the status of IPsec child SAs.
+ */
+class IPsecChildSAStatus extends Model {
+    public StringField $name;
+    public IntegerField $uniqueid;
+    public IntegerField $reqid;
+    public StringField $state;
+    public StringField $mode;
+    public StringField $protocol;
+    public BooleanField $encap;
+    public StringField $spi_in;
+    public StringField $spi_out;
+    public StringField $encr_alg;
+    public IntegerField $encr_keysize;
+    public StringField $integ_alg;
+    public StringField $dh_group;
+    public IntegerField $bytes_in;
+    public IntegerField $bytes_out;
+    public IntegerField $packets_in;
+    public IntegerField $packets_out;
+    public IntegerField $use_in;
+    public IntegerField $use_out;
+    public IntegerField $rekey_time;
+    public IntegerField $life_time;
+    public IntegerField $install_time;
+    public StringField $local_ts;
+    public StringField $remote_ts;
+
+    public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options) {
+        # Set model attributes
+        $this->internal_callable = 'get_ipsec_child SA_statuses';
+        $this->parent_model_class = 'IPsecSAStatus';
+        $this->verbose_name = 'IPsec Child SA Status';
+        $this->many = true;
+
+        # Set model fields
+        $this->name = new StringField(
+            default: '',
+            read_only: true,
+            help_text: 'The name of the connection ID for the child SA.',
+        );
+        $this->uniqueid = new IntegerField(default: 0, read_only: true, help_text: 'The unique ID of the child SA.');
+        $this->reqid = new IntegerField(default: 0, read_only: true, help_text: 'The request ID of the child SA.');
+        $this->state = new StringField(default: '', read_only: true, help_text: 'The current state of the child SA.');
+        $this->mode = new StringField(default: '', read_only: true, help_text: 'The mode of the child SA.');
+        $this->protocol = new StringField(default: '', read_only: true, help_text: 'The protocol of the child SA.');
+        $this->encap = new BooleanField(
+            default: false,
+            read_only: true,
+            indicates_true: 'yes',
+            help_text: 'Whether encapsulation is used for the child SA.',
+        );
+        $this->spi_in = new StringField(
+            default: '',
+            read_only: true,
+            internal_name: 'spi-in',
+            help_text: 'The incoming SPI of the child SA.',
+        );
+        $this->spi_out = new StringField(
+            default: '',
+            read_only: true,
+            internal_name: 'spi-out',
+            help_text: 'The outgoing SPI of the child SA.',
+        );
+        $this->encr_alg = new StringField(
+            default: '',
+            read_only: true,
+            internal_name: 'encr-alg',
+            help_text: 'The encryption algorithm used by the child SA.',
+        );
+        $this->encr_keysize = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'encr-keysize',
+            help_text: 'The encryption key size used by the child SA.',
+        );
+        $this->integ_alg = new StringField(
+            default: '',
+            read_only: true,
+            internal_name: 'integ-alg',
+            help_text: 'The integrity algorithm used by the child SA.',
+        );
+        $this->dh_group = new StringField(
+            default: '',
+            read_only: true,
+            internal_name: 'dh-group',
+            help_text: 'The Diffie-Hellman group used by the child SA.',
+        );
+        $this->bytes_in = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'bytes-in',
+            help_text: 'The number of bytes received by the child SA.',
+        );
+        $this->bytes_out = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'bytes-out',
+            help_text: 'The number of bytes sent by the child SA.',
+        );
+        $this->packets_in = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'packets-in',
+            help_text: 'The number of packets received by the child SA.',
+        );
+        $this->packets_out = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'packets-out',
+            help_text: 'The number of packets sent by the child SA.',
+        );
+        $this->use_in = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'use-in',
+            help_text: 'The number of times the child SA has been used to receive data.',
+        );
+        $this->use_out = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'use-out',
+            help_text: 'The number of times the child SA has been used to send data.',
+        );
+        $this->rekey_time = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'rekey-time',
+            help_text: 'The time at which the child SA will be rekeyed.',
+        );
+        $this->life_time = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'life-time',
+            help_text: 'The time at which the child SA will expire.',
+        );
+        $this->install_time = new IntegerField(
+            default: 0,
+            read_only: true,
+            internal_name: 'install-time',
+            help_text: 'The time at which the child SA was installed.',
+        );
+        $this->local_ts = new StringField(
+            default: '',
+            read_only: true,
+            many: true,
+            delimiter: null,
+            internal_name: 'local-ts',
+            help_text: 'The local traffic selector of the child SA.',
+        );
+        $this->remote_ts = new StringField(
+            default: '',
+            read_only: true,
+            many: true,
+            delimiter: null,
+            internal_name: 'remote-ts',
+            help_text: 'The remote traffic selector of the child SA.',
+        );
+
+        parent::__construct($id, $parent_id, $data, ...$options);
+    }
+
+    /**
+     * Obtains the status of IPsec child SAs. This is the internal callable that is used to obtain the internal data for
+     * this model.
+     * @return array The status of IPsec child SAs where each item is an associative array containing the status of an
+     * IPsec child SA on the system.
+     */
+    public function get_ipsec_sa_statuses(): array {
+        return IPsecSAStatus::get_ipsec_sa_statuses()[$this->parent_id]['child-sas'];
+    }
+}