Skip to content

Updated Readme file to include group conventions #1

Merged
merged 1 commit into from
Nov 26, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,23 @@ pieces of functionality - we'll refer to them as "plugins". This is a
kind of **design by contract**, which you can read about here:
<https://www.sciencedirect.com/topics/computer-science/design-by-contract>. Some
things to decide might be:
- Will each piece of functionality be in a separate file or subdirectory?
- Will your team have a naming convention? For example, maybe all
windows enumerators will begin with "wEnum_", linux with "lEnum_"
and so on.
- Will each piece of functionality be in a separate file or subdirectory? TO DO
- Naming Conventions:
lEnum_
lPrivesc_
wEnum_
wPrivesc_
- What will each function return or display? Will each function
print out to the user? Or will it return a block of text in a
string? Or a list of lines? Or maybe a dict with some meta-info
(version, plugin name, plugin author, date, time, etc.) and text
data? Or JSON? All are possibilities.
1.Display to terminal
2.File
- Will you have a standard set of parameters to be passed in? Or can
each plugin have a different set of required parameters?
Enumeration- No parameters
Privesc- Specific info for escalation.
- What plugins will be implemented? Who will be the author?

You should document these decisions here in the `README.md` file. Once
Expand Down