Aegis 6406 asm2vec pytorch magics

CODEOWNERS

@@ -0,0 +1,32 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @wandera/datascience
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+# *.js    @js-owner
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+#*.go [email protected]
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+# docs/*  [email protected]
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+# apps/ @octocat
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository.
+# /docs/ @doctocat

Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.10.11-slim
+
+ADD . /asm2vec-pytorch
+WORKDIR asm2vec-pytorch
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    unixodbc-dev \
+    unixodbc \
+    libpq-dev && \
+    pip install -r requirements.txt && \
+    python setup.py install
+
+CMD ["/bin/sh"]

README.md

@@ -1,6 +1,6 @@
 # asm2vec-pytorch
 
-<a><img alt="release 1.0.0" src="https://img.shields.io/badge/release-v1.0.0-yellow?style=for-the-badge"></a>
+<a><img alt="release 1.0.3" src="https://img.shields.io/badge/release-v1.0.0-yellow?style=for-the-badge"></a>
 <a><img alt="mit" src="https://img.shields.io/badge/license-MIT-brightgreen?style=for-the-badge"></a>
 <a><img alt="python" src="https://img.shields.io/badge/-python-9cf?style=for-the-badge&logo=python"></a>
 
@@ -9,30 +9,17 @@ The details of the model can be found in the original paper: [(sp'19) Asm2Vec: B
 
 ## Requirements
 
-python >= 3.6
-
-| packages | for |
-| --- | --- |
-| r2pipe | `scripts/bin2asm.py` |
-| click | `scripts/*` |
-| torch | almost all code need it |
-
-You also need to install `radare2` to run `scripts/bin2asm.py`. `r2pipe` is just the python interface to `radare2`
-
-If you only want to use the library code, you just need to install `torch`
+* python >= 3.10
+* radare2
+* Packages listed in `requirements.txt`
 
 ## Install
 
 ```
+pip install -r requirements.txt && 
 python setup.py install
 ```
 
-or
-
-```
-pip install git+https://github.com/oalieno/asm2vec-pytorch.git
-```
-
 ## Benchmark
 
 An implementation already exists here: [Lancern/asm2vec](https://github.com/Lancern/asm2vec)  
@@ -46,141 +33,20 @@ Following is the benchmark of training 1000 functions in 1 epoch.
 
 ## Get Started
 
-```bash
-python scripts/bin2asm.py -i /bin/ -o asm/
-```
-
-First generate asm files from binarys under `/bin/`.  
-You can hit `Ctrl+C` anytime when there is enough data.
-
-```bash
-python scripts/train.py -i asm/ -l 100 -o model.pt --epochs 100
-```
-
-Try to train the model using only 100 functions and 100 epochs for a taste.  
-Then you can use more data if you want.
-
-```bash
-python scripts/test.py -i asm/123456 -m model.pt
-```
-
-After you train your model, try to grab an assembly function and see the result.  
-This script will show you how the model perform.  
-Once you satisfied, you can take out the embedding vector of the function and do whatever you want with it.
+### TODO - update this with description about to how use etc
 
-## Usage
+## Tests
 
-### bin2asm.py
+### Run test suite
 
-```
-Usage: bin2asm.py [OPTIONS]
+* Run all tests: ``python -m unittest discover -v``
+* Run a certain module's tests: ``python -m unittest -v test.test_binary_to_asm``
+* Run a certain test class: ``python -m unittest -v test.test_binary_to_asm.TestBinaryToAsm``
+* Run a certain test method: 
 
-  Extract assembly functions from binary executable
+  ``python -m unittest -v test.test_binary_to_asm.TestBinaryToAsm.test_sha3``
 
-Options:
-  -i, --input TEXT   input directory / file  [required]
-  -o, --output TEXT  output directory
-  -l, --len INTEGER  ignore assembly code with instructions amount smaller
-                     than minlen
+### Coverage
 
-  --help             Show this message and exit.
-```
-
-```bash
-# Example
-python bin2asm.py -i /bin/ -o asm/
-```
-
-### train.py
-
-```
-Usage: train.py [OPTIONS]
-
-Options:
-  -i, --input TEXT                training data folder  [required]
-  -o, --output TEXT               output model path  [default: model.pt]
-  -m, --model TEXT                load previous trained model path
-  -l, --limit INTEGER             limit the number of functions to be loaded
-  -d, --ebedding-dimension INTEGER
-                                  embedding dimension  [default: 100]
-  -b, --batch-size INTEGER        batch size  [default: 1024]
-  -e, --epochs INTEGER            training epochs  [default: 10]
-  -n, --neg-sample-num INTEGER    negative sampling amount  [default: 25]
-  -a, --calculate-accuracy        whether calculate accuracy ( will be
-                                  significantly slower )
-
-  -c, --device TEXT               hardware device to be used: cpu / cuda /
-                                  auto  [default: auto]
-
-  -lr, --learning-rate FLOAT      learning rate  [default: 0.02]
-  --help                          Show this message and exit.
-```
-
-```bash
-# Example
-python train.py -i asm/ -o model.pt --epochs 100
-```
-
-### test.py
-
-```
-Usage: test.py [OPTIONS]
-
-Options:
-  -i, --input TEXT              target function  [required]
-  -m, --model TEXT              model path  [required]
-  -e, --epochs INTEGER          training epochs  [default: 10]
-  -n, --neg-sample-num INTEGER  negative sampling amount  [default: 25]
-  -l, --limit INTEGER           limit the amount of output probability result
-  -c, --device TEXT             hardware device to be used: cpu / cuda / auto
-                                [default: auto]
-
-  -lr, --learning-rate FLOAT    learning rate  [default: 0.02]
-  -p, --pretty                  pretty print table  [default: False]
-  --help                        Show this message and exit.
-```
-
-```bash
-# Example
-python test.py -i asm/123456 -m model.pt
-```
-
-```
-┌──────────────────────────────────────────┐
-│    endbr64                               │
-│  ➔ push r15                              │
-│    push r14                              │
-├────────┬─────────────────────────────────┤
-│ 34.68% │ [rdx + rsi*CONST + CONST]       │
-│ 20.29% │ push                            │
-│ 16.22% │ r15                             │
-│ 04.36% │ r14                             │
-│ 03.55% │ r11d                            │
-└────────┴─────────────────────────────────┘
-```
-
-### compare.py
-
-```
-Usage: compare.py [OPTIONS]
-
-Options:
-  -i1, --input1 TEXT          target function 1  [required]
-  -i2, --input2 TEXT          target function 2  [required]
-  -m, --model TEXT            model path  [required]
-  -e, --epochs INTEGER        training epochs  [default: 10]
-  -c, --device TEXT           hardware device to be used: cpu / cuda / auto
-                              [default: auto]
-
-  -lr, --learning-rate FLOAT  learning rate  [default: 0.02]
-  --help                      Show this message and exit.
-```
-
-```bash
-# Example
-python compare.py -i1 asm/123456 -i2 asm/654321 -m model.pt -e 30
-```
-
-```
-cosine similarity : 0.873684
-```
+* Create report: ``coverage run -m unittest discover -v``
+* Read report: ``coverage report -m``

SECURITY.md

@@ -0,0 +1,26 @@
+Thanks for helping make GitHub safe for everyone.
+
+# Security
+
+Jamf takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as asm2vec-pytorch.
+
+We will ensure that your finding gets passed along to the appropriate maintainers for remediation.
+
+# Reporting Security Issues
+
+If you believe you have found a security vulnerability in any Jamf-owned repository, please report it to us through coordinated disclosure.
+
+Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.
+
+Instead, please send an email to info[@]jamf.com.
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
+- Full paths of source file(s) related to the manifestation of the issue 
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue 
+- Step-by-step instructions to reproduce the issue 
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.

asm2vec/__init__.py

@@ -1,6 +1,9 @@
-import importlib
+import os
 
-__all__ = ['model', 'datatype', 'utils']
+__home__ = os.path.dirname(os.path.abspath(__path__[0]))
+__data__ = os.path.join(__home__, "data")
 
-for module in __all__:
-    importlib.import_module(f'.{module}', 'asm2vec')
+__all__ = [
+    "__data__", "__home__", "binary_to_asm", "data", "datatype", "model", "similarity", "tensors", "test", "train",
+    "utilities", "version"
+]