github-cve-sna's Introduction

Description

This repo aims to crawl data from github network of CVE-related directories Then, to construct the relationship graph into neo4j schema.

Installization

Install requirements, run cmd:
```
 pip install -r python_requirement.txt
```
Initialize neo4j
- Download neo4j source to a folder
```
  <NEO4J-HOME> 
```
- Set default admin⁽¹⁾, run cmd:
```
  <NEO4J-HOME>/bin/neo4j-admin set-default-admin neo4j
```
- Run neo4j console, run cmd:
```
  <NEO4J-HOME>/bin/neo4j console
```
- Open web browser⁽²⁾ and go to localhost:7474 to visit Neo4j Browser tool.
  
  Login to neo4j (default username: neo4j, default password: neo4j)
- Create new user, run cypher:
```
  CREATE USER dat1 SET PASSWORD '1'
```
- Assign roles for user, run cypher⁽¹⁾:
```
  GRANT ROLE admin to dat1
```
- Create new database⁽¹⁾:
```
  CREATE DATABASE git2neo
```
  Or import current databases.

Generate new Github Personal access tokens with scopes:

 user
 repo
 public_repo    
 repo_deployment
 repo:status
 read:repo_hook
 read:org
 read:public_key
 read:gpg_key

Replace the token in private_config.py

Running

Run github Query
- Run cmd:
```
  python git2neo.py
```

Run Analysis functions

Sample cypher queries⁽³⁾:

  MATCH (:Person)-[]->(r:Repo) 
  CALL { 
    WITH r MATCH (r)<-[]-(p) RETURN p LIMIT 5 
  } 
  CALL { 
    WITH p MATCH (r2)<-[]-(p) RETURN r2 LIMIT 5 
  } 
  RETURN r2, p

Visualize sample histograms, run cmd:
```
  python visualization/histograms.py
```

Notes

(1) Only Enterprise edition has these functionalities, Community edition has to use default single database.
(2) Sometime, neo4j browser show nothing. This seems to be a bug. Move between web browsers like Chorme, EE, FireFox,... might help.
(3) More sample queries a described in cypher_sample_queries.docx