Copyright (C) 2014 Erik-Oliver Blass
                   Travis Mayberry
                   Guevara Noubir
                   Kaan Onarlioglu <onarliog [at] ccs [dot] neu [dot] edu>

HiVE is free software, please see the file COPYING for details.

=== HiVE Userland Tool                                            ver.2014.11.03

Userland helper tool for setting up and running HiVE instances.

================================================================================

You can get the latest version of this software and more information about
HiVE on

    http://hive.ccs.neu.edu/
    http://www.onarlioglu.com/hive

=== Overview

=== Requirements

    1 - Linux kernel compiled with device-mapper support. If device-mapper is
    compiled as a module, it must be loaded.

    2 - HiVE kernel module. Note that the HiVE module has been developed for
    and tested with Linux kernel version 3.13.6.

    3 - Device-mapper userspace library and tools.

    4 - OpenSSL.

=== Build and Install Instructions

    Run "make" to compile the program. The executable "hive" can be found
    in the "./build" directory. Optionally, run "make install" to install the
    executable under "/usr/bin/".

=== Usage

    - Creating a new HiVE instance:

           hive create <block-device>                  
    OR     hive create <block-device> --single-volume              
   e.g.    hive create /dev/sdb1


    - Opening a HiVE instance:

           hive open <block-device> <hive-name>
    OR     hive open <block-device> <hive-name> --single-volume
   e.g.    hive open /dev/sdb1 my-hive-dev


    - Closing a HiVE instance:

           hive close <hive-name>
   e.g.    hive close my-hive-dev

    - Listing open HiVE instances:

           hive list

    Notes:

    1 - Create, open and close operations require root privileges, run them with
    sudo.

    2 - Use the [--single-volume] (or [-s]) option with create/open commands to
    create/open only a single, public volume. Note that if you have a hidden
    volume, this command will destroy the data in that volume.

    3 - The open command by default maps the public volume to
    "/dev/mapper/hive-public" and the hidden volume to
    "/dev/mapper/hive-hidden". You can specify different names using the
    [--public-dev] and [--hidden-dev] (or [-p] and [-h], respectively) options.

    4 - Mapped HiVE devices that are assigned random names prefixed with "map"
    are for internal use. Users should not write to those devices.

    5 - See "hive --help" for a summary of available options.
                 
=== Credits

This software is based on the following research work carried out at
Northeastern University and NEU SecLab.

    Toward Robust Hidden Volumes using Write-Only Oblivious RAM
    Erik-Oliver Blass, Travis Mayberry, Guevara Noubir, Kaan Onarlioglu
    Proceedings of the ACM Conference on Computer and Communications Security (CCS)
    Scottsdale, AZ USA, November 2014 

Authors' version of the full paper is available on

    http://hive.ccs.neu.edu/ccs2014hive.pdf
    http://www.onarlioglu.com/publications/ccs2014hive.pdf

If you would like to acknowledge our research and/or software in your works,
please use the following citation information:

    http://www.onarlioglu.com/bibtex/ccs2014hive.txt

=== EOF