Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeide committed Mar 6, 2014
1 parent 4320278 commit bb68cce
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ poortego

Latest iteration of poortego is a completely new code-base (the old ruby/metasploit code is under the poortego-ruby branch in case this ever wants to be revived).

This new iteration stems from the fun that I've had playing with neo4j and the natural way of traversing data (files) in the unix file-system as a way of traversing indicators. I'm using this for cyber threat indicators- but this framework could easily be used for managing other data points that are basic node/link data-types.
This new iteration stems from the fun that I've had playing with neo4j and using the unix-shell command style for traversing data (nodes/links and their labels/properties within the graph). I'm planning on using this framework for cyber threat indicators- but this framework could easily be used for managing other data points.

Current command interface/dispatcher is built ontop of python cmd2 and uses py2neo for neo4j REST communication.

Expand All @@ -17,15 +17,15 @@ The bare-bones commands work at present:
Roadmap
-------

Soon to come (1-2 weeks):
Soon to come (less than 1mo):
- additional argument support for bare-bones commands
- rm
- cat
- find
- man
- import/export (csv, json, mtgx, STIX, IOC, etc.)

Then:
Then (1-2mo):
- "transforms" (scripts to interact with data and create new nodes/linkages)
- "cron" (or "machines" in maltego lingo) to run/re-run scheduled transforms
- document retrieval (ala- curl/wget)
Expand Down
41 changes: 41 additions & 0 deletions README.md~
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
poortego
========

Latest iteration of poortego is a completely new code-base (the old ruby/metasploit code is under the poortego-ruby branch in case this ever wants to be revived).

This new iteration stems from the fun that I've had playing with neo4j and the natural way of traversing data (files) in the unix file-system as a way of traversing indicators. I'm using this for cyber threat indicators- but this framework could easily be used for managing other data points that are basic node/link data-types.

Current command interface/dispatcher is built ontop of python cmd2 and uses py2neo for neo4j REST communication.

The bare-bones commands work at present:
- help, exit, and namespace (standard)
- add and ln (wizards)
- cd, ls, pwd (traversals)
- session, storage, and user (information)
- purge

Roadmap
-------

Soon to come (1-2 weeks):
- additional argument support for bare-bones commands
- rm
- cat
- find
- man
- import/export (csv, json, mtgx, STIX, IOC, etc.)

Then:
- "transforms" (scripts to interact with data and create new nodes/linkages)
- "cron" (or "machines" in maltego lingo) to run/re-run scheduled transforms
- document retrieval (ala- curl/wget)
- raw document/file storage (link neo4j node to file-system path location)
-- maybe use a separate document storage solution (e.g., couchdb)

Later:
- Improved user/group/auth support (e.g., ldap)
- Better client/server support (ideally so little/no client-side requirements)
-- server API - REST/web, e.g., https://x.x.x.x/poortego.php?cmd=ls
- web interface / browser plug-in? (always preferred cli)


0 comments on commit bb68cce

Please sign in to comment.