Aeolus - Deliverable D6.2.10 - New Components for the Overlay Computing Platform - Secure Searching on Out-sourced Data (SSOD)


CONTENTS
========

* License
* System Requirements
* Introduction
* Directory Structure
* Usage and Installation
* Building instructions

License
=======

The software is licensed under the GPL, please see the gpl-3.0.txt file for more information.


System Requirements
===================

SSOD requires JDK6 or higher. You can download it at http://java.sun.com/


Introduction
============

Predicate encryption schemes are encryption schemes in which each ciphertext Ct is
associated with a binary attribute vector x = (x1, ... ,xn) and keys K are
associated with predicates.
A key K can decrypt a ciphertext Ct if and only if the attribute vector of the
ciphertext satisfies the predicate of the key. Predicate encryption schemes can be used
to perform search on encrypted data.
Using HVE, SSOD allows to store data in encrypted form on a remote server in such a
way that it is possible to perform search without having to download (and decrypt) the whole
data set.
		
The parties involved in the service are the following:
- SearchableStore: holds the encrypted data and performs the searches on it based on the query
                   keys generated by the DBOwner.
- DBOwner: is the party who wants to outsource the data.
- Writer: is the party who wants to store some data into the out-sourced repository.


Directory Structure
===================

ssod
    docs                        - Contains the documentation on how to use the library
    libs                        - Contains all the necessary third-party libraries. (junit, log4j, jxta, derby, etc...)
    license                     - Contains license information.
    ssod-aeolus                 - The module which provides the testbed support classes.
    ssos-api                    - The module which provides the api interfaces.
    ssos-plaf                   - The module which provides the default api implementation.
    pom.xml                     - Maven build file

The sources are organized in the following way (per module):

src
    main                        - Contains the core sources
        java                    - Contains the core java sources
        resources               - Contains the core resources (configuration files and so on...)
    test
        java                    - Contains the test code for java sources.
        resources               - Contains the test code resources.


Usage and Installation
======================

The project is based on the Maven build system. You can download it at http://maven.apache.org/
All necessary libraries are available in the libs directory.
To install the libraries into the local maven repository go the libs folder and execute
the following:


Unix:

    ./install.sh

Windows:

    install.bat



Building instructions
=====================

To build the project simply call from the root directory (ssod):

    mvn -Dmaven.test.skip=true clean package install


After a successful execution for each module a target folder will be created.
In those folders you will find the jar files (bytecode and sources).