https://github.com/cardi/auntietuna-server
AuntieTuna Server: Sharing Personalized Content Lists
https://github.com/cardi/auntietuna-server
Last synced: 3 months ago
JSON representation
AuntieTuna Server: Sharing Personalized Content Lists
- Host: GitHub
- URL: https://github.com/cardi/auntietuna-server
- Owner: cardi
- Created: 2017-10-25T20:51:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-06T19:31:21.000Z (over 7 years ago)
- Last Synced: 2025-02-05T19:12:43.714Z (4 months ago)
- Language: JavaScript
- Homepage: https://ant.isi.edu/software/antiphish
- Size: 377 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# auntietuna-server
Server-side code for AuntieTuna's known-good sharing site.
[AuntieTuna](https://github.com/cardi/auntietuna): lightweight,
personalized content-based phishing detection for the Chrome browser.
## pre-requisites
To use the auntietuna-server on your computer, you would need to:
1. Install node.js: https://nodejs.org/en/
2. Install MariaDB (open-source fork of MySQL)
3. Install `npm`
4. Run `npm install` to get dependencies
### macOS and MacPorts
If you're using MacPorts, the following instructions should work:
```
sudo port install nodejs8 npm5 mariadb-server
cd auntietuna-server
npm install
```
#### MariaDB/MySQL Installation
Getting MariaDB to work with MacPorts is a bit of a struggle.
Install the `errmsg.sys` file:
```
sudo mkdir -p /opt/local/lib/mariadb/share/mariadb/
sudo cp /opt/local/share/mariadb/english/errmsg.sys /opt/local/lib/mariadb/share/mariadb/.
```
Modify mysql to run on 127.0.0.1:3306 in `/opt/local/etc/mariadb/my.cnf`:
```
# Use default MacPorts settings
#!include /opt/local/etc/mariadb/macports-default.cnf
[mysqld]
port = 3306
bind = 127.0.0.1
```
Post-install steps and running the daemon:
```
sudo -u _mysql /opt/local/lib/mariadb/bin/mysql_install_db
sudo -u _mysql /opt/local/lib/mariadb/bin/mysqld_safe --datadir='/opt/local/var/db/mariadb'
/opt/local/lib/mariadb/bin/mysql_secure_installation
```
To run the daemon thereafter:
```
sudo -u _mysql /opt/local/lib/mariadb/bin/mysqld_safe --datadir='/opt/local/var/db/mariadb'
```
### installing mysql databases and tables
#### create new user
Installing mysql will automatically give you a root user and password.
You want to reset the root password by running the commands on mysql:
```
ALTER USER 'root'@'localhost' IDENTIFIED BY 'MyNewPass';
SET PASSWORD FOR 'root'@'localhost' = PASSWORD('MyNewPass');
```
From here, you can create a new user and grant them permissions:
```
CREATE USER 'newuser'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON * . * TO 'newuser'@'localhost';
```
#### create database
```
/opt/local/lib/mariadb/bin/mysql -u root -p
> create database test;
```
Need to create table, assign users, etc. Table should be in the form:
```
+--------------+----------------+------+-----+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+--------------+----------------+------+-----+---------+-------+
| user | varchar(50) | YES | | NULL | |
| last_updated | varchar(40) | YES | | NULL | |
| domain | varchar(50) | YES | | NULL | |
| hashes | varchar(65000) | YES | | NULL | |
+--------------+----------------+------+-----+---------+-------+
```
To create the database, you can use the commands:
```
CREATE TABLE auntietuna (user VARCHAR(50), last_updated VARCHAR(40), domain VARCHAR(50), hashes VARCHAR(65000));
```
Inserting things into the table have the general format of:
```
INSERT INTO auntietuna ( user, last_updated, domain, hashes ) VALUES ( val1, val2, val3, val4 );
```
## running the server
On the browser (preferably Chrome), connect to localhost. You can do
this by typing `http://localhost:3000/` in the top search bar of the
browser. In my code, I have the server connect to localhost:3000.
Currently, the browser doesn't display anything until you run the
server. To run the server, open the directory where your server code
lies and run the following command on your command-prompt:
```
node server.js
```
Your browser should update with your html code.
### development environment
Running MariaDB client:
```
/opt/local/lib/mariadb/bin/mysql -u root -p
```
Watching MariaDB error logs:
```
sudo tail -f /opt/local/var/db/mariadb/*.err
```
Not sure why `Ctrl+C` can't kill the daemon, but for now, `sudo pkill mysqld`
seems to gracefully shut it down.
## interacting with the website
Now that you have the server running and it displays the user website
and its data, you can either download data existing on the site or
import your own hashes onto the database.
Let's first disregard the Google Sign-In button at the moment since
Username features are not yet implemented.
To download data from the site, you first select the data you want by
checking the box the right of the data you want. At the bottom of the
table, you would then select the `Download Selected` button. If you had
wanted to download all of the data on the table, you could just select
the `Download All` button at the bottom of the table. Your downloaded
data will be in the format of a JSON file.
Once you have downloaded the data you want, you would import it to your
own auntietuna database by clicking the `Choose File` button at the top
of your table and select the JSON file containing the data you want to
import.
To import your own data onto the user site, you first need to have data
you wish to import. This data will need to be in the format of a JSON
file and can be attained by downloading data from your personal
auntietuna database or the `debug` feature on your auntietuna plug-in
(appears on the popup menu). You would then click on `Choose File` on
the user site and select the JSON file with data you wish to import.
# tasks to the minimum viable product (mvp)
_Note_: for now, ignore the "User" column, but that will require adding
an additional column in the database table, user authentication, etc.
1. [ ] user can upload known-good
- have a downloaded hash that you would want to add to the website
- import the json file by clicking "Choose File" like in AuntieTuna plug-in
2. [ ] website displays known-good
3. [ ] user can download known-good