combox

split and encrypted files between online file storage providers
git clone git://git.ricketyspace.net/combox.git
Log | Files | Refs

commit 154a3d5fcbf5962859fd0d345645060b27223690
parent 286421c30599dee1f1aaee500f3bfed0bada6c5f
Author: Siddharth Ravikumar <sravik@bgsu.edu>
Date:   Mon, 12 Jan 2015 16:53:36 -0500

consolidated everything into combox/combox.py.

tests were removed. will write tests using `nose` later.

	renamed:    combox/file.py -> combox/combox.py
	deleted:    combox/config.py
	deleted:    combox/crypto.py
	renamed:    tests/test_config.py -> tests/combox_tests.py
	deleted:    tests/files/the-red-star.jpg
	deleted:    tests/test_crypto.py
	deleted:    tests/test_file.py

Diffstat:
combox/combox.py | 243+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
combox/config.py | 82-------------------------------------------------------------------------------
combox/crypto.py | 84-------------------------------------------------------------------------------
combox/file.py | 127-------------------------------------------------------------------------------
tests/combox_tests.py | 30++++++++++++++++++++++++++++++
tests/files/the-red-star.jpg | 0
tests/test_config.py | 22----------------------
tests/test_crypto.py | 52----------------------------------------------------
tests/test_file.py | 47-----------------------------------------------
9 files changed, 273 insertions(+), 414 deletions(-)

