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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module pyclamd</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>pyclamd</strong></big></big> (version 0.3.9)</font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/xael/ESPACE_KM/python/pyclamd/pyclamd.py">/home/xael/ESPACE_KM/python/pyclamd/pyclamd.py</a></font></td></tr></table>
<p><tt>pyclamd.py<br>
<br>
Author : Alexandre Norman - norman()xael.org<br>
Contributors :<br>
- JB : Joe Brandt - brandt.joe () gmail.com<br>
- JS : Joni Salonen - joni.salonen () qindel.com<br>
- PL : Philippe Lagadec - philippe.lagadec()laposte.net<br>
- SK : Scott Kitterman - debian () kitterman.com<br>
- TK : Thomas Kastner - tk()underground8.com<br>
- TKL : Thomas Kluyver - thomas () kluyver.me.uk<br>
- TT : Theodoropoulos Theodoros (TeD TeD) - sbujam()gmail.com<br>
Licence : LGLPv3+<br>
<br>
Usage :<br>
<br>
Test strings :<br>
^^^^^^^^^^^^<br>
<br>
>>> import pyclamd<br>
>>> try:<br>
... cd = pyclamd.<a href="#ClamdUnixSocket">ClamdUnixSocket</a>()<br>
... # test if server is reachable<br>
... cd.ping()<br>
... except pyclamd.<a href="#ConnectionError">ConnectionError</a>:<br>
... # if failed, test for network socket<br>
... cd = pyclamd.<a href="#ClamdNetworkSocket">ClamdNetworkSocket</a>()<br>
... try:<br>
... cd.ping()<br>
... except pyclamd.<a href="#ConnectionError">ConnectionError</a>:<br>
... raise <a href="exceptions.html#ValueError">ValueError</a>('could not connect to clamd server either by unix or network socket')<br>
True<br>
>>> print(cd.<a href="#-version">version</a>().split()[0])<br>
ClamAV<br>
>>> print(cd.reload())<br>
RELOADING<br>
>>> print(cd.stats().split()[0])<br>
POOLS:<br>
>>> void = open('/tmp/EICAR','w').write(cd.EICAR())<br>
>>> void = open('/tmp/NO_EICAR','w').write('no virus in this file')<br>
>>> cd.<a href="#-scan_file">scan_file</a>('/tmp/EICAR')['/tmp/EICAR']<br>
('FOUND', 'Eicar-Test-Signature')<br>
>>> cd.<a href="#-scan_file">scan_file</a>('/tmp/NO_EICAR') is None<br>
True<br>
>>> cd.scan_stream(cd.EICAR())['stream']<br>
('FOUND', 'Eicar-Test-Signature')<br>
>>> directory = cd.<a href="#-contscan_file">contscan_file</a>('/tmp/')<br>
>>> directory['/tmp/EICAR']<br>
('FOUND', 'Eicar-Test-Signature')<br>
>>> # Testing encoding with non latin characters (Chinese ideograms taken from random site, don't know what it mean, sorry)<br>
>>> void = open('/tmp/EICAR-éèô请收藏我们的网址','w').write(cd.EICAR())<br>
>>> r = cd.<a href="#-scan_file">scan_file</a>('/tmp/EICAR-éèô请收藏我们的网址')<br>
>>> print(list(r.keys())[0])<br>
/tmp/EICAR-éèô请收藏我们的网址<br>
>>> print(r['/tmp/EICAR-éèô请收藏我们的网址'])<br>
('FOUND', 'Eicar-Test-Signature')<br>
>>> import os<br>
>>> os.remove('/tmp/EICAR')<br>
>>> os.remove('/tmp/NO_EICAR')<br>
>>> os.remove('/tmp/EICAR-éèô请收藏我们的网址')</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="base64.html">base64</a><br>
</td><td width="25%" valign=top><a href="socket.html">socket</a><br>
</td><td width="25%" valign=top><a href="struct.html">struct</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="exceptions.html#ValueError">exceptions.ValueError</a>(<a href="exceptions.html#StandardError">exceptions.StandardError</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyclamd.html#BufferTooLongError">BufferTooLongError</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyclamd.html#ClamdNetworkSocket">ClamdNetworkSocket</a>
</font></dt><dt><font face="helvetica, arial"><a href="pyclamd.html#ClamdUnixSocket">ClamdUnixSocket</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="socket.html#error">socket.error</a>(<a href="exceptions.html#IOError">exceptions.IOError</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pyclamd.html#ConnectionError">ConnectionError</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BufferTooLongError">class <strong>BufferTooLongError</strong></a>(<a href="exceptions.html#ValueError">exceptions.ValueError</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class for errors with clamd using INSTREAM with a buffer lenght > StreamMaxLength in /etc/clamav/clamd.conf<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyclamd.html#BufferTooLongError">BufferTooLongError</a></dd>
<dd><a href="exceptions.html#ValueError">exceptions.ValueError</a></dd>
<dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#ValueError">exceptions.ValueError</a>:<br>
<dl><dt><a name="BufferTooLongError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#ValueError">exceptions.ValueError</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BufferTooLongError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="BufferTooLongError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="BufferTooLongError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="BufferTooLongError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BufferTooLongError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="BufferTooLongError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ClamdNetworkSocket">class <strong>ClamdNetworkSocket</strong></a>(<a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class for using clamd with a network socket<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyclamd.html#ClamdNetworkSocket">ClamdNetworkSocket</a></dd>
<dd><a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ClamdNetworkSocket-__init__"><strong>__init__</strong></a>(self, host<font color="#909090">='127.0.0.1'</font>, port<font color="#909090">=3310</font>, timeout<font color="#909090">=None</font>)</dt><dd><tt>Network Class initialisation<br>
host (string) : hostname or ip address<br>
port (int) : TCP port<br>
timeout (float or None) : socket timeout</tt></dd></dl>
<hr>
Methods inherited from <a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>:<br>
<dl><dt><a name="ClamdNetworkSocket-EICAR"><strong>EICAR</strong></a>(self)</dt><dd><tt>returns Eicar test string</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-contscan_file"><strong>contscan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename<br>
Do not stop on <a href="socket.html#error">error</a> or virus found.<br>
Scan with archive support enabled.<br>
<br>
file (string): filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}<br>
- None: if no virus found<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-multiscan_file"><strong>multiscan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename using multiple threads (faster on SMP machines).<br>
Do not stop on <a href="socket.html#error">error</a> or virus found.<br>
Scan with archive support enabled.<br>
<br>
file (string): filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}<br>
- None: if no virus found<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-ping"><strong>ping</strong></a>(self)</dt><dd><tt>Send a PING to the clamav server, which should reply<br>
by a PONG.<br>
<br>
return: True if the server replies to PING<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: if the server do not reply by PONG</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-reload"><strong>reload</strong></a>(self)</dt><dd><tt>Force Clamd to reload signature database<br>
<br>
return: (string) "RELOADING"<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-scan_file"><strong>scan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename and stop on first virus or <a href="socket.html#error">error</a> found.<br>
Scan with archive support enabled.<br>
<br>
file (string) : filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: "virusname"}<br>
- None: if no virus found<br>
<br>
May raise :<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem<br>
- socket.timeout: if timeout has expired</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-scan_stream"><strong>scan_stream</strong></a>(self, buffer_to_test)</dt><dd><tt>Scan a buffer<br>
<br>
buffer_to_test (string): buffer to scan<br>
<br>
return either:<br>
- (dict): {filename1: "virusname"}<br>
- None: if no virus found<br>
<br>
May raise :<br>
- <a href="#BufferTooLongError">BufferTooLongError</a>: if the buffer size exceeds clamd limits<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-shutdown"><strong>shutdown</strong></a>(self)</dt><dd><tt>Force Clamd to shutdown and exit<br>
<br>
return: nothing<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-stats"><strong>stats</strong></a>(self)</dt><dd><tt>Get Clamscan stats<br>
<br>
return: (string) clamscan stats<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdNetworkSocket-version"><strong>version</strong></a>(self)</dt><dd><tt>Get Clamscan version<br>
<br>
return: (string) clamscan version<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ClamdUnixSocket">class <strong>ClamdUnixSocket</strong></a>(<a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class for using clamd with an unix socket<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyclamd.html#ClamdUnixSocket">ClamdUnixSocket</a></dd>
<dd><a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ClamdUnixSocket-__init__"><strong>__init__</strong></a>(self, filename<font color="#909090">=None</font>, timeout<font color="#909090">=None</font>)</dt><dd><tt>Unix Socket Class initialisation<br>
<br>
filename (string) : unix socket filename or None to get the socket from /etc/clamav/clamd.conf<br>
timeout (float or None) : socket timeout</tt></dd></dl>
<hr>
Methods inherited from <a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>:<br>
<dl><dt><a name="ClamdUnixSocket-EICAR"><strong>EICAR</strong></a>(self)</dt><dd><tt>returns Eicar test string</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-contscan_file"><strong>contscan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename<br>
Do not stop on <a href="socket.html#error">error</a> or virus found.<br>
Scan with archive support enabled.<br>
<br>
file (string): filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}<br>
- None: if no virus found<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-multiscan_file"><strong>multiscan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename using multiple threads (faster on SMP machines).<br>
Do not stop on <a href="socket.html#error">error</a> or virus found.<br>
Scan with archive support enabled.<br>
<br>
file (string): filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}<br>
- None: if no virus found<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-ping"><strong>ping</strong></a>(self)</dt><dd><tt>Send a PING to the clamav server, which should reply<br>
by a PONG.<br>
<br>
return: True if the server replies to PING<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: if the server do not reply by PONG</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-reload"><strong>reload</strong></a>(self)</dt><dd><tt>Force Clamd to reload signature database<br>
<br>
return: (string) "RELOADING"<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-scan_file"><strong>scan_file</strong></a>(self, file)</dt><dd><tt>Scan a file or directory given by filename and stop on first virus or <a href="socket.html#error">error</a> found.<br>
Scan with archive support enabled.<br>
<br>
file (string) : filename or directory (MUST BE ABSOLUTE PATH !)<br>
<br>
return either :<br>
- (dict): {filename1: "virusname"}<br>
- None: if no virus found<br>
<br>
May raise :<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem<br>
- socket.timeout: if timeout has expired</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-scan_stream"><strong>scan_stream</strong></a>(self, buffer_to_test)</dt><dd><tt>Scan a buffer<br>
<br>
buffer_to_test (string): buffer to scan<br>
<br>
return either:<br>
- (dict): {filename1: "virusname"}<br>
- None: if no virus found<br>
<br>
May raise :<br>
- <a href="#BufferTooLongError">BufferTooLongError</a>: if the buffer size exceeds clamd limits<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-shutdown"><strong>shutdown</strong></a>(self)</dt><dd><tt>Force Clamd to shutdown and exit<br>
<br>
return: nothing<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-stats"><strong>stats</strong></a>(self)</dt><dd><tt>Get Clamscan stats<br>
<br>
return: (string) clamscan stats<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<dl><dt><a name="ClamdUnixSocket-version"><strong>version</strong></a>(self)</dt><dd><tt>Get Clamscan version<br>
<br>
return: (string) clamscan version<br>
<br>
May raise:<br>
- <a href="#ConnectionError">ConnectionError</a>: in case of communication problem</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="pyclamd.html#_ClamdGeneric">_ClamdGeneric</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ConnectionError">class <strong>ConnectionError</strong></a>(<a href="socket.html#error">socket.error</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class for errors communication with clamd<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="pyclamd.html#ConnectionError">ConnectionError</a></dd>
<dd><a href="socket.html#error">socket.error</a></dd>
<dd><a href="exceptions.html#IOError">exceptions.IOError</a></dd>
<dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd>
<dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors inherited from <a href="socket.html#error">socket.error</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
<dl><dt><a name="ConnectionError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ConnectionError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
<dl><dt><a name="ConnectionError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="ConnectionError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
<dl><dt><strong>errno</strong></dt>
<dd><tt>exception errno</tt></dd>
</dl>
<dl><dt><strong>filename</strong></dt>
<dd><tt>exception filename</tt></dd>
</dl>
<dl><dt><strong>strerror</strong></dt>
<dd><tt>exception strerror</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="ConnectionError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="ConnectionError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="ConnectionError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="ConnectionError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="ConnectionError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="ConnectionError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="ConnectionError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="ConnectionError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-ClamdAgnostic"><strong>ClamdAgnostic</strong></a>()</dt><dd><tt>Tries to connect to clamd using <a href="#ClamdUnixSocket">ClamdUnixSocket</a> or if it fails, tries<br>
with <a href="#ClamdNetworkSocket">ClamdNetworkSocket</a> and return the corresponding object.<br>
Of course, it tries to connect with default settings...</tt></dd></dl>
<dl><dt><a name="-contscan_file"><strong>contscan_file</strong></a> = wrapper(*args, **kw)</dt><dd><tt>Deprecated API - use one of the Clamd*Socket classes instead.</tt></dd></dl>
<dl><dt><a name="-init_network_socket"><strong>init_network_socket</strong></a>(host<font color="#909090">='127.0.0.1'</font>, port<font color="#909090">=3310</font>, timeout<font color="#909090">=None</font>)</dt><dd><tt>Deprecated API - use <a href="#ClamdNetworkSocket">ClamdNetworkSocket</a> instead.</tt></dd></dl>
<dl><dt><a name="-init_unix_socket"><strong>init_unix_socket</strong></a>(filename<font color="#909090">=None</font>)</dt><dd><tt>Deprecated API - use <a href="#ClamdUnixSocket">ClamdUnixSocket</a> instead.</tt></dd></dl>
<dl><dt><a name="-multiscan_file"><strong>multiscan_file</strong></a> = wrapper(*args, **kw)</dt><dd><tt>Deprecated API - use one of the Clamd*Socket classes instead.</tt></dd></dl>
<dl><dt><a name="-scan_file"><strong>scan_file</strong></a> = wrapper(*args, **kw)</dt><dd><tt>Deprecated API - use one of the Clamd*Socket classes instead.</tt></dd></dl>
<dl><dt><a name="-version"><strong>version</strong></a> = wrapper(*args, **kw)</dt><dd><tt>Deprecated API - use one of the Clamd*Socket classes instead.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>__version__</strong> = '0.3.9'<br>
<strong>socketinst</strong> = None</td></tr></table>
</body></html>
|
