********************************* :mod:`pyrad` -- RADIUS for Python ********************************* :Author: Christian Giese (GIC-de), Istvan Ruzman (Istvan91) and Stefan Lieberth (slieberth) :Version: |version| Introduction ============ pyrad is an implementation of a RADIUS client/server as described in RFC2865. It takes care of all the details like building RADIUS packets, sending them and decoding responses. Here is an example of doing a authentication request:: from pyrad.client import Client from pyrad.dictionary import Dictionary import pyrad.packet srv = Client(server="localhost", secret=b"Kah3choteereethiejeimaeziecumi", dict=Dictionary("dictionary")) # create request req = srv.CreateAuthPacket(code=pyrad.packet.AccessRequest, User_Name="wichert", NAS_Identifier="localhost") req["User-Password"] = req.PwCrypt("password") # send request reply = srv.SendPacket(req) if reply.code == pyrad.packet.AccessAccept: print("access accepted") else: print("access denied") print("Attributes returned by server:") for i in reply.keys(): print("%s: %s" % (i, reply[i])) Requirements & Installation =========================== pyrad requires Python 3.8 or later Installing is simple; pyrad uses the standard distutils system for installing Python modules:: python setup.py install Author, Copyright, Availability =============================== pyrad was written by Wichert Akkerman and is maintained by Christian Giese (GIC-de), Istvan Ruzman (Istvan91) and Stefan Lieberth (slieberth). We’re looking for contributors to support the pyrad team! If you’re interested in helping with development, testing, documentation, or other areas, please contact us directly. This project is licensed under a BSD license. Copyright and license information can be found in the LICENSE.txt file. The current version and documentation can be found on pypi: https://pypi.org/project/pyrad/ Bugs and wishes can be submitted in the pyrad issue tracker on github: https://github.com/pyradius/pyrad/issues Related Projects & Forks ======================== **pyrad2:** Noteworthy fork with experimental RadSec (RFC 6614) support. Targets Python 3.12+, adds extensive type hints, boosts test coverage, and includes fresh bug fixes. https://github.com/nicholasamorim/pyrad2 **pyrad-server:** Lab-grade RADIUS test server built on top of pyrad. https://github.com/slieberth/pyrad-server API Documentation ================= Per-module :mod:`pyrad` API documentation. .. toctree:: :maxdepth: 2 api/client api/dictionary api/host api/packet api/proxy api/server Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`