Commit 21110335 authored by Ray Bellis's avatar Ray Bellis

updated README

parent 5ea88fee
......@@ -9,11 +9,17 @@ business logic functions, e.g. to authenticate users or to save
accounting records, while the framework itself takes care of the
protocol implementation itself.
For the core RADIUS protocol specification, see [RFC
2865](https://tools.ietf.org/html/rfc2865) and [RFC
2866](https://tools.ietf.org/html/rfc2866).
This code has no third-party runtime dependencies.
Servers
-------
Framework users create business logic by registering callback functions
with this signature:
Framework users create business logic by writing and registering
callback functions with this signature:
function handler(req, res)
......@@ -30,7 +36,7 @@ For an example server, see `test-server.js`. This trivial server
accepts only one combination of valid username and password
(myuser/mypass) and will reject all others.
Callback functions are called _asynchronously_ and return a `Promise`.
Callback functions are invoked _asynchronously_ and return a `Promise`.
If that Promise resolves to a "truthy" value the response is sent
immediately and no further handlers will be invoked. If the callback
function throws an exception (resulting in a rejected Promise) then
......@@ -63,11 +69,24 @@ RADIUS Dictionaries
-------------------
The framework can read the dictionary files supplied with FreeRADIUS
3.x, but does not (yet) support the RADIUS Extensions described in RFC
6929. Dictionary entries using those extensions are ignored.
3.x, but does not (yet) support the RADIUS Extensions described in [RFC
6929](https://tools.ietf.org/html/rfc6929). Dictionary entries using
those extensions are ignored.
Other Limitations
-----------------
Only PAP authentication is supported.
Documentation
-------------
All API functions have documentation in jsdoc format. To build it,
run `npm install` and then `npm run docs`.
Support
-------
This software is provided free-of-charge and without warranty of any
kind. Issues may be reported on the project's ISC Gitlab page.
kind. Issues may be reported on the [project's ISC Gitlab page]
(https://gitlab.isc.org/isc-projects/isc-radius).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment