mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-11 09:04:54 +00:00
6bf4eb1483
Signed-off-by: James Valleroy <jvalleroy@mailbox.org> Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
127 lines
3.8 KiB
Python
127 lines
3.8 KiB
Python
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""
|
|
Plinth module to configure Shadowsocks.
|
|
"""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import action_utils
|
|
from plinth import frontpage
|
|
from plinth import service as service_module
|
|
from plinth.menu import main_menu
|
|
|
|
|
|
version = 1
|
|
|
|
name = _('Shadowsocks')
|
|
|
|
short_description = _('Socks5 Proxy')
|
|
|
|
service = None
|
|
|
|
managed_services = ['shadowsocks-libev-local@freedombox']
|
|
|
|
managed_packages = ['shadowsocks-libev']
|
|
|
|
description = [
|
|
_('Shadowsocks is a lightweight and secure socks5 proxy, designed to '
|
|
'protect your Internet traffic. It can be used to bypass Internet '
|
|
'filtering and censorship.'),
|
|
_('Your FreedomBox can run a Shadowsocks client, that can connect '
|
|
'to a Shadowsocks server. The FreedomBox will also run a socks5 '
|
|
'server. Local devices can connect to the socks5 server, and '
|
|
'their data will be encrypted and proxied through the Shadowsocks '
|
|
'server.'),
|
|
]
|
|
|
|
|
|
def init():
|
|
"""Intialize the module."""
|
|
menu = main_menu.get('apps')
|
|
menu.add_urlname(name, 'glyphicon-send', 'shadowsocks:index',
|
|
short_description)
|
|
|
|
global service
|
|
setup_helper = globals()['setup_helper']
|
|
if setup_helper.get_state() != 'needs-setup':
|
|
service = service_module.Service(
|
|
'shadowsocks', name,
|
|
ports=['shadowsocks-local-plinth'], is_external=False,
|
|
is_enabled=is_enabled, is_running=is_running,
|
|
enable=enable, disable=disable)
|
|
|
|
if service.is_enabled():
|
|
add_shortcut()
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.install(managed_packages)
|
|
helper.call('post', actions.superuser_run, 'shadowsocks', ['setup'])
|
|
global service
|
|
if service is None:
|
|
service = service_module.Service(
|
|
'shadowsocks', name,
|
|
ports=['shadowsocks-local-plinth'], is_external=False,
|
|
is_enabled=is_enabled, is_running=is_running,
|
|
enable=enable, disable=disable)
|
|
|
|
|
|
def add_shortcut():
|
|
"""Helper method to add a shortcut to the frontpage."""
|
|
frontpage.add_shortcut('shadowsocks', name,
|
|
short_description=short_description,
|
|
details=description,
|
|
configure_url=reverse_lazy('shadowsocks:index'),
|
|
login_required=False)
|
|
|
|
|
|
def is_enabled():
|
|
"""Return whether service is enabled."""
|
|
return action_utils.service_is_enabled(managed_services[0])
|
|
|
|
|
|
def is_running():
|
|
"""Return whether service is running."""
|
|
return action_utils.service_is_running(managed_services[0])
|
|
|
|
|
|
def enable():
|
|
"""Enable service."""
|
|
actions.superuser_run('shadowsocks', ['enable'])
|
|
add_shortcut()
|
|
|
|
|
|
def disable():
|
|
"""Disable service."""
|
|
actions.superuser_run('shadowsocks', ['disable'])
|
|
frontpage.remove_shortcut('shadowsocks')
|
|
|
|
|
|
def diagnose():
|
|
"""Run diagnostics and return the results."""
|
|
results = []
|
|
|
|
results.append(action_utils.diagnose_port_listening(1080, 'tcp4'))
|
|
results.append(action_utils.diagnose_port_listening(1080, 'tcp6'))
|
|
|
|
return results
|