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
|
.. _magic-module:
############
Magic module
############
.. versionadded:: 3.1.0
The Magic module allows you to identify the type of the file based on the
output of `file <http://en.wikipedia.org/wiki/File_(command)>`_, the standard
Unix command.
.. important::
This module is not built into YARA by default, to learn how to include it
refer to :ref:`compiling-yara`. Bad news for Windows users: **this module is
not supported on Windows**.
There are two functions in this module: :c:func:`type` and :c:func:`mime_type`.
The first one returns the descriptive string returned by *file*, for example,
if you run *file* against some PDF document you'll get something like this::
$file some.pdf
some.pdf: PDF document, version 1.5
The :c:func:`type` function would return *"PDF document, version 1.5"* in this
case. Using the :c:func:`mime_type` function is similar to passing the
``--mime`` argument to *file*.::
$file --mime some.pdf
some.pdf: application/pdf; charset=binary
:c:func:`mime_type` would return *"application/pdf"*, without the charset part.
By experimenting a little with the *file* command you can learn which output to
expect for different file types. These are a few examples:
* JPEG image data, JFIF standard 1.01
* PE32 executable for MS Windows (GUI) Intel 80386 32-bit
* PNG image data, 1240 x 1753, 8-bit/color RGBA, non-interlaced
* ASCII text, with no line terminators
* Zip archive data, at least v2.0 to extract
libmagic will try and read its compiled file type database from /etc/magic.mgc
by default. If this file doesn't exist, you can set the environment variable
MAGIC to point to a magic.mgc file and libmagic will attempt to load from there
as an alternative.
.. c:function:: type()
Function returning a string with the type of the file.
*Example: magic.type() contains "PDF"*
.. c:function:: mime_type()
Function returning a string with the MIME type of the file.
*Example: magic.mime_type() == "application/pdf"*
|
