 *     __   ___   _
 *    /  \ |   \ | | /\---------<ShellCode Generator Library>----------------->
 *   / /\ \| |\ \| |/ /
 *  / /__\ \    /|   /          libShellCode is an ORK's project!
 *  \______/ |\ \| | \          For comments, bug reports, etc ...
<----------|_| \_\_|\_\         contact me at orkmail<at>katamail<dot>com


Index
-----
0 - Disclamer
1 - What is libShellCode?
2 - Where can i download libShellCode?
3 - What the tar.gz packet contains?
4 - How can i compile the library?
5 - How can i use libShellCode?
6 - What is generator?


0 - Disclamer
-------------
This software is provided "as is" and without any warranties.
The author is not responsable for the use that can be done with this software.
Sorry for my bad english :)


1 - What is libShellCode?
--------------------------
libShellCode is a library you can include in your linux/i386 exploits. 
This library provide same functions that generates on runtime an linux/i386 
ShellCode with the parameters you want. For example you can generate a 
shellcode which executes a program simply by calling one function and passing 
it the path of the parogram as parameter.


2 - Where can i download libShellCode?
--------------------------------------
You can download the last version of libShellCode from this page:

http://www.orkspace.net/software/libShellCode


3 - What does the tar.gz packet contains?
-----------------------------------------
AUTHOR                - Author
CHANGELOG             - Changelog for this version
COPYING               - GNU GENERAL PUBLIC LICENSE
examples              - Examples of using libShellCode
examples/exploits     - Examples of exploits using libShellCode
examples/README       - Readme for the examples
examples/ShellCodes   - Examples of ShellCodes built with generator
generator             - Front end for the library
generator/generator.c - generator C file
generator/generator.h - generator headers
generator/Makefile    - Make file for generator
generator/README      - Readme for generator
lib                   - libShellCode
lib/codes.h           - libShellCodes headers
lib/libShellCodes.c   - libShellCodes C file
lib/libShellCodes.h   - Prototipes of the funcions to include in your codes
lib/Makefile          - Make file for libShellCodes
lib/README            - Readme for libShellCodes
Makefile              - Makefile to compile all the software
README                - This readme file
VERSION               - This version


4 - How can i compile the library?
----------------------------------
It is simple, just a make :)


5 - How can i use libShellCode?
--------------------------------
Read the documentation in the lib subdirectory.


6 - What is generator?
----------------------
generator is a front end for the library. 
It asks you for the shellcode characteristics and builds a C file containing 
the shellcode. For more information read the documentation in generator 
subdirectory.


