Giter Club home page Giter Club logo

neo's Introduction

CheckPhish Neo API -Artificial Intellgience Based RealTime Phishing Detection

Live Demo

For live demo you can checkout https://checkphish.ai

API KEY

Request api key from https://bolster.ai/contact-us

Setup

Make sure you have python requests installed
 sudo pip install requests
Now clone or download the respository
 git clone https://github.com/bolster-inc/neo.git
if downloading then do
wget https://github.com/bolster-inc/neo/archive/master.zip
unzip master.zip

Usage

 python src/client.py -h
      usage: client.py [-h] -f FILE

 usage: client.py [-h] -k KEY -f FILE

 required arguments:
      -k KEY, --key KEY     provide your api key
      -f FILE, --file FILE  file containing urls
      -d DELIMITER, --delimiter DELIMITER  specify your delimter
      -c COLUMN, --column COLUMN  provide your column number with urls

 optional arguments:
      -h, --help            show this help message and exit

Run client

now provide your API KEY and file with urls to scan to the client. Each url needs to be in a new line.
  cd neo/src/
  python client.py  -k <YOUR_API_KEY>  -f "urls_to_scan.txt"
It accepts two optional paramaters. Multiple fields delimited by a character and we can choose the column with urls.
 cd neo/src/
 python client.py  -k <YOUR_API_KEY>  -f "urls_to_scan.txt" -d "specify_your_delimiter" -c <column_number_with_urls>

Results

results will be saved in 4 different files in the same directory

 phish.txt - all the urls that have been identified as phish
 clean.txt - all the urls that have been identified as clean
 suspicious.txt - all the urls that have been identify as suspicious
 pending.txt - all the urls that still being processed. Please query these urls again.

A results summary will also be printed. Sample summary would look something like

================ SAVING RESULTS ===========================

phish urls saved to file:       /home/john/projects/neo_client/pending.txt
phish urls saved to file:       /home/john/projects/neo_client/phish.txt
clean urls saved to file:       /home/john/projects/neo_client/clean.txt
suspicious urls saved to file:  /home/john/projects/neo_client/suspicious.txt

================ SCAN SUMMARY ===========================

Total Urls submitted:     175
Processing completed:     175
Processing pending:       0
Total phishing urls:      132
Total suspicious urls:    9
Total clean urls:         34

Support

For any issues please follow instructions on this link

neo's People

Contributors

blue-cp avatar karthikgundlapalli avatar motleycrew avatar neoande avatar shashiprakash1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

neo's Issues

drug_spam disposition

Hi.
Question:
I noticed that RedMarlin api starts to return disposition field with drug_spam value. But I cant find how this should be handled, in neo library. Is there other dispositions which I should be aware of?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.