-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Docs userguide we to you 6406 v2 #14054
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
base: main
Are you sure you want to change the base?
Docs userguide we to you 6406 v2 #14054
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.
Thanks for your contribution, there's progress here :)
Please check the inline comments, and also:
- for the quickstart file, I'd say that likes 85 and 95 could also be adjusted
- in the rules/intro.rst, section
Direction
could be worked upon, too - flow-keywords: did you review the other
we
usage cases? I see other sections with a similar situation
Since we know this touches many files, I would say that once we manage to complete the work started on these files, this can be seen as a first batch.
We will need a next iteration following our Code submission guidelines, especially with regards to commit message format and commit separation.
named `00` to `ff` where the directory shares the first 2 characters | ||
of the filename. For example, if the SHA256 hex string of an extracted | ||
file starts with "f9bc6d..." the file we be placed in the directory | ||
file starts with "f9bc6d..." the file will be placed in the directory |
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.
Good catch! As this is as typo fix, could you please put this (and any other such fixes) in a separate commit, and clearly state that it is a commit fixing typos?
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.
Hi @jufajardini sure, I'll do this. I think this is where I will have to leverage the cherrypick command right?
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.
The cherry-pick command is more for when you want to bring a commit from a different branch to your branch.
In this case, two things can be done:
- you can use
git commit --amend
to modify the last commit you've worked on - and you can use
git commit --fixup
to merge commits together
|
||
The dedicated PPA repository is added, and after updating the index, Suricata can | ||
be installed. We recommend installing the ``jq`` tool at this time as it will help | ||
be installed. Install the ``jq`` tool at this time as it will help |
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 think this one isn't needed. We as the team are indeed recommending that the user/ reader installs jq
.
The purpose of the ticket is to remove ambiguous usages of we (where it isn't clear whether it refers to the team, or the user). This one isn't ambiguous, so it can stay. :)
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.
Well noted.
fails per connection, but we have vulnerability where an attacker can | ||
continue to login after that five attempts and we need to know about | ||
Let's say you are tracking a protocol that normally allows five login | ||
fails per connection, but has a vulnerability where an attacker can |
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'm thinking that maybe (this is a bit of polishing, but, still):
fails per connection, but has a vulnerability where an attacker can | |
fails per connection, but there is a vulnerability where an attacker can |
continue to login after that five attempts and we need to know about | ||
Let's say you are tracking a protocol that normally allows five login | ||
fails per connection, but has a vulnerability where an attacker can | ||
continue to login after that five attempts and you need to detect |
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.
Since we're here, how about we improve:
continue to login after that five attempts and you need to detect | |
continue to login after those five attempts and you need to detect |
This could go in the typo-fixing commit ;)
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 see another cherrypick usage here . Thanks for pointing this out.
are the options. | ||
|
||
We will be using the above signature as an example throughout | ||
The above signature serves as the above signature as an example throughout |
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.
This proposal doesn't look correct, and is not needed (similar explanation as in the other inline comment).
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.
Got it. Will preserve the original wording.
Make sure these boxes are checked accordingly before submitting your Pull Request -- thank you.
Contribution style:
https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html
Our Contribution agreements:
https://suricata.io/about/contribution-agreement/ (note: this is only required once)
Changes (if applicable):
(including schema descriptions)
https://redmine.openinfosecfoundation.org/projects/suricata/issues
Link to ticket: https://redmine.openinfosecfoundation.org/issues/6406
Describe changes:
Provide values to any of the below to override the defaults.
link to the pull request in the respective
_BRANCH
variable.SV_REPO=
SV_BRANCH=
SU_REPO=
SU_BRANCH=