File: console.rst

package info (click to toggle)
yara 4.5.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,820 kB
  • sloc: ansic: 52,244; yacc: 2,873; lex: 2,019; cpp: 863; makefile: 479; javascript: 85; sh: 47; python: 35
file content (77 lines) | stat: -rw-r--r-- 1,929 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

.. _console-module:

##############
Console module
##############

.. versionadded:: 4.2.0

The Console module allows you to log information during condition execution. By
default, the log messages are sent to stdout but can be handled differently by
using the C api (:ref:`scanning-data`).

Every function in the console module returns true for the purposes of condition
evaluation. This means you must logically and your statements together to get
the proper output. For example:

.. code-block:: yara

    import "console"

    rule example
    {
        condition:
            console.log("Hello") and console.log("World!")
    }

.. c:function:: log(string)

    Function which sends the string to the main callback.

    *Example: console.log(pe.imphash())*

.. c:function:: log(message, string)

    Function which sends the message and string to the main callback.

    *Example: console.log("The imphash is: ", pe.imphash())*

.. c:function:: log(integer)

    Function which sends the integer to the main callback.

    *Example: console.log(uint32(0))*

.. c:function:: log(message, integer)

    Function which sends the message and integer to the main callback.

    *Example: console.log("32bits at 0: ", uint32(0))*

.. c:function:: log(float)

    Function which sends the floating point value to the main callback.

    *Example: console.log(math.entropy(0, filesize))*

.. c:function:: log(message, float)

    Function which sends the message and the floating point value to the main
    callback.

    *Example: console.log("Entropy: ", math.entropy(0, filesize))*

.. c:function:: hex(integer)

    Function which sends the integer to the main callback, formatted as a hex
    string.

    *Example: console.hex(uint32(0))*

.. c:function:: hex(message, integer)

    Function which sends the integer to the main callback, formatted as a hex
    string.

    *Example: console.hex("Hex at 0: ", uint32(0))*