Facedancer documentation

README.md

@@ -50,8 +50,7 @@ For more information, see:
 
 ## USBProxy 'Nouveau' and Protocol Analysis
 
-A major new feature of the newer Facedancer codebase is the ability to man-in-the
-middle USB connections -- replacing one of the authors' original [USBProxy](https://github.com/dominicgs/usbproxy)
+A major new feature of the newer Facedancer codebase is the ability to MITM (Meddler-In-The-Middle) USB connections -- replacing one of the authors' original [USBProxy](https://github.com/dominicgs/usbproxy)
 project. This opens up a whole new realm of applications -- including protocol analysis
 and live manipulation of USB packets -- and is especially useful when you don't control
 the software running on the target device (e.g. on embedded systems or games consoles).

docs/Makefile

@@ -13,7 +13,13 @@ help:
 
 .PHONY: help Makefile
 
+# api docs
+apidocs:
+	rm -rf source/api_docs/
+	sphinx-apidoc -o source/api_docs/ ../facedancer
+
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

docs/requirements.txt

@@ -2,3 +2,9 @@ sphinx==7.2.6
 sphinx_rtd_theme==2.0.0
 readthedocs-sphinx-search==0.3.2
 jinja2==3.1.3
+
+# needed to build api docs
+prompt_toolkit
+pyusb
+pyserial
+libusb1

docs/source/api_docs/facedancer.backends.rst

@@ -0,0 +1,77 @@
+facedancer.backends package
+===========================
+
+Submodules
+----------
+
+facedancer.backends.MAXUSBApp module
+------------------------------------
+
+.. automodule:: facedancer.backends.MAXUSBApp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.base module
+-------------------------------
+
+.. automodule:: facedancer.backends.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.goodfet module
+----------------------------------
+
+.. automodule:: facedancer.backends.goodfet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.greatdancer module
+--------------------------------------
+
+.. automodule:: facedancer.backends.greatdancer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.greathost module
+------------------------------------
+
+.. automodule:: facedancer.backends.greathost
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.libusbhost module
+-------------------------------------
+
+.. automodule:: facedancer.backends.libusbhost
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.moondancer module
+-------------------------------------
+
+.. automodule:: facedancer.backends.moondancer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.backends.raspdancer module
+-------------------------------------
+
+.. automodule:: facedancer.backends.raspdancer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer.backends
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.classes.hid.rst

@@ -0,0 +1,37 @@
+facedancer.classes.hid package
+==============================
+
+Submodules
+----------
+
+facedancer.classes.hid.descriptor module
+----------------------------------------
+
+.. automodule:: facedancer.classes.hid.descriptor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.classes.hid.keyboard module
+--------------------------------------
+
+.. automodule:: facedancer.classes.hid.keyboard
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.classes.hid.usage module
+-----------------------------------
+
+.. automodule:: facedancer.classes.hid.usage
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer.classes.hid
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.classes.rst

@@ -0,0 +1,18 @@
+facedancer.classes package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   facedancer.classes.hid
+
+Module contents
+---------------
+
+.. automodule:: facedancer.classes
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.devices.rst

@@ -0,0 +1,37 @@
+facedancer.devices package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   facedancer.devices.umass
+
+Submodules
+----------
+
+facedancer.devices.ftdi module
+------------------------------
+
+.. automodule:: facedancer.devices.ftdi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.devices.keyboard module
+----------------------------------
+
+.. automodule:: facedancer.devices.keyboard
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer.devices
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.devices.umass.rst

@@ -0,0 +1,29 @@
+facedancer.devices.umass package
+================================
+
+Submodules
+----------
+
+facedancer.devices.umass.disk\_image module
+-------------------------------------------
+
+.. automodule:: facedancer.devices.umass.disk_image
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.devices.umass.umass module
+-------------------------------------
+
+.. automodule:: facedancer.devices.umass.umass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer.devices.umass
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.filters.rst

@@ -0,0 +1,37 @@
+facedancer.filters package
+==========================
+
+Submodules
+----------
+
+facedancer.filters.base module
+------------------------------
+
+.. automodule:: facedancer.filters.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.filters.logging module
+---------------------------------
+
+.. automodule:: facedancer.filters.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.filters.standard module
+----------------------------------
+
+.. automodule:: facedancer.filters.standard
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_docs/facedancer.rst

@@ -0,0 +1,120 @@
+facedancer package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   facedancer.backends
+   facedancer.classes
+   facedancer.devices
+   facedancer.filters
+
+Submodules
+----------
+
+facedancer.configuration module
+-------------------------------
+
+.. automodule:: facedancer.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.core module
+----------------------
+
+.. automodule:: facedancer.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.descriptor module
+----------------------------
+
+.. automodule:: facedancer.descriptor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.device module
+------------------------
+
+.. automodule:: facedancer.device
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.endpoint module
+--------------------------
+
+.. automodule:: facedancer.endpoint
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.errors module
+------------------------
+
+.. automodule:: facedancer.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.interface module
+---------------------------
+
+.. automodule:: facedancer.interface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.logging module
+-------------------------
+
+.. automodule:: facedancer.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.magic module
+-----------------------
+
+.. automodule:: facedancer.magic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.proxy module
+-----------------------
+
+.. automodule:: facedancer.proxy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.request module
+-------------------------
+
+.. automodule:: facedancer.request
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+facedancer.types module
+-----------------------
+
+.. automodule:: facedancer.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: facedancer
+   :members:
+   :undoc-members:
+   :show-inheritance: