Documentation
A. User section
1. Introduction
Cryptomak is collection of php script for encrypting and decrypting messages (plain
or encrypted text). The current version of Cryptomak contains some encryptions such as shift,
affine, monoalphabetic substitution, vigenere, permutation, and so on. Also, it contains
tools such as frequency distribution and index of coincidence to analyze encrypted messages.
2. Requirements
To make it work, you need to fulfill the following requirements:
a. Web server (Apache, Xitami, IIS, etc)
b. PHP 4 must be installed on your computer. PHP4 >= 4.3.0 for all features.
3. Installation
a. Just unzip it to web-accessible directory
b. Modify user configuration in config.php on directory 'include'
c. Start the web server
d. Open web browser and go to your own Cryptomak page
e. Enjoy it
4. Changes
* October 2003 version 1.1:
a. It is programmed in modular programming. Welcome to OOP world ;)
b. Using Phrame as web aplication platform which implements MVC design
c. Using Smarty as template engine at the view layer
d. New hashing script added
e. Better web design
* March 2002 version 1.0:
a. First version of Cryptomak released
B. Developer section
1. Introduction
Cryptomak is using Phrame as web application platform which implements MVC (Model,
View, Controller) design. At the view layer, Cryptomak is using Smarty as template engine.
For better explanation, you can read the documentations at their site.
Phrame's web site is http://phrame.sf.net and Smarty's web site is http://smarty.php.net.
2. Development
Cryptomak application is divided into several directories.
Directory 'models' contains core classes.
Directory 'forms' contains form classes.
Directory 'actions' contains action classes.
Directory 'templates' contains some template designs.
If you want to add new cipher, first you need to add the core class. Core class
contains all methods and properties to be used in cipher system. Then add your form and action
class. The action class should contains your business logic for particular action. You need to
make template design for your cipher as you want. Add that template into directory 'templates'.
After doing all above, you must add all your new class files and modify configuration
in file 'config.php'. And most important thing, you must add the mapping of your new action in
file 'mappings.php'. File 'config.php' and 'mappings.php' is on directory 'include'.
Then try to open web server and go to your cryptomak page. In your browser, add
the phrame.php with query string 'action' whose value is your action mapping in 'mappings.php'.
Ex: http://www.yoursite.com/cryptomak/phrame.php?action=youraction
If you can see your new page without errors, it means you did it right. Good luck!
3. Todo
a. more ciphers, tools, hashes, and coders
b. more templates
If you have any ideas,suggestion,etc please mail me at khaidarmak@yahoo.com.
I need your contributions :-)
4. Credits
a. PHP (http://www.php.net)
b. Phrame Web Application Platform (http://phrame.sf.net)
c. Smarty Template Engine (http://smarty.php.net)
d. SourceForge (http://www.sourceforge.net)
e. Cryptomak Cipher Tools (http://makcoder.sf.net)
Cryptomak Cipher Tools is programmed by M. Abdullah Khaidar
