diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 14:11:00 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 14:11:00 +0000 |
commit | af754e596a8dbb05ed8580c342e7fe02e08b28e0 (patch) | |
tree | b2f334c2b55ede42081aa6710a72da784547d8ea /doc/source/extra | |
parent | Initial commit. (diff) | |
download | freeradius-af754e596a8dbb05ed8580c342e7fe02e08b28e0.tar.xz freeradius-af754e596a8dbb05ed8580c342e7fe02e08b28e0.zip |
Adding upstream version 3.2.3+dfsg.upstream/3.2.3+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/source/extra/client.c | 12 | ||||
-rw-r--r-- | doc/source/extra/core.c | 31 | ||||
-rw-r--r-- | doc/source/extra/freeradius.png | bin | 0 -> 14616 bytes | |||
-rw-r--r-- | doc/source/extra/module.c | 17 | ||||
-rw-r--r-- | doc/source/extra/toc.c | 102 |
5 files changed, 162 insertions, 0 deletions
diff --git a/doc/source/extra/client.c b/doc/source/extra/client.c new file mode 100644 index 0000000..b7775c4 --- /dev/null +++ b/doc/source/extra/client.c @@ -0,0 +1,12 @@ +/** + * @cond skip + * vim:syntax=doxygen + * @endcond + * + * +@page client_doc + +@section client_intro Introduction + +*/ +~ diff --git a/doc/source/extra/core.c b/doc/source/extra/core.c new file mode 100644 index 0000000..c3af04c --- /dev/null +++ b/doc/source/extra/core.c @@ -0,0 +1,31 @@ +/** + * @cond skip + * vim:syntax=doxygen + * @endcond + * + * +@page server_doc + +@section server_intro Introduction + +FreeRADIUS uses a thread pool to serve requests. Each request is processed +synchronously, and processing passes through a series of stages, and a list +of modules in each stage. + +The request is processed as follows + +- The radius packet is received by a listener - see listen.c +- The radius packet is parsed and validated into a request - see ? +- The request is processed - see process.c +- The server passes through each authentication stage + - authorize + - if Proxy-To-Realm is set: + - pre-proxy + - send proxy request + - post-proxy + - else + - authenticate + - post-auth +- Authentication stages are lists of modules - see modcall.c + +*/ diff --git a/doc/source/extra/freeradius.png b/doc/source/extra/freeradius.png Binary files differnew file mode 100644 index 0000000..45e96a4 --- /dev/null +++ b/doc/source/extra/freeradius.png diff --git a/doc/source/extra/module.c b/doc/source/extra/module.c new file mode 100644 index 0000000..74071bd --- /dev/null +++ b/doc/source/extra/module.c @@ -0,0 +1,17 @@ +/** + * @cond skip + * vim:syntax=doxygen + * @endcond + * + * +@page module_doc + +@section module_intro Introduction + +FreeRADIUS uses a pluggable module infrastructure to extend the +basic functionality of the server. + +Modules in 3.0 are dynamically linked at runtime using dlopen. + +@defgroup module_safe module_safe - Internal API functions that are safe for use by modules +*/ diff --git a/doc/source/extra/toc.c b/doc/source/extra/toc.c new file mode 100644 index 0000000..3a96fa7 --- /dev/null +++ b/doc/source/extra/toc.c @@ -0,0 +1,102 @@ +/** + * @cond skip + * vim:syntax=doxygen + * @endcond + * + * +@mainpage + +@section main_intro Introduction + +FreeRADIUS is a high-performance modular RADIUS server, supporting PAP, CHAP, +EAP (including EAP-TLS, EAP-TTLS, EAP-PEAP with EAP-MSCHAP) and a very flexible +configuration model, including conditional request processing, querying of +LDAP and SQL databases, exection of external scripts and more. + +FreeRADIUS uses a thread pool to serve requests. Each request is processed +synchronously, and processing passes through a series of stages, and a list +of modules in each stage. + +@section main_toc Table of Contents + +- @subpage server_doc "1. Core server APIs" +- @subpage module_doc "2. Server modules" +- @subpage client_doc "3. Client APIs" + +@section main_branches GIT Branch + +@subsection branch_master Master (v4) feature branch + +@code +git clone git@github.com:FreeRADIUS/freeradius-server.git +@endcode +- Web: http://github.com/FreeRADIUS/freeradius-server/tree/master + +@subsection branch_32x 3.2.x stable branch + +Minor bug fixes, documentation updatews, etc. go into this branch. + +@code +git clone git@github.com:FreeRADIUS/freeradius-server.git +cd freeradius-server +git fetch origin v3.2.x:v3.2.x +git checkout v3.2.x +@endcode +- Web: http://github.com/FreeRADIUS/freeradius-server/tree/v3.2.x + +@subsection branch_2xx 2.x.x EOL branch + +@note This branch is now permanently feature frozen. New features or modules + should be submitted against the master branch. + +@code +git clone git@github.com:FreeRADIUS/freeradius-server.git +cd freeradius-server +git fetch origin v2.x.x:v2.x.x +git checkout v2.x.x +@endcode +- Web: http://github.com/FreeRADIUS/freeradius-server/tree/v2.x.x + +@subsection branch_1xx 1.1.x EOL branch + +@note This branch is now permanently feature frozen. New features or modules + should be submitted against the master branch. + +@code +git clone git@github.com:FreeRADIUS/freeradius-server.git +cd freeradius-server +git fetch origin v2.x.x:v2.x.x +git checkout v2.x.x +@endcode +- Web: http://github.com/FreeRADIUS/freeradius-server/tree/v1.1.x + +@section main_website Website + +- http://www.freeradius.org + +@section mailinglist Mailing lists + +@subsection main_list FreeRADIUS-users + +This list is for users of the server + +@code +freeradius-users@lists.freeradius.org +@endcode +- Archives: http://lists.freeradius.org/pipermail/freeradius-users/ +- List info: http://freeradius.org/list/users.html + +@subsection dev_list FreeRADIUS-devel + +This list is for development of the server, including patches, and +new features. PLEASE DO NOT post questions related to the operation +of the server here - use the "users" list. Most of the developers +read both, and will answer your questions there if they have the time. + +@code +freeradius-devel@lists.freeradius.org +@endcode +- Archives: http://lists.freeradius.org/pipermail/freeradius-devel/ +- List info: http://freeradius.org/list/devel.html + +*/ |