]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
move WiMAX examples to the WiMAX module.
authorAlan T. DeKok <aland@freeradius.org>
Thu, 11 Dec 2025 01:28:32 +0000 (20:28 -0500)
committerAlan T. DeKok <aland@freeradius.org>
Thu, 11 Dec 2025 01:29:25 +0000 (20:29 -0500)
WiMAX is largely dead, so it does not need to appear in the default
configuration.

doc/antora/modules/reference/pages/raddb/mods-available/wimax.adoc
doc/antora/modules/reference/pages/raddb/sites-available/default.adoc
raddb/mods-available/wimax
raddb/sites-available/default

index fddb42b63ade53fd575e4607dd82c4a62b9bc760..a7ece606032dbce007b3239399c44b2f3236d845 100644 (file)
@@ -4,7 +4,7 @@
 
 = WiMAX Module
 
-The `winmax` module implements the WiMAX attributes as defined in
+The `wimax` module implements the WiMAX attributes as defined in
 NWG_R1_V1.2.1-Stage-3.pdf
 
 It should be listed in the `recv Access-Request` and `recv Accounting-Request` sections.
@@ -13,11 +13,34 @@ NOTE: The module will change the horrible binary version of
 `link:https://freeradius.org/rfc/rfc2865.html#Calling-Station-Id[Calling-Station-Id]` to the normal format, as specified in RFC
 3580, Section 3.21.
 
+## recv Access-Request
+
+In the `recv Access-Request section. the `wimax` module fixes up
+various non-standard WiMAX issues.
+
+The WiMAX specification says that the `link:https://freeradius.org/rfc/rfc2865.html#Calling-Station-Id[Calling-Station-Id]`
+is 6 octets of the MAC.  This definition conflicts with RFC
+3580, and all common RADIUS practices. Uncommenting the
+`wimax` module here allows the module to change the
+`link:https://freeradius.org/rfc/rfc2865.html#Calling-Station-Id[Calling-Station-Id]` attribute to the normal format as
+specified in https://tools.ietf.org/html/rfc3580#section-3.21.[RFC 3580 Section 3.21.]
+
+
+== send Access-Accept
+
 In order to calculate the various WiMAX keys, the module should
-be listed in the `post-auth` section.  If EAP authentication
+be listed in the `send Access-Accept` section.  If EAP authentication
 has been used, AND the EAP method derives MSK and EMSK, then
 the various WiMAX keys can be calculated.
 
+send Access-Accept {
+
+
+
+
+
+== Miscellaneous
+
 Some useful things to remember:
 
 [options="header,autowidth"]
@@ -44,7 +67,7 @@ MN-NAI:: Mobile node NAI.
 
 You have to create it, and put it into the request or reply as something like:
 
-  WiMAX-MN-NAI = "%{User-Name}"
+  WiMAX-MN-NAI = User-Name}
 
 You will also have to have the appropriate IP address (`v4` or `v6`)
 in order to calculate the keys below.
@@ -129,6 +152,31 @@ The default is to leave them in place.
 == Default Configuration
 
 ```
+#      recv Access-Request {
+#              ...
+#              wimax
+#              ...
+#      }
+#              ...
+#              # define the WiMAX NAI
+#              request.WiMAX-MN-NAI = User-Name
+#              # Update the reply with "template" values. The wimax module
+#              # will see this, and replace the template values with the
+#              #correct ones taken from the cryptographic calculations,
+#              reply += {
+#                      Vendor-Specific.WiMAX = {
+#                              FA-RK-Key = 0x00
+#                              MSK = reply.EAP-MSK
+#                      }
+#              }
+#              #  You may want to delete the `MS-MPPE-*-Keys` from the
+#              #  reply, as some WiMAX clients behave badly when those
+#              #  attributes are included. See the configuration entry
+#              #  `delete_mppe_keys` for more information.
+#              #
+#              wimax
+#              ...
+#      }
 wimax {
        delete_mppe_keys = no
 }
index eac0042135cfffcb327d79c85ec8d4c5a9369e59..4c632185c7019a9b0567c15e8a561347df1962f5 100644 (file)
@@ -916,20 +916,6 @@ FreeRADIUS, the `digest` module will set `Auth-Type :=
 
 ```
 
-The `wimax` module fixes up various WiMAX-specific stupidities.
-
-The WiMAX specification says that the `link:https://freeradius.org/rfc/rfc2865.html#Calling-Station-Id[Calling-Station-Id]`
-is 6 octets of the MAC.  This definition conflicts with RFC
-3580, and all common RADIUS practices. Uncommenting the
-`wimax` module here allows the module to change the
-`link:https://freeradius.org/rfc/rfc2865.html#Calling-Station-Id[Calling-Station-Id]` attribute to the normal format as
-specified in https://tools.ietf.org/html/rfc3580#section-3.21.[RFC 3580 Section 3.21.]
-
-```
-#      wimax
-
-```
-
 The `eap` module takes care of all EAP authentication,
 including EAP-MD5, EAP-TLS, PEAP and EAP-TTLS.
 
