cifrado 0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.swp
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Cifrado 0.1 - Sun 03 Mar 2013
+
+* Uploading/downloading files and directories to OpenStack Swift.
+* Asymmetric/Symmetric transparent encryption/decryption of files
+  when uploading/downloading using GnuPG.
+* Segmented uploads (splitting the file in multiple segments).
+* Resume (unencrypted) segmented uploads. Segments already uploaded
+  are not uploaded again. This feature does not work when using
+  file encryption at the moment.
+* Different progressbar styles. CLI does not have to be boring :).
+* Bandwidth limits when uploading/downloading stuff.
+* Music streaming (streams mp3/ogg files available in a container).
+  and plays them using mplayer if available).
+* Regular list/delete/stat commands.
+* Video streaming (streams video files available in a container).
+* Bootstrap a Swift All-In-One server in a cloud provider
+  (DigitalOcean is the only one supported ATM).
+* Ruby 1.8.7, 1.9.X and 2.0 compatibility.
+
+
+```
+SLOC  Directory SLOC-by-Language (Sorted)
+1978    lib             ruby=1663,sh=315
+918     tests           ruby=918
+5       bin             ruby=5
+
+
+Totals grouped by language (dominant language first):
+ruby:          2586 (89.14%)
+sh:             315 (10.86%)
+
+
+
+
+Total Physical Source Lines of Code (SLOC)                = 2,901
+Development Effort Estimate, Person-Years (Person-Months) = 0.61 (7.34)
+ (Basic COCOMO model, Person-Months = 2.4 * (KSLOC**1.05))
+Schedule Estimate, Years (Months)                         = 0.44 (5.33)
+ (Basic COCOMO model, Months = 2.5 * (person-months**0.38))
+Estimated Average Number of Developers (Effort/Schedule)  = 1.38
+Total Estimated Cost to Develop                           = $ 82,664
+ (average salary = $56,286/year, overhead = 2.40).
+SLOCCount, Copyright (C) 2001-2004 David A. Wheeler
+```

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cifrado.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergio Rubio
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,247 @@
+# Cifrado
+
+**WARNING** 
+
+The current Cifrado release is experimental. Use at your own risk.
+
+OpenStack Swift CLI with built in (GPG) encryption.
+
+## Features available in Cifrado 0.1
+
+* Uploading/downloading files and directories to/from OpenStack Swift.
+* Regular list/delete/stat commands to manipulate objects and containers.
+* Asymmetric/Symmetric transparent encryption/decryption of files
+  when uploading/downloading using GnuPG.
+* Segmented uploads (splitting the file in multiple segments).
+* Resume (unencrypted) segmented uploads. Segments already uploaded
+  are not uploaded again. This feature does not work when using
+  file encryption at the moment.
+* Different progressbar styles. CLI does not have to be boring :).
+* Bandwidth limits when uploading/downloading stuff.
+* Music streaming (streams mp3/ogg files available in a container)
+  and plays them using mplayer/vlc/totem if available.
+* Video streaming (streams video files available in a container).
+* Bootstrap a Swift All-In-One server in a cloud provider
+  (DigitalOcean is the only one supported ATM).
+* Ruby 1.8.7, 1.9.X and 2.0 compatibility.
+
+Cifrado has a built-in help command:
+
+```
+Tasks:
+  cifrado cinema CONTAINER VIDEO              # Stream videos from the target container
+  cifrado delete CONTAINER [OBJECT]           # Delete specific container or object
+  cifrado download [CONTAINER] [OBJECT]       # Download container, objects
+  cifrado help [TASK]                         # Describe available tasks or one specifi...
+  cifrado jukebox CONTAINER                   # Play music randomly from the target con...
+  cifrado list [CONTAINER]                    # List containers and objects
+  cifrado post CONTAINER [DESCRIPTION]        # Create a container
+  cifrado saio SUBCOMMAND ...ARGS             # Bootstrap a Swift installation
+  cifrado set-acl CONTAINER --acl=ACL         # Set an ACL on containers and objects
+  cifrado setup                               # Initial Cifrado configuration
+  cifrado stat [CONTAINER] [OBJECT]           # Displays information for the account, c...
+  cifrado upload CONTAINER FILE1 [FILE2] ...  # Upload files or directories
+
+Options:
+  [--username=USERNAME]  
+  [--quiet=QUIET]        
+  [--password=PASSWORD]  
+  [--auth-url=AUTH_URL]  
+  [--tenant=TENANT]      
+  [--config=CONFIG]      
+  [--region=REGION]      
+  [--insecure]           # Insecure SSL connections
+  [--debug]              
+```
+
+## Installation
+
+### Installing the Ubuntu packages (recommended)
+
+Ubuntu packages are available in Cifrado's PPA for Ubuntu
+Precise (12.04), Quantal (12.10) and Raring Ringtail (13.04).
+
+To add the PPA and install the packages, open a terminal and type:
+
+```
+sudo add-apt-repository ppa:rubiojr/cifrado
+sudo apt-get update
+sudo apt-get install cifrado
+```
+
+You'll also need GnuPG and MPlayer installed if you want to have
+music streaming and encryption support enabled in Cifrado
+(GnuPG and the agent is pre-installed in a regular Ubuntu 
+installation):
+
+    sudo apt-get install mplayer gnupg gnupg-agent
+
+### Installing via rubygems
+
+Needs rubygems and ruby available in your system.
+
+Ubuntu installation:
+
+    sudo apt-get install ruby rubygems
+
+Install the gem:
+
+    sudo gem install cifrado
+
+## Basic usage
+
+### Setting up Cifrado for the first time
+
+If you already have a Swift installation running,
+you can use 'cifrado setup' to configure Cifrado for the first time.
+
+Note that it's not strictly required to save the options or running the
+setup process. If you do so, you'll not be asked for the username,
+password, auth_url and other parameters required to run Cifrado.
+
+The setup command will ask you the OpenStack Swift authentication 
+information:
+
+    $ cifrado setup
+    Running cifrado setup...
+    Please provide OpenStack/Rackspace credentials.
+    
+    Cifrado can save this settings in /home/rubiojr/.config/cifrado/cifradorc
+    for later use.
+    The settings (password included) are saved unencrypted.
+    
+    Username: user
+    Tenant: my_tenant
+    Password: 
+    Auth URL: https://identity.example.net/v2.0/tokens
+    Do you want to save these settings? (y/n)  
+
+There's an alternative way to setup cifrado and provision a Swift All-In-One
+server for testing and/or personal use. Head over to the Wiki for more
+details.
+
+### Uploading/Downloading files with Cifrado
+
+#### Uploading files
+
+Uploading a single file, LICENSE.txt, to container 'test':
+
+```
+$ cifrado upload test LICENSE.txt
+
+Uploading LICENSE.txt (1.04 KB)
+[0.00 Mb/s] Progress: |=====================| 100% [Time: 00:00:02 ]
+```
+
+Uploading a directory (recursively) to container 'test':
+
+```
+$ cifrado upload test tmp
+
+Uploading tmp/LICENSE.txt (1.04 KB)
+ [0.00 Mb/s] Progress: |=====================| 100% [Time: 00:00:02 ]
+Uploading tmp/cifrado.gemspec (1.14 KB)
+ [0.00 Mb/s] Progress: |=====================| 100% [Time: 00:00:02 ]
+```
+
+Limiting upload speed with --bwlimit:
+
+```
+$ cifrado upload --bwlimit 0.10 test pkg/cifrado-0.1.gem
+
+Uploading pkg/cifrado-0.1.gem (163.00 KB)
+ [0.09 Mb/s] Progress: |=====================| 100% [Time: 00:00:14 ]
+```
+
+The bwlimit data rate unit is Mb/s. The same --bwlimit option can
+be used when downloading files.
+
+Uploading big files using segments:
+
+```
+$ cifrado upload --segments 3 test pkg/cifrado-0.1.gem 
+Segmenting file, 3 segments...
+Uploading cifrado-0.1.gem segments
+Uploading segment 1/3 (56.00 KB)
+ [0.00 Mb/s] Segment [1/3]: |================| 100% [Time: 00:00:02 ]
+Uploading segment 2/3 (56.00 KB)
+ [0.00 Mb/s] Segment [2/3]: |================| 100% [Time: 00:00:02 ]
+Uploading segment 3/3 (51.00 KB)
+ [0.00 Mb/s] Segment [3/3]: |================| 100% [Time: 00:00:03 ]
+```
+
+Note that segments are automatically reassembled by Swift when you
+download the object. That is, to download cifrado-0.1.gem from the
+test container, download it like any other regular object.
+
+#### Downloading files
+
+#### Encryption support
+
+**Symmetric Encryption**
+
+    cifrado upload --insecure \
+                   --encrypt symmetric \
+                   my-container audio.mp3
+
+Cifrado will ask you for the password.
+
+You could also specify the password as an argument (not recommended):
+
+    cifrado upload --insecure \
+                   --encrypt s:foobar \
+                   my-container audio.mp3
+
+**Asymmetric Encryption ('Traditional' GPG encryption)**
+
+    cifrado upload --insecure \
+                   --encrypt a:rubiojr@frameos.org \
+                   my-container audio.mp3
+
+Or using the key ID:
+
+    cifrado upload --insecure \
+                   --encrypt a:F345BE74 \
+                   my-container audio.mp3
+
+#### Streaming the music available in a container
+
+Needs mplayer installed:
+
+    sudo apt-get install mplayer
+
+Play the files available in the 'music' container:
+
+```
+$ cifrado jukebox music
+
+Cifrado Jukebox
+---------------
+
+Ctrl-C once   -> next song
+Ctrl-C twice  -> quit
+
+Playing song
+  * spotify/Los Lobos/La Bamba.ogg
+```
+
+## Advanced usage
+
+There's some extra documentation available in the project's wiki.
+
+Head over to https://github.com/rubiojr/cifrado/wiki to learn about
+Cifrado.
+
+## Known issues
+
+* Foo
+* Bar
+* A lot of them
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/RELEASE.md

