Commit graph

12 commits

Author SHA1 Message Date
Maximilian Nitsch
482bf69434 doc: Link Protobuf docs instead of .proto files
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-12-05 16:58:01 +01:00
Fiona Fuchs
e7c9c7579a Add existing documentation material to MkDocs
This adds existing documentation files for ud3tn to the MkDocs skeleton.

Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com>
2024-11-12 11:33:24 +01:00
Felix Walter
d44ba151cd doc: Extend documentation on AAP 2.0 security and persistence
We did not really explain how to deal with node restarts beforehand.
This adds some hints to the quick start guide and the SQLite CLA docs.

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
2024-10-01 09:27:50 +02:00
Felix Walter
0b4550f765 cmdline: Rename eid to node-id
This was confusing users. We are adding a detailed explanation in the
man page and informing in the help text that the parameter refers to the
administrative endpoint of uD3TN.

Fixes: #213

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
2024-09-13 15:18:03 +02:00
Maximilian Nitsch
40d6ec7b55 doc/sqlite-storage: Move description to the corresponding subsection
After merging !184, the description of how the storage can be accessed
when using the integrated routing agent must be moved to the
corresponding subsection.

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-07-15 14:25:07 +02:00
Felix Walter
d480ce3e4c doc: Extend sqlite CLA docs to capture three options to use it
This also fixes the CLA address specified with `aap2-config` - it has to
contain a colon at the end.

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
2024-07-14 23:32:31 +02:00
Maximilian Nitsch
099f40421d doc/sqlite-storage: Use AAP2 instead of AAP commands
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-07-12 11:02:22 +02:00
Maximilian Nitsch
15c77e2c50 doc: Update docs to reflect the latest changes to μD3TN
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-07-12 10:33:23 +02:00
Maximilian Nitsch
3ba8281796 treewide: Use python-ud3tn-utils scripts instead of those from tools/
Changes all occurrences of the old script paths from tools/ to the
scripts installed by python-ud3tn-utils.

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-07-01 10:10:56 +02:00
Felix Walter
2dcf3b35d9 aap2: Secure the control of the storage and BDMs through AAP 2.0
With the addition of the storage agent and the compat. BDM we have the
issue that two new agents accept configuration through bundles, which
cannot check that those bundles come from trustworthy sources. In the
past we restricted contact configuration messages to local clients and
performed an "EID spoofing detection" so that we could check the source
EID - if it is the same as the local node ID, we allowed the
configuration bundle to be processed. With AAPv2 and potentially more
security-relevant components (such as BDMs) appearing in the future, we
need a new mechanism.

The idea behind the implemented mechanism is to reuse the existing AAP
2.0 shared-secret authentication that is applied for BDMs themselves
also for sending configuration messages: We add the possibility to
register an AAP 2.0 RPC agent (one that sends commands *toward* uD3TN)
with the "dispatch" authorization flag. This client can then request a
special flag to be added when sending bundles. The new flag is only
added internally by uD3TN to its in-memory data structure and is
delivered to all internal agents as well as AAP 2.0 clients receiving
the marked bundles. Those agents and clients (such as the sqlite/storage
agent) can then easily check for the flag to be present and thus
determine whether the bundle comes from an authenticated and authorized
source.

Note: The `adu_flags` field for the BundleADU AAP 2.0 message is now a
`repeated` field to represent the option of multiple flags being present
(Protobuf does not support bit fields for this purpose).

Fixes: #187

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
2024-06-26 10:23:17 +02:00
Maximilian Nitsch
ed6bdcbf96 SQLiteCLA: Support volatile in-memory database
Adds support for a volatile in-memory database by enabling support for
URI-based database file names. Since the in-memory DB can only be
accessed within the process, the integration tests are changed so that
external SQL queries are only performed when a persistent DB file is
used.

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-06-26 09:28:45 +02:00
Maximilian Nitsch
c304173462 doc: Add SQLite storage documentation
Adds a brief description of the SQLite-based storage and a guide on how
to interact with the storage.

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-06-03 13:41:58 +02:00