v2.4.0 Fixes & Features

[jaredhendrickson13]

New

• Adds /api/v2/services/dhcp_relay endpoint for configuring the DHCP Relay service (Wish: DHCP Relay APIs #121)
• Adds support for SSL offloading in /api/v2/services/haproxy/frontend endpoints (HAProxy: Set SSL offload certificates and alternate certificates via API #661)
• Adds endpoints for /api/v2/services/haproxy/frontend/certificate (HAProxy: Set SSL offload certificates and alternate certificates via API #661)

Fixes

• Fixes an issue where some services' status was not accurately obtained (/api/v2/status/services shows ipsec as not running but /api/v1/services does #634)
• Fixes an issue where the WireGuard service's enabled status was not always represented correctly
• Fixes an issue where the /api/v2/services/dhcp_server endpoints could not be used if any DHCP Relay configuration is currently in the config
• Fixes an issue where /api/v2/services/dhcp_server did not accurately determine if a DHCP Relay was running

Changes

• Makes /api/v2/services/haproxy/backend's advanced_backend field a Base64Field instead of plain StringField (services/haproxy/backend - advanced_backend is in base64 format #640) This may be a breaking change for existing integrations!
• Makes /api/v2/services/bind/zone's refresh, retry, expire and minimum fields StringField's instead of IntegerFields (BindZone fields are of incorrect type #653) This may be a breaking change for existing integrations!
• POST requests to /api/v2/status/service now requires the id field to select the targeted service instead of name (/api/v2/status/services shows ipsec as not running but /api/v1/services does #634, Fix OpenVPN services actions #635)

[Copilot]

Pull Request Overview

This pull request introduces new API endpoints and fixes several service-related bugs while updating documentation to reflect these changes. Key changes include:

• The addition of new endpoints for DHCP Relay and HAProxy services.
• Several fixes for service status issues and DHCP server configurations.
• Updates to documentation, including navigation updates in mkdocs.yml and expanded setup instructions.

Reviewed Changes

Copilot reviewed 8 out of 23 changed files in this pull request and generated 2 comments.

File	Description
mkdocs.yml	Added a navigation entry for the Security Policy documentation
docs/index.md	Updated the "Important" block to link to the SECURITY.md file
docs/SECURITY.md	Expanded and reformatted security policy details
docs/INSTALL_AND_CONFIG.md	Revised update instructions and added guidance for backup and versioning

Files not reviewed (15)

• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Endpoint.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Model.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesDHCPRelayEndpoint.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/ServicesHAProxyFrontendCertificateEndpoint.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/BINDZone.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/DHCPRelay.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/DHCPServer.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/HAProxyBackend.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/HAProxyFrontend.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/HAProxyFrontendCertificate.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/Service.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsBINDZoneTestCase.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsDHCPRelayTestCase.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsDHCPServerTestCase.inc: Language not supported
• pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsHAProxyBackendTestCase.inc: Language not supported

Comments suppressed due to low confidence (2)

docs/index.md:43

• The updated 'Important' block appears to break the sentence across lines, which might lead to unintended whitespace or formatting issues in some markdown renderers. Consider consolidating the sentence into a single paragraph.

    Unless your inquiry is regarding a [security vulnerability](SECURITY.md) or other sensitive matter, please do not 

docs/SECURITY.md:9

• [nitpick] Presenting the supported versions as a continuous paragraph may reduce clarity. Consider using a table or bullet list format to clearly delineate the version information.

Currently, there are two supported versions of the package: the v2 package (pfSense-pkg-RESTAPI) and the legacy v1 package (pfSense-pkg-API). The v2 package is the latest version of the package and is actively developed and fully maintained. The legacy v1 package is no longer actively developed and is only receiving compatibility fixes and critical security updates when necessary. It is highly recommended to regularly update to the latest version of the package to ensure you are receiving important bug fixes and security updates.