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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
#
# Copyright (c) 2007-2013. The YARA Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from distutils.command.build_ext import build_ext
from setuptools import setup, Command, Extension
from codecs import open
import distutils.errors
import distutils.ccompiler
import distutils.sysconfig
import contextlib
import os
import sys
import tempfile
import shutil
import subprocess
@contextlib.contextmanager
def muted(*streams):
"""A context manager to redirect stdout and/or stderr to /dev/null.
Examples:
with muted(sys.stdout):
...
with muted(sys.stderr):
...
with muted(sys.stdout, sys.stderr):
...
"""
devnull = open(os.devnull, 'w')
try:
old_streams = [os.dup(s.fileno()) for s in streams]
for s in streams:
os.dup2(devnull.fileno(), s.fileno())
yield
finally:
for o,n in zip(old_streams, streams):
os.dup2(o, n.fileno())
devnull.close()
def has_function(function_name, libraries=None):
"""Checks if a given functions exists in the current platform."""
compiler = distutils.ccompiler.new_compiler()
with muted(sys.stdout, sys.stderr):
result = compiler.has_function(
function_name, libraries=libraries)
if os.path.exists('a.out'):
os.remove('a.out')
return result
class BuildCommand(build_ext):
user_options = build_ext.user_options + [
('dynamic-linking', None,'link dynamically against libyara'),
('enable-cuckoo', None,'enable "cuckoo" module'),
('enable-magic', None,'enable "magic" module'),
('enable-profiling', None,'enable profiling features')]
boolean_options = build_ext.boolean_options + [
'dynamic-linking', 'enable-cuckoo', 'enable-magic', 'enable-profiling']
def initialize_options(self):
build_ext.initialize_options(self)
self.dynamic_linking = None
self.enable_magic = None
self.enable_cuckoo = None
self.enable_profiling = None
def finalize_options(self):
build_ext.finalize_options(self)
if self.enable_magic and self.dynamic_linking:
raise distutils.errors.DistutilsOptionError(
'--enable-magic can''t be used with --dynamic-linking')
if self.enable_cuckoo and self.dynamic_linking:
raise distutils.errors.DistutilsOptionError(
'--enable-cuckoo can''t be used with --dynamic-linking')
def run(self):
"""Execute the build command."""
module = self.distribution.ext_modules[0]
base_dir = os.path.dirname(__file__)
if base_dir:
os.chdir(base_dir)
exclusions = []
if self.plat_name in ('win32','win-amd64'):
building_for_windows = True
bits = '64' if self.plat_name == 'win-amd64' else '32'
module.define_macros.append(('_CRT_SECURE_NO_WARNINGS','1'))
module.include_dirs.append('yara/windows/include')
module.libraries.append('advapi32')
module.libraries.append('user32')
else:
building_for_windows = False
if 'macosx' in self.plat_name:
building_for_osx = True
module.include_dirs.append('/opt/local/include')
module.library_dirs.append('/opt/local/lib')
else:
building_for_osx = False
if has_function('memmem'):
module.define_macros.append(('HAVE_MEMMEM', '1'))
if has_function('strlcpy'):
module.define_macros.append(('HAVE_STRLCPY', '1'))
if has_function('strlcat'):
module.define_macros.append(('HAVE_STRLCAT', '1'))
if self.enable_profiling:
module.define_macros.append(('PROFILING_ENABLED', '1'))
if self.dynamic_linking:
module.libraries.append('yara')
else:
if building_for_windows:
module.library_dirs.append('yara/windows/lib')
if building_for_windows:
module.define_macros.append(('HASH_MODULE', '1'))
module.libraries.append('libeay%s' % bits)
elif (has_function('MD5_Init', libraries=['crypto']) and
has_function('SHA256_Init', libraries=['crypto'])):
module.define_macros.append(('HASH_MODULE', '1'))
module.libraries.append('crypto')
else:
exclusions.append('yara/libyara/modules/hash.c')
if self.enable_magic:
module.define_macros.append(('MAGIC_MODULE', '1'))
else:
exclusions.append('yara/libyara/modules/magic.c')
if self.enable_cuckoo:
module.define_macros.append(('CUCKOO_MODULE', '1'))
if building_for_windows:
module.libraries.append('jansson%s' % bits)
else:
module.libraries.append('jansson')
else:
exclusions.append('yara/libyara/modules/cuckoo.c')
exclusions = [os.path.normpath(x) for x in exclusions]
for directory, _, files in os.walk('yara/libyara/'):
for x in files:
x = os.path.normpath(os.path.join(directory, x))
if x.endswith('.c') and x not in exclusions:
module.sources.append(x)
build_ext.run(self)
class UpdateCommand(Command):
"""Update libyara source.
This is normally only run by packagers to make a new release.
"""
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
subprocess.check_call(['git', 'stash'], cwd='yara')
subprocess.check_call(['git', 'submodule', 'init'])
subprocess.check_call(['git', 'submodule', 'update'])
subprocess.check_call(['git', 'reset', '--hard'], cwd='yara')
subprocess.check_call(['git', 'clean', '-x', '-f', '-d'],
cwd='yara')
subprocess.check_call(['git', 'checkout', 'master'], cwd='yara')
subprocess.check_call(['git', 'pull'], cwd='yara')
subprocess.check_call(['git', 'fetch', '--tags'], cwd='yara')
tag_name = 'tags/v%s' % self.distribution.metadata.version
subprocess.check_call(['git', 'checkout', tag_name], cwd='yara')
subprocess.check_call(['./bootstrap.sh'], cwd='yara')
subprocess.check_call(['./configure'], cwd='yara')
with open('README.rst', 'r', 'utf-8') as f:
readme = f.read()
setup(
name='yara-python',
version='3.5.0',
description='Python interface for YARA',
long_description=readme,
license='Apache 2.0',
author='Victor M. Alvarez',
author_email='plusvic@gmail.com;vmalvarez@virustotal.com',
url='https://github.com/VirusTotal/yara-python',
zip_safe=False,
cmdclass={
'build_ext': BuildCommand,
'update': UpdateCommand},
ext_modules=[Extension(
name='yara',
include_dirs=['yara/libyara/include', 'yara/libyara/', '.'],
sources=['yara-python.c'])])