diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8149990 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*.pyc +*.iml +*.egg-info +out + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6218a1f --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016 Ldgr Corporation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..371eff0 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Yorke + +Yorke is an experimental encryption library and command-line tool. + +# Usage + +Encrypt a file using a randomly generated pad. The encrypted cipher text is +sent to STDOUT and the random pad is sent STDERR: + +``` +cat plain.txt | yorke random_pad 1> cipher.txt 2> key.txt +cat plain.txt | yorke rp 1> cipher.txt 2> key.txt +``` + +Decrypt a file using a previously generated pad: + +``` +yorke file_xor cipher.txt key.txt > plain.txt +yorke fxor key.txt cipher.txt > plain.txt +``` + +# Installation + +``` +git clone https://github.com/ldgr/yorke.git +cd yorke +python setup.py install +``` + +# Testing + +Library: +``` +pip install nose +nosetests +``` + +Command: +``` +./test.sh +``` diff --git a/bin/yorke b/bin/yorke new file mode 100755 index 0000000..c1f8a69 --- /dev/null +++ b/bin/yorke @@ -0,0 +1,62 @@ +#!/usr/bin/env python +import argparse +import sys + +from yorke import RandomPad, Xor, byte_by_byte + + +def random_pad(args): + input = sys.stdin.read() + rp = RandomPad().encrypt(input) + sys.stdout.write(rp.cipher_text) + sys.stderr.write(rp.key_text) + + +def string_xor(args): + right = args.right or sys.stdin.read() + print Xor.str(Xor.strings(args.left, right)) + + +def file_xor(args): + with open(args.left, 'r') as left_fd: + if args.right: + with open(args.right, 'r') as right_fd: + sys.stdout.write(Xor.str(Xor.files(left_fd, right_fd))) + else: + sys.stdout.write(Xor.str(Xor.files(left_fd, sys.stdin))) + + +def init_parser(): + parser = argparse.ArgumentParser() + subparsers = parser.add_subparsers(help='Subcommand', dest='mode') + random_pad_parser = subparsers.add_parser('rp') + random_pad_parser = subparsers.add_parser('random_pad') + for input_type in ('string_', 'file_', 's', 'f'): + xor_parser = subparsers.add_parser('{}xor'.format(input_type)) + xor_parser.add_argument('left', type=str) + xor_parser.add_argument('right', nargs='?', type=str, default=None) + return parser + + +dispatch_table = dict( + random_pad=random_pad, + rp=random_pad, + + string_xor=string_xor, + sxor=string_xor, + + file_xor=file_xor, + fxor=file_xor, +) + +def main(): + parser = init_parser() + args = parser.parse_args() + try: + return dispatch_table[args.mode](args) + except KeyError: + print 'Invalid command: {}'.format(args.mode) + + +if __name__ == '__main__': + main() diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..ff0e5be --- /dev/null +++ b/setup.py @@ -0,0 +1,17 @@ +import setuptools + + +setuptools.setup( + name='yorke', + version='0.0.1', + url='https://github.com/ldgr/yorke', + license='Apache', + author='Ldgr Corporation', + author_email='patrick@ldgr.io', + description='Experimental encryption tools. ', + long_description=open('README.md').read(), + py_modules=['yorke'], + include_package_data=True, + platforms='any', + scripts=['bin/yorke'], +) diff --git a/test.py b/test.py new file mode 100644 index 0000000..921c40e --- /dev/null +++ b/test.py @@ -0,0 +1,51 @@ +from StringIO import StringIO +from unittest import TestCase + +from yorke import RandomPad, Xor + + +class TestXor(TestCase): + + def test_strings(self): + str1 = '\xff\xfe\xfb' + str2 = '\xfb\xfe\xff' + xord = Xor.strings(str1, str2) + self.assertEqual(xord, [4, 0, 4]) + + def test_bytestreams(self): + stream1 = iter(map(ord, '\xff\xfe\xfb')) + stream2 = iter(map(ord, '\xfb\xfe\xff')) + xord = Xor.bytestreams(stream1, stream2) + self.assertEqual(Xor.str(xord), '\x04\x00\x04') + + def test_files(self): + fd1 = StringIO('\xff\xfe\xfb') + fd2 = StringIO('\xfb\xfe\xff') + xord = Xor.files(fd1, fd2) + self.assertEqual(list(xord), [4, 0, 4]) + + def test_byte_list_to_string(self): + self.assertEqual( + Xor.byte_list_to_string([68, 51, 52, 68, 66, 69, 69, 70]), + 'D34DBEEF' + ) + + def test_str_alias(self): + self.assertEqual(Xor.str, Xor.byte_list_to_string) + + +class TestRandomPad(TestCase): + + def test_encrypt(self): + rp = RandomPad() + self.assertEqual(rp.key_bytes, []) + self.assertEqual(rp.cipher_bytes, []) + + plain = 'More secret than top secret' + self.assertEqual(rp, rp.encrypt(plain)) + self.assertEqual( + rp.cipher_bytes, + [ord(c) ^ b for c, b in zip(plain, rp.key_bytes)] + ) + self.assertEqual(rp.key_text, ''.join(map(chr, rp.key_bytes))) + self.assertEqual(rp.cipher_text, ''.join(map(chr, rp.cipher_bytes))) diff --git a/test.sh b/test.sh new file mode 100755 index 0000000..3a69dc5 --- /dev/null +++ b/test.sh @@ -0,0 +1,20 @@ +#!/usr/bin/env bash + +SECRET='More secret than top secret' + +mkdir out +cd out + +printf "$SECRET" | yorke random_pad 1> cipher.txt 2> key.txt +printf "$SECRET" | yorke rp 1> cipher.txt 2> key.txt + +printf "$SECRET" > expected.txt + +yorke file_xor cipher.txt key.txt > plain.txt +diff <(xxd plain.txt) <(xxd expected.txt) + +yorke fxor key.txt cipher.txt > plain.txt +diff <(xxd plain.txt) <(xxd expected.txt) + +cat key.txt | yorke fxor cipher.txt > plain.txt +diff <(xxd plain.txt) <(xxd expected.txt) diff --git a/yorke.py b/yorke.py new file mode 100644 index 0000000..eb9deb2 --- /dev/null +++ b/yorke.py @@ -0,0 +1,58 @@ +from random import randint + + +def byte_by_byte(file_descriptor): + byte = file_descriptor.read(1) + while byte: + yield ord(byte) + byte = file_descriptor.read(1) + raise StopIteration + + +class Xor(object): + + @classmethod + def strings(cls, left, right): + return [ord(l) ^ ord(r) for l, r in zip(left, right)] + + @classmethod + def bytestreams(cls, left_stream, right_stream): + while 1: + left_byte = left_stream.next() + right_byte = right_stream.next() + yield left_byte ^ right_byte + + @classmethod + def files(cls, left_fd, right_fd): + left_stream = byte_by_byte(left_fd) + right_stream = byte_by_byte(right_fd) + for byte in cls.bytestreams(left_stream, right_stream): + yield byte + + @classmethod + def byte_list_to_string(cls, byte_list): + return ''.join(chr(b) for b in byte_list) + + str = byte_list_to_string + + +class RandomPad(object): + + def __init__(self): + self.key_bytes = [] + self.cipher_bytes = [] + + def encrypt(self, plain_text): + for character in plain_text: + random_byte = randint(0, 255) + self.key_bytes.append(random_byte) + self.cipher_bytes.append(ord(character) ^ random_byte) + return self + + @property + def key_text(self): + return Xor.str(self.key_bytes) + + @property + def cipher_text(self): + return Xor.str(self.cipher_bytes)