-
Notifications
You must be signed in to change notification settings - Fork 1.6k
transform/subslice: Add subslice transform #14372
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
Closed
+448
−0
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -386,3 +386,52 @@ the buffer. | |
| local sub = string.sub(input, offset + 1, offset + bytes) | ||
| return string.upper(sub), bytes | ||
| end | ||
|
|
||
| subslice | ||
| -------- | ||
|
|
||
| This transform creates a slice of the input buffer. | ||
|
|
||
| The subslice transform requires parameters: | ||
|
|
||
| * `offset` Specifies the starting offset at which to create the | ||
| subslice. When negative, expresses how far from the end of the | ||
| input buffer to begin. [REQUIRED] | ||
| * `nbytes` Specifies the size of the subslice. When negative, | ||
| specifies that the subslice will end that many bytes from | ||
| the end of the input buffer. [OPTIONAL] | ||
|
|
||
| Specify the subslice desired -- `nbytes` is optional: | ||
|
|
||
| Format:: | ||
|
|
||
| subslice: offset <,nbytes>; | ||
|
|
||
| When `nbytes` is not specified, the size of the subslice will be the size | ||
| of the input buffer minus the `offset` value. The value of ``offset`` must | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need to document the out of bounds cases behavior |
||
|
|
||
| The following examples use an input buffer of ``This is Suricata``. | ||
|
|
||
| Examples | ||
|
|
||
| The subslice will be a copy of the input buffer but omit the input buffer's first byte. | ||
| The subslice is ``his is Suricata``:: | ||
|
|
||
| subslice: 1; | ||
|
|
||
| This example creates the subslice ``This is Suric``:: | ||
|
|
||
| subslice: 0, 13; | ||
|
|
||
| This example starts at offset ``10`` and ends at 5 bytes from the end | ||
| of the buffer which creates a subslice from offset ``10`` to offset ``12``. | ||
| The length of the input buffer is ``17`` bytes; ``5`` bytes from the end | ||
| is ``12``:: | ||
|
|
||
| subslice: 10, -5; | ||
|
|
||
| This example will create a subslice from the last 3 bytes of the input | ||
| buffer and create ``ata``:: | ||
|
|
||
| subslice: -3; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,3 +27,4 @@ pub mod http_headers; | |
| pub mod strip_whitespace; | ||
| pub mod urldecode; | ||
| pub mod xor; | ||
| pub mod subslice; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.