@@ -1353,40 +1339,6 @@ user's object in LDAP after a successful login.
 
 ```
 
-Calculate the various WiMAX keys. In order for this to
-work, you will need to define the WiMAX NAI, usually
-via:
-
-```
-#      request.WiMAX-MN-NAI = "%{User-Name}"
-
-```
-If you want various keys to be calculated, you will
-need to update the reply with "template" values. The
-module will see this, and replace the template values
-with the correct ones taken from the cryptographic
-calculations, e.g.
-
-```
-#      reply += {
-#              Vendor-Specific.WiMAX = {
-#                      FA-RK-Key = 0x00
-#                      MSK = reply.EAP-MSK
-#              }
-#      }
-
-```
-You may want to delete the `MS-MPPE-*-Keys` from the
-reply, as some WiMAX clients behave badly when those
-attributes are included. See the configuration entry
-`delete_mppe_keys` in xref:reference:raddb/mods-available/wimax.adoc[mods-available/wimax] for
-more information.
-
-```
-#      wimax
-
-```
-
 If there is a client certificate (EAP-TLS, and very
 occasionally PEAP and EAP-TTLS), then some attributes
 are filled out after the certificate verification has
index a57a9faf2def569a475b8389b1b5a4220d99f43d..1bf61e39099c7f62152eabfb45b782394c1694ea 100644 (file)
@@ -7,7 +7,7 @@
 #
 #  = WiMAX Module
 #
-#  The `winmax` module implements the WiMAX attributes as defined in
+#  The `wimax` module implements the WiMAX attributes as defined in
 #  NWG_R1_V1.2.1-Stage-3.pdf
 #
 #  It should be listed in the `recv Access-Request` and `recv Accounting-Request` sections.
 #  `Calling-Station-Id` to the normal format, as specified in RFC
 #  3580, Section 3.21.
 #
+#  ## recv Access-Request
+#
+#  In the `recv Access-Request section. the `wimax` module fixes up
+#  various non-standard WiMAX issues.
+#
+#  The WiMAX specification says that the `Calling-Station-Id`
+#  is 6 octets of the MAC.  This definition conflicts with RFC
+#  3580, and all common RADIUS practices. Uncommenting the
+#  `wimax` module here allows the module to change the
+#  `Calling-Station-Id` attribute to the normal format as
+#  specified in RFC 3580 Section 3.21.
+#
+#      recv Access-Request {
+#              ...
+#              wimax
+#              ...
+#      }
+#
+#  == send Access-Accept
+#
 #  In order to calculate the various WiMAX keys, the module should
-#  be listed in the `post-auth` section.  If EAP authentication
+#  be listed in the `send Access-Accept` section.  If EAP authentication
 #  has been used, AND the EAP method derives MSK and EMSK, then
 #  the various WiMAX keys can be calculated.
 #
+#      send Access-Accept {
+#              ...
+#
+#              # define the WiMAX NAI
+#              request.WiMAX-MN-NAI = User-Name
+#
+#              # Update the reply with "template" values. The wimax module
+#              # will see this, and replace the template values with the
+#              #correct ones taken from the cryptographic calculations,
+#              reply += {
+#                      Vendor-Specific.WiMAX = {
+#                              FA-RK-Key = 0x00
+#                              MSK = reply.EAP-MSK
+#                      }
+#              }
+#
+#              #  You may want to delete the `MS-MPPE-*-Keys` from the
+#              #  reply, as some WiMAX clients behave badly when those
+#              #  attributes are included. See the configuration entry
+#              #  `delete_mppe_keys` for more information.
+#              #
+#              wimax
+#
+#              ...
+#      }
+#
+#  == Miscellaneous
+#
 #  Some useful things to remember:
 #
 #  [options="header,autowidth"]
@@ -47,7 +95,7 @@
 #
 #  You have to create it, and put it into the request or reply as something like:
 #
-#    WiMAX-MN-NAI = "%{User-Name}"
+#    WiMAX-MN-NAI = User-Name}
 #
 #  You will also have to have the appropriate IP address (`v4` or `v6`)
 #  in order to calculate the keys below.
index e354512d7b39b248759ce732d2066ff4a9f38fdf..4f192269a01d897e82aa59f3d3ac3683b45a3bfb 100644 (file)
@@ -811,18 +811,6 @@ recv Access-Request {
        #
        digest
 
-       #
-       #  The `wimax` module fixes up various WiMAX-specific stupidities.
-       #
-       #  The WiMAX specification says that the `Calling-Station-Id`
-       #  is 6 octets of the MAC.  This definition conflicts with RFC
-       #  3580, and all common RADIUS practices. Uncommenting the
-       #  `wimax` module here allows the module to change the
-       #  `Calling-Station-Id` attribute to the normal format as
-       #  specified in RFC 3580 Section 3.21.
-       #
-#      wimax
-
        #
        #  The `eap` module takes care of all EAP authentication,
        #  including EAP-MD5, EAP-TLS, PEAP and EAP-TTLS.
@@ -1192,34 +1180,6 @@ send Access-Accept {
        #
 #      ldap
 
-       #
-       #  Calculate the various WiMAX keys. In order for this to
-       #  work, you will need to define the WiMAX NAI, usually
-       #  via:
-       #
-#      request.WiMAX-MN-NAI = "%{User-Name}"
-
-       #  If you want various keys to be calculated, you will
-       #  need to update the reply with "template" values. The
-       #  module will see this, and replace the template values
-       #  with the correct ones taken from the cryptographic
-       #  calculations, e.g.
-       #
-#      reply += {
-#              Vendor-Specific.WiMAX = {
-#                      FA-RK-Key = 0x00
-#                      MSK = reply.EAP-MSK
-#              }
-#      }
-
-       #  You may want to delete the `MS-MPPE-*-Keys` from the
-       #  reply, as some WiMAX clients behave badly when those
-       #  attributes are included. See the configuration entry
-       #  `delete_mppe_keys` in `mods-available/wimax` for
-       #  more information.
-       #
-#      wimax
-
        #
        #  If there is a client certificate (EAP-TLS, and very
        #  occasionally PEAP and EAP-TTLS), then some attributes