add gnunet protocol registry

11 files changed, 135 insertions, 0 deletions

diff --git a/gnunet-protocols/.gitignore b/gnunet-protocols/.gitignore
new file mode 100644
index 0000000..0a437d0
--- /dev/null
+++ b/gnunet-protocols/.gitignore
@@ -0,0 +1 @@
+gnu-name-system-record-types.h
diff --git a/gnunet-protocols/Makefile b/gnunet-protocols/Makefile
new file mode 100644
index 0000000..c146c30
--- /dev/null
+++ b/gnunet-protocols/Makefile
@@ -0,0 +1,25 @@
+FILES=gnunet_overlay_protocols.h gnunet_overlay_protocols.rst
+all: check $(FILES)
+
+check:
+        recfix --check registry.rec
+
+distclean:
+        rm -f *.tmp
+clean:
+        rm -f $(FILES) *.tmp
+
+gnunet_overlay_protocols.h.tmp: registry.rec h.template
+        ../format.sh h.template < registry.rec > $@
+
+gnunet_overlay_protocols.h: h.header gnunet_overlay_protocols.h.tmp h.footer
+        cat h.header gnunet_overlay_protocols.h.tmp h.footer > $@
+
+gnunet_overlay_protocols.rst.tmp: registry.rec rst.template
+        ../format.sh rst.template < registry.rec > $@
+
+gnunet_overlay_protocols.rst: rst.header gnunet_overlay_protocols.rst.tmp rst.footer
+        cat rst.header gnunet_overlay_protocols.rst.tmp rst.footer > $@
+
+
+.PHONY: check clean distclean
diff --git a/gnunet-protocols/POLICY b/gnunet-protocols/POLICY
new file mode 100644
index 0000000..e7d06f9
--- /dev/null
+++ b/gnunet-protocols/POLICY
@@ -0,0 +1,16 @@
+Each registry entry should contain three values: the "Number" of the
+protocol, which must be above 255 (to avoid conflicts with legacy
+Internet protocols), the "Name" of the protocol, and a "Reference" with links
+to further information about the record type.
+
+The "Name" must be unique in the entire registry.  The value must be a
+case insensitive ASCII string and is restricted to alphanumeric
+characters.
+
+Adding protocols is possible after expert review, using a
+first-come-first-served policy for unique "Name" allocation.
+Experts are responsible to ensure that the chosen "Name" is
+appropriate for the record type.
+
+The current contact(s) for expert review are reachable at
+gns-registry@gnunet.org.
diff --git a/gnunet-protocols/README b/gnunet-protocols/README
new file mode 100644
index 0000000..df23711
--- /dev/null
+++ b/gnunet-protocols/README
@@ -0,0 +1,9 @@
+This registry is for overlay protocols.
+
+Overlay protocol numbers uniquely identify the different kinds
+of protocols implemented to realize overlay service communication.
+
+This registry is used to ensure that the names and numeric values
+used to identify the protocols are uniquely defined and to
+allow implementors to find out details about the respective semantics and
+specifications.
diff --git a/gnunet-protocols/h.footer b/gnunet-protocols/h.footer
new file mode 100644
index 0000000..adccc7a
--- /dev/null
+++ b/gnunet-protocols/h.footer
@@ -0,0 +1,11 @@
+
+
+
+#if 0 /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/gnunet-protocols/h.header b/gnunet-protocols/h.header
new file mode 100644
index 0000000..8bbba29
--- /dev/null
+++ b/gnunet-protocols/h.header
@@ -0,0 +1,30 @@
+/*
+     This file is part of GNUnet
+     Copyright (C) 2012-2022 GNUnet e.V.
+
+     GNUnet 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.
+
+     GNUnet 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/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
+ */
+#ifndef GNUNET_OVERLAY_PROTOCOLS_H
+#define GNUNET_OVERLAY_PROTOCOLS_H
+
+/**
+ * WARNING:
+ * This header is generated!
+ * In order to add overlay protocols, you must register
+ * them in GANA, and then use the header generation script
+ * to create an update of this file. You may then replace this
+ * file with the update.
+ */
diff --git a/gnunet-protocols/h.template b/gnunet-protocols/h.template
new file mode 100644
index 0000000..2d7e828
--- /dev/null
+++ b/gnunet-protocols/h.template
@@ -0,0 +1,6 @@
+
+
+/**
+ * {{Comment}}
+ */
+#define GNUNET_OVERLAY_PROTOCOL_{{Name}} {{Number}}
diff --git a/gnunet-protocols/registry.rec b/gnunet-protocols/registry.rec
new file mode 100644
index 0000000..96c8dcb
--- /dev/null
+++ b/gnunet-protocols/registry.rec
@@ -0,0 +1,23 @@
+# -*- mode: rec -*-
+#
+# Registry for overlay protocols
+#
+
+%rec: OverlayProtocol
+%key: Number
+%typedef: NumberRange_t range 256 65535
+%type: Number NumberRange_t
+%mandatory: Number
+%typedef: Name_t regexp /^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-][abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-]*$/
+%type: Name Name_t
+%unique: Name
+%mandatory: Name
+%mandatory: Comment
+%allowed: Contact
+%allowed: References
+%sort: Number Name Contact References
+
+Number: 256
+Name: CADET
+Comment: CADET protocol.
+References: https://git.gnunet.org/bibliography.git/plain/docs/cadet.pdf
diff --git a/gnunet-protocols/rst.footer b/gnunet-protocols/rst.footer
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/gnunet-protocols/rst.footer
diff --git a/gnunet-protocols/rst.header b/gnunet-protocols/rst.header
new file mode 100644
index 0000000..c28a576
--- /dev/null
+++ b/gnunet-protocols/rst.header
@@ -0,0 +1,4 @@
+Registry for Overlay Protocols
+------------------------------
+
+
diff --git a/gnunet-protocols/rst.template b/gnunet-protocols/rst.template
new file mode 100644
index 0000000..e032a7f
--- /dev/null
+++ b/gnunet-protocols/rst.template
@@ -0,0 +1,10 @@
+
+
+=================== ===========================================================
+Name                GNUNET_OVERLAY_PROTOCOL_{{Name}}
+------------------- -----------------------------------------------------------
+Number              {{Number}}
+Comment             {{Comment}}
+References          {{References}}
+=================== ===========================================================
+