diff --git a/CHANGELOG.md b/CHANGELOG.md index 035c327..9c03e77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,10 @@ All notable changes to the Sandcastle script will be documented in this file. ## 1.2.3 – 2017-04-09 -- Fixes minor issues with `setup.py` classifiers -- Fixes additional issue with default `bucket-names.txt` import +- Due to PyPi issues, Sandcastle will not ship with a default `bucket-names.txt`. + * The example `bucket-names.txt` can be downloaded from this repo + * By default, Sandcastle searches for `bucket-names.txt` in the current directory + * As previously, use the `-f` flag to specify a different input file - Removes "no match" display from Sandcastle script ## 1.2.2 – 2017-04-09 diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index c66d22b..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,5 +0,0 @@ -include bucket-names.txt -include CHANGELOG.md -include README.md -include README.rst -include LICENSE diff --git a/README.md b/README.md index 990085f..6723891 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ The script takes a target name as the "stem" argument (e.g. `instacart`) and ite ## Getting started Here's how to get started: 1. Install with Pip: `pip install sandcastle` -2. Run `sandcastle.py` with the appropriate arguments (below) -3. Permutations which exist will be tagged as "potential matches" +2. Run `sandcastle.py` with a target name and input file (grab an example from this repo) +3. Valid bucket permutations will be identified as "matches" ``` usage: sandcastle.py [-h] -t targetStem [-f inputFile] @@ -69,7 +69,7 @@ From the Amazon [documentation](http://docs.aws.amazon.com/AmazonS3/latest/dev/U > In terms of implementation, buckets and objects are resources, and Amazon S3 provides APIs for you to manage them. ## Closing remarks -* This is my first public security project on GitHub, and is published under the MIT License. +* This is my first public security project and package; Sandcastle is published under the MIT License. * Usage acknowlegements: * Castle (icon) by Andrew Doane from the Noun Project * Nixie One (logo typeface) free by Jovanny Lemonad diff --git a/README.rst b/README.rst index b93334e..75fb683 100644 --- a/README.rst +++ b/README.rst @@ -29,9 +29,9 @@ Getting started --------------- Here's how to get started: 1. Install with Pip: -``pip install sandcastle`` 2. Run ``sandcastle.py`` with the appropriate -arguments (below) 3. Permutations which exist will be tagged as -"potential matches" +``pip install sandcastle`` 2. Run ``sandcastle.py`` with a target name +and input file (grab an example from this repo) 3. Valid bucket +permutations will be identified as "matches" :: @@ -92,8 +92,8 @@ You can then upload any number of objects to the bucket. Closing remarks --------------- -- This is my first public security project on GitHub, and is published - under the MIT License. +- This is my first public security project and package; Sandcastle is + published under the MIT License. - Usage acknowlegements: - Castle (icon) by Andrew Doane from the Noun Project - Nixie One (logo typeface) free by Jovanny Lemonad diff --git a/sandcastle.py b/sandcastle.py index de9bec5..af4ca8b 100755 --- a/sandcastle.py +++ b/sandcastle.py @@ -12,17 +12,13 @@ S3 bucket enumeration // release v1.2.3 // ysx """ # Receive – target stem and argument check -_ROOT = os.path.abspath(os.path.dirname(__file__)) -def get_data(path): - return os.path.join(_ROOT, 'data', path) -defaultFile = get_data('bucket-names.txt') targetStem = "" inputFile = "" parser = ArgumentParser() parser.add_argument("-t", "--target", dest="targetStem", help="Select a target stem name (e.g. 'instacart')", metavar="targetStem", required="True") parser.add_argument("-f", "--file", dest="inputFile", - help="Optional: select a bucket permutation file (default: bucket-names.txt)", default=defaultFile, metavar="inputFile") + help="Select a bucket permutation file (default: bucket-names.txt)", default="bucket-names.txt", metavar="inputFile") args = parser.parse_args() with open(args.inputFile, 'r') as f: bucketNames = [line.strip() for line in f] diff --git a/setup.py b/setup.py index 22f618e..7707f71 100644 --- a/setup.py +++ b/setup.py @@ -8,9 +8,6 @@ scripts=['sandcastle.py'], url = 'https://github.com/yasinS/sandcastle', download_url = 'https://github.com/yasinS/sandcastle/archive/1.2.3.tar.gz', - package_data={ - 'sandcastle': ['bucket-names.txt'], - }, keywords = ['amazons3', 'infosec', 'bucket'], classifiers=[ "License :: OSI Approved :: MIT License",