[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-go-plugins] branch master updated (be2877b -> 8eec0c3)
|
From: |
gnunet |
|
Subject: |
[gnunet-go-plugins] branch master updated (be2877b -> 8eec0c3) |
|
Date: |
Sun, 30 Oct 2022 18:22:40 +0100 |
This is an automated email from the git hooks/post-receive script.
bernd-fix pushed a change to branch master
in repository gnunet-go-plugins.
from be2877b Changed plugin interface; custom record layout.
new f0afdae Removed obsolete example.
new 2894297 example-c: Initial revision.
new e69bd78 eample-go: initial revision.
new 8eec0c3 Initial revision of documentation.
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
COPYING | 1 +
LICENSE | 616 +++++++++++++++++++++++++++++++++++++
README.md | 369 ++++++++++++++++++++++
{reclaimid => example-c}/Makefile | 6 +-
example-c/gui.htpl | 111 +++++++
example-c/main.go | 179 +++++++++++
example-c/plugin.c | 155 ++++++++++
example-c/plugin.h | 44 +++
example-c/plugin_test.go | 109 +++++++
{reclaimid => example-go}/Makefile | 6 +-
example-go/gui.htpl | 111 +++++++
example-go/main.go | 189 ++++++++++++
example-go/plugin_test.go | 109 +++++++
example-go/records.go | 96 ++++++
reclaimid/gui.htpl | 37 ---
reclaimid/main.go | 114 -------
reclaimid/rrtypes.go | 94 ------
17 files changed, 2095 insertions(+), 251 deletions(-)
create mode 120000 COPYING
create mode 100644 LICENSE
create mode 100644 README.md
copy {reclaimid => example-c}/Makefile (87%)
create mode 100644 example-c/gui.htpl
create mode 100644 example-c/main.go
create mode 100644 example-c/plugin.c
create mode 100644 example-c/plugin.h
create mode 100644 example-c/plugin_test.go
rename {reclaimid => example-go}/Makefile (88%)
create mode 100644 example-go/gui.htpl
create mode 100644 example-go/main.go
create mode 100644 example-go/plugin_test.go
create mode 100644 example-go/records.go
delete mode 100644 reclaimid/gui.htpl
delete mode 100644 reclaimid/main.go
delete mode 100644 reclaimid/rrtypes.go
diff --git a/COPYING b/COPYING
new file mode 120000
index 0000000..7a694c9
--- /dev/null
+++ b/COPYING
@@ -0,0 +1 @@
+LICENSE
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6cfcd65
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,616 @@
+GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+Preamble
+
+The GNU Affero General Public License is a free, copyleft license for software
+and other kinds of works, specifically designed to ensure cooperation with the
+community in the case of network server software.
+
+The licenses for most software and other practical works are designed to take
+away your freedom to share and change the works. By contrast, our General
+Public Licenses are intended to guarantee your freedom to share and change all
+versions of a program--to make sure it remains free software for all its users.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom to
+distribute copies of free software (and charge for them if you wish), that you
+receive source code or can get it if you want it, that you can change the
+software or use pieces of it in new free programs, and that you know you can
+do these things.
+
+Developers that use our General Public Licenses protect your rights with two
+steps: (1) assert copyright on the software, and (2) offer you this License
+which gives you legal permission to copy, distribute and/or modify the
software.
+
+A secondary benefit of defending all users' freedom is that improvements made
+in alternate versions of the program, if they receive widespread use, become
+available for other developers to incorporate. Many developers of free
+software are heartened and encouraged by the resulting cooperation. However,
+in the case of software used on network servers, this result may fail to come
+about. The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its source code
+to the public.
+
+The GNU Affero General Public License is designed specifically to ensure that,
+in such cases, the modified source code becomes available to the community. It
+requires the operator of a network server to provide the source code of the
+modified version running there to the users of that server. Therefore, public
+use of a modified version, on a publicly accessible server, gives the public
+access to the source code of the modified version.
+
+An older license, called the Affero General Public License and published by
+Affero, was designed to accomplish similar goals. This is a different license,
+not a version of the Affero GPL, but Affero has released a new version of the
+Affero GPL which permits relicensing under this license.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of works,
+such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this License.
+Each licensee is addressed as "you". "Licensees" and "recipients" may be
+individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work in a
+fashion requiring copyright permission, other than the making of an exact copy.
+ The resulting work is called a "modified version" of the earlier work or a
+work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based on the
+Program.
+
+To "propagate" a work means to do anything with it that, without permission,
+would make you directly or secondarily liable for infringement under applicable
+copyright law, except executing it on a computer or modifying a private copy.
+Propagation includes copying, distribution (with or without modification),
+making available to the public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other parties to
+make or receive copies. Mere interaction with a user through a computer
+network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to the
+extent that it includes a convenient and prominently visible feature that
+(1) displays an appropriate copyright notice, and (2) tells the user that
+there is no warranty for the work (except to the extent that warranties are
+provided), that licensees may convey the work under this License, and how to
+view a copy of this License. If the interface presents a list of user commands
+or options, such as a menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+
+The "source code" for a work means the preferred form of the work for making
+modifications to it. "Object code" means any non-source form of a work.
+
+A "Standard Interface" means an interface that either is an official standard
+defined by a recognized standards body, or, in the case of interfaces specified
+for a particular programming language, one that is widely used among developers
+working in that language.
+
+The "System Libraries" of an executable work include anything, other than the
+work as a whole, that (a) is included in the normal form of packaging a Major
+Component, but which is not part of that Major Component, and (b) serves only
+to enable use of the work with that Major Component, or to implement a Standard
+Interface for which an implementation is available to the public in source code
+form. A "Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system (if any) on
+which the executable work runs, or a compiler used to produce the work, or an
+object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all the source
+code needed to generate, install, and (for an executable work) run the object
+code and to modify the work, including scripts to control those activities.
+However, it does not include the work's System Libraries, or general-purpose
+tools or generally available free programs which are used unmodified in
+performing those activities but which are not part of the work. For example,
+Corresponding Source includes interface definition files associated with source
+files for the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require, such as
+by intimate data communication or control flow between those subprograms and
+other parts of the work.
+
+The Corresponding Source need not include anything that users can regenerate
+automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same work.
+
+2. Basic Permissions.
+
+All rights granted under this License are granted for the term of copyright on
+the Program, and are irrevocable provided the stated conditions are met. This
+License explicitly affirms your unlimited permission to run the unmodified
+Program. The output from running a covered work is covered by this License
+only if the output, given its content, constitutes a covered work. This
+License acknowledges your rights of fair use or other equivalent, as provided
+by copyright law.
+
+You may make, run and propagate covered works that you do not convey, without
+conditions so long as your license otherwise remains in force. You may convey
+covered works to others for the sole purpose of having them make modifications
+exclusively for you, or provide you with facilities for running those works,
+provided that you comply with the terms of this License in conveying all
+material for which you do not control copyright. Those thus making or running
+the covered works for you must do so exclusively on your behalf, under your
+direction and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes it
+unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological measure
+under any applicable law fulfilling obligations under article 11 of the WIPO
+copyright treaty adopted on 20 December 1996, or similar laws prohibiting or
+restricting circumvention of such measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention is
+effected by exercising rights under this License with respect to the covered
+work, and you disclaim any intention to limit operation or modification of the
+work as a means of enforcing, against the work's users, your or third parties'
+legal rights to forbid circumvention of technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you receive it,
+in any medium, provided that you conspicuously and appropriately publish on
+each copy an appropriate copyright notice; keep intact all notices stating
+that this License and any non-permissive terms added in accord with section
+7 apply to the code; keep intact all notices of the absence of any warranty;
+and give all recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey, and you
+may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to produce it
+from the Program, in the form of source code under the terms of section 4,
+provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified it, and
+ giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is released under
+ this License and any conditions added under section 7. This requirement
+ modifies the requirement in section 4 to "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this License to
+ anyone who comes into possession of a copy. This License will
+ therefore apply, along with any applicable section 7 additional terms,
+ to the whole of the work, and all its parts, regardless of how they are
+ packaged. This License gives no permission to license the work in any
+ other way, but it does not invalidate such permission if you have
+ separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your work
+ need not make them do so.
+
+A compilation of a covered work with other separate and independent works,
+which are not by their nature extensions of the covered work, and which are
+not combined with it such as to form a larger program, in or on a volume of a
+storage or distribution medium, is called an "aggregate" if the compilation
+and its resulting copyright are not used to limit the access or legal rights
+of the compilation's users beyond what the individual works permit. Inclusion
+of a covered work in an aggregate does not cause this License to apply to the
+other parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of sections
+4 and 5, provided that you also convey the machine-readable Corresponding
+Source under the terms of this License, in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium customarily
+ used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a written
+ offer, valid for at least three years and valid for as long as you
+ offer spare parts or customer support for that product model, to give
+ anyone who possesses the object code either (1) a copy of the
+ Corresponding Source for all the software in the product that is
+ covered by this License, on a durable physical medium customarily used
+ for software interchange, for a price no more than your reasonable cost
+ of physically performing this conveying of source, or (2) access to
+ copy the Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the written
+ offer to provide the Corresponding Source. This alternative is allowed
+ only occasionally and noncommercially, and only if you received the
+ object code with such an offer, in accord with subsection 6b.
+
+ d) Convey the object code by offering access from a designated place
+ (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to copy
+ the object code is a network server, the Corresponding Source may be on
+ a different server (operated by you or a third party) that supports
+ equivalent copying facilities, provided you maintain clear directions
+ next to the object code saying where to find the Corresponding Source.
+ Regardless of what server hosts the Corresponding Source, you remain
+ obligated to ensure that it is available for as long as needed to
+ satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided you
+ inform other peers where the object code and Corresponding Source of
+ the work are being offered to the general public at no charge under
+ subsection 6d.
+
+A separable portion of the object code, whose source code is excluded from the
+Corresponding Source as a System Library, need not be included in conveying
+the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any tangible
+personal property which is normally used for personal, family, or household
+purposes, or (2) anything designed or sold for incorporation into a dwelling.
+In determining whether a product is a consumer product, doubtful cases shall
+be resolved in favor of coverage. For a particular product received by a
+particular user, "normally used" refers to a typical or common use of that
+class of product, regardless of the status of the particular user or of the
+way in which the particular user actually uses, or expects or is expected to
+use, the product. A product is a consumer product regardless of whether the
+product has substantial commercial, industrial or non-consumer uses, unless
+such uses represent the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods, procedures,
+authorization keys, or other information required to install and execute
+modified versions of a covered work in that User Product from a modified
+version of its Corresponding Source. The information must suffice to ensure
+that the continued functioning of the modified object code is in no case
+prevented or interfered with solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as part of
+a transaction in which the right of possession and use of the User Product is
+transferred to the recipient in perpetuity or for a fixed term (regardless of
+how the transaction is characterized), the Corresponding Source conveyed under
+this section must be accompanied by the Installation Information. But this
+requirement does not apply if neither you nor any third party retains the
+ability to install modified object code on the User Product (for example, the
+work has been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates for a
+work that has been modified or installed by the recipient, or for the User
+Product in which it has been modified or installed. Access to a network may
+be denied when the modification itself materially and adversely affects the
+operation of the network or violates the rules and protocols for communication
+across the network.
+
+Corresponding Source conveyed, and Installation Information provided, in
+accord with this section must be in a format that is publicly documented (and
+with an implementation available to the public in source code form), and must
+require no special password or key for unpacking, reading or copying.
+
+7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this License
+by making exceptions from one or more of its conditions. Additional permissions
+that are applicable to the entire Program shall be treated as though they were
+included in this License, to the extent that they are valid under applicable
+law. If additional permissions apply only to part of the Program, that part
+may be used separately under those permissions, but the entire Program remains
+governed by this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option remove any
+additional permissions from that copy, or from any part of it. (Additional
+permissions may be written to require their own removal in certain cases when
+you modify the work.) You may place additional permissions on material, added
+by you to a covered work, for which you have or can give appropriate copyright
+permission.
+
+Notwithstanding any other provision of this License, for material you add to a
+covered work, you may (if authorized by the copyright holders of that material)
+supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the terms of
+ sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or author
+ attributions in that material or in the Appropriate Legal Notices
+ displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or authors
+ of the material; or
+
+ e) Declining to grant rights under trademark law for use of some trade
+ names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that material by
+ anyone who conveys the material (or modified versions of it) with
+ contractual assumptions of liability to the recipient, for any liability
+ that these contractual assumptions directly impose on those licensors
+ and authors.
+
+All other non-permissive additional terms are considered "further restrictions"
+within the meaning of section 10. If the Program as you received it, or any
+part of it, contains a notice stating that it is governed by this License along
+with a term that is a further restriction, you may remove that term. If a
+license document contains a further restriction but permits relicensing or
+conveying under this License, you may add to a covered work material governed
+by the terms of that license document, provided that the further restriction
+does not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you must place,
+in the relevant source files, a statement of the additional terms that apply
+to those files, or a notice indicating where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the form of a
+separately written license, or stated as exceptions; the above requirements
+apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly provided
+under this License. Any attempt otherwise to propagate or modify it is void,
+and will automatically terminate your rights under this License (including any
+patent licenses granted under the third paragraph of section 11).
+
+However, if you cease all violation of this License, then your license from a
+particular copyright holder is reinstated (a) provisionally, unless and until
+the copyright holder explicitly and finally terminates your license, and (b)
+permanently, if the copyright holder fails to notify you of the violation by
+some reasonable means prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is reinstated
+permanently if the copyright holder notifies you of the violation by some
+reasonable means, this is the first time you have received notice of violation
+of this License (for any work) from that copyright holder, and you cure the
+violation prior to 30 days after your receipt of the notice.
+
+Termination of your rights under this section does not terminate the licenses
+of parties who have received copies or rights from you under this License.
+If your rights have been terminated and not permanently reinstated, you do not
+qualify to receive new licenses for the same material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run a copy
+of the Program. Ancillary propagation of a covered work occurring solely as a
+consequence of using peer-to-peer transmission to receive a copy likewise does
+not require acceptance. However, nothing other than this License grants you
+permission to propagate or modify any covered work. These actions infringe
+copyright if you do not accept this License. Therefore, by modifying or
+propagating a covered work, you indicate your acceptance of this License to
+do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically receives a
+license from the original licensors, to run, modify and propagate that work,
+subject to this License. You are not responsible for enforcing compliance by
+third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered work
+results from an entity transaction, each party to that transaction who receives
+a copy of the work also receives whatever licenses to the work the party's
+predecessor in interest had or could give under the previous paragraph, plus a
+right to possession of the Corresponding Source of the work from the
+predecessor in interest, if the predecessor has it or can get it with
+reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the rights
+granted or affirmed under this License. For example, you may not impose a
+license fee, royalty, or other charge for exercise of rights granted under this
+License, and you may not initiate litigation (including a cross-claim or
+counterclaim in a lawsuit) alleging that any patent claim is infringed by
+making, using, selling, offering for sale, or importing the Program or any
+portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this License of
+the Program or a work on which the Program is based. The work thus licensed is
+called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned or
+controlled by the contributor, whether already acquired or hereafter acquired,
+that would be infringed by some manner, permitted by this License, of making,
+using, or selling its contributor version, but do not include claims that would
+be infringed only as a consequence of further modification of the contributor
+version. For purposes of this definition, "control" includes the right to
+grant patent sublicenses in a manner consistent with the requirements of this
+License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free patent
+license under the contributor's essential patent claims, to make, use, sell,
+offer for sale, import and otherwise run, modify and propagate the contents of
+its contributor version.
+
+In the following three paragraphs, a "patent license" is any express agreement
+or commitment, however denominated, not to enforce a patent (such as an express
+permission to practice a patent or covenant not to s ue for patent
+infringement). To "grant" such a patent license to a party means to make such
an
+agreement or commitment not to enforce a patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license, and the
+Corresponding Source of the work is not available for anyone to copy, free of
+charge and under the terms of this License, through a publicly available
+network server or other readily accessible means, then you must either
+(1) cause the Corresponding Source to be so available, or (2) arrange to
+deprive yourself of the benefit of the patent license for this particular work,
+or (3) arrange, in a manner consistent with the requirements of this License,
+to extend the patent license to downstream recipients. "Knowingly relying"
+means you have actual knowledge that, but for the patent license, your
+conveying the covered work in a country, or your recipient's use of the
+covered work in a country, would infringe one or more identifiable patents in
+that country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or arrangement, you
+convey, or propagate by procuring conveyance of, a covered work, and grant a
+patent license to some of the parties receiving the covered work authorizing
+them to use, propagate, modify or convey a specific copy of the covered work,
+then the patent license you grant is automatically extended to all recipients
+of the covered work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the scope of
+its coverage, prohibits the exercise of, or is conditioned on the non-exercise
+of one or more of the rights that are specifically granted under this License.
+You may not convey a covered work if you are a party to an arrangement with a
+third party that is in the business of distributing software, under which you
+make payment to the third party based on the extent of your activity of
+conveying the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by you (or
+copies made from those copies), or (b) primarily for and in connection with
+specific products or compilations that contain the covered work, unless you
+entered into that arrangement, or that patent license was granted, prior to
+28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting any implied
+license or other defenses to infringement that may otherwise be available to
+you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not excuse
+you from the conditions of this License. If you cannot convey a covered work
+so as to satisfy simultaneously your obligations under this License and any
+other pertinent obligations, then as a consequence you may not convey it at
+all. For example, if you agree to terms that obligate you to collect a royalty
+for further conveying from those to whom you convey the Program, the only way
+you could satisfy both those terms and this License would be to refrain
+entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the Program,
+your modified version must prominently offer all users interacting with it
+remotely through a computer network (if your version supports such interaction)
+an opportunity to receive the Corresponding Source of your version by providing
+access to the Corresponding Source from a network server at no charge, through
+some standard or customary means of facilitating copying of software. This
+Corresponding Source shall include the Corresponding Source for any work
+covered by version 3 of the GNU General Public License that is incorporated
+pursuant to the following paragraph.
+
+Notwithstanding any other provision of this License, you have permission to
+link or combine any covered work with a work licensed under version 3 of the
+GNU General Public License into a single combined work, and to convey the
+resulting work. The terms of this License will continue to apply to the part
+which is the covered work, but the work with which it is combined will remain
+governed by version 3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU
+Affero General Public License from time to time. Such new versions will be
+similar in spirit to the present version, but may differ in detail to address
+new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU Affero General Public
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that numbered version or of any
+later version published by the Free Software Foundation. If the Program does
+not specify a version number of the GNU Affero General Public License, you may
+choose any version ever published by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions of the
+GNU Affero General Public License can be used, that proxy's public statement
+of acceptance of a version permanently authorizes you to choose that version
+for the Program.
+
+Later license versions may give you additional or different permissions.
+However, no additional obligations are imposed on any author or copyright
+holder as a result of your choosing to follow a later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
+LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
+EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
+ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
+SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
+SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
+COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS
+PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
+INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
+THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
+INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
+PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided above cannot
+be given local legal effect according to their terms, reviewing courts shall
+apply local law that most closely approximates an absolute waiver of all civil
+liability in connection with the Program, unless a warranty or assumption of
+liability accompanies a copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest possible
+use to the public, the best way to achieve this is to make it free software
+which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach
+them to the start of each source file to most effectively state the exclusion
+of warranty; and each file should have at least the "copyright" line and a
+pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If your software can interact with users remotely through a computer network,
+you should also make sure that it provides a way for users to get its source.
+For example, if your program is a web application, its interface could display
+a "Source" link that leads users to an archive of the code. There are many
+ways you could offer source, and different solutions will be better for
+different programs; see section 13 for the specific requirements.
+
+You should also get your employer (if you work as a programmer) or school, if
+any, to sign a "copyright disclaimer" for the program, if necessary. For more
+information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b3b1211
--- /dev/null
+++ b/README.md
@@ -0,0 +1,369 @@
+# gnunet-go-plugins: Plugins for the GNUnet implementation in Go
+
+Copyright (C) 2022 Bernd Fix >Y<
+
+gnunet-go-plugins 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-go-plugins 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
+
+## Caveat
+
+THIS IS WORK-IN-PROGRESS AT A VERY EARLY STATE. DON'T EXPECT ANY COMPLETE
+DOCUMENTATION OR COMPILABLE, RUNNABLE OR EVEN OPERATIONAL SOURCE CODE.
+
+## Introduction
+
+The ZoneMaster implementation of GNUnet-Go provides a GUI to manage (display,
+create, edit and delete) GNS zones (identities), zone label and resource
+records below a label. The framework implementation only support GNS (and
+some DNS) record types, so custom record types (e.g. for Re:claimID or
+filesharing) cannot be displayed, created or edited (only deleted!).
+
+This gap can be closed by custom plugins that handle custom resource record
+types. The minimal implementation provides a function to convert the record
+data into human-readable format (string) suitable to be displayed on a HTML
+page. Advanced versions also allow creation of new records and editing
+existing records too.
+
+The main plugin code must be written in Go1.18+ and compiled with the exact
+same Go version as the framework using it (zonemaster-go). Differences in
+versions will result in unloadable plugins.
+
+Two examples are provided: `example-c` and `example-go`. You start with
+copying the example to a new folder for your custom plugin and customizing
+the code to your needs. The examples are rudimentary and don't cover real-world
+resource records for more complex sub-systems.
+
+# Anatomy of a ZoneMaster plugin
+
+A plugin consists of two parts: A set of methods to handle the custom
+resource records and a HTML template for the records that integrates into
+the ZoneMaster GUI framework.
+
+It is important that every name you use in your custom plugin is unique;
+_never_ share names across plugins or resource record attributes!
+
+# Plugin methods
+
+* `Name() string`: returns the name of the plugin. It is recommended that
+ the plugin name is using the common name of the GNUnet sub-system the
+ resource records belong to (e.g. "Re:claimID" or "filesharing")
+
+* `CanHandle() []uint32`: Returns a list of resource record types the
+ plugin can handle. Resource record types _must_ be registered with GANA
+ to avoid collisions with other custom plugins.
+
+* `Compatible(label string, rrSpecs [][2]uint32) ([][2]uint32, error)`:
+ Return a list of allowed record types and enforced record flags when
+ adding a new resource record under the given label with existing records
+ `rrSpecs`.
+
+* `Template() string`: Return the HTML templates used for creating and
+ editing custom resource records.
+
+* `TemplateNames() (string,string)`: Returns the names of the "new" and
+ "edit" templates in the customized template.
+
+* `Value(rrType uint32, rrData []byte) (string,error)`: Returns the
+ human-readable representation of custom resource record data for a given
+ type. This is the method that allows the display of the custom resource
+ records in the GUI. This method is only called for types registered
+ with `CanHandle()`.
+
+* `Prefix(rrType uint32) string`: Returns the prefix used for record attribues
+ used in `ToMap()` and `FromMap()` methods as well as in HTML templates.
+
+* `ToMap(rrType uint32, rrData []byte) (map[string]string, error)`: Returns
+ a map that includes all record attributes with a string name and a string
+ value. The names used for attributes must match the names used in the HTML
+ template; the details are explaind in section **HTML templates**. This method
+ is only called for types registered with `CanHandle()`.
+
+* `FromMap(rrType uint32, params map[string]string) (rrData []byte, err
error)`:
+ Returns the binary resource record data for the given type and parameter set.
+ The method reconstructs the record attributes from the map and returns the
+ binary representation of the resource record data. It uses the same names for
+ attributes as the `ToMap()` method. This method is only called for types
+ registered with `CanHandle()`.
+
+# Custom resource record types
+
+The ZoneMaster framework can only handle resource record types that are
+registered with GANA and are included in the `gnunet-go` framework.
+
+For the examples lets assume that GANA includes:
+
+```
+Number: 90666
+Name: RECTYPE1
+Comment: Custom record type #1
+
+Number: 90667
+Name: RECTYPE2
+Comment: Custom record type #2
+```
+
+The names of the resource record definition are used by the framework
+and **must** be used in the plugin (especialy the HTML template) too.
+
+# HTML templates
+
+The probably most challening part of writing a custom plugin is the HTML
template
+system used for serving the ZoneMaster GUI. It deems necessary to read the
first
+part (until the "Index" section) of the
+[Go text template package documentation](https://pkg.go.dev/text/template); it
+describes how the template system works and how you can use it within your own
+templates.
+
+In the examples a separate file called `gui.htpl` contains the templates
+handled by the custom plugin. It is embedded into the plugin so that no
+additional files have to be deployed along with the plugin.
+
+Each GUI page is rendered from HTML templates; the custom plugin must provide
+at least two templates: one for creating a new record and one for editing an
+existing record. Since most sub-systems rquire multiple record types, the
+template for "new record" must have a selection of the desired record type
+first before showing the specific GUI elements for a record and the template
+for "edit record" must automatically select the matching record template based
+on tyoe. The ZoneMaster GUI framework provides helpers to easily do that; this
+is explained in sections **"New record" dialog** and **"Edit record dialog**.
+
+For each record type you also need a template to provide HTML form fields for
+the record data. See **Resource record dialogs** for more details.
+
+Each template is called with a `Data` object that contains information to
+render the final HTML page. The `Data` object has the following fields:
+
+* **Ref int64**: database id of the reference object. In a "new" dialog,
+ the ID refers to the parent object (GNS label); in an "edit" dialog it
+ refers to the resource record being editied. The ID is used to generate
+ custom GET and POST requests.
+
+* **Action string**: "new" or "upd" action. It is used to decide if a
+ resource record dialog is in "new" or "edit" mode.
+
+* **Button string**: Recommended prefix for the submit button on record
+ dialogs.
+
+* **Names []string**: List of existing names (Zones or Labels) when creating
+ or editing zones and labels. It is empty for resource record dialogs.
+
+* **RRspecs []*enums.GNSSpec**: list of allowed record types and flags (REC)
+ when creating new records as computed by the plugin based on label name
+ and existing records (see `Compatible()` plugin method).
+
+* **Params map[string]string**: map of template parameters. Some parameters
+ are set by the framework and some parameters correspond to the custom
+ resource record.
+
+## Template parameters
+
+The framework automatically sets some template parameters:
+
+If the "New" dialog is called, the following map keys are defined:
+
+* **label**: Name of the label the record is added to. Can be used by
+ custom dialogs to decide what record types are allowed for a label
+ (e.g. the apex label "@" might enforce special record types).
+
+* **lid**: The database ID of the label (used by the framework)
+
+If the "Edit" dialog is called, the following map keys are defined:
+
+* **label**: Name of the label the record is added to. Can be used by
+ custom dialogs to decide what record types are allowed for a label
+ (e.g. the apex label "@" might enforce special record types).
+
+* **lid**: The database ID of the label (used by the framework)
+
+* **prefix**: Prefix used for naming custom form fields.
+
+* **type**: Name of the resource record type as defined in GANA
+
+* **created**: The creation timestamp of the record
+
+* **modified**: Timestamp of last modification
+
+* **<prefix>_expires**: Expiration timestamp
+
+* **<prefix>_{private,shadow,suppl}**: Resource record flags (private, shadow,
+ supplementary).
+
+`prefix` is defined by the `Prefix()` method of the plugin
+
+## "New record" dialog
+
+You can re-use and customize the example template; it provides all the
+boilerplate you don't want to reproduce on your own (although of course you
+can). For each custom type you need a template (named after the GANA name
+of the record) to handle editing record data.
+
+The HTML page has a tabbed selection of record types you can create; in our
+example the tabs will be named "RECTYPE1" and "RECTYPE2". Selecting a tab
+switches the rest of the dialog to the selected record type.
+
+```html
+{{define "new_myrecords"}}
+ <!-- customize template name -->
+ {{$data := .}}
+ <div>
+ <!-- customize heading -->
+ <h3>Creating a new record for label "{{index .Params "label"}}":</h3>
+ <div class="tabset">
+ {{range $i, $type := .RRspecs}}
+ <input type="radio" name="tabset" id="tab{{$i}}"
+ aria-controls="tab{{$i}}" {{if eq $i 0}}checked{{end}}
+ >
+ <label for="tab{{$i}}">{{rrtype $type.Type}}</label>
+ {{end}}
+ <div class="tab-panels">
+ {{range $i, $spec := .RRspecs}}
+ <section id="tab{{$i}}" class="tab-panel">
+ {{$t := rrtype $spec.Type}}
+ {{$pf := setspecs $data.Params $spec}}
+ <!-- customize here based on GANA values -->
+ {{if eq $t "RECTYPE1"}}{{template "RECTYPE1" $data}}{{end}}
+ {{if eq $t "RECTYPE2"}}{{template "RECTYPE2" $data}}{{end}}
+ <!-- end customize -->
+ </section>
+ {{end}}
+ </div>
+ </div>
+ <a href="/"><button>Leave</button></a>
+ </div>
+{{end}}
+```
+
+## "Edit record" dialog
+
+Like the new dialog, the edit dialog from the examples define all the
+boilerplate to handle edit requests; it can be customized the same way as the
+"new" dialog:
+
+```html
+{{define "edit_myrecords"}}
+ <!-- customize template name -->
+ <div>
+ <!-- customize heading -->
+ <h3>Edit a resource record for label {{index .Params "label"}}:</h3>
+ <p>
+ <small>
+ (Created: {{index .Params "created"}},
+ Last edited: {{index .Params "modified"}})
+ </small>
+ </p>
+ {{$t := rritype (index .Params "type")}}
+ <!-- customize here based on GANA values -->
+ {{if eq $t "RECTYPE1"}}{{template "RECTYPE1" .}}{{end}}
+ {{if eq $t "RECTYPE2"}}{{template "RECTYPE2" .}}{{end}}
+ <!-- end customize -->
+ </div>
+ <a href="/"><button>Leave</button></a>
+{{end}}
+```
+
+## Resource record dialogs
+
+For each custom record type you need to create a shared template to be used
+for creating and editing a specific custom record type.
+
+```html
+{{define "RECTYPE1"}}
+ <h3>RECTYPE1</h3>
+ <form action="/action/{{.Action}}/rr/{{.Ref}}"
+ {{if eq .Action "upd"}}method="post"{{end}}
+ >
+ <input type="hidden" name="type" value="{{index .Params "type"}}">
+ <table>
+ <!-- customization begins -->
+ <tr>
+ <td align="right"><b>Attribute1:</b></td>
+ <td>
+ <input type="text" name="rectype1_text"
+ maxlength="63" size="63"
+ autofocus required
+ value="{{index .Params "rectype1_text"}}"
+ >
+ </td>
+ </tr>
+ <!-- customization ends -->
+ {{template "RRCommon" .}}
+ <tr><td/><td><button id="submit">{{.Button}} record</button></td></tr>
+ </table>
+ </form>
+ <script>
+ // add JavaScript here if required
+ </script>
+{{end}}
+```
+
+Customizing a record dialog adds fields for each of the attributes of
+the record; this can be plain text, checkboxes, ranges or an other fancy
+HTML form element. If required you can even add JavaScript to provide
+interactive behaviour of form fields (or to validate values beyond HTML
+form validation).
+
+The framework automatically handles common parameters like expiration
+time or flags; you don't need to add that to our custom record templates.
+
+The most important issue about resource record dialogs is that the names
+of the form fields must be _unique across all record types_ handled by the
+plugin. This happens "automatically" by using a type-specific prefix (that
+is returnd by the plugin with the `Prefix()` method).
+
+# Mapping resource record attributes
+
+The main task of a plugin is to create a parameter map from its attributes
+and to re-create attributes from a parameter map.
+
+## `ToMap()` method
+
+Let's assume we have a simple record with type RECTYPE1 that only contains
+a string attribute:
+
+```go
+type MyRecord1 struct {
+ TxtLen uint16 `order:"big"` // length of text in NBO
+ Text []byte `size:"TxtLen"` // text data (not terminated by \0)
+}
+```
+
+If the `Prefix()`method returns "myrec1" for this type, the name of the
+exposed text attribute might be "myrec1_text" (this is what is used in the
+example HTML template). The `ToMap()` method (for the type) is simply:
+
+```go
+func (rec *MyRecord1) ToMap() (params map[string]string, err error) {
+ params = make(map[string]string)
+ params["myrec1_text"] = string(rec.Text)
+ return
+}
+```
+
+## `FromMap()` method
+
+The `FromMap()` method is the reverse of `ToMap()`; it reconstructs
+record attributes from a parameter map:
+
+```go
+func (rec *MyRecord1) FromMap(params map[string]string) error {
+ text, ok := params["myrec1_text"]
+ if !ok {
+ return errors.New("myrec1_text missing")
+ }
+ rec.TxtLen = uint16(len(text))
+ rec.Text = []byte(text)
+ return nil
+}
+```
diff --git a/reclaimid/Makefile b/example-c/Makefile
similarity index 87%
copy from reclaimid/Makefile
copy to example-c/Makefile
index 4b04dc6..d954b84 100644
--- a/reclaimid/Makefile
+++ b/example-c/Makefile
@@ -21,10 +21,10 @@
# SPDX-License-Identifier: AGPL3.0-or-later
-all: ${GOPATH}/bin/plugin_reclaimid.so
+all: ${GOPATH}/bin/plugin_example_c.so
-clean: ${GOPATH}/bin/plugin_reclaimid.so
+clean: ${GOPATH}/bin/plugin_example_c.so
rm -f $^
-${GOPATH}/bin/plugin_reclaimid.so: main.go gui.htpl
+${GOPATH}/bin/plugin_example_c.so: main.go gui.htpl plugin.h plugin.c
go build -buildmode=plugin -trimpath -gcflags="-N -l" -o $@ ./...
diff --git a/example-c/gui.htpl b/example-c/gui.htpl
new file mode 100644
index 0000000..8317a72
--- /dev/null
+++ b/example-c/gui.htpl
@@ -0,0 +1,111 @@
+{{define "new_myrecords"}}
+ <!-- DEBUG: show template parameters -->
+ <div>
+ <h3>Template data:</h3>
+ <p>Ref = {{.Ref}}</p>
+ <p>Action = {{.Action}}</p>
+ <p>Button = {{.Button}}</p>
+ <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
+ <p>RRSpecs:</p>
+ <ul>
+ {{range $i,$s := .RRspecs}}
+ <li>Type = {{$s.Type}}, Flags = {{$s.Flags}}</li>
+ {{end}}
+ </ul>
+ <p>Params:</p>
+ <ul>
+ {{range $k,$v := .Params}}
+ <li>'{{$k}}' = '{{$v}}'</li>
+ {{end}}
+ </ul>
+ </div>
+
+ {{$data := .}}
+ <div>
+ <h3>Creating a new custom resource record for label "{{index .Params
"label"}}":</h3>
+ <div class="tabset">
+ {{range $i, $type := .RRspecs}}
+ <input type="radio" name="tabset" id="tab{{$i}}"
aria-controls="tab{{$i}}" {{if eq $i 0}}checked{{end}}>
+ <label for="tab{{$i}}">{{rrtype $type.Type}}</label>
+ {{end}}
+ <div class="tab-panels">
+ {{range $i, $spec := .RRspecs}}
+ <section id="tab{{$i}}" class="tab-panel">
+ {{$t := rrtype $spec.Type}}
+ {{$pf := setspecs $data.Params $spec}}
+ {{if eq $t "MYRECTYPE1"}}{{template "MYRECTYPE1"
$data}}{{end}}
+ {{if eq $t "MYRECTYPE2"}}{{template "MYRECTYPE2"
$data}}{{end}}
+ </section>
+ {{end}}
+ </div>
+ </div>
+ <a href="/"><button>Leave</button></a>
+ </div>
+{{end}}
+
+{{define "edit_myrecords"}}
+ <!-- DEBUG: show template parameters -->
+ <div>
+ <h3>Template data:</h3>
+ <p>Ref = {{.Ref}}</p>
+ <p>Action = {{.Action}}</p>
+ <p>Button = {{.Button}}</p>
+ <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
+ <ul>
+ {{range $k,$v := .Params}}
+ <li>'{{$k}}' = '{{$v}}'</li>
+ {{end}}
+ </ul>
+ </div>
+
+ <div>
+ <h3>Edit a resource record for label {{index .Params "label"}}:</h3>
+ <p><small>(Created: {{index .Params "created"}}, Last edited: {{index
.Params "modified"}})</small></p>
+ {{$t := rritype (index .Params "type")}}
+ {{if eq $t "MYRECTYPE1"}}{{template "MYRECTYPE1" .}}{{end}}
+ {{if eq $t "MYRECTYPE2"}}{{template "MYRECTYPE2" .}}{{end}}
+ </div>
+ <a href="/"><button>Leave</button></a>
+{{end}}
+
+{{define "MYRECTYPE1"}}
+ <h3>RECTYPE1</h3>
+ <form action="/action/{{.Action}}/rr/{{.Ref}}" {{if eq .Action
"upd"}}method="post"{{end}}>
+ <input type="hidden" name="type" value="{{index .Params "type"}}">
+ <table>
+ <tr>
+ <td align="right"><b>Attribute1:</b></td>
+ <td>
+ <input type="text" name="myrec1_text"
+ maxlength="63" size="63"
+ autofocus required
+ value="{{index .Params "myrec1_text"}}"
+ >
+ </td>
+ </tr>
+ {{template "RRCommon" .}}
+ <tr><td/><td><button id="submit">{{.Button}}
record</button></td></tr>
+ </table>
+ </form>
+{{end}}
+
+{{define "MYRECTYPE2"}}
+ <h3>RECTYPE2</h3>
+ <form action="/action/{{.Action}}/rr/{{.Ref}}" {{if eq .Action
"upd"}}method="post"{{end}}>
+ <input type="hidden" name="type" value="{{index .Params "type"}}">
+ <table>
+ <tr>
+ <td align="right"><b>Attribute1:</b></td>
+ <td>
+ <input type="text" name="myrec2_text"
+ maxlength="63" size="63"
+ autofocus required
+ value="{{index .Params "myrec2_text"}}"
+ >
+ </td>
+ </tr>
+ {{template "RRCommon" .}}
+ <tr><td/><td><button id="submit">{{.Button}}
record</button></td></tr>
+ </table>
+ </form>
+{{end}}
diff --git a/example-c/main.go b/example-c/main.go
new file mode 100644
index 0000000..dcec5a3
--- /dev/null
+++ b/example-c/main.go
@@ -0,0 +1,179 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+package main
+
+// #cgo CFLAGS: -g -Wall
+// #include "plugin.h"
+import "C"
+
+import (
+ "bytes"
+ _ "embed"
+ "strings"
+ "unsafe"
+)
+
+//======================================================================
+// C U S T O M I Z A T I O N
+//======================================================================
+
+//----------------------------------------------------------------------
+// Interface implementation
+//----------------------------------------------------------------------
+
+// Name returns the plugin name (sub-system name)
+//
+// TODO: customize name of the plugin
+func (p *CustomPlugin) Name() string {
+ return "Example-C"
+}
+
+// TemplateNames returns the names of the new / edit template
+// TODO: customize template names (see gui.htpl)
+func (p *CustomPlugin) TemplateNames() (string, string) {
+ return "new_myrecords", "edit_myrecords"
+}
+
+//======================================================================
+// No need to customize code beond this point...
+//======================================================================
+
+// Plugin is the instance of a custom implementation accessed by the
+// gnunet-go framework
+var Plugin = NewCustomPlugin()
+
+// ExamplePlugin is an example plugin for custom records that implements
+// the zonemaster.Plugin interface.
+type CustomPlugin struct {
+ num int // number of managed resource record types
+}
+
+// NewCustomPlugin creates an initialized plugin instance
+func NewCustomPlugin() CustomPlugin {
+ return CustomPlugin{}
+}
+
+//go:embed gui.htpl
+var tpl []byte
+
+// Template returns the new / edit template for resource record types
+// handled by the plugin.
+func (p *CustomPlugin) Template() string {
+ return string(tpl)
+}
+
+// CanHandle returns a list of resource record types that are handled
+// by the plugin. Calls the a C function from 'plugin.c'
+func (p *CustomPlugin) CanHandle() (list []uint32) {
+ var out *C.uint32_t
+ num := C.can_handle(out)
+ p.num = int(num)
+ out = (*C.uint32_t)(C.malloc(C.ulong(p.num * 4)))
+ defer C.free(unsafe.Pointer(out))
+ C.can_handle(out)
+ clist := unsafe.Slice(out, p.num)
+ for _, v := range clist {
+ list = append(list, uint32(v))
+ }
+ return
+}
+
+// Compute a set of record specs allowed under a label with existing records.
+// Calls a C-function from 'plugin.c'
+func (p *CustomPlugin) Compatible(label string, rrSpecs [][2]uint32) (rrOut
[][2]uint32) {
+ // the result array can't be larger than the number of types managed
+ out := (*C.uint32_t)(C.malloc(C.ulong(p.num * 8)))
+ defer C.free(unsafe.Pointer(out))
+ // get label
+ labelC := C.CString(label)
+ defer C.free(unsafe.Pointer(labelC))
+ // get incoming RR specs
+ inNum := len(rrSpecs)
+ in := (*C.uint32_t)(C.malloc(C.ulong(inNum * 8)))
+ defer C.free(unsafe.Pointer(in))
+
+ // call plugin and assemble result
+ outNum := C.compatible(labelC, in, out)
+ clist := unsafe.Slice(out, 2*outNum)
+ for i := 0; i < p.num; i++ {
+ rrt := uint32(clist[2*i])
+ rrf := uint32(clist[2*i+1])
+ rrOut = append(rrOut, [2]uint32{rrt, rrf})
+ }
+ return
+}
+
+// Prefix returns the prefix for record attributes in map
+// Calls a C-function from 'plugin.c'
+func (p *CustomPlugin) Prefix(t uint32) string {
+ cs := C.prefix(C.uint32_t(t))
+ return C.GoString(cs)
+}
+
+// Value returns a human-readable description of RR data
+// Calls a C-function from 'plugin.c'
+func (p *CustomPlugin) Value(t uint32, rr []byte) (string, error) {
+ cs := C.value(C.uint32_t(t), (*C.char)(unsafe.Pointer(&rr[0])))
+ return C.GoString(cs), nil
+}
+
+// ToMap converts resource record data into GUI template variables
+// Calls a C-function from 'plugin.c'
+func (p *CustomPlugin) ToMap(t uint32, rr []byte) (params map[string]string,
err error) {
+ var res *C.char
+ num := C.to_map(C.uint32_t(t), (*C.char)(unsafe.Pointer(&rr[0])), &res)
+ defer C.free(unsafe.Pointer(res))
+ b := make([]byte, num)
+ slice := unsafe.Slice(res, num)
+ for i := range b {
+ b[i] = byte(slice[i])
+ }
+ list := strings.Split(string(b), "\000")
+ params = make(map[string]string)
+ for i := 0; i < len(list)/2; i++ {
+ params[list[2*i]] = list[2*i+1]
+ }
+ return
+}
+
+// FromMap converts a GUI template variables into resource record data
+// Calls a C-function from 'plugin.c'
+func (p *CustomPlugin) FromMap(t uint32, vars map[string]string) ([]byte,
error) {
+ buf := new(bytes.Buffer)
+ for k, v := range vars {
+ buf.WriteString(k)
+ buf.WriteByte(0)
+ buf.WriteString(v)
+ buf.WriteByte(0)
+ }
+ buf.WriteByte(0)
+ params := buf.Bytes()
+ var out *C.char
+ num := C.from_map(C.uint32_t(t), (*C.char)(unsafe.Pointer(¶ms[0])),
&out)
+ b := make([]byte, num)
+ slice := unsafe.Slice(out, num)
+ for i := range b {
+ b[i] = byte(slice[i])
+ }
+ return b, nil
+}
diff --git a/example-c/plugin.c b/example-c/plugin.c
new file mode 100644
index 0000000..9ab8198
--- /dev/null
+++ b/example-c/plugin.c
@@ -0,0 +1,155 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+#include "plugin.h"
+
+#define RECTYPE1 90666
+#define RECTYPE2 90667
+
+const char* rectype1 = "rectype1";
+const char* rectype2 = "rectype2";
+
+typedef struct {
+ uint16_t text_len;
+ // followed by string (NOT \0 terminated!)
+} REC1;
+
+typedef struct {
+ uint32_t var1;
+ uint16_t var2;
+} REC2;
+
+
+int can_handle(uint32_t* out) {
+ if (out != NULL) {
+ // TODO: customize record type list
+ out[0] = RECTYPE1;
+ out[1] = RECTYPE2;
+ }
+ return 2;
+}
+
+int compatible(const char* label, uint32_t* in, uint32_t* out) {
+ // simple case: no restrictions (all handled types allowed, no enforced
flags)
+ out[0] = RECTYPE1; // type #1
+ out[1] = 0; // flags #1
+ out[2] = RECTYPE2; // type #2
+ out[3] = 0; // flags #2
+ return 2;
+}
+
+const char* prefix(uint32_t rr) {
+ // TODO: customize record type list
+ if (rr == RECTYPE1)
+ return rectype1;
+ if (rr == RECTYPE2)
+ return rectype2;
+ return NULL;
+}
+
+char* value(uint32_t rrType, char* rrData) {
+ char* out = (char*)malloc(1024);
+ // TODO: customize record type list
+ if (rrType == RECTYPE1) {
+ REC1* rec = (REC1*)rrData;
+ if (rec->text_len == 0) {
+ out[0] = 0;
+ } else {
+ strcpy(out, rrData+2);
+ }
+ } else if (rrType == RECTYPE2) {
+ REC2* rec = (REC2*)rrData;
+ sprintf(out, "var1=%d,<br>var2=%d", ntohl(rec->var1),
ntohs(rec->var2));
+ }
+ return out;
+}
+
+int to_map(uint32_t rrType, char* rrData, char** res) {
+ *res = (char*)malloc(1024);
+ char* out = *res;
+ // TODO: customize record type list
+ if (rrType == RECTYPE1) {
+ REC1* rec = (REC1*)rrData;
+ const char* key = "rectype1_text";
+ strcpy(out, key);
+ out += strlen(key)+1;
+ if (rec->text_len == 0) {
+ *out = 0;
+ out++;
+ } else {
+ const char* value = rrData+2;
+ strncpy(out, value, rec->text_len);
+ out += strlen(value);
+ }
+ } else if (rrType == RECTYPE2) {
+ REC2* rec = (REC2*)rrData;
+ char* key = "rectype2_var1";
+ strcpy(out, key);
+ out += strlen(key)+1;
+ sprintf(out, "%d", ntohl(rec->var1));
+ out += strlen(out)+1;
+ key = "rectype2_var2";
+ strcpy(out, key);
+ out += strlen(key)+1;
+ sprintf(out, "%d", ntohs(rec->var2));
+ out += strlen(out)+1;
+ }
+ return out-*res;
+}
+
+int from_map(uint32_t rrType, char* params, char** rrData) {
+ *rrData = (char*)malloc(1024);
+ char* res = *rrData;
+ // TODO: customize record type list
+ if (rrType == RECTYPE1) {
+ printf("*** key='%s'\n", params);
+ if (strcmp(params, "rectype1_text") == 0) {
+ int n = strlen(params);
+ char* value = params+n+1;
+ n = strlen(value);
+ *(uint16_t*)res = htons(n);
+ strcpy(res+2, value);
+ return n+3;
+ }
+ } else if (rrType == RECTYPE2) {
+ char* ptr = params;
+ REC2* rec = (REC2*)(res);
+ int val;
+ for (int i = 0; ; i++) {
+ int n = strlen(ptr);
+ if (n == 0)
+ break;
+ char* value = ptr+n+1;
+ n = strlen(value);
+ if (strcmp(ptr, "rectype2_var1") == 0) {
+ sscanf(value, "%d", &val);
+ rec->var1 = htonl(val);
+ } else if (strcmp(ptr, "rectype2_var2") == 0) {
+ sscanf(value, "%d", &val);
+ rec->var2 = htons((uint16_t)(val));
+ }
+ ptr = value+n+1;
+ }
+ return 6;
+ }
+ return 0;
+}
diff --git a/example-c/plugin.h b/example-c/plugin.h
new file mode 100644
index 0000000..f73e43b
--- /dev/null
+++ b/example-c/plugin.h
@@ -0,0 +1,44 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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 _PLUGIN_H
+#define _PLUGIN_H
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <string.h>
+#include <arpa/inet.h>
+
+int can_handle(uint32_t*);
+
+int compatible(const char* label, uint32_t* in, uint32_t* out);
+
+const char* prefix(uint32_t rr);
+
+char* value(uint32_t rrType, char* rrData);
+
+int to_map(uint32_t rrType, char* rrData, char** params);
+
+int from_map(uint32_t rrType, char* params, char** rrData);
+
+#endif
diff --git a/example-c/plugin_test.go b/example-c/plugin_test.go
new file mode 100644
index 0000000..f0962e2
--- /dev/null
+++ b/example-c/plugin_test.go
@@ -0,0 +1,109 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+package main
+
+import (
+ "bytes"
+ "encoding/hex"
+ "testing"
+)
+
+func TestPluginCanHandle(t *testing.T) {
+ list := Plugin.CanHandle()
+ if len(list) == 0 {
+ t.Fatal("no type list received from plugin")
+ }
+ for _, rr := range list {
+ t.Logf("Can handle %d\n", rr)
+ }
+}
+
+func TestPluginCompatible(t *testing.T) {
+ in := make([][2]uint32, 0)
+ out := Plugin.Compatible("@", in)
+ for _, s := range out {
+ t.Logf("Compatible: type=%d, flags=%d\n", s[0], s[1])
+ }
+}
+
+func TestPluginPrefix(t *testing.T) {
+ t.Logf("Prefix: '%s' (%d)\n", Plugin.Prefix(90666), 90666)
+ t.Logf("Prefix: '%s' (%d)\n", Plugin.Prefix(90667), 90667)
+}
+
+var (
+ rec1 = []byte{0x00, 0x03, 0x66, 0x6f, 0x6f, 0x00}
+ rec2 = []byte{0x00, 0x00, 0x00, 0x23, 0x00, 0x42}
+)
+
+func TestPluginValue(t *testing.T) {
+ s1, err := Plugin.Value(90666, rec1)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("rec1: text='%s'\n", s1)
+
+ s2, err := Plugin.Value(90667, rec2)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("rec2: '%s'\n", s2)
+}
+
+func TestPluginToMap(t *testing.T) {
+ params, err := Plugin.ToMap(90666, rec1)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("ToMap: rec1 -> %v\n", params)
+
+ if params, err = Plugin.ToMap(90667, rec2); err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("ToMap: rec2 -> %v\n", params)
+}
+
+func TestPluginFromMap(t *testing.T) {
+ params := map[string]string{
+ "rectype1_text": "foo",
+ }
+ rr, err := Plugin.FromMap(90666, params)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("FromMap: rr=%s\n", hex.EncodeToString(rr))
+ if !bytes.Equal(rr, rec1) {
+ t.Fatal("FromMap for rectype1 failed")
+ }
+ params = map[string]string{
+ "rectype2_var1": "35",
+ "rectype2_var2": "66",
+ }
+ if rr, err = Plugin.FromMap(90667, params); err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("FromMap: rr=%s\n", hex.EncodeToString(rr))
+ if !bytes.Equal(rr, rec2) {
+ t.Fatal("FromMap for rectype2 failed")
+ }
+}
diff --git a/reclaimid/Makefile b/example-go/Makefile
similarity index 88%
rename from reclaimid/Makefile
rename to example-go/Makefile
index 4b04dc6..f4fa800 100644
--- a/reclaimid/Makefile
+++ b/example-go/Makefile
@@ -21,10 +21,10 @@
# SPDX-License-Identifier: AGPL3.0-or-later
-all: ${GOPATH}/bin/plugin_reclaimid.so
+all: ${GOPATH}/bin/plugin_example_go.so
-clean: ${GOPATH}/bin/plugin_reclaimid.so
+clean: ${GOPATH}/bin/plugin_example_go.so
rm -f $^
-${GOPATH}/bin/plugin_reclaimid.so: main.go gui.htpl
+${GOPATH}/bin/plugin_example_go.so: main.go gui.htpl
go build -buildmode=plugin -trimpath -gcflags="-N -l" -o $@ ./...
diff --git a/example-go/gui.htpl b/example-go/gui.htpl
new file mode 100644
index 0000000..8317a72
--- /dev/null
+++ b/example-go/gui.htpl
@@ -0,0 +1,111 @@
+{{define "new_myrecords"}}
+ <!-- DEBUG: show template parameters -->
+ <div>
+ <h3>Template data:</h3>
+ <p>Ref = {{.Ref}}</p>
+ <p>Action = {{.Action}}</p>
+ <p>Button = {{.Button}}</p>
+ <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
+ <p>RRSpecs:</p>
+ <ul>
+ {{range $i,$s := .RRspecs}}
+ <li>Type = {{$s.Type}}, Flags = {{$s.Flags}}</li>
+ {{end}}
+ </ul>
+ <p>Params:</p>
+ <ul>
+ {{range $k,$v := .Params}}
+ <li>'{{$k}}' = '{{$v}}'</li>
+ {{end}}
+ </ul>
+ </div>
+
+ {{$data := .}}
+ <div>
+ <h3>Creating a new custom resource record for label "{{index .Params
"label"}}":</h3>
+ <div class="tabset">
+ {{range $i, $type := .RRspecs}}
+ <input type="radio" name="tabset" id="tab{{$i}}"
aria-controls="tab{{$i}}" {{if eq $i 0}}checked{{end}}>
+ <label for="tab{{$i}}">{{rrtype $type.Type}}</label>
+ {{end}}
+ <div class="tab-panels">
+ {{range $i, $spec := .RRspecs}}
+ <section id="tab{{$i}}" class="tab-panel">
+ {{$t := rrtype $spec.Type}}
+ {{$pf := setspecs $data.Params $spec}}
+ {{if eq $t "MYRECTYPE1"}}{{template "MYRECTYPE1"
$data}}{{end}}
+ {{if eq $t "MYRECTYPE2"}}{{template "MYRECTYPE2"
$data}}{{end}}
+ </section>
+ {{end}}
+ </div>
+ </div>
+ <a href="/"><button>Leave</button></a>
+ </div>
+{{end}}
+
+{{define "edit_myrecords"}}
+ <!-- DEBUG: show template parameters -->
+ <div>
+ <h3>Template data:</h3>
+ <p>Ref = {{.Ref}}</p>
+ <p>Action = {{.Action}}</p>
+ <p>Button = {{.Button}}</p>
+ <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
+ <ul>
+ {{range $k,$v := .Params}}
+ <li>'{{$k}}' = '{{$v}}'</li>
+ {{end}}
+ </ul>
+ </div>
+
+ <div>
+ <h3>Edit a resource record for label {{index .Params "label"}}:</h3>
+ <p><small>(Created: {{index .Params "created"}}, Last edited: {{index
.Params "modified"}})</small></p>
+ {{$t := rritype (index .Params "type")}}
+ {{if eq $t "MYRECTYPE1"}}{{template "MYRECTYPE1" .}}{{end}}
+ {{if eq $t "MYRECTYPE2"}}{{template "MYRECTYPE2" .}}{{end}}
+ </div>
+ <a href="/"><button>Leave</button></a>
+{{end}}
+
+{{define "MYRECTYPE1"}}
+ <h3>RECTYPE1</h3>
+ <form action="/action/{{.Action}}/rr/{{.Ref}}" {{if eq .Action
"upd"}}method="post"{{end}}>
+ <input type="hidden" name="type" value="{{index .Params "type"}}">
+ <table>
+ <tr>
+ <td align="right"><b>Attribute1:</b></td>
+ <td>
+ <input type="text" name="myrec1_text"
+ maxlength="63" size="63"
+ autofocus required
+ value="{{index .Params "myrec1_text"}}"
+ >
+ </td>
+ </tr>
+ {{template "RRCommon" .}}
+ <tr><td/><td><button id="submit">{{.Button}}
record</button></td></tr>
+ </table>
+ </form>
+{{end}}
+
+{{define "MYRECTYPE2"}}
+ <h3>RECTYPE2</h3>
+ <form action="/action/{{.Action}}/rr/{{.Ref}}" {{if eq .Action
"upd"}}method="post"{{end}}>
+ <input type="hidden" name="type" value="{{index .Params "type"}}">
+ <table>
+ <tr>
+ <td align="right"><b>Attribute1:</b></td>
+ <td>
+ <input type="text" name="myrec2_text"
+ maxlength="63" size="63"
+ autofocus required
+ value="{{index .Params "myrec2_text"}}"
+ >
+ </td>
+ </tr>
+ {{template "RRCommon" .}}
+ <tr><td/><td><button id="submit">{{.Button}}
record</button></td></tr>
+ </table>
+ </form>
+{{end}}
diff --git a/example-go/main.go b/example-go/main.go
new file mode 100644
index 0000000..7a6f66a
--- /dev/null
+++ b/example-go/main.go
@@ -0,0 +1,189 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+package main
+
+import (
+ _ "embed"
+ "fmt"
+ "strconv"
+
+ "github.com/bfix/gospel/data"
+)
+
+//======================================================================
+// C U S T O M I Z A T I O N
+//======================================================================
+
+// list of custom record types
+//
+// TODO: list record types handled by the plugin
+const (
+ RECTYPE1 = 90666
+ RECTYPE2 = 90667
+)
+
+//----------------------------------------------------------------------
+// Interface implementation
+//----------------------------------------------------------------------
+
+// Name returns the plugin name (sub-system name)
+//
+// TODO: customize name of the plugin
+func (p *CustomPlugin) Name() string {
+ return "Example-Go"
+}
+
+// CanHandle returns a list of resource record types that are handled
+// by the plugin.
+//
+// TODO: customize record type list
+func (p *CustomPlugin) CanHandle() (list []uint32) {
+ return []uint32{
+ RECTYPE1,
+ RECTYPE2,
+ }
+}
+
+// Compute a set of record specs allowed under a label with existing records
+func (p *CustomPlugin) Compatible(label string, rrSpecs [][2]uint32)
[][2]uint32 {
+ // simple case: no restrictions (all types, all flags)
+ list := [][2]uint32{
+ {RECTYPE1, 0},
+ {RECTYPE2, 0},
+ }
+ return list
+}
+
+// TemplateNames returns the names of the new / edit template
+// TODO: customize template names (see gui.htpl)
+func (p *CustomPlugin) TemplateNames() (string, string) {
+ return "new_myrecords", "edit_myrecords"
+}
+
+// Prefix returns the prefix for record attributes in map
+func (p *CustomPlugin) Prefix(t uint32) string {
+ switch t {
+ case RECTYPE1:
+ return "rectype1"
+ case RECTYPE2:
+ return "rectype2"
+ }
+ return ""
+}
+
+//======================================================================
+// No need to customize code beond this point...
+//======================================================================
+
+// Plugin is the instance of a custom implementation accessed by the
+// gnunet-go framework
+var Plugin = NewCustomPlugin()
+
+// ExamplePlugin is an example plugin for custom records that implements
+// the zonemaster.Plugin interface.
+type CustomPlugin struct{}
+
+// NewCustomPlugin creates an initialized plugin instance
+func NewCustomPlugin() CustomPlugin {
+ return CustomPlugin{}
+}
+
+//go:embed gui.htpl
+var tpl []byte
+
+// Template returns the new / edit template for resource record types
+// handled by the plugin.
+func (p *CustomPlugin) Template() string {
+ return string(tpl)
+}
+
+// Value returns a human-readable description of RR data
+func (p *CustomPlugin) Value(t uint32, rr []byte) (string, error) {
+ rec, err := p.GetInstance(t, rr)
+ if err != nil {
+ return "", err
+ }
+ return rec.Value()
+}
+
+// ToMap converts resource record data into GUI template variables
+func (p *CustomPlugin) ToMap(t uint32, rr []byte) (map[string]string, error) {
+ rec, err := p.GetInstance(t, rr)
+ if err != nil {
+ return nil, err
+ }
+ return rec.ToMap()
+}
+
+// FromMap converts a GUI template variables into resource record data
+func (p *CustomPlugin) FromMap(t uint32, vars map[string]string) ([]byte,
error) {
+ rec, err := p.GetInstance(t, nil)
+ if err != nil {
+ return nil, err
+ }
+ if err = rec.FromMap(vars); err != nil {
+ return nil, err
+ }
+ return data.Marshal(rec)
+}
+
+// CustomRecord interface impemented by custom types.
+type CustomRecord interface {
+ Value() (string, error)
+ ToMap() (map[string]string, error)
+ FromMap(map[string]string) error
+}
+
+// Get record instance for given type and data
+// TODO: customize to own needs
+func (p *CustomPlugin) GetInstance(t uint32, buf []byte) (rec CustomRecord,
err error) {
+ switch t {
+ case RECTYPE1:
+ rec = new(MyRecord1)
+ case RECTYPE2:
+ rec = new(MyRecord2)
+ }
+ if buf != nil {
+ err = data.Unmarshal(rec, buf)
+ }
+ return
+}
+
+// Numbers convertable from parameter value (string)
+type Number interface {
+ uint16 | uint32 | int | int16 | int32 | float32 | float64
+}
+
+// convert parameter value (string) to given number type
+func asInt[T Number](params map[string]string, key string) (val T, err error) {
+ vs, ok := params[key]
+ if !ok {
+ err = fmt.Errorf("%s missing", key)
+ return
+ }
+ var v int
+ if v, err = strconv.Atoi(vs); err != nil {
+ return
+ }
+ return T(v), nil
+}
diff --git a/example-go/plugin_test.go b/example-go/plugin_test.go
new file mode 100644
index 0000000..d002789
--- /dev/null
+++ b/example-go/plugin_test.go
@@ -0,0 +1,109 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+package main
+
+import (
+ "bytes"
+ "encoding/hex"
+ "testing"
+)
+
+func TestPluginCanHandle(t *testing.T) {
+ list := Plugin.CanHandle()
+ if len(list) == 0 {
+ t.Fatal("no type list received from plugin")
+ }
+ for _, rr := range list {
+ t.Logf("Can handle %d\n", rr)
+ }
+}
+
+func TestPluginCompatible(t *testing.T) {
+ in := make([][2]uint32, 0)
+ out := Plugin.Compatible("@", in)
+ for _, s := range out {
+ t.Logf("Compatible: type=%d, flags=%d\n", s[0], s[1])
+ }
+}
+
+func TestPluginPrefix(t *testing.T) {
+ t.Logf("Prefix: '%s' (%d)\n", Plugin.Prefix(90666), 90666)
+ t.Logf("Prefix: '%s' (%d)\n", Plugin.Prefix(90667), 90667)
+}
+
+var (
+ rec1 = []byte{0x00, 0x03, 0x66, 0x6f, 0x6f}
+ rec2 = []byte{0x00, 0x00, 0x00, 0x23, 0x00, 0x42}
+)
+
+func TestPluginValue(t *testing.T) {
+ s1, err := Plugin.Value(90666, rec1)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("rec1: text='%s'\n", s1)
+
+ s2, err := Plugin.Value(90667, rec2)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("rec2: '%s'\n", s2)
+}
+
+func TestPluginToMap(t *testing.T) {
+ params, err := Plugin.ToMap(90666, rec1)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("ToMap: rec1 -> %v\n", params)
+
+ if params, err = Plugin.ToMap(90667, rec2); err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("ToMap: rec2 -> %v\n", params)
+}
+
+func TestPluginFromMap(t *testing.T) {
+ params := map[string]string{
+ "rectype1_text": "foo",
+ }
+ rr, err := Plugin.FromMap(90666, params)
+ if err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("FromMap: rr=%s\n", hex.EncodeToString(rr))
+ if !bytes.Equal(rr, rec1) {
+ t.Fatal("FromMap for rectype1 failed")
+ }
+ params = map[string]string{
+ "rectype2_var1": "35",
+ "rectype2_var2": "66",
+ }
+ if rr, err = Plugin.FromMap(90667, params); err != nil {
+ t.Fatal(err)
+ }
+ t.Logf("FromMap: rr=%s\n", hex.EncodeToString(rr))
+ if !bytes.Equal(rr, rec2) {
+ t.Fatal("FromMap for rectype2 failed")
+ }
+}
diff --git a/example-go/records.go b/example-go/records.go
new file mode 100644
index 0000000..9053a4c
--- /dev/null
+++ b/example-go/records.go
@@ -0,0 +1,96 @@
+// This file is part of gnunet-go-plugins, a collection of plugins for
+// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
+// implement type-specific processing of resource records (e.g. GUI).
+// Copyright (C) 2022 by the authors:
+//
+// * Bernd Fix <brf@hoi-polloi.org> >Y<
+//
+// gnunet-go-plugins 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-go 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
+
+package main
+
+import (
+ "errors"
+ "fmt"
+ "strconv"
+)
+
+//----------------------------------------------------------------------
+// MyRecord1 (example custom record #1)
+//----------------------------------------------------------------------
+
+// MyRecord1 is an example record, where the record data is a simple
+// text string.
+type MyRecord1 struct {
+ TxtLen uint16 `order:"big"` // length of text in NBO
+ Text []byte `size:"TxtLen"` // text data (not terminated by \0)
+}
+
+// Value returns a human-readable representation of the record
+func (rec *MyRecord1) Value() (string, error) {
+ return string(rec.Text), nil
+}
+
+// ToMap returns the parameter set for the record
+func (rec *MyRecord1) ToMap() (params map[string]string, err error) {
+ params = make(map[string]string)
+ params["rectype1_text"] = string(rec.Text)
+ return
+}
+
+// FromMap reconstructs the record attributes from parameter list
+func (rec *MyRecord1) FromMap(params map[string]string) error {
+ text, ok := params["rectype1_text"]
+ if !ok {
+ return errors.New("rectype1_text missing")
+ }
+ rec.TxtLen = uint16(len(text))
+ rec.Text = []byte(text)
+ return nil
+}
+
+//----------------------------------------------------------------------
+// MyRecord2 (example custom record #2)
+//----------------------------------------------------------------------
+
+// MyRecord2 is an example record, where the record data contains two
+// integer values
+type MyRecord2 struct {
+ Var1 uint32 `order:"big"` // variable #1 in NBO
+ Var2 uint16 `order:"big"` // variable #2 in NBO
+}
+
+// Value returns a human-readable representation of the record
+func (rec *MyRecord2) Value() (string, error) {
+ return fmt.Sprintf("var1=%d,<br>var2=%d", rec.Var1, rec.Var2), nil
+}
+
+// ToMap returns the parameter set for the record
+func (rec *MyRecord2) ToMap() (params map[string]string, err error) {
+ params = make(map[string]string)
+ params["rectype2_var1"] = strconv.Itoa(int(rec.Var1))
+ params["rectype2_var2"] = strconv.Itoa(int(rec.Var2))
+ return
+}
+
+// FromMap reconstructs the record attributes from parameter list
+func (rec *MyRecord2) FromMap(params map[string]string) (err error) {
+ if rec.Var1, err = asInt[uint32](params, "rectype2_var1"); err != nil {
+ return
+ }
+ rec.Var2, err = asInt[uint16](params, "rectype2_var2")
+ return
+}
diff --git a/reclaimid/gui.htpl b/reclaimid/gui.htpl
deleted file mode 100644
index 2a8f5d8..0000000
--- a/reclaimid/gui.htpl
+++ /dev/null
@@ -1,37 +0,0 @@
-{{define "new_reclaim"}}
- <h3>New Reclaim:ID resource record</h3>
- <div>
- <p>Ref = {{.Ref}}</p>
- <p>Action = {{.Action}}</p>
- <p>Button = {{.Button}}</p>
- <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
- <p>RRSpecs:</p>
- <ul>
- {{range $i,$s := .RRspecs}}
- <li>Type = {{$s.Type}}, Flags = {{$s.Flags}}</li>
- {{end}}
- </ul>
- <p>Params:</p>
- <ul>
- {{range $k,$v := .Params}}
- <li>'{{$k}}' = '{{$v}}'</li>
- {{end}}
- </ul>
- </div>
- <a href="/"><button>Leave</button></a>
-{{end}}
-{{define "edit_reclaim"}}
- <h3>Edit Reclaim:ID resource record</h3>
- <div>
- <p>Ref = {{.Ref}}</p>
- <p>Action = {{.Action}}</p>
- <p>Button = {{.Button}}</p>
- <p>Names: {{range $i,$v := .Names}}'{{$v}}',{{end}}</p>
- <ul>
- {{range $k,$v := .Params}}
- <li>'{{$k}}' = '{{$v}}'</li>
- {{end}}
- </ul>
- </div>
- <a href="/"><button>Leave</button></a>
-{{end}}
diff --git a/reclaimid/main.go b/reclaimid/main.go
deleted file mode 100644
index b8e5ad7..0000000
--- a/reclaimid/main.go
+++ /dev/null
@@ -1,114 +0,0 @@
-// This file is part of gnunet-go-plugins, a collection of plugins for
-// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
-// implement type-specific processing of resource records (e.g. GUI).
-// Copyright (C) 2022 by the authors:
-//
-// * Bernd Fix <brf@hoi-polloi.org> >Y<
-//
-// gnunet-go-plugins 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-go 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
-
-package main
-
-import (
- _ "embed"
-
- "github.com/bfix/gospel/data"
-)
-
-// List of handled resource record types.
-var handledTypes = []uint32{
- 65544, // RECLAIM_ATTRIBUTE
- 65545, // RECLAIM_TICKET
- 65550, // RECLAIM_ATTRIBUTE_REF
- 65552, // RECLAIM_OIDC_CLIENT
- 65553, // RECLAIM_OIDC_REDIRECT
- 65554, // RECLAIM_CREDENTIAL
- 65555, // RECLAIM_PRESENTATION
-}
-
-// Plugin is the instance of a custom implementation accessed by the
-// gnunet-go framework
-//
-//nolint:deadcode // used by framework
-var Plugin = NewReclaimIDPlugin()
-
-// ReclaimIDPlugin is a handler of Reclaim:ID specific records that implements
-// the zonemaster.Plugin interface.
-type ReclaimIDPlugin struct{}
-
-// NewReclaimIDPlugin creates an initialized plugin instance
-func NewReclaimIDPlugin() ReclaimIDPlugin {
- return ReclaimIDPlugin{}
-}
-
-//----------------------------------------------------------------------
-// Interface implementation
-//----------------------------------------------------------------------
-
-// Name returns the plugin name (sub-system name)
-func (p *ReclaimIDPlugin) Name() string {
- return "Reclaim:ID"
-}
-
-// CanHandle returns a list of resource record types that are handled by the
-// plugin
-func (p *ReclaimIDPlugin) CanHandle() (list []uint32) {
- return handledTypes
-}
-
-//go:embed gui.htpl
-var tpl []byte
-
-// Template returns the new / edit template for resource record types
-// handled by the plugin.
-func (p *ReclaimIDPlugin) Template() string {
- return string(tpl)
-}
-
-// TemplateNames returns the names of the new / edit template
-func (p *ReclaimIDPlugin) TemplateNames() (string, string) {
- return "new_reclaim", "edit_reclaim"
-}
-
-// Value returns a human-readable description of RR data
-func (p *ReclaimIDPlugin) Value(t uint32, rr []byte) (string, error) {
- rec, err := GetInstance(t, rr)
- if err != nil {
- return "", err
- }
- return rec.Value()
-}
-
-// ToMap converts resource record data into GUI template variables
-func (p *ReclaimIDPlugin) ToMap(t uint32, rr []byte) (map[string]string,
error) {
- rec, err := GetInstance(t, rr)
- if err != nil {
- return nil, err
- }
- return rec.ToMap()
-}
-
-// FromMap converts a GUI template variables into resource record data
-func (p *ReclaimIDPlugin) FromMap(t uint32, vars map[string]string) ([]byte,
error) {
- rec, err := GetInstance(t, nil)
- if err != nil {
- return nil, err
- }
- if err = rec.FromMap(vars); err != nil {
- return nil, err
- }
- return data.Marshal(rec)
-}
diff --git a/reclaimid/rrtypes.go b/reclaimid/rrtypes.go
deleted file mode 100644
index 7a92254..0000000
--- a/reclaimid/rrtypes.go
+++ /dev/null
@@ -1,94 +0,0 @@
-// This file is part of gnunet-go-plugins, a collection of plugins for
-// the GNUnet-implementation in Golang (gnunet.go). Plugins are used to
-// implement type-specific processing of resource records (e.g. GUI).
-// Copyright (C) 2022 by the authors:
-//
-// * Bernd Fix <brf@hoi-polloi.org> >Y<
-//
-// gnunet-go-plugins 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-go 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
-
-package main
-
-import (
- "errors"
-
- "github.com/bfix/gospel/data"
-)
-
-// ReclaimRecord interface impemented by custom types.
-type ReclaimRecord interface {
- Value() (string, error)
- ToMap() (map[string]string, error)
- FromMap(map[string]string) error
-}
-
-// Get record instance for given type and data
-func GetInstance(t uint32, buf []byte) (rec ReclaimRecord, err error) {
- switch t {
- case 65544: // RECLAIM_ATTRIBUTE
- rec = new(ReclaimAttribute)
- case 65545: // RECLAIM_TICKET
- case 65550: // RECLAIM_ATTRIBUTE_REF
- case 65552: // RECLAIM_OIDC_CLIENT
- case 65553: // RECLAIM_OIDC_REDIRECT
- case 65554: // RECLAIM_CREDENTIAL
- case 65555: // RECLAIM_PRESENTATION
- }
- if buf != nil {
- err = data.Unmarshal(rec, buf)
- }
- return
-}
-
-//======================================================================
-// Reclaim Resource Records
-//======================================================================
-
-//----------------------------------------------------------------------
-// Reclaim Attribute
-//----------------------------------------------------------------------
-
-// ReclaimAttribute record
-type ReclaimAttribute struct {
- ID []byte `size:"32"` // Reclaim identifier
- Credential []byte `size:"32"` // Reclaim identifier
- Claim uint32 `order:"big"` // claim
- Type uint32 `order:"big"` // type
- Flags uint32 `order:"big"` // flags
- Name string `` // name
- LenData uint16 `order:"big"` // length of data
- Data []byte `size:"LenData"` // binary data
-}
-
-// Value returns a human-readable representation of the record
-func (rec *ReclaimAttribute) Value() (string, error) {
- return "", errors.New("not implemented yet")
-}
-
-// ToMap returns the parameter set for the record
-func (rec *ReclaimAttribute) ToMap() (params map[string]string, err error) {
- params = make(map[string]string)
- return
-}
-
-// FromMap reconstructs the record attributes from parameter list
-func (rec *ReclaimAttribute) FromMap(params map[string]string) error {
- return nil
-}
-
-//----------------------------------------------------------------------
-// Reclaim ...
-//----------------------------------------------------------------------
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet-go-plugins] branch master updated (be2877b -> 8eec0c3),
gnunet <=