@@ -0,0 +1,10 @@
+Releasing a new version to rubygems.org
+
+* shindo tests/
+* Bump lib/cifrado/version.rb
+* Update CHANGELOG
+* Update README if required
+* Commit changes
+* Tag version
+* rake build
+* Push to rubygem 

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'fileutils'
+require './lib/cifrado/version.rb'
+
+PROJECT = 'cifrado'
+PROJECT_VERSION = Cifrado::VERSION
+
+task :deb, :destdir do |t, args|
+  destdir = (args[:destdir] || '/tmp')
+  FileUtils.mkdir_p(destdir) unless File.directory?(destdir)
+  pwd = Dir.pwd
+  Dir.chdir '../'
+  system "tar --exclude #{PROJECT}/.git --exclude #{PROJECT}/exclude --exclude " + \
+         "#{PROJECT}/debian " + \
+         "-czf #{destdir}/#{PROJECT}_#{PROJECT_VERSION}.orig.tar.gz " + \
+         "#{PROJECT}"
+  Dir.chdir "#{destdir}"
+  system "tar xzf #{PROJECT}_#{PROJECT_VERSION}.orig.tar.gz"
+  Dir.chdir pwd
+  system "cp -r debian #{destdir}/#{PROJECT}/"
+end

data/TODO.md

