mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-11 08:23:49 +00:00
956530ab8a
Certificate can be setup for a single domain at a time in Mumble. So, allow the user to choose the domain purely for this propose even though Mumble can work with multiple domains. Tell Let's Encrypt to work with this domain. Tests: - Without Mumble installed, change the domain name. Notice the mumble related certificate events are ignored. - Install Mumble, a TLS domain is automatically selected. Certificate is setup for that domain. - Ensure at least two domains are setup in the system. See the list in the Mumble app page. Choose a non-default domain. Domain should change and cert should be setup for that domain. - Go to config app and change the domain. Mumble domain should get set to a different domain and cert should get updated. - Install mumble without these changes. Apply the changes and start FreedomBox. Mumble app should get upgraded and certificate should get setup for a domain. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
133 lines
4.3 KiB
Python
133 lines
4.3 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app to configure Mumble server.
|
|
"""
|
|
|
|
import pathlib
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import frontpage, menu
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules import names
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.letsencrypt.components import LetsEncrypt
|
|
from plinth.modules.users.components import UsersAndGroups
|
|
|
|
from .manifest import backup, clients # noqa, pylint: disable=unused-import
|
|
|
|
version = 2
|
|
|
|
managed_services = ['mumble-server']
|
|
|
|
managed_packages = ['mumble-server']
|
|
|
|
managed_paths = [pathlib.Path('/var/lib/mumble-server')]
|
|
|
|
_description = [
|
|
_('Mumble is an open source, low-latency, encrypted, high quality '
|
|
'voice chat software.'),
|
|
_('You can connect to your Mumble server on the regular Mumble port '
|
|
'64738. <a href="http://mumble.info">Clients</a> to connect to Mumble '
|
|
'from your desktop and Android devices are available.')
|
|
]
|
|
|
|
app = None
|
|
|
|
|
|
class MumbleApp(app_module.App):
|
|
"""FreedomBox app for Mumble."""
|
|
|
|
app_id = 'mumble'
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
info = app_module.Info(app_id=self.app_id, version=version,
|
|
name=_('Mumble'), icon_filename='mumble',
|
|
short_description=_('Voice Chat'),
|
|
description=_description, manual_page='Mumble',
|
|
clients=clients)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-mumble', info.name, info.short_description,
|
|
'mumble', 'mumble:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-mumble', info.name,
|
|
short_description=info.short_description, icon=info.icon_filename,
|
|
description=info.description,
|
|
configure_url=reverse_lazy('mumble:index'), clients=info.clients)
|
|
self.add(shortcut)
|
|
|
|
firewall = Firewall('firewall-mumble', info.name,
|
|
ports=['mumble-plinth'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
letsencrypt = LetsEncrypt(
|
|
'letsencrypt-mumble', domains=get_domains,
|
|
daemons=managed_services, should_copy_certificates=True,
|
|
private_key_path='/var/lib/mumble-server/privkey.pem',
|
|
certificate_path='/var/lib/mumble-server/fullchain.pem',
|
|
user_owner='mumble-server', group_owner='mumble-server',
|
|
managing_app='mumble')
|
|
self.add(letsencrypt)
|
|
|
|
daemon = Daemon(
|
|
'daemon-mumble', managed_services[0],
|
|
listen_ports=[(64738, 'tcp4'), (64738, 'tcp6'), (64738, 'udp4'),
|
|
(64738, 'udp6')])
|
|
self.add(daemon)
|
|
|
|
users_and_groups = UsersAndGroups('users-and-groups-mumble',
|
|
reserved_usernames=['mumble-server'])
|
|
self.add(users_and_groups)
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.install(managed_packages)
|
|
helper.call('post', actions.superuser_run, 'mumble', ['setup'])
|
|
if not old_version:
|
|
helper.call('post', app.enable)
|
|
|
|
app.get_component('letsencrypt-mumble').setup_certificates()
|
|
|
|
|
|
def get_available_domains():
|
|
"""Return an iterator with all domains able to have a certificate."""
|
|
return (domain.name for domain in names.components.DomainName.list()
|
|
if domain.domain_type.can_have_certificate)
|
|
|
|
|
|
def set_domain(domain):
|
|
"""Set the TLS domain by writing a file to data directory."""
|
|
if domain:
|
|
actions.superuser_run('mumble', ['set-domain', domain])
|
|
|
|
|
|
def get_domain():
|
|
"""Read TLS domain from config file select first available if none."""
|
|
domain = actions.superuser_run('mumble', ['get-domain']).strip()
|
|
if not domain:
|
|
domain = next(get_available_domains(), None)
|
|
set_domain(domain)
|
|
|
|
return domain
|
|
|
|
|
|
def get_domains():
|
|
"""Return a list with the configured domains."""
|
|
if not pathlib.Path('/var/lib/mumble-server/').exists():
|
|
return []
|
|
|
|
domain = get_domain()
|
|
if domain:
|
|
return [domain]
|
|
|
|
return []
|