Skip to content
No description, website, or topics provided.
Java Other
  1. Java 99.5%
  2. Other 0.5%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/main
.gitignore
LICENSE.md
README.md
icct.bat
icct.sh
pom.xml

README.md

Ionic Cloud Copy Tool demo

Requirements

Java 7 or later Maven 3 or later

Building the jar

From the project root run mvn package

Using the tool

Ionic Requirements

Enroll an Ionic Persistor

Either use a plaintext persistor located at $HOME/.ionicsecurity/profiles.pt or edit the code on lines 90-103 to use another persistor class. Guides on persistor enrollment can be found here and code examples of different persistors can be found here.

AWS Setup

Set up AWS ENV variables

AWS_ACCESS_KEY_ID=your_access_key_id AWS_SECRET_ACCESS_KEY=your_secret_access_key AWS_REGION=your_default_amazon_region

Details on setting up and configuring Ionic for AWS S3 can be found at here.

GCS Setup

Set up GCS ENV variables

GOOGLE_APPLICATION_CREDENTIALS=path/to/a/google/serviceAccount.json

Details on setting up and configuring Ionic for GCS can be found here.

Azure Setup

Set up Azure ENV variables

AZURE_STORAGE_ACCESS_KEY=your_azure_access_key AZURE_STORAGE_ACCOUNT=the_azure_storage_account_to_use

Details on setting up and configuring Ionic for Azure can be found here.

Running the tool

Once the tool has been built it can be called using the icct.sh or icct.bat script (referred to as icct for the rest of this document).

Commands

Secure Cloud Copy

Running the command icct <source> <destination> will copy the data specified in the source to the destination. If the destination is a remote location then the data will be protected by encryption en route. If the source is a remote location the data will be decrypted en route. If both the source and the destination are remote then the data will be decrypted and then reprotected en route preserving any attributes associated with the underlying Ionic key.

Local Sources

A file from the local file system can be used as a source by providing a path to the file for the <source> argument. A UTF8 encoded string can be used as a source by using the following syntax string:Your-string-here for the source argument.

Additionally local sources can optionally include attributes to be set on the Ionic Key protecting the data by using the -a flag. Ex: -a attribute1:val1:val2,attribute2:val3.

Local Destinations

The data from a source can be written to the local file system by providing a path to the file to write to for the <destination> argument. If the file already exists it will be overwritten. The data from the source can be displayed via standard out by using stdout: as the argument for the <destination>.

Remote Sources and Destinations

An AWS S3 object can be used as either a <source> or <destination> by using the following syntax: s3://s3bucket/path/to/object/.

A GCS object can be used as either a <source> or a <destination> by using the following syntax: gs://gcsbucket/path/to/object.

An Azure blob can be used as either a <source> or a <destination> by using the following syntax: az://container/path/to/blob. In this version of ICCT azure blobs may only be moved to or from Containers that exist under the Storage Account specified by the current AZURE_STORAGE_ACCOUNT environment variable.

Configuration check

Running the command icct config will check and display the configuration status of the dependent services.

Version

Running the command icct version will display the version of the tool.

Limitations

The underlying implementations store the Ionic KeyIds within the Blob and Object Metadata. For more details see the documentation for the individual components: IDTS for AWS S3, IDTS for Google Cloud Storage, IDTS for Azure Blob Storage

NOTE: Corruption or removal of the metadata values storing the Ionic KeyIds will render the data unrecoverable. Care should be taken to set appropriate permissions on protected objects.

You can’t perform that action at this time.