Skip to content

Commit

Permalink
Devel (#97)
Browse files Browse the repository at this point in the history 
* back merge main onto devel (#94)

* Update main to latest (#77)

* Updated pkg-plist

* Makefile fix

* Experimenting with wireguard service

* Update README.md

Co-authored-by: vajonam <[email protected]>
Co-authored-by: Manojav Sridhar <[email protected]>

* docs: add theonemcdonald as a contributor (#84)

* docs: update README.md [skip ci]

* docs: create .all-contributorsrc [skip ci]

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

* Update README.md

* Update README.md

* Update .all-contributorsrc

* Update .all-contributorsrc

* Update README.md

* Update README.md

* Update Makefile

* Cleanup

* Cleanup

* Clean upload of v0.1.2

* Create FUNDING.yml

* Add files via upload

Co-authored-by: vajonam <[email protected]>
Co-authored-by: Manojav Sridhar <[email protected]>
Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

* Clean ups

* Syntax

* Updated README

Co-authored-by: vajonam <[email protected]>
Co-authored-by: Manojav Sridhar <[email protected]>
Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
  • Loading branch information
@rcmcdonald91 @vajonam @allcontributors
4 people authored Jun 2, 2021
1 parent 7ca603a commit 37a85aa
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 178 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ You can find pre-compiled binaries and packages [here](https://github.com/theone

https://docs.netgate.com/pfsense/en/latest/vpn/wireguard/index.html

**Note:** The Netgate documentation reflects WireGuard as implemented in 2.5.0. There are several differences due to the packaged nature of this implementation that diverge the configuration steps from the official Netgate docs. (See the notes above).

## Recognition

\*** "WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld.
167 changes: 43 additions & 124 deletions net/pfSense-pkg-WireGuard/files/usr/local/pkg/wireguard/wg.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function wg_toggle_tunnel($tunnel_name) {
$action_txt = $enabled ? 'disabled' : 'enabled';

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Tunnel {$tunnel['name']} {$action_txt}.");
write_config("[{$wgg['pkg_name']}] Tunnel {$tunnel['name']} {$action_txt}.");

// We've got meaningful changes...
$changes = true;
Expand Down Expand Up @@ -118,7 +118,7 @@ function wg_toggle_peer($peer_idx) {
$action_text = $enabled ? 'disabled' : 'enabled';

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Peer {$peer_id} {$action_text}.");
write_config("[{$wgg['pkg_name']}] Peer {$peer_id} {$action_text}.");

$tunnel_names = array_map(fn($x) => $x['name'], $wgg['tunnels']);

Expand Down Expand Up @@ -166,7 +166,7 @@ function wg_delete_peer($peer_idx) {
unset($wgg['peers'][$peer_idx]);

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Peer {$peer_idx} deleted.");
write_config("[{$wgg['pkg_name']}] Peer {$peer_idx} deleted.");

$tunnel_names = array_map(fn($x) => $x['name'], $wgg['tunnels']);

Expand Down Expand Up @@ -223,7 +223,7 @@ function wg_delete_tunnel($tunnel_name) {
unset($wgg['tunnels'][$tun_idx]);

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Tunnel {$tunnel['name']} deleted.");
write_config("[{$wgg['pkg_name']}] Tunnel {$tunnel['name']} deleted.");

// We've got meaningful changes...
$changes = true;
Expand Down Expand Up @@ -385,7 +385,7 @@ function wg_do_peer_post($post) {
$wgg['peers'][$peer_idx] = $pconfig;

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Peer {$pconfig['descr']} updated.");
write_config("[{$wgg['pkg_name']}] Peer {$pconfig['descr']} updated.");

// Check if anything actually changed or was this just a clean re-save?
if (md5(serialize($pconfig)) != md5(serialize($old_config))) {
Expand Down Expand Up @@ -468,7 +468,7 @@ function wg_do_tunnel_post($post) {
$wgg['tunnels'][$tun_idx] = $pconfig;

// Sync with configuration backend
write_config("[{$wgg['pkg_names'][0]}] Tunnel {$pconfig['name']} updated.");
write_config("[{$wgg['pkg_name']}] Tunnel {$pconfig['name']} updated.");

// Check if anything actually changed or was this just a clean re-save?
if (md5(serialize($pconfig)) != md5(serialize($old_config))) {
Expand Down Expand Up @@ -541,91 +541,6 @@ function wg_apply_list_add($entry, $list) {

}

/*
* This resyncs (i.e. wg syncconf) all configured tunnel interfaces
*/
function wg_tunnel_resync_all() {
global $wgg;

$ret_tunnels = array();

// Let's assume everything will be fine
$ret_code = 0;

wg_resync();

if (isset($wgg['tunnels']) && is_array($wgg['tunnels'])) {

// Resync each tunnel
foreach ($wgg['tunnels'] as $tunnel) {

$build_status = wg_tunnel_resync($tunnel['name']);

// Build an aggregated return code
$ret_code |= $build_status['ret_code'];

$ret_tunnels[] = array(
'name' => $tunnel['name'],
'ret_code' => $build_status['ret_code'],
'errors' => $build_status['errors'],
'config' => $build_status['config']);

}

}

return array('ret_code' => $ret_code, 'tunnels' => $ret_tunnels);

}

/*
* This resyncs (i.e. wg syncconf) a specific tunnel interface by name
*/
function wg_tunnel_resync($tunnel_name) {
global $wgg;

wg_globals();

$ret_code = 0;

$errors = $tunnel = array();

$tun_idx = wg_get_tunnel_array_index($tunnel_name);

if (!isset($wgg['tunnels'][$tun_idx])) {

$ret_code |= WG_ERROR_WG_ERROR_IF_NAME;

}

if (isset($wgg['tunnels'][$tun_idx])) {

$tunnel = $wgg['tunnels'][$tun_idx];

// Sync interface with WireGuard wg(8)
if (wg_interface_syncconf($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_SYNC;

}

}

// Now collect the errors...
foreach ($wgg['error_flags']['tunnel'] as $error_mask => $error_text) {

if (($ret_code & $error_mask) > 0) {

$errors[$error_mask] = $error_text;

}

}

return array('name' => $tunnel_name, 'ret_code' => $ret_code, 'errors' => $errors, 'config' => $tunnel);

}

/*
* This builds, rebuilds, or destroys tunnel interfaces
* If $tunnels is empty, this will apply to all configured tunnel interfaces
Expand All @@ -651,7 +566,7 @@ function wg_tunnel_sync($tunnel_names = null) {
if (isset($wgg['tunnels']) && is_array($wgg['tunnels'])) {

$tunnel_names = array_map(fn($x) => $x['name'], $wgg['tunnels']);

} else {

// Nope...
Expand Down Expand Up @@ -698,67 +613,67 @@ function wg_tunnel_sync_by_name($tunnel_name) {
$errors = $tunnel = array();

$tun_idx = wg_get_tunnel_array_index($tunnel_name);

// We've got a tunnel we need to build...
if (isset($wgg['tunnels'][$tun_idx])) {

$tunnel = $wgg['tunnels'][$tun_idx];

// Create the tunnel interface if it does not yet exist
if (wg_interface_create($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_CREATE;

}

// Add the tunnel interface to the WireGuard interface group
if (wg_interface_group_add($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_GROUP;

}

// Update the addresses on the tunnel interface
if (wg_interface_update_addresses($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_ADDRESSES;

}

// Toggle the interface accordingly instead of tearing it down completely
if (isset($tunnel['enabled']) && $tunnel['enabled'] == 'yes') {

if (wg_ifconfig_up_interface($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_UP;

}

} else {

if (wg_ifconfig_down_interface($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_DOWN;

}
}

// Sync interface with WireGuard wg(8)
if (wg_interface_syncconf($tunnel['name']) <> 0) {

$ret_code |= WG_ERROR_IF_SYNC;

}

// We've got a tunnel we need to destroy...
} elseif (in_array($tunnel_name, wg_get_real_ifs())) {

if (wg_interface_destroy($tunnel_name) <> 0) {

$ret_code |= WG_ERROR_IF_DESTROY;

}

// No idea what's going on...
} else {

Expand All @@ -782,26 +697,28 @@ function wg_tunnel_sync_by_name($tunnel_name) {

}

// This performs some routine checks to make sure everything is still in order
/*
* This performs some routine checks just to make sure everything is still in order
*/
function wg_resync() {
global $wgg;

// Create WireGuard configuration files
wg_create_config_files();

// Reinstall earlyshellcmd in case it was accidently deleted...
// Reinstall earlyshellcmd in case it was accidently deleted
wg_earlyshellcmd_install();

// Reinstall interface group in case it was accidently deleted...
// Reinstall interface group in case it was accidently deleted
wg_ifgroup_install();

// Update by re-installing the Unbound ACL
wg_unbound_acl_install();

// Reinstall service in case it was accidently deleted...
// Reinstall service in case it was accidently deleted
wg_service_install();

// We don't want active tunnels when the service isn't running...
// We don't want active tunnels when the service isn't running
if (is_module_loaded($wgg['kmod']) && !wg_is_service_running()) {

wg_destroy_tunnels();
Expand All @@ -810,6 +727,9 @@ function wg_resync() {

}

/*
* Returns an array of enabled tunnels
*/
function wg_get_enabled_tunnels() {
global $wgg;

Expand All @@ -831,9 +751,8 @@ function wg_get_enabled_tunnels() {

}


/*
* (Re)creates configuration files based on the current configuration
* Creates (or recreates) all WireGuard .conf files based on the current XML configuration
*/
function wg_create_config_files($clean = true) {
global $wgg;
Expand Down Expand Up @@ -872,7 +791,7 @@ function wg_create_config_files($clean = true) {
}

/*
* Remove all wg config files from any potential conf directory
* Remove all wg .conf files from any potential configuration directory
*/
function wg_delete_config_files() {
global $wgg;
Expand Down Expand Up @@ -904,11 +823,11 @@ function wg_htmlspecialchars(&...$vars) {
array_walk($var, function(&$x) {

$x = htmlspecialchars($x);

});

continue;

}

$var = htmlspecialchars($var);
Expand All @@ -931,11 +850,11 @@ function wg_escapeshellarg(&...$vars) {
array_walk($var, function(&$x) {

$x = escapeshellarg($x);

});

continue;

}

$var = escapeshellarg($var);
Expand All @@ -962,7 +881,7 @@ function wg_remove_config_settings() {
}

// Now write out the new config to disk
write_config("[{$wgg['pkg_names'][0]}] Package configuration removed");
write_config("[{$wgg['pkg_name']}] Package configuration removed");

}

Expand All @@ -972,8 +891,7 @@ function wg_remove_config_settings() {
function make_wg_conf($tunnel) {
global $wgg;

$txt = "# This WireGuard config file has been created automatically. " .
"Do not edit!\n";
$txt = "# This WireGuard config file has been created automatically. Do not edit!\n";

$txt .= "# Description: {$tunnel['descr']}\n\n";

Expand Down Expand Up @@ -1016,6 +934,7 @@ function make_wg_conf($tunnel) {
if (!empty($peer['presharedkey'])) {

$txt .= "PresharedKey = {$peer['presharedkey']}\n";

}


Expand All @@ -1028,7 +947,7 @@ function make_wg_conf($tunnel) {
}

if (!empty($peer['endpoint'])) {

$peer['endpoint'] = is_ipaddrv6($peer['endpoint']) ? "[{$peer['endpoint']}]" : $peer['endpoint'];

$peer['port'] = empty($peer['port']) ? $wgg['default_port'] : $peer['port'];
Expand All @@ -1045,7 +964,7 @@ function make_wg_conf($tunnel) {
$txt .= "\n";

}

}

}
Expand Down
2 changes: 1 addition & 1 deletion net/pfSense-pkg-WireGuard/files/usr/local/pkg/wireguard/wg_api.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ function wg_pkg_info() {

$field_string = implode("\t", $a_fields);

$a_packages = $wgg['pkg_names'];
$a_packages = $wgg['depends_names'];

// Each package needs to be escaped individually before imploding
wg_escapeshellarg($field_string, $a_packages);
Expand Down
Loading

0 comments on commit 37a85aa

Please sign in to comment.