knife-tarsnap 0.1.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    knife-tarsnap (0.1.0)
+      chef (>= 0.10.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chef (11.4.0)
+      erubis
+      highline (>= 1.6.9)
+      json (>= 1.4.4, <= 1.7.7)
+      mixlib-authentication (>= 1.3.0)
+      mixlib-cli (~> 1.3.0)
+      mixlib-config (>= 1.1.2)
+      mixlib-log (>= 1.3.0)
+      mixlib-shellout
+      net-ssh (~> 2.6)
+      net-ssh-multi (~> 1.1.0)
+      ohai (>= 0.6.0)
+      rest-client (>= 1.0.4, < 1.7.0)
+      yajl-ruby (~> 1.1)
+    erubis (2.7.0)
+    highline (1.6.16)
+    ipaddress (0.8.0)
+    json (1.7.7)
+    mime-types (1.22)
+    mixlib-authentication (1.3.0)
+      mixlib-log
+    mixlib-cli (1.3.0)
+    mixlib-config (1.1.2)
+    mixlib-log (1.6.0)
+    mixlib-shellout (1.1.0)
+    net-ssh (2.6.6)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    net-ssh-multi (1.1)
+      net-ssh (>= 2.1.4)
+      net-ssh-gateway (>= 0.99.0)
+    ohai (6.16.0)
+      ipaddress
+      mixlib-cli
+      mixlib-config
+      mixlib-log
+      mixlib-shellout
+      systemu
+      yajl-ruby
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    systemu (2.5.2)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  knife-tarsnap!

data/LICENSE

@@ -0,0 +1,201 @@
+                              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 [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,249 @@
+# Chef Tarsnap
+
+Provides a chef cookbook with LWRP's to directory snapshots and maintain retention schedules. Includes a knife plugin for managing tarsnap keys, listing backups, and restoring files.
+
+
+## Installation
+
+### Cookbook Installation
+
+Install the cookbook using knife:
+
+    $ knife cookbook install tarsnap
+
+Or install the cookbook from github:
+
+    $ git clone git://github.com/jssjr/chef-tarsnap.git cookbooks/tarsnap
+    $ rm -rf cookbooks/tarsnap/.git
+
+Or use the [knife-github-cookbooks](https://github.com/websterclay/knife-github-cookbooks) plugin:
+
+    $ knife cookbook github install jssjr/chef-tarsnap
+
+
+### Knife Plugin Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knife-tarsnap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-tarsnap
+
+Alternatively, and add this line to your application's Gemfile:
+
+    gem 'chef-tarsnap', :path => 'cookbooks/tarsnap/knife-plugin'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### Backing up node data
+
+Create a recipe to define your tarnsap resources, like this:
+
+```ruby
+# my-app::backups
+
+include_recipe 'tarsnap'
+
+tarsnap_backup 'app-data' do
+  path '/opt/my_app/data'
+  schedule 'hourly'
+end
+
+tarsnap_backup 'etc-data' do
+  path [ '/etc', '/usr/local/etc' ]
+  schedule 'daily'
+end
+```
+
+The tarsnap LWRP will create an archive for each resource and will maintain a set of snapshots according to the schedule.
+
+You can use the default by including the `tarsnap::default_schedule` recipe or define your own. See the documentation for scheduling at [danrue/feather](https://github.com/danrue/feather) for more information on the rotation behavior. The default schedule is below:
+
+```ruby
+tarsnap_schedule "monthly" do
+  period 2592000 # 30 days
+  always_keep 12
+  before "0600"
+end
+
+tarsnap_schedule "weekly" do
+  period 604800 # 7 days
+  always_keep 6
+  after "0200"
+  before "0600"
+  implies "monthly"
+end
+
+tarsnap_schedule "daily" do
+  period 86400 # 1 day
+  always_keep 14
+  after "0200"
+  before "0600"
+  implies "weekly"
+end
+
+tarsnap_schedule "hourly" do
+  period 3600 # 1 hour
+  always_keep 24
+  implies "daily"
+end
+
+tarsnap_schedule "realtime" do
+  period 900 # 15 minutes
+  always_keep 10
+  implies "hourly"
+end
+```
+
+
+### Tarsnap keys
+
+Tarsnap keys are stored on the chef server in an encrypted data bag. When the tarsnap::default recipe is included in a node's run list, it will call the tarsnap_key LWRP and attempt to create the /root/tarsnap.key file. If the key is not found in the tarsnap keys data bag, then the LWRP will create a placeholder data bag item indicating the key needs to be created. The tarsnap knife plugin provides tasks to simplify key management.
+
+The format of the encrypted data bag item is:
+
+```json
+{
+  "id": "hostname_domain_tld",
+  "node": "hostname.domain.tld",
+  "key": "# START OF TARSNAP KEY FILE\ndGFyc25hcAAAAAAA..."
+}
+```
+
+
+### Configuring the tarsnap knife plugin
+
+> **NOTE** This plugin requires you to have tarsnap installed! Please see [https://www.tarsnap.com/download.html](https://www.tarsnap.com/download.html) for sources, or ask your favorite operating system's package manager.
+
+> **NOTE** Tarsnap requires an account at [tarsnap.com](http://tarsnap.com) to work. The service is frighteningly secure, lightweight, and very inexpensive.
+
+You can provide the required options for the knife plugin on the command line, or you can set them in your knife.rb file.
+
+* **Username**
+
+  command line: `-A` or `--tarsnap-username`
+
+  knife.rb: `knife[:tarsnap_username] = "root@example.com"`
+
+* **Password** (By default, knife will prompt for the password if required.)
+
+  command line: `-K` or `--tarsnap-password`
+
+  knife.rb: `knife[:tarsnap_password] = "supersecret" # Bad idea!`
+
+* **Data Bag** (By default, the keys data bag is `tarsnap_keys`)
+
+  command line: `-B` or `--tarsnap-data-bag`
+
+  knife.rb: `knife[:tarsnap_data_bag] = "tarsnap_keys"`
+
+
+### Managing keys with the knife plugin
+
+#### $ knife tarsnap key list (options)
+
+Lists all known and pending tarsnap keys.
+
+#### $ knife tarsnap key create NODE (options)
+
+Creates the tarsnap key for a node, and removes the placeholder data bag item so the node is no longer considered pending. This command will prompt for your Tarsnap password if it isn't provided as an option or in your knife.rb config file.
+
+#### $ knife tarsnap key from file KEYFILE NODE (options)
+
+Create the tarsnap key for a node by reading the key contents from a file.
+
+#### $ knife tarsnap key show NODE (options)
+
+Output the decrypted tarsnap key for a node.
+
+
+### Managing backups with the knife plugin
+
+#### $ knife tarsnap backup show NODE \[ARCHIVE\] (options)
+
+Show all of the archives that tarsnap has for a node. If the archive name is provided, then list the filenames in the archive.
+
+Example:
+
+    $ knife tarsnap backup show ip-10-72-206-146.ec2.internal                                                                                                                                     <<<
+    etc-201304070526UTC-daily
+    etc-201304070526UTC-hourly
+    etc-201304070526UTC-monthly
+    etc-201304070526UTC-realtime
+    etc-201304070526UTC-weekly
+    etc-201304070545UTC-realtime
+
+Example:
+
+    $ knife tarsnap backup show ip-10-72-206-146.ec2.internal etc-201304070526UTC-daily | head
+    etc/
+    etc/.pwd.lock
+    etc/X11/
+    etc/X11/xkb/
+    etc/acpi/
+    etc/acpi/events/
+    etc/acpi/events/powerbtn
+    etc/acpi/powerbtn.sh
+    etc/adduser.conf
+
+#### $ knife tarsnap backup download NODE ARCHIVE (options)
+
+Download an archive tarball from the tarsnap server.
+
+#### $ knife tarsnap backup dump NODE ARCHIVE PATTERN (options)
+
+Dump the contents of files in an archive that match the provided pattern to standard output. This is similar to using the tar command with an inclusion pattern. Use the `-D DIRECTORY` option to retrieve the matching files into a local directory instead.
+
+Example:
+
+    $ knife tarsnap backup dump ip-10-72-206-146.ec2.internal etc-201304070526UTC-daily 'etc/adduser.conf' | head
+    # /etc/adduser.conf: `adduser' configuration.
+    # See adduser(8) and adduser.conf(5) for full documentation.
+    
+    # The DSHELL variable specifies the default login shell on your
+    # system.
+    DSHELL=/bin/bash
+    
+    # The DHOME variable specifies the directory containing users' home
+    # directories.
+    DHOME=/home
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Author:: Scott Sanders (ssanders@taximagic.com)
+
+Copyright:: Copyright (c) 2013 RideCharge, Inc.
+
+License:: Apache License, Version 2.0
+
+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.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/knife-tarsnap.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/knife-tarsnap/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "knife-tarsnap"
+  gem.version       = Knife::Tarsnap::VERSION
+  gem.authors       = ["Scott Sanders"]
+  gem.email         = ["ssanders@taximagic.com"]
+  gem.description   = %q{Knife plugin and Chef cookbook for managing tarsnap.}
+  gem.summary       = %q{Provides a chef cookbook with LWRP's to directory snapshots and maintain retention schedules. Includes a knife plugin for managing tarsnap keys, listing backups, and restoring files.}
+  gem.homepage      = "https://github.com/jssjr/chef-tarsnap"
+  gem.licenses      = ["APACHE"]
+
+  gem.files         = Dir['lib/**/*.rb'] + Dir['bin/*']
+  gem.files        += Dir['[A-Z]*'] + Dir['test/**/*']
+  gem.files        += Dir['*\.gemspec']
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency "chef", ">= 0.10.10"
+
+  gem.require_paths = ["lib"]
+end

data/lib/chef/knife/tarsnap/core.rb

@@ -0,0 +1,146 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+class Chef
+  class Knife
+    class Tarsnap
+      module Core
+
+        # :nodoc:
+        # Would prefer to do this in a rational way, but can't be done b/c of
+        # Mixlib::CLI's design :(
+        def self.included(includer)
+          includer.class_eval do
+
+            deps do
+              require 'chef/knife'
+              require 'chef/shell/ext'
+              Chef::Knife.load_deps
+            end
+
+            option :tarsnap_username,
+              :short => "-A USERNAME",
+              :long => "--tarsnap-username KEY",
+              :description => "Your Tarsnap Username",
+              :proc => Proc.new { |key| Chef::Config[:knife][:tarsnap_username] = key }
+
+            option :tarsnap_password,
+              :short => "-K SECRET",
+              :long => "--tarsnap-password SECRET",
+              :description => "Your Tarsnap Password",
+              :proc => Proc.new { |key| Chef::Config[:knife][:tarsnap_password] = key }
+
+            option :tarsnap_data_bag,
+              :short => "-B BAG_NAME",
+              :long => "--tarsnap-data-bag BAG_NAME",
+              :description => "The data bag containing Tarsnap keys",
+              :proc => Proc.new { |key| Chef::Config[:knife][:tarsnap_data_bag] = key },
+              :default => "tarsnap_keys"
+
+          end
+        end
+
+        # Convenience methods for options
+
+        def tarsnap_username
+          if Chef::Config[:knife][:tarsnap_username]
+            Chef::Config[:knife][:tarsnap_username]
+          else
+            raise StandardError, "Please provide the tarsnap account username"
+          end
+        end
+
+        def tarsnap_password
+          if Chef::Config[:knife][:tarsnap_password].nil?
+            Chef::Config[:knife][:tarsnap_password] = ui.ask('Tarsnap Password: ') { |q| q.echo = '*' }
+          end
+          Chef::Config[:knife][:tarsnap_password]
+        end
+
+        def tarsnap_data_bag
+          Chef::Config[:knife][:tarsnap_data_bag] || config[:tarsnap_data_bag]
+        end
+
+        # Required tools
+
+        def keygen_tool
+          @_keygen_path || @_keygen_path = which('tarsnap-keygen')
+        end
+
+        def tarsnap_tool
+          @_tarsnap_path || @_tarsnap_path = which('tarsnap')
+        end
+
+        # Helpers
+
+        def canonicalize(fqdn)
+          fqdn.gsub(".","_")
+        end
+
+        def pending_nodes
+          @_pending_nodes || @_pending_nodes = Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k =~ /^__/}.map{|k,v| k.gsub(/^__/, '').gsub("_",".")}
+        end
+
+        def tarsnap_nodes
+          @_tarsnap_nodes || @_tarsnap_nodes = Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k !~ /^__/}.map{|k,v| k.gsub("_",".")}
+        end
+
+        def fetch_node(fqdn)
+          Shell::Extensions.extend_context_object(self)
+          nodes.find("fqdn:#{fqdn}").first
+        end
+
+        def fetch_key(fqdn)
+          bag_item = fetch_tarsnap_bag_item(fqdn)
+          if bag_item
+            bag_item['key']
+          else
+            nil
+          end
+        end
+
+        def is_a_tarsnap_node?(fqdn)
+          tarsnap_nodes.include?(fqdn)
+        end
+
+        def remove_pending_node(fqdn)
+          rest.delete_rest("data/#{tarsnap_data_bag}/__#{canonicalize(fqdn)}")
+        end
+
+        private
+
+        def which(binary)
+          which_cmd = "which #{binary}"
+          which_shell = Mixlib::ShellOut.new(which_cmd)
+          which_shell.run_command
+          unless which_shell.status.exitstatus == 0
+            raise StandardError, "Unable to locate the tarsnap tool (#{binary}). Is it installed and in your path?"
+          end
+          which_shell.stdout.chomp
+        end
+
+        def fetch_tarsnap_bag_item(fqdn)
+          begin
+            Chef::EncryptedDataBagItem.load(tarsnap_data_bag, canonicalize(fqdn))
+          rescue Net::HTTPServerException => e
+            nil
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/chef/knife/tarsnap_backup_download.rb

@@ -0,0 +1,69 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapBackupDownload < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap backup download NODE ARCHIVE (options)"
+
+      option :save_to,
+        :short => "-S TARBALL",
+        :long => "--save-to TARBALL",
+        :description => "Retrieves the archive tarball into the specific file"
+
+      def run
+
+        unless name_args.size == 2
+          ui.fatal "Must provide only NODE and ARCHIVE."
+          exit 1
+        end
+
+        node_name = name_args[0]
+        archive_name = name_args[1]
+
+        tarball = config[:save_to] || File.join(Dir.pwd, "#{archive_name}.tar")
+
+        if File.exists?(tarball)
+          ui.warn "A file named #{tarball} already exists. Do you want to overwrite it?"
+          ui.confirm "Overwrite"
+        end
+
+        Tempfile.open('tarsnap', '/tmp') do |f|
+          key = fetch_key(node_name)
+          f.write(key)
+          f.close
+
+          list_cmd = "#{tarsnap_tool} --keyfile #{f.path} -r -f #{archive_name} > #{tarball}"
+
+          ui.msg "Downloading #{tarball}..."
+          list_shell = Mixlib::ShellOut.new(list_cmd, :timeout => 604800)
+          list_shell.run_command
+          unless list_shell.status.exitstatus == 0
+            raise StandardError, "tarsnap error: #{list_shell.stderr}"
+          end
+          ui.msg "#{tarball} saved."
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_backup_dump.rb

@@ -0,0 +1,65 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapBackupDump < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap backup dump NODE ARCHIVE PATTERN (options)"
+
+      option :directory,
+        :short => "-D USERNAME",
+        :long => "--directory KEY",
+        :description => "Retrieve matching files into this local directory"
+
+      def run
+
+        if name_args.size == 3
+          node_name = name_args[0]
+          archive_name = name_args[1]
+          filename = name_args.last
+        else
+          ui.fatal "Incorrect number of options provided"
+          exit 1
+        end
+
+        Tempfile.open('tarsnap', '/tmp') do |f|
+          key = fetch_key(node_name)
+          f.write(key)
+          f.close
+
+          if config[:directory]
+            dump_cmd = "#{tarsnap_tool} --keyfile #{f.path} -x -f #{archive_name} -C #{config[:directory]} --include '#{filename}'"
+          else
+            dump_cmd = "#{tarsnap_tool} --keyfile #{f.path} -x -f #{archive_name} -O --include '#{filename}'"
+          end
+          dump_shell = Mixlib::ShellOut.new(dump_cmd, :timeout => 604800, :environment => {'LC_ALL'=>nil})
+          dump_shell.run_command
+          unless dump_shell.status.exitstatus == 0
+            raise StandardError, "tarsnap error: #{dump_shell.stderr}"
+          end
+          ui.msg dump_shell.stdout
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_backup_show.rb

@@ -0,0 +1,62 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapBackupShow < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap backup show NODE [ARCHIVE] (options)"
+
+      def run
+
+        node_name = name_args.first
+        if name_args.size == 2
+          archive_name = name_args.last
+        elsif name_args.size == 1
+          archive_name = nil
+        else
+          ui.fatal "Must provide only NODE and an option ARCHIVE."
+          exit 1
+        end
+
+        Tempfile.open('tarsnap', '/tmp') do |f|
+          key = fetch_key(node_name)
+          f.write(key)
+          f.close
+
+          if archive_name.nil?
+            list_cmd = "#{tarsnap_tool} --keyfile #{f.path} --list-archives" 
+          else
+            list_cmd = "#{tarsnap_tool} -t --keyfile #{f.path} -f #{archive_name}"
+          end
+
+          list_shell = Mixlib::ShellOut.new(list_cmd, :environment => {'LC_ALL'=>nil})
+          list_shell.run_command
+          unless list_shell.stderr.empty?
+            raise StandardError, "tarsnap error: #{list_shell.stderr}"
+          end
+          list_shell.stdout.split("\n").sort.each { |l| ui.msg l }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_key_create.rb

@@ -0,0 +1,83 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapKeyCreate < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap key create NODE (options)"
+
+      def run
+
+        unless name_args.size == 1
+          ui.fatal "You must provide a node name"
+          exit 1
+        end
+
+        n = name_args.last
+
+        match = fetch_node(n)
+        unless match.is_a? Chef::Node
+          ui.fatal "#{n} is not a node. Skipping..."
+          exit 1
+        end
+
+        existing_key = fetch_key(n)
+        if existing_key
+          ui.warn "A key for #{n} already exists! Overwrite it with a new key?"
+          ui.warn "The old key will be saved to #{ENV['HOME']}/tarsnap.#{n}.key.old"
+          ui.confirm "Overwrite"
+          IO.write("#{ENV['HOME']}/tarsnap.#{n}.key.old", existing_key)
+        end
+
+        begin
+          keyfile = File.join('/tmp', "tarsnap-#{rand(36**8).to_s(36)}")
+          keygen_cmd = "echo '#{tarsnap_password}' | #{keygen_tool} --keyfile #{keyfile} --user #{tarsnap_username} --machine #{n}"
+          keygen_shell = Mixlib::ShellOut.new(keygen_cmd)
+          keygen_shell.run_command
+          unless keygen_shell.stderr.empty?
+            raise StandardError, "tarsnap-keygen error: #{keygen_shell.stderr}"
+          end
+
+          ui.info "Creating data bag #{tarsnap_data_bag}/#{canonicalize(n)}"
+          data = { "id" => canonicalize(n), "node" => n, "key" => IO.read(keyfile) }
+          secret = Chef::EncryptedDataBagItem.load_secret(config[:secret_file])
+          item = Chef::EncryptedDataBagItem.encrypt_data_bag_item(data, secret)
+          data_bag = Chef::DataBagItem.new
+          data_bag.data_bag(tarsnap_data_bag)
+          data_bag.raw_data = item
+          data_bag.save
+
+          remove_pending_node(n)
+
+          ui.info ui.color("Data bag created!", :green)
+        rescue Exception => e
+          ui.msg "Error: #{e}"
+          ui.warn ui.color("Key creation failed!", :red)
+          exit 1
+        ensure
+          File.unlink(keyfile) if File.exists?(keyfile)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_key_from_file.rb

@@ -0,0 +1,73 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapKeyFromFile < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap key from file KEYFILE NODE (options)"
+
+      def run
+
+        unless name_args.size == 2
+          ui.fatal "You must provide a key file and a node name"
+          exit 1
+        end
+
+        k = name_args.first
+        n = name_args.last
+
+        match = fetch_node(n)
+        unless match.is_a? Chef::Node
+          ui.fatal "#{n} is not a node. Skipping..."
+          exit 1
+        end
+
+        existing_key = fetch_key(n)
+        if existing_key
+          ui.warn "A key for #{n} already exists! Overwrite it with a new key?"
+          ui.warn "The old key will be saved to #{ENV['HOME']}/tarsnap.#{n}.key.old"
+          ui.confirm "Continue"
+          IO.write("#{ENV['HOME']}/tarsnap.#{n}.key.old", existing_key)
+        end
+
+        begin
+          data = { "id" => canonicalize(n), "node" => n, "key" => IO.read(k) }
+          secret = Chef::EncryptedDataBagItem.load_secret(config[:secret_file])
+          item = Chef::EncryptedDataBagItem.encrypt_data_bag_item(data, secret)
+          data_bag = Chef::DataBagItem.new
+          data_bag.data_bag(tarsnap_data_bag)
+          data_bag.raw_data = item
+          data_bag.save
+
+          remove_pending_node(n)
+
+          ui.info ui.color("Data bag created from file!", :green)
+        rescue Exception => e
+          ui.msg "Error: #{e}"
+          ui.warn ui.color("Key creation failed!", :red)
+          exit 1
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_key_list.rb

@@ -0,0 +1,41 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapKeyList < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap key list (options)"
+
+      def run
+
+        ui.msg ui.color('status      node', :bold)
+        tarsnap_nodes.each do |n|
+          ui.msg "#{ui.color('registered  ', :green)}#{n}"
+        end
+        pending_nodes.each do |n|
+          ui.msg "#{ui.color('pending     ', :yellow)}#{n}"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef/knife/tarsnap_key_show.rb

@@ -0,0 +1,42 @@
+# Author:: Scott Sanders (ssanders@taximagic.com)
+# Copyright:: Copyright (c) 2013 RideCharge, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+require 'chef/knife/tarsnap/core'
+
+class Chef
+  class Knife
+    class TarsnapKeyShow < Knife
+
+      include Knife::Tarsnap::Core
+
+      banner "knife tarsnap key show NODE (options)"
+
+      def run
+
+        unless name_args.size == 1
+          ui.fatal "You must provide a node name"
+          exit 1
+        end
+
+        n = name_args.first
+
+        ui.msg fetch_key(n)
+
+      end
+
+    end
+  end
+end

data/lib/knife-tarsnap/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Tarsnap
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: knife-tarsnap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+description: Knife plugin and Chef cookbook for managing tarsnap.
+email:
+- ssanders@taximagic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chef/knife/tarsnap/core.rb
+- lib/chef/knife/tarsnap_backup_download.rb
+- lib/chef/knife/tarsnap_backup_dump.rb
+- lib/chef/knife/tarsnap_backup_show.rb
+- lib/chef/knife/tarsnap_key_create.rb
+- lib/chef/knife/tarsnap_key_from_file.rb
+- lib/chef/knife/tarsnap_key_list.rb
+- lib/chef/knife/tarsnap_key_show.rb
+- lib/knife-tarsnap/version.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- README.md
+- knife-tarsnap.gemspec
+homepage: https://github.com/jssjr/chef-tarsnap
+licenses:
+- APACHE
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides a chef cookbook with LWRP's to directory snapshots and maintain
+  retention schedules. Includes a knife plugin for managing tarsnap keys, listing
+  backups, and restoring files.
+test_files: []
+has_rdoc: