upstream/opnsense-plugins
1
0
Fork 0
mirror of https://github.com/opnsense/plugins.git synced 2026-05-28 04:34:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

net/zerotier: merge version 0.1.2 from master

Browse source
This commit is contained in:
Franco Fichtner 2017-07-31 22:41:37 +02:00
parent 73ea236001
commit eab1b4254f
15 changed files with 591 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -43,6 +43,7 @@ net/quagga -- Quagga Routing Suite
net/relayd -- Relayd Load Balancer
net/upnp -- Universal Plug and Play Service
net/wol -- Wake on LAN Service
net/zerotier -- Virtual Networks That Just Work
net-mgmt/collectd -- Collect system and application performance metrics periodically
net-mgmt/snmp -- SNMP Server via bsnmpd
net-mgmt/zabbix-agent -- Enterprise-class open source distributed monitoring agent

8
net/zerotier/Makefile Normal file
View file

@ -0,0 +1,8 @@
PLUGIN_NAME= zerotier
PLUGIN_VERSION= 0.1.2
PLUGIN_COMMENT= Virtual Networks That Just Work
PLUGIN_DEPENDS= zerotier
PLUGIN_MAINTAINER= dharrigan@gmail.com
PLUGIN_DEVEL= yes
.include "../../Mk/plugins.mk"

6
net/zerotier/pkg-descr Normal file
View file

@ -0,0 +1,6 @@
ZeroTier can be used for on-premise network virtualization, as a
peer to peer VPN for mobile teams, for hybrid or multi-data-center
cloud deployments, or just about anywhere else secure software
defined virtual networking is useful.
WWW: https://www.zerotier.com

63
net/zerotier/src/etc/inc/plugins.inc.d/zerotier.inc Normal file
View file

@ -0,0 +1,63 @@
<?php
/*
* Copyright (C) 2017 David Harrigan
* Copyright (C) 2017 Deciso B.V.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
function zerotier_enabled()
{
$mdl = new \OPNsense\Zerotier\Zerotier();
foreach ($mdl->networks->network->__items as $network) {
if ($network->enabled == '1') {
return true;
}
}
return false;
}
function zerotier_services()
{
$services = array();
if (!zerotier_enabled()) {
return $services;
}
$services[] = array(
'description' => gettext('Zerotier'),
'configd' => array(
'restart' => array('zerotier restart'),
'start' => array('zerotier start'),
'stop' => array('zerotier stop'),
),
'name' => 'zerotier',
'pidfile' => '/var/db/zerotier-one/zerotier-one.pid'
);
return $services;
}

232
net/zerotier/src/opnsense/mvc/app/controllers/OPNsense/Zerotier/Api/ZerotierController.php Normal file
View file

@ -0,0 +1,232 @@
<?php
/*
* Copyright (C) 2017 David Harrigan
* Copyright (C) 2017 Deciso B.V.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace OPNsense\Zerotier\Api;
use \OPNsense\Base\ApiMutableModelControllerBase;
use \OPNsense\Base\UIModelGrid;
use \OPNsense\Core\Backend;
use \OPNsense\Core\Config;
use \OPNsense\Zerotier\Zerotier;
class ZerotierController extends ApiMutableModelControllerBase
{
static protected $internalModelName = 'Zerotier';
static protected $internalModelClass = '\OPNsense\Zerotier\Zerotier';
public function getAction()
{
$result = array();
if ($this->request->isGet()) {
$mdlZerotier = new Zerotier();
$result['zerotier'] = $mdlZerotier->getNodes();
}
return $result;
}
public function searchNetworkAction()
{
$this->sessionClose();
$mdlZerotier = $this->getModel();
$grid = new UIModelGrid($mdlZerotier->networks->network);
return $grid->fetchBindRequest(
$this->request,
array("enabled", "networkId", "description")
);
}
public function getNetworkAction($uuid = null)
{
$mdlZerotier = $this->getModel();
if ($uuid != null) {
$network = $mdlZerotier->getNodeByReference('networks.network.' . $uuid);
if ($network != null) {
return array("network" => $network->getNodes());
}
} else {
$network = $mdlZerotier->networks->network->add();
return array("network" => $network->getNodes());
}
return array();
}
public function setNetworkAction()
{
$result = array("result" => "failed");
if ($this->request->isPost()) {
$mdlZerotier = new Zerotier();
$mdlZerotier->setNodes($this->request->getPost("network"));
$validationMessages = $mdlZerotier->performValidation();
foreach ($validationMessages as $field => $msg) {
if (!array_key_exists("validation", $result)) {
$result["validations"] = array();
}
$result["validation"]["network.".$msg->getField()] = $msg->getMessage();
}
if ($validationMessages->count() == 0) {
unset($result["validations"]);
$mdlZerotier->serializeToConfig();
Config::getInstance()->save();
$result["result"] = "saved";
}
}
return $result;
}
public function addNetworkAction()
{
$result = array("result" => "failed");
if ($this->request->isPost() && $this->request->hasPost("network")) {
$result = array("result" => "failed", "validations" => array());
$mdlZerotier = $this->getModel();
$network = $mdlZerotier->networks->network->add();
$network->setNodes($this->request->getPost("network"));
$validationMessages = $mdlZerotier->performValidation();
foreach ($validationMessages as $field => $msg) {
$fieldName = str_replace($network->__reference, "network", $msg->getField());
$result["validations"][$fieldName] = $msg->getMessage();
}
if ($validationMessages->count() == 0) {
unset($result["validations"]);
$mdlZerotier->serializeToConfig();
Config::getInstance()->save();
$result["result"] = "saved";
}
}
return $result;
}
public function delNetworkAction($uuid = null)
{
$result = array("result" => "failed");
if ($this->request->isPost()) {
$mdlZerotier = $this->getModel();
if ($uuid != null) {
$node = $mdlZerotier->getNodeByReference('networks.network.' . $uuid);
if ($node->enabled->__toString() == "1") {
# Ensure we remove the interface before deleting the network
$this->toggleZerotierNetwork($node->networkId, 0);
}
if ($mdlZerotier->networks->network->del($uuid)) {
$mdlZerotier->serializeToConfig();
Config::getInstance()->save();
$result["result"] = "deleted";
} else {
$result["result"] = "not found";
}
}
}
return $result;
}
public function toggleNetworkAction($uuid)
{
$result = array("result" => "failed");
if ($this->request->isPost()) {
$mdlZerotier = $this->getModel();
if ($uuid != null) {
$node = $mdlZerotier->getNodeByReference('networks.network.' . $uuid);
if ($node != null) {
$networkId = $node->networkId;
if ($node->enabled->__toString() == "1") {
$node->enabled = "0";
$result['result'] = $this->toggleZerotierNetwork($networkId, 0);
} else {
$node->enabled = "1";
$result['result'] = $this->toggleZerotierNetwork($networkId, 1);
}
$mdlZerotier->serializeToConfig();
Config::getInstance()->save();
}
}
}
return $result;
}
public function reconfigureZerotierAction()
{
if ($this->request->isPost()) {
$this->sessionClose();
$backend = new Backend();
$backend->configdRun("template reload OPNsense/zerotier");
$mdlZerotier = $this->getModel();
$action = 'stop';
foreach ($mdlZerotier->networks->network->__items as $network) {
if ($network->enabled == '1') {
$action = 'restart';
break;
}
}
$result = trim($backend->configdRun("zerotier $action"));
return array("status" => $result);
} else {
return array("status" => "failed");
}
}
public function statusAction()
{
$mdlZerotier = $this->getModel();
$enabled = false;
foreach ($mdlZerotier->networks->network->__items as $network) {
if ($network->enabled == '1') {
$enabled = true;
break;
}
}
$backend = new Backend();
$response = $backend->configdRun('zerotier status');
if (strpos($response, "not running") > 0) {
if ($enabled) {
$status = "stopped";
} else {
$status = "disabled";
}
} elseif (strpos($response, "is running") > 0) {
$status = "running";
} elseif (!$enabled) {
$status = "disabled";
} else {
$status = "unkown";
}
return array("status" => $status);
}
private function toggleZerotierNetwork($networkId, $enabled)
{
$backend = new Backend();
$action = $enabled ? 'join' : 'leave';
return trim($backend->configdRun("zerotier $action $networkId"));
}
}

40
net/zerotier/src/opnsense/mvc/app/controllers/OPNsense/Zerotier/IndexController.php Normal file
View file

@ -0,0 +1,40 @@
<?php
/**
* Copyright (C) 2017 David Harrigan
* Copyright (C) 2017 Deciso B.V.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
namespace OPNsense\Zerotier;
class IndexController extends \OPNsense\Base\IndexController
{
public function indexAction()
{
$this->view->title = "VPN: Zerotier";
$this->view->pick('OPNsense/Zerotier/index');
$this->view->formDialogNetwork = $this->getForm("dialogNetwork");
}
}

14
net/zerotier/src/opnsense/mvc/app/controllers/OPNsense/Zerotier/forms/dialogNetwork.xml Normal file
View file

@ -0,0 +1,14 @@
<form>
<field>
<id>network.networkId</id>
<label>Network ID</label>
<type>text</type>
<help>Zerotier Network ID e.g., 161411d4f6abe4a7</help>
</field>
<field>
<id>network.description</id>
<label>Description</label>
<type>text</type>
<help>Description to help identify this network</help>
</field>
</form>

9
net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/ACL/ACL.xml Normal file
View file

@ -0,0 +1,9 @@
<acl>
<page-vpn-zerotier>
<name>VPN: Zerotier</name>
<patterns>
<pattern>ui/zerotier/*</pattern>
<pattern>api/zerotier/*</pattern>
</patterns>
</page-vpn-zerotier>
</acl>

5
net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Menu/Menu.xml Normal file
View file

@ -0,0 +1,5 @@
<menu>
<VPN>
<Zerotier order="30" VisibleName="Zerotier" cssClass="fa fa-lock fa-fw" url="/ui/zerotier/"/>
</VPN>
</menu>

37
net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.php Normal file
View file

@ -0,0 +1,37 @@
<?php
/**
* Copyright (C) 2017 David Harrigan
* Copyright (C) 2017 Deciso B.V.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
namespace OPNsense\Zerotier;
use OPNsense\Base\BaseModel;
class Zerotier extends BaseModel
{
}

24
net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.xml Normal file
View file

@ -0,0 +1,24 @@
<model>
<mount>//OPNsense/zerotier</mount>
<description>
Zerotier - Virtual Networks That Just Work.
</description>
<items>
<networks>
<network type="ArrayField">
<enabled type="BooleanField">
<default>0</default>
<Required>Y</Required>
</enabled>
<networkId type="TextField">
<default></default>
<Required>Y</Required>
</networkId>
<description type="TextField">
<default></default>
<Required>N</Required>
</description>
</network>
</networks>
</items>
</model>

105
net/zerotier/src/opnsense/mvc/app/views/OPNsense/Zerotier/index.volt Normal file
View file

@ -0,0 +1,105 @@
{#
OPNsense® is Copyright © 2014 – 2017 by Deciso B.V.
Copyright (C) 2017 David Harrigan
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
#}
<script type="text/javascript">
$(document).ready(function() {
$("#grid-networks").UIBootgrid(
{
search: '/api/zerotier/zerotier/searchNetwork',
get:'/api/zerotier/zerotier/getNetwork/',
set:'/api/zerotier/zerotier/setNetwork/',
add:'/api/zerotier/zerotier/addNetwork/',
del:'/api/zerotier/zerotier/delNetwork/',
toggle:'/api/zerotier/zerotier/toggleNetwork/'
}
);
ajaxCall(url="/api/zerotier/zerotier/status", sendData={}, callback=function(data,status) {
updateServiceStatusUI(data['status']);
});
$("#reconfigureZerotier").click(function() {
$("#reconfigureZerotierProgress").addClass("fa fa-spinner fa-pulse");
ajaxCall(url="/api/zerotier/zerotier/reconfigureZerotier", sendData={}, callback=function(data, status) {
ajaxCall(url="/api/zerotier/zerotier/status", sendData={}, callback=function(data,status) {
updateServiceStatusUI(data['status']);
});
$("#reconfigureZerotierProgress").removeClass("fa fa-spinner fa-pulse");
if (status != "success" || data['status'] != 'OK') {
BootstrapDialog.show({
type: BootstrapDialog.TYPE_WARNING,
title: "{{ lang._('Error reconfiguring Zerotier') }}",
message: data['status'],
draggable: true
});
}
});
});
});
</script>
<ul class="nav nav-tabs" data-tabs="tabs" id="maintabs">
<li class="active"><a data-toggle="tab" href="#networks">{{ lang._('Networks') }}</a></li>
</ul>
<div class="tab-content content-box tab-content">
<div id="networks" class="tab-pane fade in active">
<table id="grid-networks" class="table table-condensed table-hover table-striped table-responsive" data-editDialog="dialogNetwork">
<thead>
<tr>
<th data-column-id="enabled" data-width="6em" data-type="string" data-formatter="rowtoggle">{{ lang._('Enabled') }}</th>
<th data-column-id="networkId" data-type="string" data-visible="true">{{ lang._('Network Id') }}</th>
<th data-column-id="description" data-width="7em" data-type="string" data-visible="true">{{ lang._('Description') }}</th>
<th data-column-id="uuid" data-type="string" data-identifier="true" data-visible="false">{{ lang._('ID') }}</th>
</tr>
</thead>
<tbody>
</tbody>
<tfoot>
<tr>
<td></td>
<td>
<button data-action="add" type="button" class="btn btn-xs btn-default"><span class="fa fa-plus"></span></button>
<button data-action="deleteSelected" type="button" class="btn btn-xs btn-default"><span class="fa fa-trash-o"></span></button>
</td>
</tr>
</tfoot>
</table>
</div>
<div class="col-md-12">
<hr/>
<button class="btn btn-primary" id="reconfigureZerotier" type="button"><b>{{ lang._('Apply') }}</b> <i id="reconfigureZerotierProgress" class=""></i></button>
<br/><br/>
</div>
</div>
{{ partial("layout_partials/base_dialog",['fields':formDialogNetwork,'id':'dialogNetwork','label':lang._('Edit Zerotier Network')]) }}

35
net/zerotier/src/opnsense/service/conf/actions.d/actions_zerotier.conf Normal file
View file

@ -0,0 +1,35 @@
[start]
command:/usr/local/etc/rc.d/zerotier start
parameters:
type:script
message:Starting Zerotier Service
[stop]
command:/usr/local/etc/rc.d/zerotier stop
parameters:
type:script
message:Stopping Zerotier Service
[restart]
command:/usr/local/etc/rc.d/zerotier restart
parameters:
type:script
message:Restarting Zerotier Service
[status]
command:/usr/local/etc/rc.d/zerotier status;exit 0
parameters:
type:script_output
message:Probing Zerotier Service
[join]
command:/usr/local/bin/zerotier-cli
parameters: join %s
type:script_output
message:Joining Zerotier Network
[leave]
command:/usr/local/bin/zerotier-cli
parameters: leave %s
type:script_output
message:Leaving Zerotier Network

1
net/zerotier/src/opnsense/service/templates/OPNsense/zerotier/+TARGETS Normal file
View file

@ -0,0 +1 @@
zerotier:/etc/rc.conf.d/zerotier

11
net/zerotier/src/opnsense/service/templates/OPNsense/zerotier/zerotier Normal file
View file

@ -0,0 +1,11 @@
{% set networks = [] %}
{% for network in helpers.toList('OPNsense.zerotier.networks.network') %}
{% if network.enabled == '1' %}
{% do networks.append(network) %}
{% endif %}
{% endfor %}
{% if networks|length > 0 %}
zerotier_enable="YES"
{% else %}
zerotier_enable="NO"
{% endif %}