Skip to content
Closed
Show file tree
Hide file tree
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
49 changes: 49 additions & 0 deletions doc/userguide/rules/transforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Contributor

Choose a reason for hiding this comment

The 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;
1 change: 1 addition & 0 deletions rust/src/detect/transforms/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ pub mod http_headers;
pub mod strip_whitespace;
pub mod urldecode;
pub mod xor;
pub mod subslice;
Loading
Loading