Skip to content

Commit 7bd9579

Browse files
Update README.md
Signed-off-by: Shahm Najeeb <Nirt_12023@outlook.com>
1 parent c19792a commit 7bd9579

File tree

1 file changed

+1
-93
lines changed

1 file changed

+1
-93
lines changed

README.md

Lines changed: 1 addition & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -112,99 +112,7 @@ Remove add and delete files, it's the safe directory where your backups, hashes,
112112

113113
Logicytics uses a config.ini file to store configurations. The config.ini is located in the CODE directory.
114114

115-
The config.ini file is a INI file that contains the following information:
116-
117-
```ini
118-
[Settings]
119-
# Would you like to enable debug mode?
120-
# This will print out more information to the console, with prefix DEBUG
121-
# This will not be logged however
122-
log_using_debug = false
123-
# Would you like for new logs to be created every execution?
124-
# Or would you like to append to the same log file?
125-
delete_old_logs = false
126-
127-
[System Settings]
128-
# Do not play with these settings unless you know what you are doing
129-
version = 3.0.0
130-
files = "browser_miner.ps1, cmd_commands.py, dir_list.py, event_log.py, Logicytics.py, log_miner.py, media_backup.py, netadapter.ps1, packet_sniffer.py, property_scraper.ps1, registry.py, sensitive_data_miner.py, ssh_miner.py, sys_internal.py, tasklist.py, tree.ps1, vulnscan.py, wifi_stealer.py, window_feature_miner.ps1, wmic.py, _debug.py, _dev.py, _extra.py, logicytics\Checks.py, logicytics\Execute.py, logicytics\FileManagement.py, logicytics\Flag.py, logicytics\Get.py, logicytics\Logger.py, logicytics\__init__.py, VulnScan\tools\_test_gpu_acceleration.py, VulnScan\tools\_vectorizer.py, VulnScan\v2-deprecated\_generate_data.py, VulnScan\v2-deprecated\_train.py, VulnScan\v3\_generate_data.py, VulnScan\v3\_train.py"
131-
132-
###################################################
133-
# The following settings are for specific modules #
134-
###################################################
135-
136-
[PacketSniffer Settings]
137-
# The interface to sniff packets on, keep it as WiFi for most cases
138-
# Autocorrects between WiFi and Wi-Fi
139-
interface = WiFi
140-
# The number of packets to sniff,
141-
packet_count = 10000
142-
# The time to timeout the sniffing process
143-
timeout = 10
144-
145-
###################################################
146-
147-
[VulnScan.train Settings]
148-
# The following settings are for the Train module for training models
149-
# NeuralNetwork seems to be the best choice for this task
150-
# Options: "NeuralNetwork", "LogReg",
151-
# "RandomForest", "ExtraTrees", "GBM",
152-
# "XGBoost", "DecisionTree", "NaiveBayes"
153-
model_name = NeuralNetwork
154-
# General Training Parameters
155-
epochs = 10
156-
batch_size = 32
157-
learning_rate = 0.001
158-
use_cuda = true
159-
160-
# Paths to train and save data
161-
train_data_path = C:\Users\Hp\Desktop\Model Tests\Model Data\GeneratedData
162-
# If all models are to be trained, this is the path to save all models,
163-
# and will be appended with the model codename and follow naming convention
164-
save_model_path = C:\Users\Hp\Desktop\Model Tests\Model SenseMini
165-
166-
[VulnScan.generate Settings]
167-
# The following settings are for the Generate module for fake training data
168-
extensions = .txt, .log, .md, .csv, .json, .xml, .html, .yaml, .ini, .pdf, .docx, .xlsx, .pptx
169-
save_path = C:\Users\Hp\Desktop\Model Tests\Generated Data
170-
# Options include:
171-
# 'Sense' - Generates 50k files, each 25KB in size.
172-
# 'SenseNano' - Generates 5 files, each 5KB in size.
173-
# 'SenseMacro' - Generates 1m files, each 10KB in size.
174-
# 'SenseMini' - Generates 10k files, each 10KB in size.
175-
# 'SenseCustom' - Uses custom size settings from the configuration file.
176-
code_name = SenseMini
177-
# This allows more randomness in the file sizes, use 0 to disable
178-
# this is applied randomly every time a file is generated
179-
# Variation is applied in the following way:
180-
# size +- (size */ variation) where its random weather to add or subtract and divide or multiply
181-
size_variation = 0.1
182-
# Set to SenseCustom to use below size settings
183-
min_file_size = 5KB
184-
max_file_size = 50KB
185-
# Chances for the following data types in files:
186-
# 0.0 - 1.0, the rest will be for pure data
187-
full_sensitive_chance = 0.07
188-
partial_sensitive_chance = 0.2
189-
190-
[VulnScan.vectorizer Settings]
191-
# The following settings are for the Vectorizer module for vectorizing data
192-
# Usually it automatically vectorizes data, but this is for manual vectorization
193-
194-
# We advise to use this vectorization, although not knowing the vectorizer is not advised
195-
# as this may lead to ValueErrors due to different inputs
196-
# Use the vectorizer supplied for any v3 model on SenseMini
197-
198-
# The path to the data to vectorize, either a file or a directory
199-
data_path = C:\Users\Hp\Desktop\Model Tests\Model Data\GeneratedData
200-
# The path to save the vectorized data - It will automatically be appended '\Vectorizer.pkl'
201-
# Make sure the path is a directory, and it exists
202-
output_path = C:\Users\Hp\Desktop\Model Tests\Model Sense - Vectorizer
203-
204-
# Vectorizer to use, options include:
205-
# tfidf or count - The code for the training only supports tfidf - we advise to use tfidf
206-
vectorizer_type = tfidf
207-
```
115+
The config.ini file is a INI file that contains important information, you can find it [here](CODE/config.ini)
208116

209117
The config.ini file is used to store the DEBUG flag bool, the VERSION, and the CURRENT_FILES.
210118
It is also used to store and save settings for other programs.

0 commit comments

Comments
 (0)