forked from extremeshok/clamav-unofficial-sigs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
clamav-unofficial-sigs.sh
executable file
·3170 lines (2905 loc) · 137 KB
/
clamav-unofficial-sigs.sh
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
#!/bin/bash
# shellcheck disable=SC2154
# shellcheck disable=SC2128
################################################################################
# This is property of eXtremeSHOK.com
# You are free to use, modify and distribute, however you may not remove this notice.
# Copyright (c) Adrian Jon Kriel :: admin@extremeshok.com
# License: BSD (Berkeley Software Distribution)
################################################################################
#
# Script updates can be found at: https://github.com/extremeshok/clamav-unofficial-sigs
#
# Originially based on Script provided by Bill Landry (unofficialsigs@gmail.com).
#
################################################################################
#
# THERE ARE NO USER CONFIGURABLE OPTIONS IN THIS SCRIPT
# ALL CONFIGURATION OPTIONS ARE LOCATED IN THE INCLUDED CONFIGURATION FILE
#
################################################################################
###### ####### # # ####### ####### ####### ###### ### #######
# # # # ## # # # # # # # # #
# # # # # # # # # # # # # # #
# # # # # # # # # # ##### # # # #
# # # # # # # # # # # # # # #
# # # # # ## # # # # # # # #
###### ####### # # ####### # ####### ###### ### #
################################################################################
# Detect to make sure the entire script is avilable, fail if the script is missing contents
if [ "$(tail -n 1 "$0" | head -n 1 | cut -c 1-7)" != "exit \$?" ] ; then
echo "FATAL ERROR: Script is incomplete, please redownload"
exit 1
fi
# Trap the keyboard interrupt (Ctrl + C)
trap xshok_control_c SIGINT
################################################################################
# HELPER FUNCTIONS
################################################################################
# Support user config settings for applying file and directory access permissions.
function perms () {
if [ -n "$clam_user" ] && [ -n "$clam_group" ] ; then
"${@:-}"
fi
}
# Prompt a user if they should complete an action with Y or N
# Usage: xshok_prompt_confirm
# if xshok_prompt_confirm; then
# xshok_prompt_confirm && echo "accepted"
# xshok_prompt_confirm && echo "yes" || echo "no"
# shellcheck disable=SC2120
function xshok_prompt_confirm () { # optional_message
message="${1:-Are you sure?}"
while true; do
read -r -p "$message [y/N]" response < /dev/tty
case "$response" in
[yY]) return 0 ;;
[nN]) return 1 ;;
*) printf " \033[31m %s \n\033[0m" "invalid input"
esac
done
}
# Create a pid file
function xshok_create_pid_file () { # pid.file
if [ "$1" ] ; then
pidfile="$1"
echo $$ > "$pidfile"
if [ $? -ne 0 ] ; then
xshok_pretty_echo_and_log "ERROR: Could not create PID file: $pidfile"
exit 1
fi
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
}
# Intercept ctrl+c and calls the cleanup function
function xshok_control_c () {
echo
xshok_pretty_echo_and_log "--------------| Exiting ... Please wait |--------------" "-"
xshok_cleanup
exit $?
}
# Cleanup function
function xshok_cleanup () {
# Wait for all processes to end
wait
xshok_pretty_echo_and_log " Powered By https://eXtremeSHOK.com " "#"
return $?
}
# Check if the current running user is the root user, otherwise return false
function xshok_is_root () {
if [ "$(uname -s)" == "SunOS" ] ; then
id_bin="/usr/xpg4/bin/id"
else
id_bin="$(which id 2> /dev/null)"
fi
if [ "$($id_bin -u)" == 0 ] ; then
return 0
else
return 1 # Not root
fi
}
# Check if its a file, otherwise return false
function xshok_is_file () { # filepath
filepath="$1"
if [ -f "${filepath}" ] ; then
return 0 ;
else
return 1 ; # Not a file
fi
}
# Check if filepath is a subdir, otherwise return false
# Usage: xshok_is_subdir "filepath"
# xshok_is_subdir "/root/" - false
# xshok_is_subdir "/usr/local/etc" && echo "yes" - yes
function xshok_is_subdir () { # filepath
shopt -s extglob; filepath="${filepath%%+(/)}"
if [ -d "$filepath" ] ; then
res="${filepath//[^\/]}"
if [ "${#res}" -gt 1 ] ; then
return 0 ;
else
return 1 ; # Not a subdir
fi
else
return 1 ; # Not a dir
fi
}
# Create a dir and set the ownership
function xshok_mkdir_ownership () { # path
if [ "$1" ] ; then
mkdir -p "$1" 2>/dev/null
if [ $? -ne 0 ] ; then
xshok_pretty_echo_and_log "ERROR: Could not create directory: $1"
exit 1
fi
perms chown -f "$clam_user:$clam_group" "$1" > /dev/null 2>&1
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
}
# Check if a user and group exists on the system otherwise return false
# Usage:
# xshok_is_subdir "username" && echo "user found" || echo "no"
# xshok_is_subdir "username" "groupname" && echo "user and group found" || echo "no"
function xshok_user_group_exists () { # username groupname
if [ "$(uname -s)" == "SunOS" ] ; then
id_bin="/usr/xpg4/bin/id"
else
id_bin="$(which id 2> /dev/null)"
fi
if [ "$2" ] ; then
if [ "$(uname -s)" == "Darwin" ] ; then
#use ruby, as this is the best way. Ruby is always avilable as brew uses ruby
ruby -e 'require "etc"; puts Etc::getgrnam("_clamav").gid' > /dev/null 2>&1
ret="$?"
else
getent_bin="$(which getent 2> /dev/null)"
$getent_bin group "$2" >/dev/null 2>&1
ret="$?"
fi
fi
if [ "$1" ] ; then
$id_bin -u "$1" > /dev/null 2>&1
if [ $? -eq 0 ]; then
if [ "$2" ] ; then
if [ "$ret" -eq 0 ]; then
return 0 ; # User and group exists
else
return 1 ; # Group does NOT exist
fi
else
return 0 ; # User exists
fi
else
return 1 ; # User does NOT exist
fi
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
}
# Handle comments with/out borders and logging.
# Usage:
# pretty_echo_and_log "one"
# one
# pretty_echo_and_log "two" "-"
# ---
# two
# ---
# pretty_echo_and_log "three" "=" "8"
# ========
# three
# ========
# pretty_echo_and_log "" "/\" "7"
# /\/\/\/\/\/\
# type: e = error, w= warning ""
function xshok_pretty_echo_and_log () { # "string" "repeating" "count" "type"
# Handle comments
if [ "$comment_silence" == "no" ] ; then
if [ "${#@}" -eq 1 ] ; then
echo "$1"
else
myvar=""
if [ -n "$3" ] ; then
mycount="$3"
else
mycount="${#1}"
fi
for (( n = 0; n < mycount; n++ )) ; do
myvar="$myvar$2"
done
if [ -n "$1" ] ; then
echo -e "$myvar\n$1\n$myvar"
else
echo -e "$myvar"
fi
fi
fi
# Handle logging
if [ "$enable_log" == "yes" ] ; then
if [ ! -e "$log_file_path/$log_file_name" ] ; then
# xshok_mkdir_ownership "$log_file_path"
mkdir -p "$log_file_path"
touch "$log_file_path/$log_file_name" 2>/dev/null
perms chown -f "$clam_user:$clam_group" "$log_file_path/$log_file_name"
fi
if [ ! -w "$log_file_path/$log_file_name" ] ; then
echo "Warning: Logging Disabled, as file not writable: $log_file_path/$log_file_name"
enable_log="no"
else
echo "$(date "+%b %d %T")" "$1" >> "$log_file_path/$log_file_name"
fi
fi
}
# Check if the $2 value is not null and does not start with -
function xshok_check_s2 () { # value1 value2
if [ "$1" ] ; then
if [[ "$1" =~ ^-.* ]] ; then
xshok_pretty_echo_and_log "ERROR: Missing value for option or value begins with -" "="
exit 1
fi
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
}
# Time remaining information function
function xshok_draw_time_remaining () { #time_remaining #update_hours #name
if [ "$1" ] && [ "$2" ]; then
time_remaining="$1"
hours_left="$((time_remaining / 3600))"
minutes_left="$((time_remaining % 3600 / 60))"
xshok_pretty_echo_and_log "$2 hours have not yet elapsed since the last $3 update check"
xshok_pretty_echo_and_log "No update check was performed at this time" "-"
xshok_pretty_echo_and_log "Next check will be performed in approximately $hours_left hour(s), $minutes_left minute(s)"
fi
}
# Download function
function xshok_file_download () { #outputfile #url
if [ "$1" ] && [ "$2" ]; then
if [ -n "$wget_bin" ] ; then
# shellcheck disable=SC2086
$wget_bin $wget_proxy_https $wget_proxy_http $wget_insecure $wget_output_level --connect-timeout="$downloader_connect_timeout" --random-wait --tries="$downloader_tries" --timeout="$downloader_max_time" --output-document="$1" "$2"
result=$?
else
# shellcheck disable=SC2086
$curl_bin $curl_proxy $curl_insecure $curl_output_level --connect-timeout "$downloader_connect_timeout" --remote-time --location --retry "$downloader_tries" --max-time "$downloader_max_time" --output "$1" "$2"
result=$?
fi
return $result
fi
}
# Auto update
function xshok_auto_update () { # version
xshok_pretty_echo_and_log "Performing automatic update..."
# Download new version
echo -n "Downloading latest version..."
xshok_file_download "$0.tmp" "$UPDATE_BASE/$SELF"
result=$?
if [ "$result" -ne 0 ]; then
echo "Failed: Error while trying to get new version!"
echo "File requested: $UPDATE_BASE/$SELF"
exit 1
fi
echo "Done."
# Copy over modes from old version
OCTAL_MODE="$(stat -c "%a" "$SELF")"
if ! chmod "$OCTAL_MODE" "${0}.tmp" ; then
echo "Failed: Error while trying to set mode on ${0}.tmp."
exit 1
fi
# Generate the update script
cat > xshok_update_script.sh << EOF
#!/bin/bash
# Overwrite old file with new
if mv "$0.tmp" "$0"; then
echo "Done. Update complete."
rm \$0
else
echo "Failed! The update was not completed."
fi
EOF
echo -n "Inserting update process..."
# Replaced with $0, so code will update and then call itself with the same parameters it had
#exec /bin/bash xshok_update_script.sh
exec "$0" "$@"
}
# Handle list of database files
function clamav_files () {
echo "$clam_dbs/$db" >> "$current_tmp"
if [ "$keep_db_backup" == "yes" ] ; then
echo "$clam_dbs/$db-bak" >> "$current_tmp"
fi
}
# Manage the databases and allow multi-dimensions as well as global overrides
# Since the datbases are basically a multi-dimentional associative arrays in bash
# ratings: LOW| MEDIUM| HIGH| REQUIRED| LOWONLY| MEDIUMONLY| LOWMEDIUMONLY | MEDIUMHIGHONLY | HIGHONLY| DISABLED
function xshok_database () { # rating database_array
# Assign
current_rating="$1"
declare -a current_dbs=( "${@:2}" )
# Zero
declare -a new_dbs=( )
if [ -n "${current_dbs[0]}" ] ; then
if [ ${#current_dbs} -ge 1 ] ; then
for db_name in "${current_dbs[@]}" ; do
# Checks
if [ "$enable_yararules" == "no" ] ; then # YARA rules are disabled
if [[ "$db_name" == *".yar"* ]] ; then # If it's the value you want to delete
continue # Skip to the next value
fi
fi
if [ -z "$current_rating" ] ; then # YARA rules are disabled
new_dbs+=( "$db_name" )
else
if [[ ! "$db_name" = *"|"* ]] ; then # This old format
new_dbs+=( "$db_name" )
else
db_name_rating="${db_name#*|}"
db_name="${db_name%|*}"
if [ "$db_name_rating" != "DISABLED" ] ; then
if [ "$db_name_rating" == "$current_rating" ] ; then
new_dbs+=( "$db_name" )
elif [ "$db_name_rating" == "REQUIRED" ] ; then
new_dbs+=( "$db_name" )
elif [ "$current_rating" == "LOW" ] ; then
if [ "$db_name_rating" == "LOWONLY" ] || [ "$db_name_rating" == "LOW" ] || [ "$db_name_rating" == "LOWMEDIUM" ] ; then
new_dbs+=( "$db_name" )
fi
elif [ "$current_rating" == "MEDIUM" ] ; then
if [ "$db_name_rating" == "MEDIUMONLY" ] || [ "$db_name_rating" == "MEDIUM" ] || [ "$db_name_rating" == "LOW" ] || [ "$db_name_rating" == "LOWMEDIUM" ] ; then
new_dbs+=( "$db_name" )
fi
elif [ "$current_rating" == "HIGH" ] ; then
if [ "$db_name_rating" == "HIGH" ] || [ "$db_name_rating" == "MEDIUM" ] || [ "$db_name_rating" == "LOW" ] ; then
new_dbs+=( "$db_name" )
fi
fi
fi
fi
fi
done
fi
fi
echo "${new_dbs[@]}" | xargs # Remove extra whitespace
}
################################################################################
# ADDITIONAL PROGRAM FUNCTIONS
################################################################################
# Generates a man config and installs it
function install_man () {
if [ -n "$pkg_mgr" ] || [ -n "$pkg_rm" ] ; then
echo "This script (clamav-unofficial-sigs) was installed on the system via '$pkg_mgr'"
exit 1
fi
echo ""
echo "Generating man file for install...."
# Use defined varibles or attempt to use default varibles
if [ ! -e "$man_dir/$man_filename" ] ; then
mkdir -p "$man_dir"
touch "$man_dir/$man_filename" 2>/dev/null
fi
if [ ! -w "$man_dir/$man_filename" ] ; then
echo "ERROR: man install aborted, as file not writable: $man_dir/$man_filename"
else
BOLD="\fB"
#REV=""
NORM="\fR"
manresult="$(help_and_usage "man")"
# Our template..
cat << EOF > "$man_dir/$man_filename"
.\" Manual page for eXtremeSHOK.com ClamAV Unofficial Signature Updater
.TH clamav-unofficial-sigs 8 "$script_version_date" "Version: $script_version" "SCRIPT COMMANDS"
.SH NAME
clamav-unofficial-sigs \- Download, test, and install third-party ClamAV signature databases.
.SH SYNOPSIS
.B clamav-unofficial-sigs
.RI [ options ]
.SH DESCRIPTION
\fBclamav-unofficial-sigs\fP provides a simple way to download, test, and update third-party signature databases provided by Sanesecurity, FOXHOLE, OITC, Scamnailer, BOFHLAND, CRDF, Porcupine, Securiteinfo, MalwarePatrol, Yara-Rules Project, etc. It will also generate and install cron, logrotate, and man files.
.SH UPDATES
Script updates can be found at: \fBhttps://github.com/extremeshok/clamav-unofficial-sigs\fP
.SH OPTIONS
This script follows the standard GNU command line syntax.
.LP
$manresult
.SH SEE ALSO
.BR clamd (8),
.BR clamscan (1)
.SH COPYRIGHT
Copyright (c) Adrian Jon Kriel :: admin@extremeshok.com
.TP
You are free to use, modify and distribute, however you may not remove this notice.
.SH LICENSE
BSD (Berkeley Software Distribution)
.SH BUGS
Report bugs to \fBhttps://github.com/extremeshok/clamav-unofficial-sigs\fP
.SH AUTHOR
Adrian Jon Kriel :: admin@extremeshok.com
Originially based on Script provide by Bill Landry
EOF
fi
echo "Completed: man installed, as file: $man_dir/$man_filename"
}
# Generate a logrotate config and install it
function install_logrotate () {
if [ -n "$pkg_mgr" ] || [ -n "$pkg_rm" ] ; then
echo "This script (clamav-unofficial-sigs) was installed on the system via '$pkg_mgr'"
exit 1
fi
echo ""
echo "Generating logrotate file for install...."
# Use defined varibles or attempt to use default varibles
if [ -z "$logrotate_user" ] ; then
logrotate_user="$clam_user";
fi
if [ -z "$logrotate_group" ] ; then
logrotate_group="$clam_group";
fi
if [ -z "$logrotate_log_file_full_path" ] ; then
logrotate_log_file_full_path="$log_file_path/$log_file_name"
fi
if [ ! -e "$logrotate_dir/$logrotate_filename" ] ; then
mkdir -p "$logrotate_dir"
touch "$logrotate_dir/$logrotate_filename" 2>/dev/null
fi
if [ ! -w "$logrotate_dir/$logrotate_filename" ] ; then
echo "ERROR: logrotate install aborted, as file not writable: $logrotate_dir/$logrotate_filename"
else
# Our template..
cat << EOF > "$logrotate_dir/$logrotate_filename"
# https://eXtremeSHOK.com ######################################################
# This file contains the logrotate settings for clamav-unofficial-sigs.sh
###################
# This is property of eXtremeSHOK.com
# You are free to use, modify and distribute, however you may not remove this notice.
# Copyright (c) Adrian Jon Kriel :: admin@extremeshok.com
##################
#
# Script updates can be found at: https://github.com/extremeshok/clamav-unofficial-sigs
#
# Originially based on:
# Script provide by Bill Landry (unofficialsigs@gmail.com).
#
# License: BSD (Berkeley Software Distribution)
#
##################
# Automatically Generated: $(date)
##################
#
# This logrotate file will rotate the logs generated by the clamav-unofficial-sigs.sh
#
# To Adjust the logrotate values, edit your configs and run
# bash clamav-unofficial-sigs.sh --install-logrotate to generate a new file.
$logrotate_log_file_full_path {
weekly
rotate 4
missingok
notifempty
compress
create 0640 $logrotate_user $logrotate_group
}
EOF
fi
echo "Completed: logrotate installed, as file: $logrotate_dir/$logrotate_filename"
}
# Generate a cron config and install it
function install_cron () {
if [ -n "$pkg_mgr" ] || [ -n "$pkg_rm" ] ; then
echo "This script (clamav-unofficial-sigs) was installed on the system via '$pkg_mgr'"
exit 1
fi
echo ""
echo "Generating cron file for install...."
# Use defined varibles or attempt to use default varibles
if [ -z "$cron_minute" ] ; then
cron_minute="$(( ( RANDOM % 59 ) + 1 ))"
fi
if [ -z "$cron_user" ] ; then
cron_user="$clam_user";
fi
if [ -z "$cron_bash" ] ; then
cron_bash="$(which bash 2> /dev/null)"
fi
if [ -z "$cron_script_full_path" ] ; then
cron_script_full_path="$this_script_full_path"
fi
if [ ! -e "$cron_dir/$cron_filename" ] ; then
mkdir -p "$cron_dir"
touch "$cron_dir/$cron_filename" 2>/dev/null
fi
if [ ! -w "$cron_dir/$cron_filename" ] ; then
echo "ERROR: cron install aborted, as file not writable: $cron_dir/$cron_filename"
else
# Our template..
cat << EOF > "$cron_dir/$cron_filename"
# https://eXtremeSHOK.com ######################################################
# This file contains the cron settings for clamav-unofficial-sigs.sh
###################
# This is property of eXtremeSHOK.com
# You are free to use, modify and distribute, however you may not remove this notice.
# Copyright (c) Adrian Jon Kriel :: admin@extremeshok.com
##################
#
# Script updates can be found at: https://github.com/extremeshok/clamav-unofficial-sigs
#
# Originially based on:
# Script provide by Bill Landry (unofficialsigs@gmail.com).
#
# License: BSD (Berkeley Software Distribution)
#
##################
# Automatically Generated: $(date)
##################
#
# This cron file will execute the clamav-unofficial-sigs.sh script that
# currently supports updating third-party signature databases provided
# by Sanesecurity, SecuriteInfo, MalwarePatrol, OITC, etc.
#
# The script is set to run hourly, at a random minute past the hour, and the
# script itself is set to randomize the actual execution time between
# 60 - 600 seconds. To Adjust the cron values, edit your configs and run
# bash clamav-unofficial-sigs.sh --install-cron to generate a new file.
$cron_minute * * * * $cron_user [ -x $cron_script_full_path ] && $cron_bash $cron_script_full_path > /dev/null
# https://eXtremeSHOK.com ######################################################
EOF
fi
echo "Completed: cron installed, as file: $cron_dir/$cron_filename"
}
# Decode a third-party signature either by signature name
function decode_third_party_signature_by_signature_name () {
echo ""
echo "Input a third-party signature name to decode (e.g: Sanesecurity.Junk.15248) or"
echo "a hexadecimal encoded data string and press enter (do not include '.UNOFFICIAL'"
echo "in the signature name nor add quote marks to any input string):"
read -r input
input="$(echo "$input" | tr -d "'" | tr -d '"')"
if echo "$input" | $grep_bin "\." > /dev/null ; then
cd "$clam_dbs" || exit
sig="$($grep_bin "$input:" ./*.ndb)"
if [ -n "$sig" ] ; then
db_file="${sig%:*}"
echo "$input found in: $db_file"
echo "$input signature decodes to:"
echo "$sig" | cut -d ":" -f 5 | perl -pe 's/([a-fA-F0-9]{2})|(\{[^}]*\}|\([^)]*\))/defined $2 ? $2 : chr(hex $1)/eg'
else
echo "Signature '$input' could not be found."
echo "This script will only decode ClamAV 'UNOFFICIAL' third-Party,"
echo "non-image based, signatures as found in the *.ndb databases."
fi
else
echo "Here is the decoded hexadecimal input string:"
echo "$input" | perl -pe 's/([a-fA-F0-9]{2})|(\{[^}]*\}|\([^)]*\))/defined $2 ? $2 : chr(hex $1)/eg'
fi
}
# Hexadecimal encode an entire input string
function hexadecimal_encode_entire_input_string () {
echo ""
echo "Input the data string that you want to hexadecimal encode and then press enter. Do not include"
echo "any quotes around the string unless you want them included in the hexadecimal encoded output:"
read -r input
echo "Here is the hexadecimal encoded input string:"
echo "$input" | perl -pe 's/(.)/sprintf("%02lx", ord $1)/eg'
}
# Hexadecimal encode a formatted input string
function hexadecimal_encode_formatted_input_string () {
echo ""
echo "Input a formated data string containing spacing fields '{}, (), *' that you want to hexadecimal"
echo "encode, without encoding the spacing fields, and then press enter. Do not include any quotes"
echo "around the string unless you want them included in the hexadecimal encoded output:"
read -r input
echo "Here is the hexadecimal encoded input string:"
echo "$input" | perl -pe 's/(\{[^}]*\}|\([^)]*\)|\*)|(.)/defined $1 ? $1 : sprintf("%02lx", ord $2)/eg'
}
# GPG verify a specific Sanesecurity database file
function gpg_verify_specific_sanesecurity_database_file () { # databasefile
echo ""
if [ "$enable_gpg" == "no" ] ; then
xshok_pretty_echo_and_log "Notice: GnuPG / signature verification disabled" "-"
else
if [ "$1" ] ; then
db_file="$(echo "$1" | awk -F "/" '{print $NF}')"
if [ -r "$work_dir_sanesecurity/$db_file" ] ; then
echo "GPG signature testing database file: $work_dir_sanesecurity/$db_file"
if [ -r "$work_dir_sanesecurity/$db_file".sig ] ; then
"$gpg_bin" -q --trust-model always --no-default-keyring --homedir "$work_dir_gpg" --keyring "$work_dir_gpg"/ss-keyring.gpg --verify "$work_dir_sanesecurity"/"$db_file".sig "$work_dir_sanesecurity"/"$db_file"
if [ $? -ne 0 ]; then
"$gpg_bin" -q --always-trust --no-default-keyring --homedir "$work_dir_gpg" --keyring "$work_dir_gpg"/ss-keyring.gpg --verify "$work_dir_sanesecurity"/"$db_file".sig "$work_dir_sanesecurity"/"$db_file"
if [ $? -eq 0 ]; then
exit 0
else
exit 1
fi
else
exit 0
fi
else
echo "Signature '${db_file}.sig' cannot be found."
fi
else
echo "File '$db_file' cannot be found or is not a Sanesecurity database file."
echo "Only the following Sanesecurity and OITC databases can be GPG signature tested:"
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_sanesecurity"
fi
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
exit 1
fi
}
# Output system and configuration information
function output_system_configuration_information () {
echo ""
echo "*** SCRIPT VERSION ***"
echo "$this_script_name $script_version ($script_version_date)"
echo "*** SYSTEM INFORMATION ***"
$uname_bin -a
echo "*** CLAMSCAN LOCATION & VERSION ***"
echo "$clamscan_bin"
$clamscan_bin --version | head -1
echo "*** RSYNC LOCATION & VERSION ***"
echo "$rsync_bin"
$rsync_bin --version | head -1
if [ -n "$wget_bin" ] ; then
echo "*** WGET LOCATION & VERSION ***"
echo "$wget_bin"
$wget_bin --version | head -1
else
echo "*** CURL LOCATION & VERSION ***"
echo "$curl_bin"
$curl_bin --version | head -1
fi
if [ "$enable_gpg" == "yes" ] ; then
echo "*** GPG LOCATION & VERSION ***"
echo "$gpg_bin"
$gpg_bin --version | head -1
fi
echo "*** SCRIPT WORKING DIRECTORY INFORMATION ***"
echo "$work_dir"
echo "*** CLAMAV DIRECTORY INFORMATION ***"
echo "$clam_dbs"
echo "*** SCRIPT CONFIGURATION SETTINGS ***"
if [ "$custom_config" != "no" ] ; then
if [ -d "$custom_config" ] ; then
# Assign the custom config dir and remove trailing / (removes / and //)
echo "Custom Configuration Directory: $config_dir"
else
echo "Custom Configuration File: $custom_config"
fi
else
echo "Configuration Directory: $config_dir"
fi
}
# Make a signature database from an ascii file
function make_signature_database_from_ascii_file () {
echo ""
echo "
The '-m' script flag provides a way to create a ClamAV hexadecimal signature database (*.ndb) file
from a list of data strings stored in a clear-text ascii file, with one data string entry per line.
- Hexadecimal encoding can be either 'full' or 'formatted' on a per line basis:
Full line encoding should be used if there are no formatted spacing entries [{}, (), *]
included on the line. Prefix unformatted lines with: '-:' (no quote marks).
Example:
-:This signature contains no formatted spacing fields
Encodes to:
54686973207369676e617475726520636f6e7461696e73206e6f20666f726d61747465642073706163696e67206669656c6473
Formatted line encoding should be used if there are user added spacing entries [{}, (), *]
included on the line. Prefix formatted lines with '=:' (no quote marks).
Example:
=:This signature{-10}contains several(25|26|27)formatted spacing*fields
Encodes to:
54686973207369676e6174757265{-10}636f6e7461696e73207365766572616c(25|26|27)666f726d61747465642073706163696e67*6669656c6473
Use 'full' encoding if you want to encode everything on the line [including {}, (), *] and 'formatted'
encoding if you want to encode everything on the line except the formatted character spacing fields.
The prefixes ('-:' and '=:') will be stripped from the line before hexadecimal encoding is done.
If no prefix is found at the beginning of the line, full line encoding will be done (default).
- It is assumed that the signatures will be created for email scanning purposes, thus the '4'
target type is used and full file scanning is enabled (see ClamAV signatures.pdf for details).
- Line numbering will be done automatically by the script.
" | command sed 's/^ //g'
echo -n "Do you wish to continue? "
if xshok_prompt_confirm ; then
echo -n "Enter the source file as /path/filename: "
read -r source
if [ -r "$source" ] ; then
source_file="$(basename "$source")"
echo "What signature prefix would you like to use? For example: 'Phish.Domains'"
echo "will create signatures that looks like: 'Phish.Domains.1:4:*:HexSigHere'"
echo -n "Enter signature prefix: "
read -r prefix
path_file="$(echo "$source" | cut -d "." -f -1 | command sed 's/$/.ndb/')"
db_file="$(basename "$path_file")"
rm -f "$path_file"
total="$(wc -l "$source" | cut -d " " -f 1)"
line_num="1"
while read -r line ; do
line_prefix="$(echo "$line" | awk -F ":" '{print $1}')"
if [ "$line_prefix" == "-" ] ; then
echo "$line" | cut -d ":" -f 2- | perl -pe 's/(.)/sprintf("%02lx", ord $1)/eg' | command sed "s/^/$prefix\.$line_num:4:\*:/" >> "$path_file"
elif [ "$line_prefix" == "=" ] ; then
echo "$line" | cut -d ":" -f 2- | perl -pe 's/(\{[^}]*\}|\([^)]*\)|\*)|(.)/defined $1 ? $1 : sprintf("%02lx", ord $2)/eg' | command sed "s/^/$prefix\.$line_num:4:\*:/" >> "$path_file"
else
echo "$line" | perl -pe 's/(.)/sprintf("%02lx", ord $1)/eg' | command sed "s/^/$prefix\.$line_num:4:\*:/" >> "$path_file"
fi
echo "Hexadecimal encoding $source_file line: $line_num of $total"
line_num="$((line_num + 1))"
done < "$source"
else
echo "Source file not found, exiting..."
exit
fi
echo "Signature database file created at: $path_file"
if $clamscan_bin --quiet -d "$path_file" "$work_dir_work_configs/scan-test.txt" 2>/dev/null ; then
echo "Clamscan reports database integrity tested good."
echo -n "Would you like to move '$db_file' into '$clam_dbs' and reload databases?"
if xshok_prompt_confirm ; then
if ! cmp -s "$path_file" "$clam_dbs/$db_file" ; then
if $rsync_bin -pcqt "$path_file" "$clam_dbs" ; then
perms chown -f "$clam_user:$clam_group" "$clam_dbs/$db_file"
perms chmod -f 0644 "$clam_dbs"/"$db_file"
if [ "$selinux_fixes" == "yes" ] ; then
restorecon "$clam_dbs/$db_file"
fi
$clamd_restart_opt
echo "Signature database '$db_file' was successfully implemented and ClamD databases reloaded."
else
echo "Failed to add/update '$db_file', ClamD database not reloaded."
fi
else
echo "Database '$db_file' has not changed - skipping"
fi
else
echo "No action taken."
fi
else
echo "Clamscan reports that '$db_file' signature database integrity tested bad."
fi
fi
}
# Remove the clamav-unofficial-sigs script
function remove_script () {
echo ""
if [ -n "$pkg_mgr" ] || [ -n "$pkg_rm" ] ; then
echo "This script (clamav-unofficial-sigs) was installed on the system via '$pkg_mgr'"
echo "use '$pkg_rm' to remove the script and all of its associated files and databases from the system."
else
cron_file_full_path="$cron_dir/$cron_filename"
logrotate_file_full_path="$logrotate_dir/$logrotate_filename"
man_file_full_path="$man_dir/$man_filename"
echo "This will remove the workdir ($work_dir), logrotate file ($logrotate_file_full_path), cron file ($cron_file_full_path), man file ($man_file_full_path)"
echo "Are you sure you want to remove the clamav-unofficial-sigs script and all of its associated files, third-party databases, and work directory from the system?"
if xshok_prompt_confirm ; then
echo "This can not be undone are you sure ?"
if xshok_prompt_confirm ; then
if [ -r "$work_dir_work_configs/purge.txt" ] ; then
while read -r file ; do
xshok_is_file "$file" && rm -f -- "$file"
echo " Removed file: $file"
done < "$work_dir_work_configs"/purge.txt
if [ -r "$cron_file_full_path" ] ; then
xshok_is_file "$cron_file_full_path" && rm -f "$cron_file_full_path"
echo " Removed file: $cron_file_full_path"
fi
if [ -r "$logrotate_file_full_path" ] ; then
xshok_is_file "$logrotate_file_full_path" && rm -f "$logrotate_file_full_path"
echo " Removed file: $logrotate_file_full_path"
fi
if [ -r "$man_file_full_path" ] ; then
xshok_is_file "$man_file_full_path" && rm -f "$man_file_full_path"
echo " Removed file: $man_file_full_path"
fi
# Rather keep the configs
#rm -f -- "$default_config" && echo " Removed file: $default_config"
#rm -f -- "$0" && echo " Removed file: $0"
xshok_is_subdir "$work_dir" && rm -rf -- "${work_dir:?}" && echo " Removed script working directories: $work_dir"
echo " The clamav-unofficial-sigs script and all of its associated files, third-party"
echo " databases, and work directories have been successfully removed from the system."
else
echo " Cannot locate 'purge.txt' file in $work_dir_work_configs."
echo " Files and signature database will need to be removed manually."
fi
else
echo "Aborted"
fi
else
echo "Aborted"
fi
fi
}
# Clamscan integrity test a specific database file
function clamscan_integrity_test_specific_database_file () { # databasefile
echo ""
if [ "$1" ] ; then
input="$(echo "$1" | awk -F "/" '{print $NF}')"
db_file="$(find "$work_dir" -name "$input")"
if [ -r "$db_file" ] ; then
echo "Clamscan integrity testing: $db_file"
$clamscan_bin --quiet -d "$db_file" "$work_dir_work_configs/scan-test.txt"
if [ $? -eq 0 ]; then
echo "Clamscan reports that '$input' database integrity tested GOOD"
exit 0
else
echo "Clamscan reports that '$input' database integrity tested BAD"
exit 1
fi
else
echo "File '$input' cannot be found."
echo "Here is a list of third-party databases that can be clamscan integrity tested:"
echo "=== Sanesecurity ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_sanesecurity"
echo "=== SecuriteInfo ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_securiteinfo"
echo "=== MalwarePatrol ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_malwarepatrol"
echo "=== Linux Malware Detect ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_linuxmalwaredetect"
echo "=== Linux Malware Detect ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_yararulesproject"
echo "=== User Defined Databases ==="
ls --ignore "*.sig" --ignore "*.md5" --ignore "*.ign2" "$work_dir_add"
echo "Check the file name and try again..."
fi
else
xshok_pretty_echo_and_log "ERROR: Missing value for option" "="
exit 1
fi
}
# Output names of any third-party signatures that triggered during the HAM directory scan
function output_signatures_triggered_during_ham_directory_scan () {
echo ""
if [ -n "$ham_dir" ] ; then
if [ -r "$work_dir_work_configs/whitelist.hex" ] ; then
echo "The following third-party signatures triggered hits during the HAM Directory scan:"
$grep_bin -h -f "$work_dir_work_configs/whitelist.hex" "$work_dir"/*/*.ndb | cut -d ":" -f 1
else
echo "No third-party signatures have triggered hits during the HAM Directory scan."
fi
else
echo "Ham directory scanning is not currently enabled in the script's configuration file."
fi
}
# Adds a signature whitelist entry in the newer ClamAV IGN2 format
function add_signature_whitelist_entry () {
echo ""
echo "Input a third-party signature name that you wish to whitelist due to false-positives"
echo "and press enter (do not include '.UNOFFICIAL' in the signature name nor add quote"
echo "marks to the input string):"
read -r input
if [ -n "$input" ] ; then
cd "$clam_dbs" || exit
input="$(echo "$input" | tr -d "'" | tr -d '"')"
sig_full="$($grep_bin -H "$input" ./*.*db)"
sig_name="$(echo "$sig_full" | cut -d ":" -f 2)"
if [ -n "$sig_name" ] ; then