@@ -0,0 +1,6 @@
+* Cifrado::CLI needs heavy refactoring
+* Graceful exits (i.e. when hitting Ctrl-C)
+* Uploads with progressbar are very inefficient under ruby 1.8 
+  (1.9 is slightly better)
+* High CPU utilisation when uplading at high speed
+* Implement 'swift style' segmented uploads

data/bin/cifrado

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'cifrado'
+require 'yaml'
+require 'uri'
+
+$0 = "cifrado #{ARGV.join(' ')}"
+Cifrado::CLI.start ARGV, :shell => Thor::Shell::Color.new

data/cifrado.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cifrado/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cifrado"
+  gem.version       = Cifrado::VERSION
+  gem.authors       = ["Sergio Rubio"]
+  gem.signing_key   = File.expand_path("~/.gem/gem-private_key.pem")
+  gem.cert_chain    = ["gem-public_cert.pem"]
+  gem.email         = ["rubiojr@frameos.org"]
+  gem.description   = %q{OpenStack Swift CLI with encryption support}
+  gem.summary       = %q{OpenStack Swift CLI with encryption support}
+  gem.homepage      = "http://rubiojr.github.com/cifrado"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'excon'
+  gem.add_dependency 'thor', '>= 0.17'
+  gem.add_dependency 'ruby-progressbar'
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'mime-types'
+  gem.add_dependency 'yajl-ruby'
+  gem.add_dependency 'formatador'
+  gem.add_dependency 'shexy'
+  
+  gem.add_development_dependency 'shindo'
+end

