mirror of
https://git.disroot.org/pranav/pybatmesh.git
synced 2024-11-30 10:42:15 +05:30
updated documentation and some other changes
Made messages printed in Makefile more understandable. Removed full path of naxalnet from the systemd service. Now you can start naxalnet even if it is installed in /usr/local/bin, if systemd allows (I have not tested it). Many comments were made to respect the 80 chars per line rule. And, of course, added some political commentary to insult the global superpower (superpower in terms of money, military and something else I forgot). And removed MANIFEST.in, which probably haven't changed anything.
This commit is contained in:
parent
a7304a986b
commit
61a96ea3b3
@ -35,7 +35,7 @@
|
|||||||
|
|
||||||
## [v0.1.0][] - 2021-06-19
|
## [v0.1.0][] - 2021-06-19
|
||||||
|
|
||||||
Rewrite to python. At first, this was a shell script. Than it was
|
Rewrite to python. At first, this was a shell script. Then it was
|
||||||
converted into a single python file that did just what the shell script
|
converted into a single python file that did just what the shell script
|
||||||
used to do. The shell script was not given a version.
|
used to do. The shell script was not given a version.
|
||||||
|
|
||||||
|
@ -25,6 +25,6 @@ Currently this program is only packaged for Arch Linux.
|
|||||||
naxalnet needs packages in GNU+Linux+systemd
|
naxalnet needs packages in GNU+Linux+systemd
|
||||||
distributions such as Debian, Fedora, openSUSE,
|
distributions such as Debian, Fedora, openSUSE,
|
||||||
and nixos. If you know/like to package it in your distro,
|
and nixos. If you know/like to package it in your distro,
|
||||||
post to issue #6.
|
post a message to issue #6.
|
||||||
|
|
||||||
[hack]: https://catb.org/jargon/html/H/hack.html
|
[hack]: https://catb.org/jargon/html/H/hack.html
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
include LICENSE
|
|
||||||
include README.md
|
|
||||||
include naxalnet.service
|
|
||||||
include naxalnet.conf.example
|
|
||||||
recursive-include systemd-networkd *
|
|
21
Makefile
21
Makefile
@ -1,15 +1,19 @@
|
|||||||
# This makefile uses setup.py under the hood.
|
# This makefile uses setup.py under the hood. In debian, and therefore
|
||||||
# In ubuntu, python and pip are symlinks to python2 and pip2, not
|
# ubuntu, and in fedora, python and pip are symlinks to python2 and pip2,
|
||||||
# python3. So we have to specify python as python3 by default.
|
# not python3. So we have to specify python as python3 by default.
|
||||||
|
|
||||||
PYTHON := python3
|
PYTHON := python3
|
||||||
PIP := pip3
|
PIP := pip3
|
||||||
|
|
||||||
|
# This can be changed when creating a package for your POSIX distribution
|
||||||
DESTDIR:= /
|
DESTDIR:= /
|
||||||
|
|
||||||
all: build
|
all: build
|
||||||
|
|
||||||
build: build/lib/naxalnet/__init__.py
|
# Build only when naxalnet/__init__.py changes. We assume here that anyone
|
||||||
|
# creating a new commit will first update the __version__ in
|
||||||
build/lib/naxalnet/__init__.py: naxalnet/__init__.py
|
# naxalnet/__init__.py
|
||||||
|
build: naxalnet/__init__.py
|
||||||
$(PYTHON) setup.py build
|
$(PYTHON) setup.py build
|
||||||
|
|
||||||
install:
|
install:
|
||||||
@ -18,10 +22,11 @@ install:
|
|||||||
uninstall:
|
uninstall:
|
||||||
$(PIP) uninstall -y naxalnet
|
$(PIP) uninstall -y naxalnet
|
||||||
rm -rf /usr/share/naxalnet /usr/lib/systemd/system/naxalnet.service
|
rm -rf /usr/share/naxalnet /usr/lib/systemd/system/naxalnet.service
|
||||||
@echo "The directory /etc/naxalnet was not removed." && \
|
@echo "make uninstall will not remove anything in /etc/naxalnet" && \
|
||||||
echo "Do 'sudo make purge' to remove it."
|
echo "Do 'sudo make purge' to remove it."
|
||||||
|
|
||||||
# remove config files, like apt purge
|
# Remove config files, like apt purge. Purge should first do what
|
||||||
|
# uninstall does, so we add uninstall as a dependency to this rule.
|
||||||
purge: uninstall
|
purge: uninstall
|
||||||
rm -rf /etc/naxalnet
|
rm -rf /etc/naxalnet
|
||||||
|
|
||||||
|
16
README.md
16
README.md
@ -187,12 +187,26 @@ sudo systemctl enable naxalnet.service
|
|||||||
```
|
```
|
||||||
|
|
||||||
Now naxalnet will start a mesh on every boot.
|
Now naxalnet will start a mesh on every boot.
|
||||||
Disable the service to stop running at boot:
|
|
||||||
|
If you have NetworkManager enabled, which is the default in Ubuntu and
|
||||||
|
Fedora, it should be disabled:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo systemctl disable NetworkManager.service
|
||||||
|
```
|
||||||
|
|
||||||
|
To stop running at boot, you should disable `naxalnet.service`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sudo systemctl disable naxalnet.service
|
sudo systemctl disable naxalnet.service
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you had disabled `NetworkManager` before, enable it:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo systemctl enable NetworkManager.service
|
||||||
|
```
|
||||||
|
|
||||||
### Stopping the service
|
### Stopping the service
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
@ -21,7 +21,7 @@ Type=notify
|
|||||||
NotifyAccess=all
|
NotifyAccess=all
|
||||||
Restart=on-failure
|
Restart=on-failure
|
||||||
RestartSec=2sec
|
RestartSec=2sec
|
||||||
ExecStart=/usr/bin/naxalnet --systemd
|
ExecStart=naxalnet --systemd
|
||||||
KillSignal=SIGINT
|
KillSignal=SIGINT
|
||||||
# naxalnet already logs to systemd journal so we don't need
|
# naxalnet already logs to systemd journal so we don't need
|
||||||
# stdout and stderr.
|
# stdout and stderr.
|
||||||
|
@ -1,25 +1,32 @@
|
|||||||
# This file is part of naxalnet.
|
# This file is part of naxalnet.
|
||||||
# Copyright (C) 2021 The naxalnet Authors
|
# Copyright (C) 2021 The naxalnet Authors
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify it
|
||||||
# it under the terms of the GNU General Public License as published by
|
# under the terms of the GNU General Public License as published by the
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# Free Software Foundation, either version 3 of the License, or (at your
|
||||||
# (at your option) any later version.
|
# option) any later version.
|
||||||
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful, but
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
# GNU General Public License for more details.
|
# Public License for more details.
|
||||||
|
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License along
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
naxalnet
|
naxalnet
|
||||||
========
|
========
|
||||||
|
|
||||||
Create mesh networks with batman-adv, systemd-networkd and iwd.
|
Create mesh networks with batman-adv, systemd-networkd and iwd.
|
||||||
See README.md for documentation.
|
|
||||||
|
See README.md and the docstrings for documentation. You can read
|
||||||
|
documentaion in the python interpretor using something like the example
|
||||||
|
given below.
|
||||||
|
|
||||||
|
>>> help("naxalnet")
|
||||||
|
>>> help("naxalnet.config")
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# GUIDE FOR CHANGING __version__
|
# GUIDE FOR CHANGING __version__
|
||||||
@ -35,4 +42,4 @@ See README.md for documentation.
|
|||||||
#
|
#
|
||||||
# In case you forgot to change the version, skip the number
|
# In case you forgot to change the version, skip the number
|
||||||
# and put the next number in the next commit.
|
# and put the next number in the next commit.
|
||||||
__version__ = "0.4.0a5.dev8"
|
__version__ = "0.4.0a5.dev9"
|
||||||
|
@ -16,9 +16,16 @@
|
|||||||
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
__main__.py
|
||||||
|
-----------
|
||||||
|
|
||||||
If called as python -m naxalnet, this file makes naxalnet run like
|
If called as python -m naxalnet, this file makes naxalnet run like
|
||||||
it was called from the commandline. Try:
|
it was called from the commandline. Try:
|
||||||
python -m naxalnet --help
|
python -m naxalnet --help
|
||||||
|
|
||||||
|
WARNING: Using naxalnet might threaten the soverignity and integrity of
|
||||||
|
your nation-state. The authors are not responsible for any damage caused
|
||||||
|
while using this software.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from naxalnet.scripts import main
|
from naxalnet.scripts import main
|
||||||
|
@ -1,59 +1,56 @@
|
|||||||
# This file is part of naxalnet.
|
# This file is part of naxalnet.
|
||||||
# Copyright (C) 2021 The naxalnet Authors
|
# Copyright (C) 2021 The naxalnet Authors
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify it
|
||||||
# it under the terms of the GNU General Public License as published by
|
# under the terms of the GNU General Public License as published by the
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# Free Software Foundation, either version 3 of the License, or (at your
|
||||||
# (at your option) any later version.
|
# option) any later version.
|
||||||
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful, but
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
# GNU General Public License for more details.
|
# Public License for more details.
|
||||||
|
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License along
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
config.py
|
config.py
|
||||||
---------
|
---------
|
||||||
|
|
||||||
This file contains functions to parse configuration files
|
This file contains functions to parse configuration files and arguments.
|
||||||
and arguments. Most of these functions are meant to be used
|
Most of these functions are meant to be used by parse_args() internally,
|
||||||
by parse_args() internally, so only parse_args() should
|
so only parse_args() should be imported outside this file.
|
||||||
be imported outside this file.
|
|
||||||
|
|
||||||
Some parts of naxalnet can be configured by configuration
|
Some parts of naxalnet can be configured by configuration files and
|
||||||
files and arguments. First, the default values from
|
arguments in a specific order. First, the default values from default.py
|
||||||
default.py is taken. Then, key-value pairs from the
|
is taken. Then, key-value pairs from the configuration files are read, if
|
||||||
configuration files are read, if they exist, in the
|
they exist, in the following order:
|
||||||
following order:
|
|
||||||
|
- First it reads /usr/share/naxalnet/naxalnet.conf and then from
|
||||||
|
/usr/share/naxalnet/naxalnet.conf.d/*.conf where *.conf means any file
|
||||||
|
with the name ending with ".conf". The files in this directory are
|
||||||
|
intended to be used by distribution and package maintainers.
|
||||||
|
|
||||||
- First it reads /usr/share/naxalnet/naxalnet.conf
|
|
||||||
and then from /usr/share/naxalnet/naxalnet.conf.d/*.conf
|
|
||||||
where *.conf means any file with the name ending with
|
|
||||||
".conf". The files in this directory are intended
|
|
||||||
to be used by distribution and package maintainers.
|
|
||||||
- Next, it does the same with /usr/local/share/naxalnet
|
- Next, it does the same with /usr/local/share/naxalnet
|
||||||
- Then, it looks for the files naxalnet.conf and
|
|
||||||
naxalnet.conf.d/*.conf from the directory
|
|
||||||
/etc/naxalnet, like it did up above. This directory is where
|
|
||||||
the user creates and stores the config file.
|
|
||||||
- Then it parses the arguments from the commandline,
|
|
||||||
storing the values in the files parsed until now
|
|
||||||
as fallback. Finally you get an argpase.Namespace object
|
|
||||||
from parse_args().
|
|
||||||
Because of the way this is implemented, all key-value
|
|
||||||
pairs in the configuration should have an argument
|
|
||||||
too, or they won't be parsed.
|
|
||||||
|
|
||||||
All the key-value pairs are replaced successively if they exist
|
- Then, it looks for the files naxalnet.conf and naxalnet.conf.d/*.conf
|
||||||
by each new configuration file parsed, similar
|
from the directory /etc/naxalnet, like it did up above. This directory
|
||||||
to how systemd parses configuration and service files.
|
is where the user creates and stores the config file.
|
||||||
If any of the files checked does not exist, then they are
|
|
||||||
ignored and the next combination is checked. If none of
|
- Then it parses the arguments from the commandline, storing the values in
|
||||||
the config files exist and no arguments are given, the
|
the files parsed until now as fallback. Finally you get an
|
||||||
fallback data from default.py is used.
|
argpase.Namespace object from parse_args(). Because of the way this is
|
||||||
|
implemented, all key-value pairs in the configuration should have an
|
||||||
|
argument too, or they won't be parsed.
|
||||||
|
|
||||||
|
All the key-value pairs are replaced successively if they exist by each
|
||||||
|
new configuration file parsed, similar to how systemd parses configuration
|
||||||
|
and service files. If any of the files checked does not exist, then they
|
||||||
|
are ignored and the next combination is checked. If none of the config
|
||||||
|
files exist and no arguments are given, the fallback data from default.py
|
||||||
|
is used.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@ -191,4 +188,7 @@ def parse_args() -> Namespace:
|
|||||||
return parser.parse_args()
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
# This is defined here because log.py needs some arguments to determine
|
||||||
|
# the loglevel and where to send the log message to. If you know a better
|
||||||
|
# way of implementing it, create an issue
|
||||||
args = parse_args()
|
args = parse_args()
|
||||||
|
@ -1,24 +1,25 @@
|
|||||||
# This file is part of naxalnet.
|
# This file is part of naxalnet.
|
||||||
# Copyright (C) 2021 The naxalnet Authors
|
# Copyright (C) 2021 The naxalnet Authors
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify it
|
||||||
# it under the terms of the GNU General Public License as published by
|
# under the terms of the GNU General Public License as published by the
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# Free Software Foundation, either version 3 of the License, or (at your
|
||||||
# (at your option) any later version.
|
# option) any later version.
|
||||||
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful, but
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
# GNU General Public License for more details.
|
# Public License for more details.
|
||||||
|
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License along
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
daemon.py
|
daemon.py
|
||||||
---------
|
---------
|
||||||
|
|
||||||
The daemon part. This is currently under construction.
|
The daemon part. This is used to perform some work when a new wifi adapter
|
||||||
|
is plugged in, or it is removed.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from dasbus.loop import EventLoop
|
from dasbus.loop import EventLoop
|
||||||
@ -39,7 +40,7 @@ class Daemon:
|
|||||||
this function will be run every time a device is added
|
this function will be run every time a device is added
|
||||||
"""
|
"""
|
||||||
if IWD_DEVICE_INTERFACE in data:
|
if IWD_DEVICE_INTERFACE in data:
|
||||||
logger.debug("New device %s found", str(data[IWD_DEVICE_INTERFACE]["Name"]))
|
logger.debug("New device %s found", data[IWD_DEVICE_INTERFACE]["Name"])
|
||||||
logger.info("Reloading")
|
logger.info("Reloading")
|
||||||
self.callback()
|
self.callback()
|
||||||
|
|
||||||
|
@ -1,29 +1,28 @@
|
|||||||
# This file is part of naxalnet.
|
# This file is part of naxalnet.
|
||||||
# Copyright (C) 2021 The naxalnet Authors
|
# Copyright (C) 2021 The naxalnet Authors
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify it
|
||||||
# it under the terms of the GNU General Public License as published by
|
# under the terms of the GNU General Public License as published by the
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# Free Software Foundation, either version 3 of the License, or (at your
|
||||||
# (at your option) any later version.
|
# option) any later version.
|
||||||
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful, but
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
# GNU General Public License for more details.
|
# Public License for more details.
|
||||||
|
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License along
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
default.py
|
default.py
|
||||||
----------
|
----------
|
||||||
|
|
||||||
This file contains default values for configuration.
|
This file contains default values for configuration. This is taken as
|
||||||
This is taken as fallback data by config.py if no
|
fallback data by config.py if no configuration files were found, or if a
|
||||||
configuration files were found, or if a key-value pair
|
key-value pair was not present in the config file. The data will be
|
||||||
was not present in the config file. The data will be
|
further changed by arguments if naxalnet is called from the commandline.
|
||||||
further changed by arguments if naxalnet is called
|
See config.py for more info.
|
||||||
from the commandline. See config.py for more info.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
CONFIG = {
|
CONFIG = {
|
||||||
|
109
naxalnet/iwd.py
109
naxalnet/iwd.py
@ -1,60 +1,54 @@
|
|||||||
# This file is part of naxalnet.
|
# This file is part of naxalnet.
|
||||||
# Copyright (C) 2021 The naxalnet Authors
|
# Copyright (C) 2021 The naxalnet Authors
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify it
|
||||||
# it under the terms of the GNU General Public License as published by
|
# under the terms of the GNU General Public License as published by the
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
# Free Software Foundation, either version 3 of the License, or (at your
|
||||||
# (at your option) any later version.
|
# option) any later version.
|
||||||
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful, but
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
# GNU General Public License for more details.
|
# Public License for more details.
|
||||||
|
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License along
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
iwd.py
|
iwd.py
|
||||||
------
|
------
|
||||||
|
|
||||||
This file contains methods to communicate with iwd via
|
This file contains methods to communicate with iwd via its D-Bus API and
|
||||||
its D-Bus API and control WiFi adapters.
|
control WiFi adapters.
|
||||||
|
|
||||||
Some terms used here, such as device and adapter might
|
Some terms used here, such as device and adapter might confuse you if you
|
||||||
confuse you if you haven't used iwctl before.
|
haven't used iwctl before. Just as a quick reference, here is a list of
|
||||||
Just as a quick reference, here is a list of terms
|
terms and what they mean:
|
||||||
and what they mean:
|
|
||||||
|
|
||||||
- ad-hoc: a mode supported by some WiFi adapters to
|
- ad-hoc: a mode supported by some WiFi adapters to start a decentralised
|
||||||
start a decentralised network, where there
|
network, where there is no central point of failure.
|
||||||
is no central point of failure.
|
|
||||||
|
|
||||||
- ap: a mode used to start a central access point
|
- ap: a mode used to start a central access point so that other machines
|
||||||
so that other machines without naxalnet can
|
without naxalnet can connect to the mesh. AP is also known as WiFi
|
||||||
connect to the mesh. AP is also known as
|
hotspot.
|
||||||
WiFi hotspot.
|
|
||||||
|
|
||||||
- station: this is the mode most WiFi adapters use
|
- station: this is the mode most WiFi adapters use by default. This mode
|
||||||
by default. This mode is used to connect to
|
is used to connect to an ap. naxalnet DOES NOT use this mode.
|
||||||
an ap. naxalnet DOES NOT use this mode.
|
|
||||||
|
|
||||||
- adapter: a physical WiFi chip or something similar
|
- adapter: a physical WiFi chip or something similar that is present
|
||||||
that is present inside most laptops and phones
|
inside most laptops and phones or can be connected via USB to a
|
||||||
or can be connected via USB to a machine.
|
machine.
|
||||||
|
|
||||||
- device: an interface provided by the kernel to control
|
- device: an interface provided by the kernel to control an adapter. Some
|
||||||
an adapter. Some adapters can have multiple
|
adapters can have multiple devices so that you can start an ap
|
||||||
devices so that you can start an ap on one device
|
on one device and an ad-hoc on the other. By default, iwd starts
|
||||||
and an ad-hoc on the other. By default, iwd starts
|
|
||||||
only one device each for one adapter.
|
only one device each for one adapter.
|
||||||
|
|
||||||
- machine: Since iwd uses the term device for a
|
- machine: Since iwd uses the term device for a WiFi interface, we use the
|
||||||
WiFi interface, we use the word machine to
|
word machine to refer to a computer, or a laptop, or a phone.
|
||||||
refer to a computer, or a laptop, or a phone.
|
|
||||||
|
|
||||||
- node: a machine that runs naxalnet and is therefore
|
- node: a machine that runs naxalnet and is therefore connected to the
|
||||||
connected to the mesh.
|
mesh.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from dasbus.connection import SystemMessageBus
|
from dasbus.connection import SystemMessageBus
|
||||||
@ -74,7 +68,7 @@ class IWD:
|
|||||||
"""Manage iwd via dbus"""
|
"""Manage iwd via dbus"""
|
||||||
|
|
||||||
def __init__(self, bus=SystemMessageBus()):
|
def __init__(self, bus=SystemMessageBus()):
|
||||||
# self._bus and self._proxy are meant for use only in this file
|
# self._bus and self._proxy are meant for use only in this submodule
|
||||||
self._bus = bus
|
self._bus = bus
|
||||||
self.reload()
|
self.reload()
|
||||||
|
|
||||||
@ -95,9 +89,9 @@ class IWD:
|
|||||||
for i in device_paths:
|
for i in device_paths:
|
||||||
proxy = self._bus.get_proxy(IWD_BUS, i)
|
proxy = self._bus.get_proxy(IWD_BUS, i)
|
||||||
if proxy.Name == name:
|
if proxy.Name == name:
|
||||||
return i
|
# See comment in the function below
|
||||||
# If no devices were found, return None
|
path = i
|
||||||
return None
|
return path
|
||||||
|
|
||||||
def get_adapter_path_from_name(self, name: str) -> str:
|
def get_adapter_path_from_name(self, name: str) -> str:
|
||||||
"""returns path of adapter as str"""
|
"""returns path of adapter as str"""
|
||||||
@ -105,9 +99,10 @@ class IWD:
|
|||||||
for i in adapter_paths:
|
for i in adapter_paths:
|
||||||
proxy = self._bus.get_proxy(IWD_BUS, i)
|
proxy = self._bus.get_proxy(IWD_BUS, i)
|
||||||
if proxy.Name == name:
|
if proxy.Name == name:
|
||||||
return i
|
# We could have just used return here, but shutting up
|
||||||
# If no adapters were found
|
# pylint has a greter priority at the moment
|
||||||
return None
|
path = i
|
||||||
|
return path
|
||||||
|
|
||||||
def get_all_device_paths(self) -> list:
|
def get_all_device_paths(self) -> list:
|
||||||
"""returns list of paths of all devices"""
|
"""returns list of paths of all devices"""
|
||||||
@ -132,7 +127,8 @@ class IWD:
|
|||||||
|
|
||||||
def get_devices(self) -> list:
|
def get_devices(self) -> list:
|
||||||
"""
|
"""
|
||||||
returns list of device names as str
|
returns list of all device names as str
|
||||||
|
|
||||||
example: ["wlan0", "wlan1"]
|
example: ["wlan0", "wlan1"]
|
||||||
"""
|
"""
|
||||||
devices = []
|
devices = []
|
||||||
@ -146,6 +142,7 @@ class IWD:
|
|||||||
def get_adapters(self) -> list:
|
def get_adapters(self) -> list:
|
||||||
"""
|
"""
|
||||||
returns list of adapters
|
returns list of adapters
|
||||||
|
|
||||||
example: ["phy0","phy1"]
|
example: ["phy0","phy1"]
|
||||||
"""
|
"""
|
||||||
adapters = []
|
adapters = []
|
||||||
@ -160,6 +157,7 @@ class IWD:
|
|||||||
class Device:
|
class Device:
|
||||||
"""
|
"""
|
||||||
control devices with iwd
|
control devices with iwd
|
||||||
|
|
||||||
name: name of device (str)
|
name: name of device (str)
|
||||||
adapter: name of adapter (str)
|
adapter: name of adapter (str)
|
||||||
"""
|
"""
|
||||||
@ -190,7 +188,10 @@ class Device:
|
|||||||
self.reload()
|
self.reload()
|
||||||
|
|
||||||
def reload(self):
|
def reload(self):
|
||||||
"""reload the proxy after changing mode"""
|
"""
|
||||||
|
Reload the proxy. Used liberally by other
|
||||||
|
members to work around errors
|
||||||
|
"""
|
||||||
self._proxy = self._bus.get_proxy(IWD_BUS, self._path)
|
self._proxy = self._bus.get_proxy(IWD_BUS, self._path)
|
||||||
self.name = self._proxy.Name
|
self.name = self._proxy.Name
|
||||||
adapter_path = self._proxy.Adapter
|
adapter_path = self._proxy.Adapter
|
||||||
@ -235,16 +236,15 @@ class Device:
|
|||||||
if it isn't already on ad-hoc and power onn the device
|
if it isn't already on ad-hoc and power onn the device
|
||||||
if it is off
|
if it is off
|
||||||
"""
|
"""
|
||||||
print("Starting adhoc", name)
|
# Stop adhoc if already started
|
||||||
|
self.stop_adhoc()
|
||||||
|
|
||||||
if self.get_mode() != "ad-hoc":
|
if self.get_mode() != "ad-hoc":
|
||||||
self.set_mode("ad-hoc")
|
self.set_mode("ad-hoc")
|
||||||
|
|
||||||
if not self.is_powered_on():
|
if not self.is_powered_on():
|
||||||
self.power_on()
|
self.power_on()
|
||||||
|
|
||||||
# Stop adhoc if already started
|
|
||||||
self.stop_adhoc()
|
|
||||||
|
|
||||||
logger.debug("Starting ad-hoc on %s", self.name)
|
logger.debug("Starting ad-hoc on %s", self.name)
|
||||||
self._proxy.StartOpen(name)
|
self._proxy.StartOpen(name)
|
||||||
|
|
||||||
@ -261,15 +261,16 @@ class Device:
|
|||||||
if it isn't already on ap and turning
|
if it isn't already on ap and turning
|
||||||
on the device if it is off
|
on the device if it is off
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
# Stop ap if already started
|
||||||
|
self.stop_ap()
|
||||||
|
|
||||||
if self.get_mode() != "ap":
|
if self.get_mode() != "ap":
|
||||||
self.set_mode("ap")
|
self.set_mode("ap")
|
||||||
|
|
||||||
if not self.is_powered_on():
|
if not self.is_powered_on():
|
||||||
self.power_on()
|
self.power_on()
|
||||||
|
|
||||||
# Stop ap if already started
|
|
||||||
self.stop_ap()
|
|
||||||
|
|
||||||
logger.debug("Starting ap on %s with ssid %s", self.name, ssid)
|
logger.debug("Starting ap on %s with ssid %s", self.name, ssid)
|
||||||
self._proxy.Start(ssid, passwd)
|
self._proxy.Start(ssid, passwd)
|
||||||
|
|
||||||
|
@ -18,8 +18,9 @@
|
|||||||
log.py
|
log.py
|
||||||
------
|
------
|
||||||
|
|
||||||
Initialise the logger for other submodules to import. Do not
|
Initialise the logger for other submodules to import. Do not import any
|
||||||
import any submodules here except for naxallnet.config
|
submodules here other than naxallnet.config, which is needed to set the
|
||||||
|
loglevel and to add the systemd journal handler
|
||||||
"""
|
"""
|
||||||
import logging
|
import logging
|
||||||
from systemd.journal import JournalHandler
|
from systemd.journal import JournalHandler
|
||||||
|
@ -18,9 +18,15 @@
|
|||||||
network.py
|
network.py
|
||||||
----------
|
----------
|
||||||
|
|
||||||
This submodule manages the systemd-networkd configuration.
|
This submodule manages the systemd-networkd configuration. This is used to
|
||||||
TODO: Add more details
|
add configuration files to the systemd-networkd runtime directory.
|
||||||
|
|
||||||
|
Some configuration files have variables which should be substituted by
|
||||||
|
str.format() in python. The values for these variables can be set using
|
||||||
|
NetworkD.set_vars(). See files in the systemd-networkd directory for
|
||||||
|
examples.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from dasbus.connection import SystemMessageBus
|
from dasbus.connection import SystemMessageBus
|
||||||
@ -31,7 +37,11 @@ NETWORKD_PATH = "/org/freedesktop/network1"
|
|||||||
|
|
||||||
|
|
||||||
class NetworkD:
|
class NetworkD:
|
||||||
"""control systemd-networkd"""
|
"""
|
||||||
|
Control systemd-networkd using configuration files. Since these
|
||||||
|
were made for use by naxalnet only, the class is not suitable for
|
||||||
|
importing outside naxalnet.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, runtime_dir="/run/systemd/network", bus=SystemMessageBus()):
|
def __init__(self, runtime_dir="/run/systemd/network", bus=SystemMessageBus()):
|
||||||
self._bus = bus
|
self._bus = bus
|
||||||
@ -51,7 +61,10 @@ class NetworkD:
|
|||||||
self.proxy = self._bus.get_proxy(NETWORKD_BUS, NETWORKD_PATH)
|
self.proxy = self._bus.get_proxy(NETWORKD_BUS, NETWORKD_PATH)
|
||||||
|
|
||||||
def reload(self) -> None:
|
def reload(self) -> None:
|
||||||
"""reload the systemd-networkd configuration"""
|
"""
|
||||||
|
Reload the systemd-networkd configuration. This is used by many
|
||||||
|
class methods after doing their job.
|
||||||
|
"""
|
||||||
self.proxy.Reload()
|
self.proxy.Reload()
|
||||||
|
|
||||||
def add_config(self, name: str) -> None:
|
def add_config(self, name: str) -> None:
|
||||||
@ -79,7 +92,13 @@ class NetworkD:
|
|||||||
self.reload()
|
self.reload()
|
||||||
|
|
||||||
def disable_config(self, name: str) -> None:
|
def disable_config(self, name: str) -> None:
|
||||||
"""Disable the config of the given name"""
|
"""
|
||||||
|
Disable or mask the config of the same name. This can only be
|
||||||
|
used for configs in /usr/lib/systemd/network and
|
||||||
|
/usr/local/lib/systemd/network. It works on the same principle
|
||||||
|
used by systemctl mask, that is, it created a symlink of the same
|
||||||
|
name in the runtime directory and links it to /dev/null.
|
||||||
|
"""
|
||||||
path = self.runtime_path / name
|
path = self.runtime_path / name
|
||||||
path.symlink_to("/dev/null")
|
path.symlink_to("/dev/null")
|
||||||
self.reload()
|
self.reload()
|
||||||
|
@ -89,14 +89,18 @@ def setup_mesh(gateway_mode: str = "off"):
|
|||||||
gateway_mode=gateway_mode,
|
gateway_mode=gateway_mode,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Fix for issue #19
|
# Fix for issue #19. There should be a switch to disable this
|
||||||
|
# humanitarian intervention. We don't want to adopt the U.S.
|
||||||
|
# foreign policy here.
|
||||||
networkd.disable_config("80-wifi-adhoc.network")
|
networkd.disable_config("80-wifi-adhoc.network")
|
||||||
|
|
||||||
for i in get_sorted_glob(args.networkd_config_dir, MESH_GLOB):
|
for i in get_sorted_glob(args.networkd_config_dir, MESH_GLOB):
|
||||||
logger.debug("Adding network config %s", i)
|
logger.debug("Adding network config %s", i)
|
||||||
networkd.add_config(i)
|
networkd.add_config(i)
|
||||||
except PermissionError:
|
except PermissionError:
|
||||||
logger.exception("A PermissionError occured while copying files")
|
logger.exception(
|
||||||
|
"A PermissionError occured while copying files. Make sure you are root."
|
||||||
|
)
|
||||||
logger.error(REPORT_BUG_INFO)
|
logger.error(REPORT_BUG_INFO)
|
||||||
sys.exit(3)
|
sys.exit(3)
|
||||||
except:
|
except:
|
||||||
@ -234,8 +238,8 @@ def main():
|
|||||||
# see man:sd_notify(3)
|
# see man:sd_notify(3)
|
||||||
notify("READY=1")
|
notify("READY=1")
|
||||||
|
|
||||||
# Gateway mode comes in handy when many nodes have a DHCP server
|
# Gateway mode comes in handy when many nodes have a DHCP server and
|
||||||
# and you want to prevent conflicts.
|
# you want to prevent conflicts. It defaults to "auto" in naxalnet.
|
||||||
# https://www.open-mesh.org/projects/batman-adv/wiki/Gateways
|
# https://www.open-mesh.org/projects/batman-adv/wiki/Gateways
|
||||||
if args.gateway_mode == "auto":
|
if args.gateway_mode == "auto":
|
||||||
logger.info("Checking for internet connection")
|
logger.info("Checking for internet connection")
|
||||||
|
Loading…
Reference in New Issue
Block a user