Initial commit

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyrad
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=pyrad
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/api/client.rst

@@ -0,0 +1,10 @@
+:mod:`pyrad.client` -- basic client
+===================================
+
+.. automodule:: pyrad.client
+
+  .. autoclass:: Timeout
+    :members:
+
+  .. autoclass:: Client
+    :members:

docs/source/api/dictionary.rst

@@ -0,0 +1,10 @@
+:mod:`pyrad.dictionary` -- RADIUS dictionary
+============================================
+
+.. automodule:: pyrad.dictionary
+
+  .. autoclass:: ParseError
+    :members:
+
+  .. autoclass:: Dictionary
+    :members:

docs/source/api/host.rst

@@ -0,0 +1,7 @@
+:mod:`pyrad.host` -- RADIUS host definition
+===========================================
+
+.. automodule:: pyrad.host
+
+  .. autoclass:: Host
+    :members:

docs/source/api/packet.rst

@@ -0,0 +1,48 @@
+:mod:`pyrad.packet` -- packet encoding and decoding
+===================================================
+
+.. automodule:: pyrad.packet
+
+  .. autoclass:: Packet
+    :members:
+
+  .. autoclass:: AuthPacket
+    :members:
+
+  .. autoclass:: AcctPacket
+    :members:
+
+  .. autoclass:: CoAPacket
+    :members:
+
+  .. autoclass:: PacketError
+    :members:
+
+
+Constants
+---------
+
+The :mod:`pyrad.packet` module defines several common constants
+that are useful when dealing with RADIUS packets.
+
+The following packet codes are defined:
+
+==================    ======
+Constant name         Value
+==================    ======
+AccessRequest         1
+------------------    ------
+AccessAccept          2
+AccessReject          3
+AccountingRequest     4
+AccountingResponse    5
+AccessChallenge       11
+StatusServer          12
+StatusClient          13
+DisconnectRequest     40
+DisconnectACK         41
+DisconnectNAK         42
+CoARequest            43
+CoAACK                44
+CoANAK                45
+==================    ======

docs/source/api/proxy.rst

@@ -0,0 +1,7 @@
+:mod:`pyrad.proxy` -- basic proxy
+=================================
+
+.. automodule:: pyrad.proxy
+
+  .. autoclass:: Proxy
+    :members:

docs/source/api/server.rst

@@ -0,0 +1,13 @@
+:mod:`pyrad.server` -- basic server
+===================================
+
+.. automodule:: pyrad.server
+
+  .. autoclass:: RemoteHost
+    :members:
+
+  .. autoclass:: ServerPacketError
+    :members:
+
+  .. autoclass:: Server
+    :members:

docs/source/conf.py

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+#
+# pyrad documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb  2 15:16:16 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.todo',
+              'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyrad'
+copyright = u'Copyright 2002-2020 Wichert Akkerman and Christian Giese. All rights reserved.'
+author = u'Christian Giese <developer@gicnet.de>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'2.3'
+# The full version, including alpha/beta/rc tags.
+release = u'2.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_logo = '_static/logo.png'
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyraddoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pyrad.tex', u'pyrad Documentation',
+     u'Wichert Akkerman', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyrad', u'pyrad Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pyrad', u'pyrad Documentation',
+     author, 'pyrad', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/source/index.rst

@@ -0,0 +1,75 @@
+
+*********************************
+:mod:`pyrad` -- RADIUS for Python
+*********************************
+
+:Author: Wichert Akkerman
+: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 2.6 or later, or Python 3.2 or later
+
+Installing is simple; pyrad uses the standard distutils system for installing
+Python modules::
+
+  python setup.py install
+
+
+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`