gana

GNUnet Assigned Numbers Authority
Log | Files | Refs | README | LICENSE

README (2495B)

      1             GNUnet Assigned Numbers Authority (GANA)
      2             ========================================
      3 
      4 
      5 This Git repository contains various registries we maintain, for
      6 GNUnet other projects that need names and numbers for use in network
      7 protocols.  If you need to open a new registry, please feel free
      8 to contact us at gana@gnunet.org.
      9 
     10 
     11 Contributors
     12 ============
     13 
     14 If you have Git access to GANA, you are generally authorized to add
     15 new entries to the registries.  Most registries are under a simple
     16 first-come first-use policy. If you are unsure about the registration
     17 policy of a particular registry, do ask gana@gnunet.org before making
     18 changes.
     19 
     20 Deleting or modifying existing entries (except improving comments)
     21 should be done particularly carefully, so if unsure you might want to
     22 double-check with gana@gnunet.org before changing or deleting
     23 anything.
     24 
     25 
     26 History
     27 =======
     28 
     29 Barry Leiba wrote on April 4th 2020 that "Neither IANA nor
     30 participants in the IETF will have any necessary expertise to evaluate
     31 registration requests in the sort of registry described, and no one
     32 will be well served by the creation of such a registry at IANA.  It
     33 would be far better to have a registration process be described in
     34 this document involving experts from the industry as reviewers and
     35 maintenance of the registrations by an industry organization, rather
     36 than by IANA."
     37 
     38 So here we are. As IETF/IANA "lack the necessary expertise to operate
     39 a registry" for names and numbers used in network protocols, the
     40 GNUnet project is happy to step up.
     41 
     42 
     43 License
     44 =======
     45 
     46 The GANA database is licensed under the GPL. See COPYING.
     47 
     48 
     49 Design
     50 ======
     51 
     52 Each registry must have a unique name and all associated information
     53 lives in a directory under that unique name in this Git repository.
     54 
     55 Each registry must include at least the following files:
     56 
     57 * README[.*]:
     58     document describing the purpose of the registry in English
     59 * POLICY[.*]:
     60     registration policy, explaining required fields and
     61     the procedure for adding, updating and deleting entries
     62 * registry.rec:
     63     GNU recutils data file with all of the current entries in
     64     the registry
     65 * Makefile:
     66     GNU make makefile with a 'make check' target to run the validation logic.
     67     Ideally, the registry.rec should be written such that the 'check' target
     68     is simply invoking "recfix --check registry.rec".
     69     Additional targets to convert data.rec to various formats may be defined.
     70     In particular, see format.sh in this directory (try --help).