-
Notifications
You must be signed in to change notification settings - Fork 51
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
Src11 security information standard #55
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would break the required function section and the SecurityInformation
struct into two parts. The function defining that it returns the struct and then the SecurityInformation
section defining the struct's contents and any optional parameters.
The header logo in the README is using the Vault Standards README, this must be updated.
|
||
# Security Considerations | ||
|
||
The information is entirely self reported and as such might not be accurate. Accuracy of information cannot be enforced and as such, anyone using this information should be aware of that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"might not be accurate"
Isn't it defined in the standard that it must be up to date?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah but people can lie lol, important to note that its entirely self reported, just because its on the blockchain doesnt make it verified or real
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just needs the examples and standard to be added to their respective workspace as well as a link to the standard in the source README
examples/src11-security-information/hardcoded-information/src/main.sw
Outdated
Show resolved
Hide resolved
- The struct MAY contain `None` for `Option<T>` type fields, if they are deemed unnecessary. | ||
- The struct MUST NOT contain empty `String` or `Vec` fields. | ||
- The struct MAY contain a link or the information directly for the following fields: `project_url`, `policy`, `encryption`, `source_code`, `auditors`, `acknowledgments`, `additional_information`. | ||
- The struct MUST contain the information directly for the following fields: `name`, `contact_information`, `preferred_languages`, `source_release`, and `source_revision`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure how I feel about "directly". Maybe "The struct MUST contain the following information encoded as a String
for the following fields:"?
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Co-authored-by: Cameron Carstens <bitzoic.eth@gmail.com>
Type of change
Changes
The following changes have been made: