/ 
YaraFFI-0.06
/ YaraFFI::Event

NAME

YaraFFI::Event - Event class that stringifies to rule name but also works as a hash

VERSION

Version 0.06

SYNOPSIS

use YaraFFI::Event;

# Create a rule match event with metadata
my $event = YaraFFI::Event->new(
    event    => 'rule_match',
    rule     => 'MalwareRule',
    metadata => {
        author      => 'Security Team',
        description => 'Detects malware',
        severity    => 5,
        active      => 1,
    },
);

print "Matched: $event\n";  # Stringifies to rule name
print "Author: ", $event->metadata->{author}, "\n";
print "Severity: ", $event->severity, "\n";

# Create a string match event with offsets
my $str_event = YaraFFI::Event->new(
    event     => 'string_match',
    rule      => 'MalwareRule',
    string_id => '$suspicious',
    offsets   => [0, 42, 128],
);

print "String: ", $str_event->string_id, "\n";
print "Found at: ", join(", ", @{$str_event->offsets}), "\n";

DESCRIPTION

YaraFFI::Event represents a scanning event from YARA. It can be used as a string (stringifies to the rule name) or as a hash/object to access event details.

Events are created during YARA scans and passed to callback functions.

EVENT TYPES

rule_match

Emitted when a YARA rule matches the scanned data.

Fields:
    event    => 'rule_match'
    rule     => 'RuleName'
    metadata => { key => value, ... }  # Optional, rule metadata

string_match

Emitted when a string pattern within a rule matches.

Fields:
    event     => 'string_match'
    rule      => 'RuleName'
    string_id => '$string_identifier'
    offsets   => [offset1, offset2, ...]  # Byte offsets where string matched

METHODS

new(%args)

Creates a new event object.

my $event = YaraFFI::Event->new(
    event => 'rule_match',
    rule  => 'TestRule',
);

event

Returns the event type (rule_match or string_match).

my $type = $event->event;

rule

Returns the name of the matched rule.

my $rule_name = $event->rule;

metadata

Returns the rule metadata as a hash reference (rule_match events only).

my $meta = $event->metadata;
if ($meta) {
    print "Author: $meta->{author}\n";
    print "Severity: $meta->{severity}\n";
}

string_id

Returns the string identifier (string_match events only).

my $id = $event->string_id;  # e.g., '$suspicious'

offsets

Returns an array reference of byte offsets where the string matched (string_match events only).

my $offsets = $event->offsets;
for my $offset (@$offsets) {
    print "Match at byte $offset\n";
}

Convenience Metadata Accessors

For common metadata fields, you can access them directly:

my $author = $event->author;
my $desc   = $event->description;
my $sev    = $event->severity;

These return undef if the metadata doesn't exist or the field isn't present.

has_metadata

Returns true if the event has metadata.

if ($event->has_metadata) {
    # Process metadata
}

has_offsets

Returns true if the event has match offsets.

if ($event->has_offsets) {
    print "Matches at: ", join(", ", @{$event->offsets}), "\n";
}

match_count

Returns the number of times the string matched (for string_match events).

my $count = $event->match_count;

is_rule_match

Returns true if this is a rule_match event.

if ($event->is_rule_match) {
    # Handle rule match
}

is_string_match

Returns true if this is a string_match event.

if ($event->is_string_match) {
    # Handle string match
}

to_hash

Returns the event as a plain hash reference.

my $hash = $event->to_hash;

OVERLOADING

The event object overloads string concatenation, so it can be used directly in print statements and will display the rule name:

print "Matched: $event\n";  # Prints "Matched: RuleName"

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/YaraFFI

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/YaraFFI/issues. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc YaraFFI::Event

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2025 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.