Documentation

[rtadros125]

I don't think we'll have time to get this into Release 4.2, but maybe in some point releases.

• [x] README up-to-date + index for the docs folder [PR #1066]
• [x] Documentation of the utilities in build directory. Or maybe take them out of there? [PR #1049]
• [x] Document the classes/methods/functions in the tool (this should be divided into sub-categories for tracking) [Postponed #1125]
• [x] Add a document (or append to an existing one) addressing the first comment below (from AndrewB) [PR #1078]
• [x] The readmes inside the vulClasses need to be revised. [PR #1096]
• [x] Add a readme in ./besspin/cwesEvaluation/multitasking/: [PR #1140]
  • Explain the multitasking in more details
  • Explicitly mention the claims made by those scores
  • Write how the scores (the last column) is calculated
  • Add a link to this document in ./docs/cwesEvaluation/configuration.md.

[rtadros125]

From @Abivin12's meeting notes with AustinR:

• Position paper on what testgen tries to achieve might help:
  • Testgen is currently quite platform agnostic. This has strengths and weaknesses (some tests fail / trip over other parts of the system). Could use some theory/philosophy on why this approach is taken and where to expect such behavior.
  • Give context on why some tests segfault and others don't.
• The "position paper" was a suggestion to avoid confusion with future users wrt what the tool is "philosophically" trying to achieve and what it is not trying to do (i.e. be specific to every build/system, but provides extensibility to customize for specific systems).

[rtadros125]

2nd task is done in #1049. Now moving to the 1st one.

[rtadros125]

Task-1 breakdown (started on update-readmes-and-docs):

• [x] AWS
• [x] CWEs
  • [x] README
  • [x] Configuration
• [x] bugBounty
• [x] cyberPhys
• [x] Base
  • [x] Config
  • [x] Targets
  • [x] OSes
  • [x] Modes
  • [x] Nix
• [x] Main Readme:
  • [x] Overview
  • [x] Software reqs
  • [x] Config
  • [x] User Manual
  • [x] Dev Manual
  • [x] Table Of Contents

[rtadros125]

Opened #1066 to address the first task. I will jump next to the fourth task (The BESSPIN philosophy document).

[bboston7]

Here are the various parts of the codebase that need to be documented. Feel free to further subdivide as needed.

• [ ] ci
• [ ] besspin
  • [ ] fett
  • [ ] base (Ramy)
  • [ ] cwesEvaluation
    • [x] Top level files (besspin/cwesEvaluation/*.py) [#1100]
    • [ ] bufferErrors (Brett)
    • [ ] hardwareSoC
    • [ ] informationLeakage
    • [ ] injection
    • [ ] multitasking
    • [ ] numericErrors
    • [ ] PPAC
    • [ ] resourceManagement
    • [ ] utils
  • [ ] cyberPhys
  • [ ] target
• [x] utils [#1116]

[rtadros125]

Finished the fourth task on branch testgen-methodology-document, but won't open a PR until #1066 is merged (because the new branch is rebased on it). Update: Done and merged in #1078.

[rtadros125]

I have added a 5th task here. I will work on it at some point soon.

[rtadros125]

Started to work on the fifth task.

[rtadros125]

@bboston7 I added a sixth task, and it has your name all over it :)

[bboston7]

@rtadros125 Yes it does! I'll work on that one.

[bboston7]

I broke the cwesEvaluation subtask of task 3 down to for easier tracking.

[rtadros125]

I will move the "Document the classes/functions" to a new issue that is not labeled open-source. Let's be realistic, especially with DARPA's push on open-sourcing quickly.

Moved to #1125