Compare commits

...
Author SHA1 Message Date
Dan Petro 7c5681a2ad Removed warning about TF2.0 in the readme 2019-12-02 12:27:33 -07:00
Dan Petro d831cb5bd6 A few more Readme updates 2019-11-19 16:53:50 -07:00
Dan Petro 3d6ee7ba2a Updated readme and npm dependency file 2019-11-19 16:30:02 -07:00
Dan Petro ee2d55fb02 Initial commit of webui
- Sorta works
 - Frontend needs work, but functionality is there
2019-11-14 15:33:17 -07:00
Dan Petro b9c8839390 Changed eyeballer model files to hold the whole model, not just weights
- It's cleaner to do this, fewer errors
 - Plus it works with tensorflow.js better
2019-11-14 10:22:31 -07:00
15 changed files with 306 additions and 29 deletions

No files matched your search

+7 -3
View File
@@ -104,9 +104,10 @@ venv.bak/
.mypy_cache/
#screenshot data
*.png
*.jpg
*.tar
images*
#Graphs and Results
graphs/*
#model files
*.h5
@@ -119,3 +120,6 @@ results.html
!tests/models/*
!tests/data/*
!docs/*
#Leave the webui things alone for their own gitignore
!webui/*
+31 -6
View File
@@ -14,9 +14,34 @@ Eyeballer is meant for large-scope network penetration tests where you need to f
| ------ |:-----:|
| ![Sample Homepage](/docs/homepage.png) | ![Sample Custom 404](/docs/404.png) |
## Setup
## Web UI Setup
Eyeballer uses TF.keras on Tensorflow 2.0. This is (as of this moment) still in "beta". So the pip requirement for it looks a bit weird. It'll also probably conflict with an existing TensorFlow installation if you've got the regular 1.0 version installed. So, heads-up there. But 2.0 should be out of beta and official "soon" according to Google, so this problem ought to solve itself in short order.
Eyeballer's Web UI uses TensorflowJS and React. It runs entirely in your browser locally, with no backend functionality whatsoever. So you can "upload" files to classify and get results without the files ever leaving your computer. To run the Eyeballer Web UI locally, you'll need Node. On Debian, you can install that with the npm package:
```
sudo apt install npm
```
Then you'll need to install some Node dependencies:
```
cd webui/
npm install
```
Copy a pre-trained model file (in TensorflowJS format) into a jsmodel/ folder under public/, so that it's available in the web server.
```
cp YOUR_MODEL/ webui/public/
```
Then you can run the Web UI with:
```
npm start
```
## Python Setup
Download required packages on pip:
```
@@ -46,13 +71,13 @@ Copy all three into the root of the Eyeballer code tree.
To eyeball some screenshots, just run the "predict" mode:
```
eyeballer.py --weights YOUR_WEIGHTS.h5 predict YOUR_FILE.png
eyeballer.py --model YOUR_MODEL.h5 predict YOUR_FILE.png
```
Or for a whole directory of files:
```
eyeballer.py --weights YOUR_WEIGHTS.h5 predict PATH_TO/YOUR_FILES/
eyeballer.py --model YOUR_MODEL.h5 predict PATH_TO/YOUR_FILES/
```
Eyeballer will spit the results back to you in human readable format (a `results.html` file so you can browse it easily) and machine readable format (a `results.csv` file).
@@ -66,14 +91,14 @@ eyeballer.py train
You'll want a machine with a good GPU for this to run in a reasonable amount of time. Setting that up is outside the scope of this readme, however.
This will output a new model file (weights.h5 by default).
This will output a new model file (model.h5 by default).
## Evaluation
You just trained a new model, cool! Let's see how well it performs against some images it's never seen before, across a variety of metrics:
```
eyeballer.py --weights YOUR_WEIGHTS.h5 evaluate
eyeballer.py --model YOUR_MODEL.h5 evaluate
```
The output will describe the model's accuracy in both recall and precision for each of the program's labels. (Including "none of the above" as a pseudo-label)
+3 -3
View File
@@ -9,12 +9,12 @@ from jinja2 import Template
@click.group(invoke_without_command=True)
@click.option('--weights', default=None, type=click.Path(), help="Weights file for input/output")
@click.option('--model', default=None, type=click.Path(), help="Model file for input/output")
@click.option('--summary/--no-summary', default=False, help="Print model summary at start")
@click.option('--seed', default=None, type=int, help="RNG seed for data shuffling and transformations, defaults to random value")
@click.pass_context
def cli(ctx, weights, summary, seed):
model_kwargs = {"weights_file": weights,
def cli(ctx, model, summary, seed):
model_kwargs = {"model_file": model,
"print_summary": summary,
"seed": seed}
+10 -10
View File
@@ -26,17 +26,17 @@ class EyeballModel:
Contains high-level functions for training, evaluating, and predicting.
"""
graphs_directory = "graphs/"
checkpoint_file = "weights.h5"
checkpoint_file = "model.h5"
image_dir = "images/"
image_width, image_height = 224, 224
input_shape = (image_width, image_height, 3)
def __init__(self, weights_file, print_summary=False, seed=None, quiet=False):
def __init__(self, model_file, print_summary=False, seed=None, quiet=False):
"""Constructor for model class.
Keyword arguments:
print_summary -- Whether or not to print to stdout the keras model summary, containing a detailed description of every model layer
weights_file -- A filename for where to load the model's weights.
model_file -- A filename for where to load the model's model.
seed -- PRNG seed, useful for repeating a previous run and using the same data. Training/Validation split is determined randomly.
"""
# # Build the model
@@ -78,15 +78,15 @@ class EyeballModel:
random.seed(self.seed)
self.training_labels = self.training_labels.sample(frac=1)
if weights_file is not None and os.path.isfile(weights_file):
if model_file is not None and os.path.isfile(model_file):
try:
self.model.load_weights(weights_file)
self.model = tf.keras.models.load_model(model_file)
except OSError:
print("ERROR: Unable to open weights file '{}'".foramt(weights_file))
print("ERROR: Unable to open model file '{}'".format(model_file))
sys.exit(-1)
print("Loaded model from file.")
else:
if weights_file is not None:
if model_file is not None:
raise FileNotFoundError
print("WARN: No model loaded from file. Generating random model")
@@ -105,7 +105,7 @@ class EyeballModel:
self.preprocess_training_function = augmentor.keras_preprocess_func()
def train(self, epochs=20, batch_size=32, print_graphs=False):
"""Train the model, making a new weights file at each successfull checkpoint. You'll probably need a GPU for this to realistically run.
"""Train the model, making a new model file at each successfull checkpoint. You'll probably need a GPU for this to realistically run.
Keyword arguments:
epochs -- The number of epochs to train for. (An epoch is one pass-through of the dataset)
@@ -142,12 +142,12 @@ class EyeballModel:
seed=self.seed,
class_mode="other")
# Model checkpoint - Saves model weights when validation accuracy improves
# Model checkpoint - Saves model when validation accuracy improves
callbacks = [tf.keras.callbacks.ModelCheckpoint(self.checkpoint_file,
monitor='val_loss',
verbose=1,
save_best_only=True,
save_weights_only=True,
save_weights_only=False,
mode='min')]
history = self.model.fit_generator(
+7 -7
View File
@@ -15,16 +15,16 @@ class PredictTest(unittest.TestCase):
def flush(self): pass
sys.stdout = DummyFile()
weights_file = "tests/models/test_weights.h5"
if not os.path.isfile(weights_file):
print("Error: Symlink the latest weights file to " + weights_file)
model_file = "tests/models/model_file.h5"
if not os.path.isfile(model_file):
print("Error: Symlink the latest model file to " + model_file)
raise FileNotFoundError(
errno.ENOENT,
os.strerror(errno.ENOENT),
weights_file)
model_file)
model_kwargs = {
"weights_file": weights_file,
"model_file": model_file,
"print_summary": False,
"seed": None,
"quiet": True
@@ -33,7 +33,7 @@ class PredictTest(unittest.TestCase):
def test_different_seed_predict(self):
model_kwargs = {
"weights_file": None,
"model_file": None,
"print_summary": False,
"seed": 12345678,
"quiet": True
@@ -49,7 +49,7 @@ class PredictTest(unittest.TestCase):
def test_same_seed_predict(self):
model_kwargs = {
"weights_file": None,
"model_file": None,
"print_summary": False,
"seed": 12345678,
"quiet": True
+20
View File
@@ -0,0 +1,20 @@
# See https://help.github.com/ignore-files/ for more about ignoring files.
# dependencies
/node_modules
# testing
/coverage
# production
/build
# misc
.DS_Store
.env
npm-debug.log*
yarn-debug.log*
yarn-error.log*
#Model files
public/jsmodel/*
+20
View File
@@ -0,0 +1,20 @@
{
"name": "eyeballer-webui",
"version": "0.1.0",
"private": true,
"dependencies": {
"react": "^16.11.0",
"react-dom": "^16.11.0",
"react-dropzone": "^10.1.10",
"react-scripts": "0.9.5",
"bootstrap": "^4.3.1",
"@tensorflow/tfjs": "^1.3.2"
},
"devDependencies": {},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test --env=jsdom",
"eject": "react-scripts eject"
}
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

+31
View File
@@ -0,0 +1,31 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.png">
<!--
Notice the use of %PUBLIC_URL% in the tag above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start`.
To create a production bundle, use `npm run build`.
-->
</body>
</html>
+23
View File
@@ -0,0 +1,23 @@
.App {
text-align: center;
}
.App-logo {
height: 100px;
}
.App-header {
background-color: #222;
height: 170px;
padding: 10px;
color: white;
}
.App-intro {
font-size: large;
}
.thumbnail {
height: 280px;
width: 480px;
}
+132
View File
@@ -0,0 +1,132 @@
import React, { Component } from 'react';
import logo from './eyeballer_logo.png';
import './App.css';
import 'bootstrap/dist/css/bootstrap.min.css';
import * as tf from '@tensorflow/tfjs';
class App extends Component {
constructor(props) {
super(props);
this.state = {
fileContents: "Try uploading a file",
}
}
render() {
return (
<div className="App">
<div className="App-header">
<img src={logo} className="App-logo" alt="logo" />
<h2>Eyeballer</h2>
</div>
<PredictButton />
<ImageFile />
</div>
);
}
}
export default App;
class ImageFile extends React.Component {
constructor(props){
super(props);
this.state = {
id : "someUniqueId", // I would use this.props.id for a real world implementation
imageURI : null
}
}
buildImgTag(){
let imgTag = null;
if (this.state.imageURI !== null)
imgTag = (<div className="row">
<div className="small-9 small-centered columns">
<img className="thumbnail" id="thumbnail" alt="Screenshot to be classified" src={this.state.imageURI}></img>
</div>
</div>);
return imgTag;
}
readURI(e){
if(e.target.files && e.target.files[0]){
let reader = new FileReader();
reader.onload = function(ev){
this.setState({imageURI:ev.target.result});
}.bind(this);
reader.readAsDataURL(e.target.files[0]);
}
}
handleChange(e){
this.readURI(e); // maybe call this with webworker or async library?
if (this.props.onChange !== undefined)
this.props.onChange(e); // propagate to parent component
}
render() {
const imgTag = this.buildImgTag();
return <div>
<label
htmlFor={this.state.id}
className="button">
Upload an image
</label>
<input
id={this.state.id}
type="file"
onChange={this.handleChange.bind(this)}
className="show-for-sr" />
{imgTag}
</div>;
}
}
class PredictButton extends Component {
constructor(props) {
super(props);
this.state = {
classification: ""
}
}
onpress = async () => {
const modelUrl = 'jsmodel/model.json';
const model = await tf.loadLayersModel(modelUrl);
const offset = tf.scalar(127.5);
const image = tf.browser.fromPixels(document.getElementById('thumbnail'))
.resizeNearestNeighbor([224,224])
.toFloat()
.sub(offset)
.div(offset)
.expandDims();
const predictions = Array.from(model.predict(image).dataSync());
this.setState({classification: ""});
if (predictions[0] > 0.5) {
this.setState({classification: this.state.classification + "Custom 404, "});
}
if (predictions[1] > 0.5) {
this.setState({classification: this.state.classification + "Login Page, "});
}
if (predictions[2] > 0.5) {
this.setState({classification: this.state.classification + "Homepage, "});
}
if (predictions[3] > 0.5) {
this.setState({classification: this.state.classification + "Old Looking "});
}
}
render() {
return (
<div className="custom-file">
<button className="default" type="button" id="predictButton" onClick={this.onpress}>Classify</button>
{this.state.classification}
</div>
);
}
}
+8
View File
@@ -0,0 +1,8 @@
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
it('renders without crashing', () => {
const div = document.createElement('div');
ReactDOM.render(<App />, div);
});
Binary file not shown.

After

Width:  |  Height:  |  Size: 962 KiB

+5
View File
@@ -0,0 +1,5 @@
body {
margin: 0;
padding: 0;
font-family: sans-serif;
}
+9
View File
@@ -0,0 +1,9 @@
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
import './index.css';
ReactDOM.render(
<App />,
document.getElementById('root')
);