-
Notifications
You must be signed in to change notification settings - Fork 687
/
bytecode_api.h
1470 lines (1332 loc) · 48.3 KB
/
bytecode_api.h
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2013-2022 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
* Copyright (C) 2009-2013 Sourcefire, Inc.
* Authors: Török Edvin, Kevin Lin
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/** @file bytecode_api.h */
#ifndef BYTECODE_API_H
#define BYTECODE_API_H
#ifdef __CLAMBC__
#include "bytecode_execs.h"
#include "bytecode_pe.h"
#include "bytecode_disasm.h"
#include "bytecode_detect.h"
#endif
#ifndef __CLAMBC__
struct cli_exe_section;
struct DISASM_RESULT;
#endif
#ifdef __CLAMBC__
enum {
/**
* \group_pe
* Invalid RVA specified
*/
PE_INVALID_RVA = 0xFFFFFFFF
};
#endif
#ifndef __CLAMBC__
#define PE_INVALID_RVA 0xFFFFFFFF
#endif
/**
\group_config
* Specifies the bytecode type and how ClamAV executes it
*/
enum BytecodeKind {
/** generic bytecode, not tied a specific hook */
BC_GENERIC = 0,
/** triggered at startup, only one is allowed per ClamAV startup */
BC_STARTUP = 1,
_BC_START_HOOKS = 256,
/** executed on a logical trigger */
BC_LOGICAL = 256,
/** specifies a PE unpacker, executed on PE files on a logical trigger */
BC_PE_UNPACKER,
/** specifies a PDF hook, executes at a predetermined point of PDF parsing for PDF files */
BC_PDF,
/** specifies a PE hook, executes at a predetermined point in PE parsing for PE files,
* both packed and unpacked files */
BC_PE_ALL,
/** specifies a PRECLASS hook, executes at the end of file property collection and
* operates on the original file targeted for property collection */
BC_PRECLASS,
/** specifies an ELF unpacker, executed on ELF files on a logical trigger */
BC_ELF_UNPACKER,
/** specifies an Mach-O unpacker, executed on Mach-O files on a logical trigger */
BC_MACHO_UNPACKER,
_BC_LAST_HOOK
};
/**
\group_config
* LibClamAV functionality level constants
*/
enum FunctionalityLevels {
FUNC_LEVEL_096 = 51, /**< LibClamAV release 0.96.0: bytecode engine released */
FUNC_LEVEL_096_dev = 52,
FUNC_LEVEL_096_1 = 53, /**< LibClamAV release 0.96.1: logical signature use of VI/macros requires this minimum functionality level */
FUNC_LEVEL_096_1_dev = 54,
FUNC_LEVEL_096_2 = 54, /**< LibClamAV release 0.96.2: PDF Hooks require this minimum level */
FUNC_LEVEL_096_2_dev = 55,
FUNC_LEVEL_096_3 = 55, /**< LibClamAV release 0.96.3: BC_PE_ALL bytecodes require this minimum level */
FUNC_LEVEL_096_4 = 56, /**< LibClamAV release 0.96.4: minimum recommended engine version, older versions have quadratic load time */
FUNC_LEVEL_096_5 = 58, /**< LibClamAV release 0.96.5 */
FUNC_LEVEL_097 = 60, /**< LibClamAV release 0.97.0: older bytecodes may incorrectly use 57 */
FUNC_LEVEL_097_1 = 61, /**< LibClamAV release 0.97.1 */
FUNC_LEVEL_097_2 = 62, /**< LibClamAV release 0.97.2 */
FUNC_LEVEL_097_3 = 63, /**< LibClamAV release 0.97.3: last bcc changes as former team resigns*/
FUNC_LEVEL_097_4 = 64, /**< LibClamAV release 0.97.4 */
FUNC_LEVEL_097_5 = 65, /**< LibClamAV release 0.97.5 */
FUNC_LEVEL_097_6 = 67, /**< LibClamAV release 0.97.6 */
FUNC_LEVEL_097_7 = 68, /**< LibClamAV release 0.97.7 */
FUNC_LEVEL_097_8 = 69, /**< LibClamAV release 0.97.8 */
FUNC_LEVEL_098 = 74, /**< LibClamAV release 0.98.0 */
FUNC_LEVEL_098_1 = 76, /**< LibClamAV release 0.98.1: last syncing to clamav*/
FUNC_LEVEL_098_2 = 77, /**< LibClamAV release 0.98.2 */
FUNC_LEVEL_098_3 = 77, /**< LibClamAV release 0.98.3 */
FUNC_LEVEL_098_4 = 77, /**< LibClamAV release 0.98.4 */
FUNC_LEVEL_098_5 = 79, /**< LibClamAV release 0.98.5: JSON reading API requires this minimum level */
FUNC_LEVEL_098_6 = 79, /**< LibClamAV release 0.98.6 */
FUNC_LEVEL_098_7 = 80, /**< LibClamAV release 0.98.7: BC_PRECLASS bytecodes require minimum level */
FUNC_LEVEL_099 = 81, /**< LibClamAV release 0.99.0 */
FUNC_LEVEL_099_1 = 82, /**< LibClamAV release 0.99.1 */
FUNC_LEVEL_099_2 = 82, /**< LibClamAV release 0.99.2: not a typo, the FLEVEL did not change */
FUNC_LEVEL_099_3 = 84, /**< LibClamAV release 0.99.3 */
FUNC_LEVEL_099_4 = 85, /**< LibClamAV release 0.99.4 */
FUNC_LEVEL_0100_BETA = 90, /**< LibClamAV release 0.100.0-BETA */
FUNC_LEVEL_0100 = 91, /**< LibClamAV release 0.100.0 */
FUNC_LEVEL_0100_1 = 92, /**< LibClamAV release 0.100.1 */
FUNC_LEVEL_0100_2 = 93, /**< LibClamAV release 0.100.2 */
FUNC_LEVEL_0100_3 = 94, /**< LibClamAV release 0.100.3 */
FUNC_LEVEL_0101_BETA = 100, /**< LibClamAV release 0.101.0-BETA */
FUNC_LEVEL_0101 = 101, /**< LibClamAV release 0.101.0 */
FUNC_LEVEL_0101_1 = 102, /**< LibClamAV release 0.101.1 */
FUNC_LEVEL_0101_2 = 102, /**< LibClamAV release 0.101.2 */
FUNC_LEVEL_0101_3 = 102, /**< LibClamAV release 0.101.3 */
FUNC_LEVEL_0101_4 = 105, /**< LibClamAV release 0.101.4 */
FUNC_LEVEL_0101_5 = 106, /**< LibClamAV release 0.101.5 */
FUNC_LEVEL_0102_BETA = 110, /**< LibClamAV release 0.102.0-BETA */
FUNC_LEVEL_0102 = 111, /**< LibClamAV release 0.102.0 */
FUNC_LEVEL_0102_1 = 112, /**< LibClamAV release 0.102.1 */
FUNC_LEVEL_0103_BETA = 120, /**< LibClamAV release 0.103.0-BETA */
FUNC_LEVEL_0103 = 121, /**< LibClamAV release 0.103.0 */
FUNC_LEVEL_0103_1 = 122, /**< LibClamAV release 0.103.1 */
FUNC_LEVEL_0103_2 = 123, /**< LibClamAV release 0.103.2 */
FUNC_LEVEL_0103_3 = 124, /**< LibClamAV release 0.103.3 */
FUNC_LEVEL_0103_4 = 125, /**< LibClamAV release 0.103.4 */
FUNC_LEVEL_0103_5 = 126, /**< LibClamAV release 0.103.5 */
FUNC_LEVEL_0103_6 = 127, /**< LibClamAV release 0.103.6 */
FUNC_LEVEL_0103_7 = 128, /**< LibClamAV release 0.103.7 */
FUNC_LEVEL_0104 = 140, /**< LibClamAV release 0.104.0 */
FUNC_LEVEL_0104_1 = 141, /**< LibClamAV release 0.104.1 */
FUNC_LEVEL_0104_2 = 142, /**< LibClamAV release 0.104.2 */
FUNC_LEVEL_0104_3 = 143, /**< LibClamAV release 0.104.3 */
FUNC_LEVEL_0104_4 = 144, /**< LibClamAV release 0.104.4 */
FUNC_LEVEL_0105 = 150, /**< LibClamAV release 0.105.0 */
FUNC_LEVEL_0105_1 = 151, /**< LibClamAV release 0.105.1 */
FUNC_LEVEL_1_0 = 160, /**< LibClamAV release 1.0.0 */
};
/**
\group_pdf
* Phase of PDF parsing used for PDF Hooks
*/
enum pdf_phase {
PDF_PHASE_NONE, /* not a PDF */
PDF_PHASE_PARSED, /* after parsing a PDF, object flags can be set etc. */
PDF_PHASE_POSTDUMP, /* after an obj was dumped and scanned */
PDF_PHASE_END, /* after the pdf scan finished */
PDF_PHASE_PRE /* before pdf is parsed at all */
};
/**
\group_pdf
* PDF flags
*/
enum pdf_flag {
BAD_PDF_VERSION = 0, /* */
BAD_PDF_HEADERPOS, /* */
BAD_PDF_TRAILER, /* */
BAD_PDF_TOOMANYOBJS, /* */
BAD_STREAM_FILTERS, /* */
BAD_FLATE, /* */
BAD_FLATESTART, /* */
BAD_STREAMSTART, /* */
BAD_ASCIIDECODE, /* */
BAD_INDOBJ, /* */
UNTERMINATED_OBJ_DICT, /* */
ESCAPED_COMMON_PDFNAME, /* */
HEX_JAVASCRIPT, /* */
UNKNOWN_FILTER, /* */
MANY_FILTERS, /* */
HAS_OPENACTION, /* */
BAD_STREAMLEN, /* */
ENCRYPTED_PDF, /* */
LINEARIZED_PDF, /* not bad, just as flag */
DECRYPTABLE_PDF, /* */
HAS_LAUNCHACTION /* */
};
/**
\group_pdf
* PDF obj flags
*/
enum pdf_objflags {
OBJ_STREAM = 0, /* */
OBJ_DICT, /* */
OBJ_EMBEDDED_FILE, /* */
OBJ_FILTER_AH, /* */
OBJ_FILTER_A85, /* */
OBJ_FILTER_FLATE, /* */
OBJ_FILTER_LZW, /* */
OBJ_FILTER_RL, /* */
OBJ_FILTER_FAX, /* */
OBJ_FILTER_JBIG2, /* */
OBJ_FILTER_DCT, /* */
OBJ_FILTER_JPX, /* */
OBJ_FILTER_CRYPT, /* */
OBJ_FILTER_UNKNOWN, /* */
OBJ_JAVASCRIPT, /* */
OBJ_OPENACTION, /* */
OBJ_HASFILTERS, /* */
OBJ_SIGNED, /* */
OBJ_IMAGE, /* */
OBJ_TRUNCATED, /* */
OBJ_FORCEDUMP, /* */
OBJ_FILTER_STANDARD, /* */
OBJ_LAUNCHACTION, /* */
OBJ_PAGE, /* */
OBJ_CONTENTS /* */
};
/**
\group_json
* JSON types
*/
enum bc_json_type {
JSON_TYPE_NULL = 0, /* */
JSON_TYPE_BOOLEAN, /* */
JSON_TYPE_DOUBLE, /* */
JSON_TYPE_INT, /* */
JSON_TYPE_OBJECT, /* */
JSON_TYPE_ARRAY, /* */
JSON_TYPE_STRING /* */
};
/**
\group_adt
* LZMA return codes
*/
enum lzma_returncode {
LZMA_RESULT_OK = 0, /* Function completed successfully */
LZMA_RESULT_DATA_ERROR = 1, /* The LZMA stream contained invalid data */
LZMA_STREAM_END = 2 /* The LZMA stream ended unexpectedly */
};
/**
\group adt
* Bzip2 return codes
*/
enum bzip2_returncode {
BZIP2_OK = 0, /* Function returned without error */
BZIP2_SEQUENCE_ERROR = -1,
BZIP2_PARAM_ERROR = -2,
BZIP2_MEM_ERROR = -3,
BZIP2_DATA_ERROR = -4,
BZIP2_DATA_ERROR_MAGIC = -5,
BZIP2_IO_ERROR = -6,
BZIP2_UNEXPECTED_EOF = -7,
BZIP2_OUTBUFF_FULL = -8,
BZIP2_CONFIG_ERROR = -9,
BZIP2_RUN_OK = 1,
BZIP2_FLUSH_OK = 2,
BZIP2_FINISH_OK = 3,
BZIP2_STREAM_END = 4
};
/**
\group_engine
* Scan option flag values for engine_scan_options(). *DEPRECATED*
*/
// clang-format off
enum {
CL_SCAN_RAW = 0x0,
CL_SCAN_ARCHIVE = 0x1,
CL_SCAN_MAIL = 0x2,
CL_SCAN_OLE2 = 0x4,
CL_SCAN_BLOCKENCRYPTED = 0x8,
CL_SCAN_HTML = 0x10,
CL_SCAN_PE = 0x20,
CL_SCAN_BLOCKBROKEN = 0x40,
CL_SCAN_MAILURL = 0x80, /* deprecated circa 2009 */
CL_SCAN_BLOCKMAX = 0x100,
CL_SCAN_ALGORITHMIC = 0x200,
// UNUSED = 0x400,
CL_SCAN_PHISHING_BLOCKSSL = 0x800, /* ssl mismatches, not ssl by itself*/
CL_SCAN_PHISHING_BLOCKCLOAK = 0x1000,
CL_SCAN_ELF = 0x2000,
CL_SCAN_PDF = 0x4000,
CL_SCAN_STRUCTURED = 0x8000,
CL_SCAN_STRUCTURED_SSN_NORMAL = 0x10000,
CL_SCAN_STRUCTURED_SSN_STRIPPED = 0x20000,
CL_SCAN_PARTIAL_MESSAGE = 0x40000,
CL_SCAN_HEURISTIC_PRECEDENCE = 0x80000,
CL_SCAN_BLOCKMACROS = 0x100000,
CL_SCAN_ALLMATCHES = 0x200000,
CL_SCAN_SWF = 0x400000,
CL_SCAN_PARTITION_INTXN = 0x800000,
CL_SCAN_XMLDOCS = 0x1000000,
CL_SCAN_HWP3 = 0x2000000,
// UNUSED = 0x4000000,
// UNUSED = 0x8000000,
CL_SCAN_FILE_PROPERTIES = 0x10000000,
// UNUSED = 0x20000000,
CL_SCAN_PERFORMANCE_INFO = 0x40000000, /* Collect performance timings */
CL_SCAN_INTERNAL_COLLECT_SHA = 0x80000000 /* Enables hash output in sha-collect builds - for internal use only */
};
// clang-format on
#ifdef __CLAMBC__
/* --------------- BEGIN GLOBALS -------------------------------------------- */
/**
\group_globals
* Logical signature match counts
* @brief This is a low-level variable, use the Macros in bytecode_local.h instead to
* access it.
*/
extern const uint32_t __clambc_match_counts[64];
/**
\group_globals
* Logical signature match offsets
* @brief This is a low-level variable, use the Macros in bytecode_local.h instead to
* access it.
*/
extern const uint32_t __clambc_match_offsets[64];
/**
\group_globals
* PE data, if this is a PE hook.
*/
extern const struct cli_pe_hook_data __clambc_pedata;
/**
\group_globals
* File size (max 4G).
*/
extern const uint32_t __clambc_filesize[1];
/**
\group_globals
* Kind of the bytecode, affects LibClamAV usage
*/
const uint16_t __clambc_kind;
/* ---------------- END GLOBALS --------------------------------------------- */
/* ---------------- BEGIN 0.96 APIs (don't touch) --------------------------- */
/**
* Test api.
* @param[in] a 0xf00dbeef
* @param[in] b 0xbeeff00d
* @return 0x12345678 if parameters match, 0x55 otherwise
*/
uint32_t test1(uint32_t a, uint32_t b);
/**
\group_file
* Reads specified amount of bytes from the current file
* into a buffer. Also moves current position in the file.
* @param[in] size amount of bytes to read
* @param[out] data pointer to buffer where data is read into
* @return amount read.
*/
int32_t read(uint8_t* data, int32_t size);
/**
\group_file
*/
enum {
/**set file position to specified absolute position */
SEEK_SET = 0,
/**set file position relative to current position */
SEEK_CUR,
/**set file position relative to file end*/
SEEK_END
};
/**
\group_file
* Writes the specified amount of bytes from a buffer to the
* current temporary file.
* @param[in] data pointer to buffer of data to write
* @param[in] size amount of bytes to write
* \p size bytes to temporary file, from the buffer pointed to
* byte
* @return amount of bytes successfully written
*/
int32_t write(uint8_t* data, int32_t size);
/**
\group_file
* Changes the current file position to the specified one.
* @sa SEEK_SET, SEEK_CUR, SEEK_END
* @param[in] pos offset (absolute or relative depending on \p whence param)
* @param[in] whence one of \p SEEK_SET, \p SEEK_CUR, \p SEEK_END
* @return absolute position in file
*/
int32_t seek(int32_t pos, uint32_t whence);
/**
\group_scan
* Sets the name of the virus found.
* @param[in] name the name of the virus
* @param[in] len length of the virusname
* @return 0
*/
uint32_t setvirusname(const uint8_t* name, uint32_t len);
/**
\group_debug
* Prints a debug message string.
* @param[in] str Message to print
* @param[in] len length of message to print
* @return 0
*/
uint32_t debug_print_str(const uint8_t* str, uint32_t len);
/**
\group_debug
* Prints a number as a debug message.
* This is similar to \p debug_print_str_nonl.
* @param[in] a number to print
* @return 0
*/
uint32_t debug_print_uint(uint32_t a);
/**
\group_disasm
* Disassembles starting from current file position, the specified amount of
* bytes.
* @param[out] result pointer to struct holding result
* @param[in] len how many bytes to disassemble
* @return 0 for success
*
* You can use lseek to disassemble starting from a different location.
* This is a low-level API, the result is in ClamAV type-8 signature format
* (64 bytes/instruction).
* \sa DisassembleAt
*/
uint32_t disasm_x86(struct DISASM_RESULT* result, uint32_t len);
/* tracing API, private */
/* a scope: lexical block, function, or compile unit */
uint32_t trace_directory(const uint8_t* directory, uint32_t dummy);
uint32_t trace_scope(const uint8_t* newscope, uint32_t scopeid);
uint32_t trace_source(const uint8_t* srcfile, uint32_t line);
uint32_t trace_op(const uint8_t* opname, uint32_t column);
uint32_t trace_value(const uint8_t* name, uint32_t v);
uint32_t trace_ptr(const uint8_t* ptr, uint32_t dummy);
/**
\group_pe
* Converts a RVA (Relative Virtual Address) to
* an absolute PE file offset.
* @param[in] rva a rva address from the PE file
* @return absolute file offset mapped to the \p rva,
* or PE_INVALID_RVA if the \p rva is invalid.
*/
uint32_t pe_rawaddr(uint32_t rva);
/**
\group_file
* Looks for the specified sequence of bytes in the current file.
* @param[in] data the sequence of bytes to look for
* @param[in] len length of \p data, cannot be more than 1024
* @return offset in the current file if match is found, -1 otherwise
*/
int32_t file_find(const uint8_t* data, uint32_t len);
/**
\group_file
* Read a single byte from current file
* @param[in] offset file offset
* @return byte at offset \p off in the current file, or -1 if offset is
* invalid
*/
int32_t file_byteat(uint32_t offset);
/**
\group_adt
* Allocates memory. Currently this memory is freed automatically on exit
* from the bytecode, and there is no way to free it sooner.
* @param[in] size amount of memory to allocate in bytes
* @return pointer to allocated memory
*/
void* malloc(uint32_t size);
/**
* Test api2.
* @param[in] a 0xf00d
* @return 0xd00f if parameter matches, 0x5555 otherwise
*/
uint32_t test2(uint32_t a);
/**
\group_pe
* Gets information about the specified PE section.
* @param[out] section PE section information will be stored here
* @param[in] num PE section number
* @return 0 - success
* @return -1 - failure
*/
int32_t get_pe_section(struct cli_exe_section* section, uint32_t num);
/**
\group_file
* Fills the specified buffer with at least \p fill bytes.
* @param[out] buffer the buffer to fill
* @param[in] len length of buffer
* @param[in] filled how much of the buffer is currently filled
* @param[in] cursor position of cursor in buffer
* @param[in] fill amount of bytes to fill in (0 is valid)
* @return <0 on error
* @return 0 on EOF
* @return number bytes available in buffer (starting from 0)\n
* The character at the cursor will be at position 0 after this call.
*/
int32_t fill_buffer(uint8_t* buffer, uint32_t len, uint32_t filled,
uint32_t cursor, uint32_t fill);
/**
\group_scan
* Prepares for extracting a new file, if we've already extracted one it scans
* it.
* @param[in] id an id for the new file (for example position in container)
* @return 1 if previous extracted file was infected
*/
int32_t extract_new(int32_t id);
/**
\group_file
* Reads a number in the specified radix starting from the current position.
* Non-numeric characters are ignored.
* @param[in] radix 10 or 16
* @return the number read
*/
int32_t read_number(uint32_t radix);
/**
\group_adt
* Creates a new hashset and returns its id.
* @return ID for new hashset
*/
int32_t hashset_new(void);
/**
\group_adt
* Add a new 32-bit key to the hashset.
* @param[in] hs ID of hashset (from hashset_new)
* @param[in] key the key to add
* @return 0 on success
*/
int32_t hashset_add(int32_t hs, uint32_t key);
/**
\group_adt
* Remove a 32-bit key from the hashset.
* @param[in] hs ID of hashset (from hashset_new)
* @param[in] key the key to add
* @return 0 on success
*/
int32_t hashset_remove(int32_t hs, uint32_t key);
/**
\group_adt
* Returns whether the hashset contains the specified key.
* @param[in] hs ID of hashset (from hashset_new)
* @param[in] key the key to lookup
* @return 1 if found
* @return 0 if not found
* @return <0 on invalid hashset ID
*/
int32_t hashset_contains(int32_t hs, uint32_t key);
/**
\group_adt
* Deallocates the memory used by the specified hashset.
* Trying to use the hashset after this will result in an error.
* The hashset may not be used after this.
* All hashsets are automatically deallocated when bytecode
* finishes execution.
* @param[in] id ID of hashset (from hashset_new)
* @return 0 on success
*/
int32_t hashset_done(int32_t id);
/**
\group_adt
* Returns whether the hashset is empty.
* @param[in] id of hashset (from hashset_new)
* @return 0 on success
*/
int32_t hashset_empty(int32_t id);
/**
\group_adt
* Creates a new pipe with the specified buffer size
* @param[in] size size of buffer
* @return ID of newly created buffer_pipe
*/
int32_t buffer_pipe_new(uint32_t size);
/**
\group_adt
* Creates a new pipe with the specified buffer size w/ tied input
* to the current file, at the specified position.
* @param[in] pos starting position of pipe input in current file
* @return ID of newly created buffer_pipe
*/
int32_t buffer_pipe_new_fromfile(uint32_t pos);
/**
\group_adt
* Returns the amount of bytes available to read.
* @param[in] id ID of buffer_pipe
* @return amount of bytes available to read
*/
uint32_t buffer_pipe_read_avail(int32_t id);
/**
\group_adt
* Returns a pointer to the buffer for reading.
* The 'amount' parameter should be obtained by a call to
* buffer_pipe_read_avail().
* @param[in] id ID of buffer_pipe
* @param[in] amount to read
* @return pointer to buffer, or NULL if buffer has less than
* specified amount
*/
// uint8_t *buffer_pipe_read_get(int32_t id, uint32_t amount);
const uint8_t* buffer_pipe_read_get(int32_t id, uint32_t amount);
/**
\group_adt
* Updates read cursor in buffer_pipe.
* @param[in] id ID of buffer_pipe
* @param[in] amount amount of bytes to move read cursor
* @return 0 on success
*/
int32_t buffer_pipe_read_stopped(int32_t id, uint32_t amount);
/**
\group_adt
* Returns the amount of bytes available for writing.
* @param[in] id ID of buffer_pipe
* @return amount of bytes available for writing
*/
uint32_t buffer_pipe_write_avail(int32_t id);
/**
\group_adt
* Returns pointer to writable buffer.
* The 'size' parameter should be obtained by a call to
* buffer_pipe_write_avail().
* @param[in] id ID of buffer_pipe
* @param[in] size amount of bytes to write
* @return pointer to write buffer, or NULL if requested amount
* is more than what is available in the buffer
*/
uint8_t* buffer_pipe_write_get(int32_t id, uint32_t size);
/**
\group_adt
* Updates the write cursor in buffer_pipe.
* @param[in] id ID of buffer_pipe
* @param[in] amount amount of bytes to move write cursor
* @return 0 on success
*/
int32_t buffer_pipe_write_stopped(int32_t id, uint32_t amount);
/**
\group_adt
* Deallocate memory used by buffer.
* After this all attempts to use this buffer will result in error.
* All buffer_pipes are automatically deallocated when bytecode
* finishes execution.
* @param[in] id ID of buffer_pipe
* @return 0 on success
*/
int32_t buffer_pipe_done(int32_t id);
/**
\group_adt
* Initializes inflate data structures for decompressing data
* 'from_buffer' and writing uncompressed uncompressed data 'to_buffer'.
* @param[in] from_buffer ID of buffer_pipe to read compressed data from
* @param[in] to_buffer ID of buffer_pipe to write decompressed data to
* @param[in] windowBits (see zlib documentation)
* @return ID of newly created inflate data structure, <0 on failure
*/
int32_t inflate_init(int32_t from_buffer, int32_t to_buffer, int32_t windowBits);
/**
\group_adt
* Inflate all available data in the input buffer, and write to output buffer.
* Stops when the input buffer becomes empty, or write buffer becomes full.
* Also attempts to recover from corrupted inflate stream (via inflateSync).
* This function can be called repeatedly on success after filling the input
* buffer, and flushing the output buffer.
* The inflate stream is done processing when 0 bytes are available from output
* buffer, and input buffer is not empty.
* @param[in] id ID of inflate data structure
* @return 0 on success, zlib error code otherwise
*/
int32_t inflate_process(int32_t id);
/**
\group_adt
* Deallocates inflate data structure.
* Using the inflate data structure after this will result in an error.
* All inflate data structures are automatically deallocated when bytecode
* finishes execution.
* @param[in] id ID of inflate data structure
* @return 0 on success.
*/
int32_t inflate_done(int32_t id);
/**
\group_scan
* Report a runtime error at the specified locationID.
* @param[in] locationid (line << 8) | (column&0xff)
* @return 0
*/
int32_t bytecode_rt_error(int32_t locationid);
/**
\group_js
* Initializes JS normalizer for reading 'from_buffer'.
* Normalized JS will be written to a single tempfile,
* one normalized JS per line, and automatically scanned
* when the bytecode finishes execution.
* @param[in] from_buffer ID of buffer_pipe to read javascript from
* @return ID of JS normalizer, <0 on failure
*/
int32_t jsnorm_init(int32_t from_buffer);
/**
\group_js
* Normalize all javascript from the input buffer, and write to tempfile.
* You can call this function repeatedly on success, if you (re)fill the input
* buffer.
* @param[in] id ID of JS normalizer
* @return 0 on success, <0 on failure
*/
int32_t jsnorm_process(int32_t id);
/**
\group_js
* Flushes JS normalizer.
* @param[in] id ID of js normalizer to flush
* @return 0 on success, <0 on failure
*/
int32_t jsnorm_done(int32_t id);
/* ---------------- END 0.96 APIs (don't touch) --------------------------- */
/* ---------------- BEGIN 0.96.1 APIs ------------------------------------- */
/* ---------------- Math -------------------------------------------------- */
/**
\group_math
* Returns 2^26*log2(a/b)
* @param[in] a input
* @param[in] b input
* @return 2^26*log2(a/b)
*/
int32_t ilog2(uint32_t a, uint32_t b);
/**
\group_math
* Returns c*a^b.
* @param[in] a integer
* @param[in] b integer
* @param[in] c integer
* @return c*pow(a,b)
*/
int32_t ipow(int32_t a, int32_t b, int32_t c);
/**
\group_math
* Returns exp(a/b)*c
* @param[in] a integer
* @param[in] b integer
* @param[in] c integer
* @return c*exp(a/b)
*/
uint32_t iexp(int32_t a, int32_t b, int32_t c);
/**
\group_math
* Returns c*sin(a/b).
* @param[in] a integer
* @param[in] b integer
* @param[in] c integer
* @return c*sin(a/b)
*/
int32_t isin(int32_t a, int32_t b, int32_t c);
/**
\group_math
* Returns c*cos(a/b).
* @param[in] a integer
* @param[in] b integer
* @param[in] c integer
* @return c*sin(a/b)
*/
int32_t icos(int32_t a, int32_t b, int32_t c);
/* ---------------- String operations --------------------------------------- */
/**
\group_string
* Return position of match, -1 otherwise.
* @param[in] haystack buffer to search
* @param[in] haysize size of \p haystack
* @param[in] needle substring to search
* @param[in] needlesize size of needle
* @return location of match, -1 otherwise
*/
int32_t memstr(const uint8_t* haystack, int32_t haysize,
const uint8_t* needle, int32_t needlesize);
/**
\group_string
* Returns hexadecimal characters \p hex1 and \p hex2 converted to 8-bit
* number.
* @param[in] hex1 hexadecimal character
* @param[in] hex2 hexadecimal character
* @return hex1 hex2 converted to 8-bit integer, -1 on error
*/
int32_t hex2ui(uint32_t hex1, uint32_t hex2);
/**
\group_string
* Converts string to positive number.
* @param[in] str buffer
* @param[in] size size of \p str
* @return >0 string converted to number if possible, -1 on error
*/
int32_t atoi(const uint8_t* str, int32_t size);
/**
\group_debug
* Prints a debug message with a trailing newline,
* but preceded by 'LibClamAV debug'.
* @param[in] str the string
* @param[in] len length of \p str
* @return 0
*/
uint32_t debug_print_str_start(const uint8_t* str, uint32_t len);
/**
\group_debug
* Prints a debug message with a trailing newline,
* and not preceded by 'LibClamAV debug'.
* @param[in] str the string
* @param[in] len length of \p str
* @return 0
*/
uint32_t debug_print_str_nonl(const uint8_t* str, uint32_t len);
/**
\group_string
* Returns an approximation for the entropy of \p buffer.
* @param[in] buffer input buffer
* @param[in] size size of buffer
* @return entropy estimation * 2^26
*/
uint32_t entropy_buffer(uint8_t* buffer, int32_t size);
/* ------------------ Data Structures --------------------------------------- */
/**
\group_adt
* Creates a new map and returns its id.
* @param[in] keysize size of key
* @param[in] valuesize size of value, if 0 then value is allocated separately
* @return ID of new map
*/
int32_t map_new(int32_t keysize, int32_t valuesize);
/**
\group_adt
* Inserts the specified key/value pair into the map.
* @param[in] id id of table
* @param[in] key key
* @param[in] ksize size of \p key
* @return 0 - if key existed before
* @return 1 - if key didn't exist before
* @return <0 - if ksize doesn't match keysize specified at table creation
*/
int32_t map_addkey(const uint8_t* key, int32_t ksize, int32_t id);
/**
\group_adt
* Sets the value for the last inserted key with map_addkey.
* @param[in] id id of table
* @param[in] value value
* @param[in] vsize size of \p value
* @return 0 - if update was successful
* @return <0 - if there is no last key
*/
int32_t map_setvalue(const uint8_t* value, int32_t vsize, int32_t id);
/**
\group_adt
* Remove an element from the map.
* @param[in] id id of map
* @param[in] key key
* @param[in] ksize size of key
* @return 0 on success, key was present
* @return 1 if key was not present
* @return <0 if ksize doesn't match keysize specified at table creation
*/
int32_t map_remove(const uint8_t* key, int32_t ksize, int32_t id);
/**
\group_adt
* Looks up key in map.
* The map remember the last looked up key (so you can retrieve the
* value).
* @param[in] id id of map
* @param[in] key key
* @param[in] ksize size of key
* @return 0 - if not found
* @return 1 - if found
* @return <0 - if ksize doesn't match the size specified at table creation
*/
int32_t map_find(const uint8_t* key, int32_t ksize, int32_t id);
/**
\group_adt
* Returns the size of value obtained during last map_find.
* @param[in] id id of map.
* @return size of value
*/
int32_t map_getvaluesize(int32_t id);
/**
\group_adt
* Returns the value obtained during last map_find.
* @param[in] id id of map.
* @param[in] size size of value (obtained from map_getvaluesize)
* @return value
*/
uint8_t* map_getvalue(int32_t id, int32_t size);
/**
\group_adt
* Deallocates the memory used by the specified map.
* Trying to use the map after this will result in an error.
* All maps are automatically deallocated when the bytecode finishes
* execution.
* @param[in] id id of map
* @return 0 - success
* @return -1 - invalid map
*/
int32_t map_done(int32_t id);
/* -------------- File Operations ------------------------------------------- */
/**
\group_file
* Looks for the specified sequence of bytes in the current file, up to the
* specified position.
* @param[in] data the sequence of bytes to look for
* @param[in] len length of \p data, cannot be more than 1024
* @param[in] maxpos maximum position to look for a match,
* note that this is 1 byte after the end of last possible match:
* match_pos + \p len < \p maxpos
* @return offset in the current file if match is found, -1 otherwise
*/
int32_t file_find_limit(const uint8_t* data, uint32_t len, int32_t maxpos);
/* ------------- Engine Query ----------------------------------------------- */
/**
\group_engine
* Returns the current engine (feature) functionality level.
* To map these to ClamAV releases, compare it with #FunctionalityLevels.
* @return an integer representing current engine functionality level.
*/
uint32_t engine_functionality_level(void);
/**
\group_engine