Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation for conditions #28

Open
colesmj opened this issue Oct 21, 2018 · 5 comments
Open

Missing documentation for conditions #28

colesmj opened this issue Oct 21, 2018 · 5 comments
Labels
Hacktoberfest help wanted Extra attention is needed

Comments

@colesmj
Copy link
Collaborator

colesmj commented Oct 21, 2018

Some properties/conditions are obvious and don't really need documentation, such as protocol or isEncrypted. But other properties may not be obvious to some, such as Dataflow.authenticatedWith - with what?

@colesmj colesmj added the enhancement New feature or request label Oct 21, 2018
@colesmj
Copy link
Collaborator Author

colesmj commented Apr 24, 2019

@shambho Does your commit 3 days ago resolve this issue? If so, let's close this one.
Alternately, or maybe also, we should document the object model on the wiki. I had put one up there a long time ago, but it is no longer valid, so I will deprecate it (I'd like to keep it around for some future looking work).

@shambho
Copy link
Contributor

shambho commented Apr 26, 2019

@colesmj nope. Commit from 3 days ago was about adding some cosmetic changes to tm.py, Readme and pytm.py. Agree, we should have more documentation on the properties available in each Class.

@nineinchnick
Copy link
Collaborator

#91 documents a very small subset of attributes.

@cptfixit
Copy link

I would like to second this issue report: flags such as "sourceFiles" are not clear to the average user/reader, without explanation.

@colesmj colesmj added help wanted Extra attention is needed and removed enhancement New feature or request labels Jun 25, 2023
@Dakes
Copy link
Contributor

Dakes commented May 16, 2024

+1 Being new to threat modeling, some of these are quite hard to understand. Some can be figured out with a google search, like usesStrongSessionIdentifiers.
But for checksInputBounds, I had to check in the threats.json to understand, that it refers to Buffer sizes. So some additional documentation for many properties would certainly be beneficial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

6 participants