From: Alan T. DeKok <aland@freeradius.org>
Date: Mon, 21 Dec 2020 13:35:08 +0000 (-0500)
Subject: some updates for the new dictionary functionality
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8aff01a8f68e96c8e2e2da09a57337713e3d940;p=thirdparty%2Ffreeradius-server.git

some updates for the new dictionary functionality
---

diff --git a/man/man5/dictionary.5 b/man/man5/dictionary.5
index 29fcbf00655..74a6387fa0e 100644
--- a/man/man5/dictionary.5
+++ b/man/man5/dictionary.5
@@ -74,27 +74,63 @@ name.  In most cases, it is a decimal number, such as "256".  For
 certain attributes, a "dotted number" notation is used, e.g. "1.2".
 The "dotted number" notation is used only for certain attributes.
 
-The \fItype\fP field can be one of the standard types:
+The \fItype\fP field can be one of the standard types, as defined in
+RFC 8044:
 
      string       UTF-8 printable text (the RFCs call this "text")
      octets       opaque binary data (the RFCs call this "string")
      ipaddr       IPv4 address
-     date         Seconds since January 1, 1970 (32-bits)
      integer      32-bit unsigned integer
+     ipv4prefix   IPv4 Prefix as given in RFC 6572.
      ipv6addr     IPv6 Address
      ipv6prefix   IPV6 prefix, with mask
      ifid         Interface Id (hex:hex:hex:hex)
-     integer64	  64-bit unsigned integer
 
 The \fItype\fP field can also be one of the following non-standard types:
 
+     bit[]	  Bit arrays, but are only allowed for MEMBERs
+     bool	  Boolean true / false value
+     combo=ip     Either IPv4 or IPv6 address, for WiMAX
+     combo=ipprefix   Either IPv4 or IPv6 prefix, for WiMAX
+     date         Seconds since January 1, 1970 (32-bits)
      ether        Ethernet MAC address
-     byte         8-bit unsigned integer
-     short        16-bit unsigned integer
-     signed       31-bit signed integer (packed into 32-bit field)
+     group        DHCPv6 or Diameter-style grouping
+     int8         8-bit signed integer
+     int16        16-bit signed integer
+     int32        32-bit signed integer
+     int64        64-bit signed integer
      struct       fixed-size structures
+     time_delta   a delta between two times
      tlv          Type-Length-Value (allows nested attributes)
-     ipv4prefix   IPv4 Prefix as given in RFC 6572.
+     uint8        8-bit unsigned integer
+     uint16       16-bit unsigned integer
+     uint32       32-bit unsigned integer
+     uint64       64-bit unsigned integer
+
+The following values for the \fItype\fP field are accepted, but are
+deprecated.
+
+     byte         use "int8" instead
+     integer      use "uint32" instead
+     integer64    use "uint64" instead
+     signed       use "int32" instead
+     short        use "int16" instead
+
+The following values for the \fItype\fP field are defined in RFC 8044,
+but are not accepted in FreeRADIUS.  The equivalent FreeRADIUS
+definition is, however, accepted:
+
+     concat       use "concat" as a flag instead
+     enum         use "uint32" instead
+     evs          use "vsa" instead
+     extended     use "extended" as a flag instead
+     long-extended use "long-extended" as a flag instead
+     time         use "date" instead
+
+FreeRADIUS will accept a VALUE definition for any "base" data type.
+For example, you can define VALUEs for IP addresses, Ethernet
+addresses, etc.  VALUEs cannot be defined for "structural" data types
+such as struct, tlv, vsa, group, etc.
 
 The "struct" type is a compound type.  An attribute of data type
 "struct" can have multiple sub-attributes defined, just as with TLVs.
@@ -112,7 +148,7 @@ This usage is no longer allowed.
 
 The options are:
 
-     encrypt=#    set encryption type 1, 2, or 3.
+     encrypt=...    set encryption type 1, 2, or 3.
      has_tag      The attribute can have an RFC 2868 style tag
 
 The "encrypt" flag marks the attribute as being encrypted with one of