You are on page 1of 19

The Hash Kit

User Manual

Contents
General Information ..................................................................................................................... 2 Software website overview ..................................................................................................... 2 Organisation of the manual .................................................................................................... 3 Authorised Use Permission .................................................................................................... 3 Contingencies ........................................................................................................................... 3 Points of contact ....................................................................................................................... 3 Prerequisites ................................................................................................................................. 4 System configuration ............................................................................................................... 4 Getting Started.............................................................................................................................. 5 Signing in ................................................................................................................................... 6 Register...................................................................................................................................... 7 Using The Hash Kit ...................................................................................................................... 8 Overview (Users) ...................................................................................................................... 8 Begin a Test .............................................................................................................................. 9 Basic hashing........................................................................................................................ 9 Compute and Compare ..................................................................................................... 11 My Test Result ........................................................................................................................ 12 Overview (Admin) ................................................................................................................... 13 Create a new user .............................................................................................................. 14 View an user ....................................................................................................................... 15 Edit an user ......................................................................................................................... 15 Delete an user..................................................................................................................... 16 FAQ .............................................................................................................................................. 17 Login help ................................................................................................................................ 17 Process help ........................................................................................................................... 18 Other topics help .................................................................................................................... 18

General Information 1

General Information
This section explains in general terms the website and the purpose for which it is intended.

Software website overview


The new hash kit website has been developed on the basis of research carried out by the members of the DSS-14-S1-12 project team (The Hash Kit Team) during the final year project into the needs of the cryptographic sector. Our new website provides all the functionality of the current available hash kits and additional features such as: Input plaintext or upload a file into the websites application. Compute collision, pre-image and 2nd pre-image resistance Output the results such as collision rate and give the option to save output as text file. Allow you to sign up, login in and use the available web applications such as doing comparison between hash functions. Notifications will be sent to your email once the hash functions have produced results

General Information 2

Organisation of the manual


The users manual consists of five sections: Introduction, Prerequisites, Getting Started, Using hash web application and FAQ. The introduction section explains in general terms the website and the purpose for which it is intended, user access levels and the web applications behaviour during the entire process. Prerequisites section provides an outline of the uses of the systems hardware and web browsers requirements and configuration. Getting started section provides the details of how to access the website and briefly explains on the web applications user interfaces. Using Hash Kit section explains a detailed description of the web application functions. FAQ section presents the common questions asked by users and possible solutions. The manual explains the ways in which to use site in order to get the most out of our resources.

Authorised Use Permission


Only registered users and administrators can access all available resources on their user account in the website.

Contingencies
In case of any lost or interrupted connection between the server and the user, the server will continue to do its processing and the user should be able to return their initial screen when they are waiting for the process to be done. Once the processing is done, the result data will be stored in the users account.

Points of contact
For additional information, please contact The Hash Kit team at hashkitproject@gmail.com

General Information 3

Prerequisites
Prerequisites section provides an outline of the uses of the systems hardware and web browsers requirements and configuration, and the web applications behaviour during the entire process.

System configuration
The system must be connected to the internet at all times in order to view results and other resources or do the processing from the users input. Once it is connected to the internet, then the hash kit website is accessible via current web browsers: Internet Explorer (pre-installed on any Microsoft operating system), Google Chrome, Apple Safari (pre-installed on most Macintosh computer systems), Mozilla Firefox, Opera and maybe others. It also can be accessed on the mobile platform browsers such as android browsers. As for the required settings for all web browsers, the web browser must be given permission by the user to run scripts, add-ons and plugins such JavaScript. Additional information will be provided in the getting started section.

Prerequisites 4

Getting Started
This section provides the details of how to access the website and briefly explains on The Hash Kits user interfaces.

3 4

Signing up to The Hash Kit account is mandatory. 1: Sign in to your Hash Kit account 2: Register a Hash Kit account 3: Brings you back to the home page 4: Brings you to the project development blog .. pg6 .. pg7

Getting Started 5

Signing in

Log in to your account here. You will only give 3 attempts to login successfully. If you fail to login successfully after 3 tries, your account will be locked.

Getting Started 6

Register

