]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
docs: Update Concepts section and rearrange directory structure.
authornolade <nola.aunger@inkbridge.io>
Fri, 13 Jun 2025 22:47:08 +0000 (18:47 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Tue, 24 Jun 2025 02:38:42 +0000 (22:38 -0400)
- New intro/landing page, xrefs to link with other sections in docs.
- Added components section to include server, nas, datastore info
- Added radius session/message/processing sections.docs:
- Rename Module >> Protocol>> LDAP section to Authentication with LDAP and added relevant subsections

22 files changed:
doc/antora/modules/ROOT/pages/faq.adoc
doc/antora/modules/concepts/nav.adoc
doc/antora/modules/concepts/pages/aaa/aaa.adoc [moved from doc/antora/modules/concepts/pages/modules/aaa/aaa.adoc with 90% similarity]
doc/antora/modules/concepts/pages/aaa/acct.adoc [moved from doc/antora/modules/concepts/pages/modules/aaa/acct.adoc with 100% similarity]
doc/antora/modules/concepts/pages/aaa/authn.adoc [moved from doc/antora/modules/concepts/pages/modules/aaa/authn.adoc with 100% similarity]
doc/antora/modules/concepts/pages/aaa/authz.adoc [moved from doc/antora/modules/concepts/pages/modules/aaa/authz.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/architecture.adoc [moved from doc/antora/modules/concepts/pages/modules/components/architecture.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/datastore.adoc [moved from doc/antora/modules/concepts/pages/modules/components/datastore.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/nac.adoc [moved from doc/antora/modules/concepts/pages/modules/components/nac.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/nas.adoc [moved from doc/antora/modules/concepts/pages/modules/components/nas.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/policy.adoc [moved from doc/antora/modules/concepts/pages/modules/components/policy.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/radius.adoc [moved from doc/antora/modules/concepts/pages/modules/components/radius.adoc with 100% similarity]
doc/antora/modules/concepts/pages/components/radius_servers.adoc [moved from doc/antora/modules/concepts/pages/modules/components/radius_servers.adoc with 100% similarity]
doc/antora/modules/concepts/pages/freeradius.adoc [moved from doc/antora/modules/concepts/pages/modules/freeradius.adoc with 100% similarity]
doc/antora/modules/concepts/pages/index.adoc
doc/antora/modules/concepts/pages/protocol/authproto.adoc [moved from doc/antora/modules/concepts/pages/modules/protocol/authproto.adoc with 100% similarity]
doc/antora/modules/concepts/pages/protocol/peap.adoc [moved from doc/antora/modules/concepts/pages/modules/protocol/peap.adoc with 100% similarity]
doc/antora/modules/concepts/pages/protocol/wep.adoc [moved from doc/antora/modules/concepts/pages/modules/protocol/wep.adoc with 100% similarity]
doc/antora/modules/concepts/pages/protocol/wpa.adoc [moved from doc/antora/modules/concepts/pages/modules/protocol/wpa.adoc with 100% similarity]
doc/antora/modules/concepts/pages/session/processing.adoc [moved from doc/antora/modules/concepts/pages/modules/session/processing.adoc with 97% similarity]
doc/antora/modules/concepts/pages/session/radius_session.adoc [moved from doc/antora/modules/concepts/pages/modules/session/radius_session.adoc with 100% similarity]
doc/antora/modules/concepts/pages/session/radius_session_msg.adoc [moved from doc/antora/modules/concepts/pages/modules/session/radius_session_msg.adoc with 99% similarity]

index 76bc3a9a0a5fc12b6ed9cca53d24671bd007ea7b..fbde47cd91a1475e7fbe6c0b60f06ed2d8d3e3c7 100644 (file)
@@ -10,14 +10,14 @@ Read this FAQ before posting questions to the mailing lists as your question may
 
 == FreeRADIUS Overview
 
-FreeRADIUS is the worlds leading RADIUS server used by Internet Service Providers (ISPs), cellular providers, and corporate and educational networks.  RADIUS, which stands for “Remote Authentication Dial In User Service”, is a network protocol used to manage network access using xref:concepts:modules/protocol/authproto.adoc[Authentication, Authorization and Accounting] processes.
+FreeRADIUS is the worlds leading RADIUS server used by Internet Service Providers (ISPs), cellular providers, and corporate and educational networks.  RADIUS, which stands for “Remote Authentication Dial In User Service”, is a network protocol used to manage network access using xref:concepts:protocol/authproto.adoc[Authentication, Authorization and Accounting] processes.
 
 FreeRADIUS is developed by a group of people who call themselves "The FreeRADIUS Project" and is sponsored by https://www.inkbridgenetworks.com/[InkBridge Networks].
 
 === What is FreeRADIUS and what is it supposed to do?
 
 The FreeRADIUS Server is a daemon for unix and unix like operating systems which allows one to set up a radius protocol server. The RADIUS protocol manages the communication between network devices to facilitate remote user
-authentication and accounting practices. See xref:concepts:modules/components/architecture.adoc[Architecture] for more information on RADIUS components and interactions. The RADIUS protocol serves three primary functions:
+authentication and accounting practices. See xref:concepts:components/architecture.adoc[Architecture] for more information on RADIUS components and interactions. The RADIUS protocol serves three primary functions:
 
 * Authenticates users or devices before allowing them access to a network.
 * Authorizes those users or devices for specific network services.
index 73942695583693444f1a2a376dabd11b37418f24..cb0bcd007d1eecfa036003e72426cecea845d651 100644 (file)
@@ -1,19 +1,19 @@
 * xref:index.adoc[Concepts]
 ** xref:overview.adoc[Overview]
-*** xref:modules/freeradius.adoc[What is FreeRADIUS]
-*** xref:modules/aaa/aaa.adoc[Authentication Authorisation Accounting (AAA)]
-**** xref:modules/aaa/authz.adoc[Authorisation]
-**** xref:modules/aaa/authn.adoc[Authentication]
-**** xref:modules/aaa/acct.adoc[Accounting]
-*** xref:modules/components/architecture.adoc[RADIUS System Components]
-**** xref:modules/components/nas.adoc[Network Access Server (NAS)]
-**** xref:modules/components/radius_servers.adoc[RADIUS Server]
-***** xref:modules/components/radius_servers.adoc#policy[Server Policies]
-**** xref:modules/components/datastore.adoc[Datastores]
-*** xref:modules/session/radius_session.adoc[RADIUS Sessions]
-**** xref:modules/session/radius_session_msg.adoc[Messages]
-**** xref:modules/session/processing.adoc[Processing]
-** xref:modules/protocol/authproto.adoc[Protocols]
+*** xref:freeradius.adoc[What is FreeRADIUS]
+*** xref:aaa/aaa.adoc[Authentication Authorisation Accounting (AAA)]
+**** xref:aaa/authz.adoc[Authorisation]
+**** xref:aaa/authn.adoc[Authentication]
+**** xref:aaa/acct.adoc[Accounting]
+*** xref:components/architecture.adoc[RADIUS System Components]
+**** xref:components/nas.adoc[Network Access Server (NAS)]
+**** xref:components/radius_servers.adoc[RADIUS Server]
+***** xref:components/radius_servers.adoc#policy[Server Policies]
+**** xref:components/datastore.adoc[Datastores]
+*** xref:session/radius_session.adoc[RADIUS Sessions]
+**** xref:session/radius_session_msg.adoc[Messages]
+**** xref:session/processing.adoc[Processing]
+** xref:protocol/authproto.adoc[Protocols]
 ** xref:modules/ldap/authentication.adoc[Authentication with LDAP]
 *** xref:modules/ldap/password_storage.adoc[Password Storage]
 *** xref:modules/ldap/novell.adoc[Integrate Novell]
similarity index 90%
rename from doc/antora/modules/concepts/pages/modules/aaa/aaa.adoc
rename to doc/antora/modules/concepts/pages/aaa/aaa.adoc
index 36af4fc6ad1d99c1e4a3bb14c7303ee30d35f332..7187717ed0fc532524bf57dabdae39847e76dee3 100644 (file)
@@ -12,7 +12,7 @@ The following sections describe each part of the AAA solution, and how each one
 
 == AAA request handling
 
-AAA request handling refers to the process by which a system manages xref:modules/aaa/authn.adoc[authentication], xref:modules/aaa/authz.adoc[authorisation], and xref:modules/aaa/acct.adoc[accounting] (AAA) services for users accessing computer resources or network services. This process involves verifying user identities, granting access based on permissions, and tracking their activities for auditing or billing purposes.
+AAA request handling refers to the process by which a system manages xref:aaa/authn.adoc[authentication], xref:aaa/authz.adoc[authorisation], and xref:aaa/acct.adoc[accounting] (AAA) services for users accessing computer resources or network services. This process involves verifying user identities, granting access based on permissions, and tracking their activities for auditing or billing purposes.
 
 Normally there are two steps in processing an authentication request
 coming from a NAS in FreeRADIUS: authorisation and authentication.
index bb502634b8526263cd9596cde8d878617f37d2d2..796f05915af9392e2dbc80e66563a4060b7a0292 100644 (file)
@@ -5,19 +5,19 @@ The Concepts guide introduces the main concepts for readers who are new to RADIU
 == Sections in this Guide
 
 * xref:concepts:overview.adoc[Overview] explains the RADIUS server, FreeRADIUS, and the core services provided.
-        ** xref:modules/freeradius.adoc[What is FreeRADIUS] explains the benefits of the open-source software version.
-        ** xref:modules/aaa/aaa.adoc[Authentication Authorisation Accounting (AAA)] explains the core services provided by FreeRADIUS.
-                *** xref:modules/aaa/authz.adoc[Authorisation] is the process of allowing an authenticated user to access services on the network.
-                *** xref:modules/aaa/authn.adoc[Authentication] if the process of verifying an end-user's credentials.
-                *** xref:modules/aaa/acct.adoc[Accounting] operations record the time spent on the network and services accessed for auditing or billing purposes.
-        ** xref:modules/components/architecture.adoc[RADIUS System Components] explains the RADIUS design and components.
-                *** xref:modules/components/nas.adoc[Network Access Server (NAS)] outlines the NAS operations and access management.
-                *** xref:modules/components/radius_servers.adoc[RADIUS Server] describes the role of the server and how server policies work.
-                *** xref:modules/components/datastore.adoc[Datastores] details how datastores work and what's supported.
-        ** xref:modules/session/radius_session.adoc[RADIUS Sessions] explains session transmission and management or these session on the network.
-                *** xref:modules/session/radius_session_msg.adoc[Session Messages] details the format and content of session messages.
-                *** xref:modules/session/processing.adoc[Processing] outlines the flow of messages and how aaa services are implemented.
-* xref:modules/protocol/authproto.adoc[Protocols] defines the protocols used in the RADIUS environment.
+        ** xref:freeradius.adoc[What is FreeRADIUS] explains the benefits of the open-source software version.
+        ** xref:aaa/aaa.adoc[Authentication Authorisation Accounting (AAA)] explains the core services provided by FreeRADIUS.
+                *** xref:aaa/authz.adoc[Authorisation] is the process of allowing an authenticated user to access services on the network.
+                *** xref:aaa/authn.adoc[Authentication] if the process of verifying an end-user's credentials.
+                *** xref:aaa/acct.adoc[Accounting] operations record the time spent on the network and services accessed for auditing or billing purposes.
+        ** xref:components/architecture.adoc[RADIUS System Components] explains the RADIUS design and components.
+                *** xref:components/nas.adoc[Network Access Server (NAS)] outlines the NAS operations and access management.
+                *** xref:components/radius_servers.adoc[RADIUS Server] describes the role of the server and how server policies work.
+                *** xref:components/datastore.adoc[Datastores] details how datastores work and what's supported.
+        ** xref:session/radius_session.adoc[RADIUS Sessions] explains session transmission and management or these session on the network.
+                *** xref:session/radius_session_msg.adoc[Session Messages] details the format and content of session messages.
+                *** xref:session/processing.adoc[Processing] outlines the flow of messages and how aaa services are implemented.
+* xref:protocol/authproto.adoc[Protocols] defines the protocols used in the RADIUS environment.
 * xref:modules/ldap/authentication.adoc[Authentication with LDAP] can be used by RADIUS servers to authenticate the network users.
         ** xref:modules/ldap/password_storage.adoc[Password Storage] explains the methods of how the user's information can be stored.
         ** xref:modules/ldap/novell.adoc[Integrate Novell] with RADIUS networks using LDAP.
similarity index 97%
rename from doc/antora/modules/concepts/pages/modules/session/processing.adoc
rename to doc/antora/modules/concepts/pages/session/processing.adoc
index 0ee29963948dfde89bb2247209d7065fcf44c460..60673414b787e80868a21c2d69aa92b385bcf247 100644 (file)
@@ -115,7 +115,7 @@ But WAIT! What if the client sends a MSCHAP request? What does the RADIUS server
 > Well, this difficult and not the same as previous request
 > That client has made this difficult. I'm limited by some constraints!
 
-In this case, the mschap module looks at the request, and finds the MS-CHAP attributes.  It sets the *Auth-Type* to itself (mschap).  A database module (such as LDAP, above) gets the "known good" password, and adds it to the request.  The mschap module is then run for authentication.  It looks for either a clear text password or nt-hash. See an explanation for this limitation is explained in the xref:modules/protocol/authproto.adoc#Proto-Password-Compat[Protocol Password Compatibilty] table. If one of those hasn't been added by a database, the mschap module says:
+In this case, the mschap module looks at the request, and finds the MS-CHAP attributes.  It sets the *Auth-Type* to itself (mschap).  A database module (such as LDAP, above) gets the "known good" password, and adds it to the request.  The mschap module is then run for authentication.  It looks for either a clear text password or nt-hash. See an explanation for this limitation is explained in the xref:protocol/authproto.adoc#Proto-Password-Compat[Protocol Password Compatibilty] table. If one of those hasn't been added by a database, the mschap module says:
 
 > Sorry, I can't authenticate the user,
 > because I don't have the information I need to validate MSCHAP.
similarity index 99%
rename from doc/antora/modules/concepts/pages/modules/session/radius_session_msg.adoc
rename to doc/antora/modules/concepts/pages/session/radius_session_msg.adoc
index 839a2faab640b270771ae8aa351ebd0927e8e562..d0bbb079067119b001c7aa785b8159e5da43d466 100644 (file)
@@ -101,7 +101,7 @@ Information such as “use LDAP server X”, or “remember that the user is in
 
 Server-side attributes are presented using the same format as standard or vendor RADIUS attributes. This format gives the administrator the same control over internal aspects of the server behavior as over the server external responses. The server-side attribute information can be retrieved as part of one policy and checked later as part of another policy. For example, the policy can say “use LDAP server X for this request” and “respond with attribute X, value Y”.
 
-=== xref:modules/session/processing.adoc[Processing Requests]
+=== xref:session/processing.adoc[Processing Requests]
 
 The server processes requests through local site policy. That policy is used to examine the request, the request attributes, and the attribute values. The server then builds a reply message using responses (determined by local policy) such as time of day restrictions, group access limitations, and IP address allocation. The processing stage may include keeping track of <<server-attr,server-side attributes>>. FreeRADIUS maintains these attribute lists for every request.