diff --git a/combox/combox.py b/combox/combox.py @@ -0,0 +1,243 @@ +# Copyright (C) 2014 Combox author(s). See AUTHORS. +# +# This file is part of Combox. +# +# Combox is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Combox is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Combox (see COPYING). If not, see +# <http://www.gnu.org/licenses/>. + +import base64 +import os +import yaml +import getpass +import hashlib +import sys +import stat + +from Crypto.Cipher import AES +from os import path +from sys import exit +from glob import glob + + +#### Start of combox config function + +def config_cb(): + """ + Configure combox, if not already configured. + """ + # First whether combox is already configured. + config_dir = os.path.join(os.getenv('HOME'),'.combox/') + if not os.path.exists(config_dir): + # Create combox dir and configure. + os.mkdir(config_dir, 0700) + config_file_path = os.path.join(config_dir, 'config.yaml') + config_info = {} + + config_info['combox_dir'] = raw_input('path to combox directory: ') + config_info['topsecret'] = hashlib.sha224(getpass.getpass('passphrase: ')).hexdigest() + + no_nodes = int(raw_input('number of nodes: ')) + + nodes = {} + for i in range(no_nodes): + node_name = raw_input('node %d name: ' % i) + nodes[node_name] = {} + nodes[node_name]['path'] = raw_input('node %d path: ' % i) + nodes[node_name]['size'] = raw_input('node %d size (in mega bytes): ' % i) + nodes[node_name]['available'] = nodes[node_name]['size'] + + config_info['nodes_info'] = nodes + config_file = open(config_file_path, 'w') + yaml.dump(config_info, config_file, default_flow_style=False) + os.chmod(config_file_path,stat.S_IRUSR|stat.S_IWUSR) + else: + # should put something here later + pass + +#### End of combox config function + + + + +#### Start of crypto functions. +def pad(data): + """Pad data such that its length is a multiple of BLOCK_SIZE. + """ + + padding = (BLOCK_SIZE - (len(data) % BLOCK_SIZE)) * PAD_CHAR + data += padding + + return data + + +def encrypt(data, secret): + """Encrypt byestream and return cipher. + """ + aes = AES.new(pad(secret)) + cipher = base64.b64encode(aes.encrypt(pad(data))) + + return cipher + + +def decrypt(cipher, secret): + """Decrypt cipher and return data. + """ + aes = AES.new(pad(secret)) + data = aes.decrypt(base64.b64decode(cipher)).rstrip(PAD_CHAR) + + return data + +def encrypt_shards(shards, secret): + """Encrypt the shards of data and return a list of ciphers. + + shards: list of shards (string, bytes). + secret: top secret passphrase + """ + + ciphers = [] + for shard in shards: + cipher = encrypt(shard, secret) + ciphers.append(cipher) + + return ciphers + + +def decrypt_shards(ciphers, secret): + """Decrypt the ciphered shards and return a list of shards. + + shards: list of ciphered shards. + secret: top secret passphrase + """ + + shards = [] + for cipher in ciphers: + shard = decrypt(cipher, secret) + shards.append(shard) + + return shards + +#### End of crypto functions. + + + +#### Start of File related functions + +def split_data(data, n): + """Split data into `n' parts and return them as an array. + + data: Stream of bytes or string + n: Number of parts the file has to be split. + """ + + d_parts = [] + # File size in bytes. + data_size = len(data) + # No. of bytes for each data part. + part_size = data_size / n + # Take note of remaining bytes; this is non-zero when data_size is + # not divisible by `n'. + rem_bytes = data_size % n + + start = 0 + end = part_size + while end <= data_size: + d_parts.append(data[start:end]) + start = end + end = end + part_size + + # read the remaining bytes into the last data part. + end += start + rem_bytes + d_parts[n-1] += data[start:end] + + return d_parts + + +def glue_data(d_parts): + """Glue different parts of the data to one. + + d_parts: Array containing different parts of the data. Each part + is a sequence of bytes. + """ + + data = '' + for part in d_parts: + data += part + + return data + + +def read_file(filename): + """Read file and return it as a string. + + filename: Absolute pathname of the file. + """ + file_ = None + try: + file_ = open(filename, 'rb') + except IOError: + print "ERROR: opening %s" % (filename) + exit(1) + + return file_.read() + + +def write_file(filename, filecontent): + """Write `filecontent' to `filename'. + + filename: Absolute pathname of the file. + filecontent: String/bytstream to write to filename. + """ + file_ = None + try: + file_ = open(filename, 'wb') + file_.write(filecontent) + except IOError: + print "ERROR: creating and writing content to %s" % (filename) + exit(1) + +def write_shards(shards, directory, shard_basename): + """Write shards to respective files respective files. + + shard: list of strings (ciphers or data). + directory: absolute path of directory to which it shards must be written to. + shard_basename: base name of the shard. + """ + + # partial filename of the shard + p_filename = path.join(directory, shard_basename) + shard_no = 0 + for shard in shards: + shard_name = "%s.shard%s" % (p_filename, shard_no) + write_file(shard_name, shard) + shard_no += 1 + +def read_shards(directory, shard_basename): + """Read the shards from directory and return it as a list. + + directory: absolute path of directory from which to read the shards. + shard_basename: base name of the shard. + """ + + shards = [] + # partial filename of the shard + p_filename = "%s.shard*" % path.join(directory, shard_basename) + for shard_file in sorted(glob(p_filename)): + shard_content = read_file(shard_file) + shards.append(shard_content) + + return shards + + + +#### End of File related functions. diff --git a/combox/config.py b/combox/config.py @@ -1,82 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -################################################## -## YAML Config format -################################################## -## -## combox_dir: path/to/combox/ -## -## topsecret: dba0079f1cb3a3b56e102dd5e04fa2af -## -## nodes_info: -## node_name: -## path: path/to/shard1/dir/ -## size: 1000 # in MB -## available: 500 # in MB -## node name: -## path: path/to/shard2/dir/ -## size: 2000 -## available: 1500 -## node name: -## path: path/to/shard3/dir -## size: 3000 -## available: 1500 -## -################################################## - -import os -import yaml -import getpass -import hashlib -import sys -import stat - - -def config_cb(): - """ - Configure combox, if not already configured. - """ - # First whether combox is already configured. - config_dir = os.path.join(os.getenv('HOME'),'.combox/') - if not os.path.exists(config_dir): - # Create combox dir and configure. - os.mkdir(config_dir, 0700) - config_file_path = os.path.join(config_dir, 'config.yaml') - config_info = {} - - config_info['combox_dir'] = raw_input('path to combox directory: ') - config_info['topsecret'] = hashlib.sha224(getpass.getpass('passphrase: ')).hexdigest() - - no_nodes = int(raw_input('number of nodes: ')) - - nodes = {} - for i in range(no_nodes): - node_name = raw_input('node %d name: ' % i) - nodes[node_name] = {} - nodes[node_name]['path'] = raw_input('node %d path: ' % i) - nodes[node_name]['size'] = raw_input('node %d size (in mega bytes): ' % i) - nodes[node_name]['available'] = nodes[node_name]['size'] - - config_info['nodes_info'] = nodes - config_file = open(config_file_path, 'w') - yaml.dump(config_info, config_file, default_flow_style=False) - os.chmod(config_file_path,stat.S_IRUSR|stat.S_IWUSR) - else: - # should put something here later - pass diff --git a/combox/crypto.py b/combox/crypto.py @@ -1,84 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -## Adapted from https://gist.github.com/sekondus/4322469 - -import base64 -import os - -from Crypto.Cipher import AES - -BLOCK_SIZE = 32 -PAD_CHAR = '#' - - -def pad(data): - """Pad data such that its length is a multiple of BLOCK_SIZE. - """ - - padding = (BLOCK_SIZE - (len(data) % BLOCK_SIZE)) * PAD_CHAR - data += padding - - return data - - -def encrypt(data, secret): - """Encrypt byestream and return cipher. - """ - aes = AES.new(pad(secret)) - cipher = base64.b64encode(aes.encrypt(pad(data))) - - return cipher - - -def decrypt(cipher, secret): - """Decrypt cipher and return data. - """ - aes = AES.new(pad(secret)) - data = aes.decrypt(base64.b64decode(cipher)).rstrip(PAD_CHAR) - - return data - -def encrypt_shards(shards, secret): - """Encrypt the shards of data and return a list of ciphers. - - shards: list of shards (string, bytes). - secret: top secret passphrase - """ - - ciphers = [] - for shard in shards: - cipher = encrypt(shard, secret) - ciphers.append(cipher) - - return ciphers - - -def decrypt_shards(ciphers, secret): - """Decrypt the ciphered shards and return a list of shards. - - shards: list of ciphered shards. - secret: top secret passphrase - """ - - shards = [] - for cipher in ciphers: - shard = decrypt(cipher, secret) - shards.append(shard) - - return shards diff --git a/combox/file.py b/combox/file.py @@ -1,127 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -from os import path -from sys import exit -from glob import glob - - -def split_data(data, n): - """Split data into `n' parts and return them as an array. - - data: Stream of bytes or string - n: Number of parts the file has to be split. - """ - - d_parts = [] - # File size in bytes. - data_size = len(data) - # No. of bytes for each data part. - part_size = data_size / n - # Take note of remaining bytes; this is non-zero when data_size is - # not divisible by `n'. - rem_bytes = data_size % n - - start = 0 - end = part_size - while end <= data_size: - d_parts.append(data[start:end]) - start = end - end = end + part_size - - # read the remaining bytes into the last data part. - end += start + rem_bytes - d_parts[n-1] += data[start:end] - - return d_parts - - -def glue_data(d_parts): - """Glue different parts of the data to one. - - d_parts: Array containing different parts of the data. Each part - is a sequence of bytes. - """ - - data = '' - for part in d_parts: - data += part - - return data - - -def read_file(filename): - """Read file and return it as a string. - - filename: Absolute pathname of the file. - """ - file_ = None - try: - file_ = open(filename, 'rb') - except IOError: - print "ERROR: opening %s" % (filename) - exit(1) - - return file_.read() - - -def write_file(filename, filecontent): - """Write `filecontent' to `filename'. - - filename: Absolute pathname of the file. - filecontent: String/bytstream to write to filename. - """ - file_ = None - try: - file_ = open(filename, 'wb') - file_.write(filecontent) - except IOError: - print "ERROR: creating and writing content to %s" % (filename) - exit(1) - -def write_shards(shards, directory, shard_basename): - """Write shards to respective files respective files. - - shard: list of strings (ciphers or data). - directory: absolute path of directory to which it shards must be written to. - shard_basename: base name of the shard. - """ - - # partial filename of the shard - p_filename = path.join(directory, shard_basename) - shard_no = 0 - for shard in shards: - shard_name = "%s.shard%s" % (p_filename, shard_no) - write_file(shard_name, shard) - shard_no += 1 - -def read_shards(directory, shard_basename): - """Read the shards from directory and return it as a list. - - directory: absolute path of directory from which to read the shards. - shard_basename: base name of the shard. - """ - - shards = [] - # partial filename of the shard - p_filename = "%s.shard*" % path.join(directory, shard_basename) - for shard_file in sorted(glob(p_filename)): - shard_content = read_file(shard_file) - shards.append(shard_content) - - return shards diff --git a/tests/combox_tests.py b/tests/combox_tests.py @@ -0,0 +1,30 @@ +# Copyright (C) 2014 Combox author(s). See AUTHORS. +# +# This file is part of Combox. +# +# Combox is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Combox is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Combox (see COPYING). If not, see +# <http://www.gnu.org/licenses/>. + +from nose.tools import * +import combox + +def setup(): + print "SETUP!" + +def teardown(): + print "TEAR DOWN!" + +def test_basic(): + print "I RAN!" + diff --git a/tests/files/the-red-star.jpg b/tests/files/the-red-star.jpg Binary files differ. diff --git a/tests/test_config.py b/tests/test_config.py @@ -1,22 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -from config import config_cb - -# test this function. -config_cb() diff --git a/tests/test_crypto.py b/tests/test_crypto.py @@ -1,52 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -from os import path - -from file import (split_data, glue_data, write_file, - read_file, write_shards, read_shards) -from crypto import encrypt, decrypt, encrypt_shards, decrypt_shards - -PASS = 'topsecret' -### Read file, encrypt it to a cipher, write cipher to file, read -### encrypted file, decrypt it, write decrypted data to file. -f = path.abspath('tests/files/the-red-star.jpg') -f_content = read_file(f) -f_cipher = encrypt(f_content, PASS) -f_encrypted = path.abspath('tests/files/the-red-star.cipher') -write_file(f_encrypted, f_cipher) -f_cipher = read_file(f_encrypted) -f_content = decrypt(f_cipher, PASS) -f = path.abspath('tests/files/the-red-star-decrypted.jpg') -write_file(f, f_content) - -### Read file, split it, encrypt shards, write encrypted shards to -### file, read encrypted shards from file, decrypt the encrypted -### shards, glue the shards together, write glued data to file. -f = path.abspath('tests/files/the-red-star.jpg') -f_content = read_file(f) -f_shards = split_data(f_content, 5) -ciphered_shards = encrypt_shards(f_shards, PASS) -f_path = path.dirname(f) -f_basename = "%s.ciphered" % path.basename(f) -write_shards(ciphered_shards, f_path, f_basename) -ciphered_shards = read_shards(f_path, f_basename) -f_parts = decrypt_shards(ciphered_shards, PASS) -f_content = glue_data(f_parts) -f = path.abspath('tests/files/the-red-star-from-ciphered-shards.jpg') -write_file(f, f_content) diff --git a/tests/test_file.py b/tests/test_file.py @@ -1,47 +0,0 @@ -# Copyright (C) 2014 Combox author(s). See AUTHORS. -# -# This file is part of Combox. -# -# Combox is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Combox is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Combox (see COPYING). If not, see -# <http://www.gnu.org/licenses/>. - -from os import path - -from file import (split_data, glue_data, write_file, - read_file, write_shards, read_shards) - -### Test to split, glue and create a copy of the image file from the -### glued image file. -f = path.abspath('tests/files/the-red-star.jpg') -f_content = read_file(f) -f_parts = split_data(f_content, 5) -f_content = glue_data(f_parts) -f_copy = path.abspath('tests/files/the-red-star-copy.jpg') -write_file(f_copy, f_content) - - -## read file and split it into N shards and write the shards to disk. -SHARDS = 5 -f = path.abspath('tests/files/the-red-star.jpg') -f_content = read_file(f) -f_shards = split_data(f_content, SHARDS) -f_path = path.dirname(f) -f_basename = path.basename(f) -write_shards(f_shards, f_path, f_basename) - -## read file shards, glue them together and write to disk. -f_shards = read_shards(f_path, f_basename) -f_content = glue_data(f_shards) -f_copy = path.abspath('tests/files/the-red-star-glued.jpg') -write_file(f_copy, f_content)