It is mandatory to have a Hash Kit account before you can start using the applications. Register your account here. You should enter a valid email account in the Email field. Here are the requirements of password: - The use of both uppercase and lowercase letters (case sensitivity) - Inclusion of one or more numerical digits - Inclusion of special characters, e.g. @, #, &, $ etc. - At least 8 characters

Getting Started 7

Using The Hash Kit


To start using The Hash Kit, you can choose one of the links from the quick link bar

Overview (Users)

1 2 3 4

You will be greeted with a welcome page which consists of links for you to choose from. 1: Brings you back to the home page 2: Start a test to do basic hashing or computations 3: View your past test results 4: Brings you to the project development blog 5: Log out of your Hash Kit account

.. pg7, 8 .. pg9

Using The Hash Kit 8

Begin a Test

1: Does basic hashing with a selection of hashing algorithm 2: Compare between a selection of hashing algorithm with information such as collision resistance, pre-image resistance, etc.

Basic hashing
This function hashes plaintext provided by the user into message digest

Selection of hash algorithms available, multiple selections is accepted.

Using The Hash Kit 9

Enter your plaintext here

Or upload your own text file

You can enter plaintext manually or upload a file (.txt).

Save your result to your PC

You will be given an option to save your result to text file.

Using The Hash Kit 10

Compute and Compare


Inputs for Compute and Compare will be the same as basic hashing except the inclusion of email notification selection

Tick this option and the system will Email you once your result is ready

Included analysis of your hash result, whether is your hash value common in your selected algorithm

Included comparison of chosen hash algorithm between these properties

Your hash result will be different from basic hashings hash result.

Using The Hash Kit 11

My Test Result
Shows a list of your past test results

Click on this button to see the details of your hash result

Using The Hash Kit 12

Overview (Admin)
An admin can start a test like any other registered users. They have additional abilities to create, read, update, and delete users.

Select this option to go to the administrative panel

Using The Hash Kit 13

The administrative panel

1 2 3 4

1: Creates a new user 2: View an user 3: Edit an user 4: Delete an user 5: Search for an user (using Email address)

Create a new user

All fields are mandatory

Using The Hash Kit 14

View an user

Edit an user

Using The Hash Kit 15

Delete an user

Using The Hash Kit 16

FAQ
FAQ section presents the common questions asked by users and possible solutions.

Login help
What are the requirements for passwords on Hash Kit account? Here are the requirements of password: - The use of both uppercase and lowercase letters (case sensitivity) - Inclusion of one or more numerical digits - Inclusion of special characters, e.g. @, #, &, $ etc. - At least 8 characters How do I change my password? You can find a change password button in your profile and this will change your password with immediate effects and an email will be sent to your email upon confirmation. I cant remember my password, what should I do? Click on the forget password link at the login page, an email will be sent to you to assist on resetting your password. Can I access the web application without logging in? A Hash Kit account is mandatory for the usage of this application. I haven't received the reset email in my mailbox, what should I do next? Please wait for few minutes for the server to process the email and check your spam mail. If the email still did not arrive, you can contact the administrator (hashkitproject@gmail.com) for further assistance.

FAQ 17

Process help
What happens if I unexpectedly/accidently close the browser? You will have to restart the browser and try to run the application again. If my browser hangs when the processing is still been carried out, what should I do next? You will have to restart the browser and try to run the application again. After the process is done, I cannot see the result screen and what should I do next? Check your internet connection. You can refresh the page by pressing the refresh button on the web browser and wait for it to load. If it still does not work, please contact the administrator (hashkitproject@gmail.com) for further assistance.

Other topics help


I cant see anything on the website, what should i do? Check your internet connection. You can refresh the page by pressing the refresh button on the web browser and wait for it to load. If it still does not work, please contact the administrator (hashkitproject@gmail.com) for further assistance. If I have selected the choice of emailing result to my email account and I did not receive it, what should I do next? Please wait for few minutes for the server to process the email and check your spam mail. If the email still did not arrive, you can contact the administrator (hashkitproject@gmail.com) for further assistance. If I received any 404 error page in anytime during the visit of the website, what should I do next? Check your internet connection. You can refresh the page by pressing the refresh button on the web browser and wait for it to load. If it still does not work, please contact the administrator (hashkitproject@gmail.com) for further assistance.

FAQ 18

You might also like