Permalink
Browse files

updated documentation information, added new information and commands

  • Loading branch information...
s3inlc committed Oct 31, 2018
1 parent 176983b commit 3277eaa22b76ede83e991c0023eba3d213db9ffe
Showing with 9 additions and 681 deletions.
  1. +2 −0 README.md
  2. +2 −1 doc/README.md
  3. +1 −0 doc/changelog.md
  4. BIN doc/db_er.png
  5. +0 −678 doc/db_er.xml
  6. BIN doc/protocol.pdf
  7. +4 −2 doc/protocol.tex
@@ -44,6 +44,8 @@ In an effort to make the Hashtopussy project conform to a more politically neutr
- Small and/or CPU-only tasks
- Group assignment for agents and users for fine-grained access-control
- Compatible with crackers supporting certain flags
- Report generation fro executed attacks and agent status
- Multiple file distribution variants
## Setup and Usage
@@ -2,7 +2,8 @@
## Hashtopolis Protocol
The current up-to-date protocol version which Hashtopolis uses to communicate with clients is contained in the `protocol.pdf` file.
The current up-to-date protocol version which Hashtopolis uses to communicate with clients is contained in the `protocol.pdf` file.
The documentation for the User API can be found in `user-api/user-api.pdf`, listing all functions which can be called.
## Generic Crackers
@@ -8,6 +8,7 @@
- Notes can be added to hashlists.
- Added optional trace logging of actions from the client API to get more information in case of failures.
- Slow hashes are marked, so the client can decide if piping could make sense for this hash type.
- Agents can run health checks to determine if all agents are running correctly.
## Bugfixes
BIN -851 KB doc/db_er.png
Binary file not shown.

This file was deleted.

Oops, something went wrong.
BIN -56 Bytes (100%) doc/protocol.pdf
Binary file not shown.
@@ -8,7 +8,7 @@
\title{Hashtopolis Communication Protocol (V2)}
\maketitle
\section*{Introduction}
The communication between Hashtopolis Clients and Server is always in JSON formatted values. When sending a request to the server, it should be a POST containing the JSON data.
The communication between Hashtopolis Clients (Agents) and Server is always in JSON formatted values. When sending a request to the server, it should be a POST containing the JSON data.
\section*{Errors}
In case of an error with the query which the client sends to the server, the response will have following format with the corresponding action which was requested and the error message which should help in getting information about this error.
@@ -217,7 +217,9 @@
{
"action":"getFile",
"response":"SUCCESS",
"url":"get.php?file=5&token=GHhgdf(/&"
"extension": ".txt",
"url":"get.php?file=5&token=GHhgdf(/&",
"filesize": 267729
}
\end{verbatim}

0 comments on commit 3277eaa

Please sign in to comment.