mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
When a hostname is set or changed, expose <hostname>.local as a domain. With this, daemons can configure themselves to work properly with .local domains. Cockpit is an example of a daemon that can be configured to allow connections from .local domains Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
128 lines
4.2 KiB
Python
128 lines
4.2 KiB
Python
#
|
|
# This file is part of FreedomBox.
|
|
#
|
|
# 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/>.
|
|
#
|
|
"""
|
|
FreedomBox app for service discovery.
|
|
"""
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import cfg, menu
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules.config import get_hostname
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.names.components import DomainType
|
|
from plinth.signals import domain_added, domain_removed, post_hostname_change
|
|
from plinth.utils import format_lazy
|
|
from plinth.views import AppView
|
|
|
|
from .manifest import backup # noqa, pylint: disable=unused-import
|
|
|
|
# pylint: disable=C0103
|
|
|
|
version = 1
|
|
|
|
is_essential = True
|
|
|
|
managed_services = ['avahi-daemon']
|
|
|
|
managed_packages = ['avahi-daemon', 'avahi-utils']
|
|
|
|
name = _('Service Discovery')
|
|
|
|
description = [
|
|
format_lazy(
|
|
_('Service discovery allows other devices on the network to '
|
|
'discover your {box_name} and services running on it. It '
|
|
'also allows {box_name} to discover other devices and '
|
|
'services running on your local network. Service discovery is '
|
|
'not essential and works only on internal networks. It may be '
|
|
'disabled to improve security especially when connecting to a '
|
|
'hostile local network.'), box_name=_(cfg.box_name))
|
|
]
|
|
|
|
manual_page = 'ServiceDiscovery'
|
|
|
|
app = None
|
|
|
|
|
|
class AvahiApp(app_module.App):
|
|
"""FreedomBox app for Avahi."""
|
|
|
|
app_id = 'avahi'
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
menu_item = menu.Menu('menu-avahi', name, None, 'fa-compass',
|
|
'avahi:index', parent_url_name='system')
|
|
self.add(menu_item)
|
|
|
|
domain_type = DomainType('domain-type-local',
|
|
_('Local Network Domain'), 'config:index',
|
|
can_have_certificate=False)
|
|
self.add(domain_type)
|
|
|
|
firewall = Firewall('firewall-avahi', name, ports=['mdns'],
|
|
is_external=False)
|
|
self.add(firewall)
|
|
|
|
daemon = Daemon('daemon-avahi', managed_services[0])
|
|
self.add(daemon)
|
|
|
|
|
|
def init():
|
|
"""Initialize the service discovery module."""
|
|
global app
|
|
app = AvahiApp()
|
|
if app.is_enabled():
|
|
domain_added.send_robust(
|
|
sender='avahi', domain_type='domain-type-local',
|
|
name=get_hostname() + '.local', services='__all__')
|
|
app.set_enabled(True)
|
|
|
|
post_hostname_change.connect(on_post_hostname_change)
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.install(managed_packages)
|
|
# Reload avahi-daemon now that first-run does not reboot. After performing
|
|
# FreedomBox Service (Plinth) package installation, new Avahi files will be
|
|
# available and require restart.
|
|
helper.call('post', actions.superuser_run, 'service',
|
|
['reload', 'avahi-daemon'])
|
|
|
|
|
|
def on_post_hostname_change(sender, old_hostname, new_hostname, **kwargs):
|
|
"""Update .local domain after hostname change."""
|
|
del sender # Unused
|
|
del kwargs # Unused
|
|
|
|
domain_removed.send_robust(sender='avahi', domain_type='domain-type-local',
|
|
name=old_hostname + '.local')
|
|
domain_added.send_robust(sender='avahi', domain_type='domain-type-local',
|
|
name=new_hostname + '.local', services='__all__')
|
|
|
|
|
|
class AvahiAppView(AppView):
|
|
app_id = 'avahi'
|
|
name = name
|
|
description = description
|
|
manual_page = manual_page
|