data/gem-public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDNDCCAhygAwIBAgIBADANBgkqhkiG9w0BAQUFADBAMRAwDgYDVQQDDAdydWJp
+b2pyMRcwFQYKCZImiZPyLGQBGRYHZnJhbWVvczETMBEGCgmSJomT8ixkARkWA29y
+ZzAeFw0xMzAyMTIyMDU0NTFaFw0xNDAyMTIyMDU0NTFaMEAxEDAOBgNVBAMMB3J1
+YmlvanIxFzAVBgoJkiaJk/IsZAEZFgdmcmFtZW9zMRMwEQYKCZImiZPyLGQBGRYD
+b3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6gSsIib3HHQ87Dsu
+9EZzKMk2oswglzatmxIbCKXTCflTFd7U4I3sinGCOPdkRmqf9vjJSv2ppFnq8D/J
+flUrqpvqnDSGWW4mHdCXGGkbgsmNGV2d3AYGC1fhstBTxJIvQaDibxrH5IIqBtNN
+wBGrOVuSb1HjqPpp+5MKcQdqYT4GW1rZkeV4FYXg+SThwjx+AlmvUKmMT9cmB2Ml
+JWpId4O027AjcdmOk1s1ZMIlr+ZzV0EDmqPyNFmxZm72QUsywijM9B76eVC5sdOH
+JKZK75oXtz0Pr++MYTlNaXHu98RzgMyOzLHM5LRCZg1f/zB9NbI2Fqm7IIfKpz0e
+9KGBFQIDAQABozkwNzAJBgNVHRMEAjAAMB0GA1UdDgQWBBSO48JZEE9yvI13QfH2
+UVEWt45QaTALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQADggEBABTq7sClnZ83
+ZeGgOUKMYq7/I5gGgZHyjIcuceMuVlhVWcjrxC1Fn7eqCZupAfveoxiNrWROmZ3C
+26+nSlwMVQub9ruoGwejS1PSEBrtR56sZ78WNwUMogjzPUzDDgHZgDMneKLytSco
+ustJSPP8wjxoV+59JuIFY8oqFy3B0o9b7WU59RNwqdauaWye1JEWr5c18dM8VJKC
+9gNNNiwrh1Q5Q3HwjjeNlUjGZmQcgceG4Xdoox89/HNm5by83mHknD++tqwa2n8F
+/Nnaz9wOXu6/VjBcnvFOGY8f32hVq619QiJVpV9zRgYa5M05mWRmwHByrb4yK0Ab
+3GpyuMMNBMk=
+-----END CERTIFICATE-----