zanzibar 0.1.9 → 0.1.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGVkMGM2YjU2MjA3YTAyZjQ2NDBkZTUxNjkzZTdhZDk1NGFmMjdmZg==
+    Y2NmMTgxMGFhODNjYWQ4MWNmNjY3MWFjZWZiMGYyZjIzMzgwYzc1Yw==
   data.tar.gz: !binary |-
-    OGVkZTA1ZjljMjVkYTA1MzMwMTRiODIzYmM1NzBiODQzMmRiMWU1OQ==
+    ZDZhYThhNTk3MTk4MTc1MzJjYjlhMDQzMzI1YmI1Yjc3MTZlNDJkZg==
 SHA512:
   metadata.gz: !binary |-
-    MmJhMzQ3NDczMTU0YWQyNTIwODJmNjAzNzg4MDBjY2M3NDM3ODY2N2MwOGY4
-    MWE1NTMwNjBlYmIyYTdmMGM3NDBkNjg5MzE0N2I5YTJmMjAzOTFjNmRlZWI5
-    MTE2YjJjY2IzOTViMzhkNDEwOTllMDE1MzFkN2NhODBkMzc3MmU=
+    Y2Y3NDM5M2E3MDM3NTZkOGE4OWQ0YTZkZThhNmMxNjcxNzU3MjcwNTEzYzAw
+    MWNlNGY3MTdmODdjZGIxY2VjMzliM2JlYzJlYTZjMzQ1YTBmYTkxYzZjYmNi
+    ZDIzNzIzZGEwNWQwMDczMjVjY2JkOTE1Nzk5N2RmM2MzODIxNDE=
   data.tar.gz: !binary |-
-    YjMwMjI1YzhkOThjN2FhMGFjZjYyZjY4MmJmODY2MmU1NzY5MjU2NGJmMjBi
-    ZTAwYmQ3NWY5OGU4NzQxMjZiZjkyOWVkMGI0MmFkNDg4NGEwOWJlNGJhODk2
-    Zjc2NjUyYmE0MDk1YjM2YzZiZDFjOTA4MzQ0OTJmZWJlMGMzN2U=
+    ZGFkNDI2NDNlMjBiZDI4ZjYzNDdlMzZkMmE4ZGI1NDc4MTk0ZjRmODMyZWU5
+    NDdhOTg4NjA3YTNiMDg1MDhlYjRhMWVkODI3NzM1NTc4MmQ0MGMyNDM4OGJk
+    YjA3YzVmODI5YzkxZDU0NzMyYzM5MDQ2NTcxNTg1YmVlY2FlZTk=

data/lib/zanzibar.rb

@@ -1,210 +1,188 @@
-require "zanzibar/version"
-require 'savon'
-require 'io/console'
-require 'fileutils'
-
-module Zanzibar
-
-  ##
-  # Class for interacting with Secret Server
-  class Zanzibar
-
-    ##
-    # @param args{:domain, :wsdl, :pwd, :username, :globals{}}
-
-    def initialize(args = {})
-
-      if args[:username]
-        @@username = args[:username]
-      else
-        @@username = ENV['USER']
-      end
-
-      if args[:wsdl]
-        @@wsdl = args[:wsdl]
-      else
-        @@wsdl = get_wsdl_location
-      end
-      if args[:pwd]
-          @@password = args[:pwd]
-      else
-        @@password = prompt_for_password
-      end
-      if args[:domain]
-        @@domain = args[:domain]
-      else
-        @@domain = prompt_for_domain
-      end
-      args[:globals] = {} unless args[:globals]
-      init_client(args[:globals])
-    end
-
-    ## Initializes the Savon client class variable with the wdsl document location and optional global variables
-    # @param globals{}, optional
-
-    def init_client(globals = {})
-      globals = {} if globals == nil
-      @@client = Savon.client(globals) do
-        wsdl @@wsdl
-      end
-    end
-
-    ## Gets the user's password if none is provided in the constructor.
-    # @return [String] the password for the current user
-
-    def prompt_for_password
-      puts "Please enter password for #{@@username}:"
-      return STDIN.noecho(&:gets).chomp
-    end
-
-    ## Gets the wsdl document location if none is provided in the constructor
-    # @return [String] the location of the WDSL document
-
-    def get_wsdl_location
-      puts "Enter the URL of the Secret Server WSDL:"
-      return STDIN.gets.chomp
-    end
-
-    ## Gets the domain of the Secret Server installation if none is provided in the constructor
-    # @return [String] the domain of the secret server installation
-
-    def prompt_for_domain
-      puts "Enter the domain of your Secret Server:"
-      return STDIN.gets.chomp
-    end
-
-
-    ## Get an authentication token for interacting with Secret Server. These are only good for about 10 minutes so just get a new one each time.
-    # Will raise an error if there is an issue with the authentication.
-    # @return the authentication token for the current user.
-
-    def get_token
-      begin
-        response = @@client.call(:authenticate, message: { username: @@username, password: @@password, organization: "", domain: @@domain }).hash
-        if response[:envelope][:body][:authenticate_response][:authenticate_result][:errors]
-          raise "Error generating the authentication token for user #{@@username}: #{response[:envelope][:body][:authenticate_response][:authenticate_result][:errors][:string]}"
-        end
-        response[:envelope][:body][:authenticate_response][:authenticate_result][:token]
-      rescue Savon::Error => err
-        raise "There was an error generating the authentiaton token for user #{@@username}: #{err}"
-      end
-    end
-
-    ## Get a secret returned as a hash
-    # Will raise an error if there was an issue getting the secret
-    # @param [Integer] the secret id
-    # @return [Hash] the secret hash retrieved from the wsdl
-
-    def get_secret(scrt_id, token = nil)
-      begin
-        secret = @@client.call(:get_secret, message: { token: token || get_token, secretId: scrt_id}).hash
-        if secret[:envelope][:body][:get_secret_response][:get_secret_result][:errors]
-          raise "There was an error getting secret #{scrt_id}: #{secret[:envelope][:body][:get_secret_response][:get_secret_result][:errors][:string]}"
-        end
-        return secret
-      rescue Savon::Error => err
-        raise "There was an error getting the secret with id #{scrt_id}: #{err}"
-      end
-    end
-
-    ## Retrieve a simple password from a secret
-    # Will raise an error if there are any issues
-    # @param [Integer] the secret id
-    # @return [String] the password for the given secret
-
-    def get_password(scrt_id)
-      begin
-        secret = get_secret(scrt_id)
-        secret_items = secret[:envelope][:body][:get_secret_response][:get_secret_result][:secret][:items][:secret_item]
-        return get_secret_item_by_field_name(secret_items,"Password")[:value]
-      rescue Savon::Error => err
-        raise "There was an error getting the password for secret #{scrt_id}: #{err}"
-      end
-    end
-
-    def get_secret_item_by_field_name(secret_items, field_name)
-      secret_items.each do |item|
-        return item if item[:field_name] == field_name
-      end
-    end
-
-    ## Get the secret item id that relates to a key file or attachment.
-    # Will raise on error
-    # @param [Integer] the secret id
-    # @param [String] the type of secret item to get, one of privatekey, publickey, attachment
-    # @return [Integer] the secret item id
-
-    def get_scrt_item_id(scrt_id, type, token)
-      secret = get_secret(scrt_id, token)
-      secret_items = secret[:envelope][:body][:get_secret_response][:get_secret_result][:secret][:items][:secret_item]
-      begin
-        return get_secret_item_by_field_name(secret_items, type)[:id]
-      rescue
-        raise "Unknown type, #{type}."
-      end
-    end
-
-    ## Downloads the private key for a secret and places it where Zanzibar is running, or :path if specified
-    # Raise on error
-    # @param [Hash] args, :scrt_id, :scrt_item_id - optional, :path - optional
-
-    def download_private_key(args = {})
-      token = get_token
-      FileUtils.mkdir_p(args[:path]) if args[:path]
-      path = args[:path] ? args[:path] : '.' ## The File.join below doesn't handle nils well, so let's take that possibility away.
-      begin
-        response = @@client.call(:download_file_attachment_by_item_id, message: { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], 'Private Key', token)}).hash
-        if response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:errors]
-          raise "There was an error getting the private key for secret #{args[:scrt_id]}: #{response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:string]}"
-        end
-        File.open(File.join(path, response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_name]), 'wb') do |file|
-          file.puts Base64.decode64(response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_attachment])
-        end
-      rescue Savon::Error => err
-        raise "There was an error getting the private key for secret #{args[:scrt_id]}: #{err}"
-      end
-    end
-
-    ## Downloads the public key for a secret and places it where Zanzibar is running, or :path if specified
-    # Raise on error
-    # @param [Hash] args, :scrt_id, :scrt_item_id - optional, :path - optional
-
-    def download_public_key(args = {})
-      token = get_token
-      FileUtils.mkdir_p(args[:path]) if args[:path]
-      path = args[:path] ? args[:path] : '.' ## The File.join below doesn't handle nils well, so let's take that possibility away.
-      begin
-        response = @@client.call(:download_file_attachment_by_item_id, message: { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], 'Public Key', token)}).hash
-        if response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:errors]
-          raise "There was an error getting the public key for secret #{args[:scrt_id]}: #{response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:string]}"
-      end
-        File.open(File.join(path, response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_name]), 'wb') do |file|
-          file.puts Base64.decode64(response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_attachment])
-        end
-      rescue Savon::Error => err
-        raise "There was an error getting the public key for secret #{args[:scrt_id]}: #{err}"
-      end
-    end
-
-    ## Downloads an attachment for a secret and places it where Zanzibar is running, or :path if specified
-    # Raise on error
-    # @param [Hash] args, :scrt_id, :scrt_item_id - optional, :path - optional
-
-    def download_attachment(args = {})
-      token = get_token
-      FileUtils.mkdir_p(args[:path]) if args[:path]
-      path = args[:path] ? args[:path] : '.' ## The File.join below doesn't handle nils well, so let's take that possibility away.
-      begin
-        response = @@client.call(:download_file_attachment_by_item_id, message: { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], 'Attachment', token)}).hash
-        if response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:errors]
-          raise "There was an error getting the attachment for secret #{args[:scrt_id]}: #{response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:string]}"
-      end
-        File.open(File.join(path, response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_name]), 'wb') do |file|
-          file.puts Base64.decode64(response[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result][:file_attachment])
-        end
-      rescue Savon::Error => err
-        raise "There was an error getting the attachment from secret #{args[:scrt_id]}: #{err}"
-      end
-    end
-  end
-end
+require "zanzibar/version"
+require 'savon'
+require 'io/console'
+require 'fileutils'
+
+module Zanzibar
+
+  ##
+  # Class for interacting with Secret Server
+  class Zanzibar
+
+    ##
+    # @param args{:domain, :wsdl, :pwd, :username, :globals{}}
+
+    def initialize(args = {})
+
+      if args[:username]
+        @@username = args[:username]
+      else
+        @@username = ENV['USER']
+      end
+
+      if args[:wsdl]
+        @@wsdl = args[:wsdl]
+      else
+        @@wsdl = get_wsdl_location
+      end
+      if args[:pwd]
+          @@password = args[:pwd]
+      else
+        @@password = prompt_for_password
+      end
+      if args[:domain]
+        @@domain = args[:domain]
+      else
+        @@domain = prompt_for_domain
+      end
+      args[:globals] = {} unless args[:globals]
+      init_client(args[:globals])
+    end
+
+    ## Initializes the Savon client class variable with the wdsl document location and optional global variables
+    # @param globals{}, optional
+
+    def init_client(globals = {})
+      globals = {} if globals == nil
+      @@client = Savon.client(globals) do
+        wsdl @@wsdl
+      end
+    end
+
+    ## Gets the user's password if none is provided in the constructor.
+    # @return [String] the password for the current user
+
+    def prompt_for_password
+      puts "Please enter password for #{@@username}:"
+      return STDIN.noecho(&:gets).chomp
+    end
+
+    ## Gets the wsdl document location if none is provided in the constructor
+    # @return [String] the location of the WDSL document
+
+    def prompt_for_wsdl_location
+      puts "Enter the URL of the Secret Server WSDL:"
+      return STDIN.gets.chomp
+    end
+
+    ## Gets the domain of the Secret Server installation if none is provided in the constructor
+    # @return [String] the domain of the secret server installation
+
+    def prompt_for_domain
+      puts "Enter the domain of your Secret Server:"
+      return STDIN.gets.chomp
+    end
+
+
+    ## Get an authentication token for interacting with Secret Server. These are only good for about 10 minutes so just get a new one each time.
+    # Will raise an error if there is an issue with the authentication.
+    # @return the authentication token for the current user.
+
+    def get_token
+      begin
+        response = @@client.call(:authenticate, message: { username: @@username, password: @@password, organization: "", domain: @@domain })
+          .hash[:envelope][:body][:authenticate_response][:authenticate_result]
+        raise "Error generating the authentication token for user #{@@username}: #{response[:errors][:string]}"  if response[:errors]
+        response[:token]
+      rescue Savon::Error => err
+        raise "There was an error generating the authentiaton token for user #{@@username}: #{err}"
+      end
+    end
+
+    ## Get a secret returned as a hash
+    # Will raise an error if there was an issue getting the secret
+    # @param [Integer] the secret id
+    # @return [Hash] the secret hash retrieved from the wsdl
+
+    def get_secret(scrt_id, token = nil)
+      begin
+        secret = @@client.call(:get_secret, message: { token: token || get_token, secretId: scrt_id}).hash[:envelope][:body][:get_secret_response][:get_secret_result]
+        raise "There was an error getting secret #{scrt_id}: #{secret[:errors][:string]}" if secret[:errors]
+        return secret
+      rescue Savon::Error => err
+        raise "There was an error getting the secret with id #{scrt_id}: #{err}"
+      end
+    end
+
+    ## Retrieve a simple password from a secret
+    # Will raise an error if there are any issues
+    # @param [Integer] the secret id
+    # @return [String] the password for the given secret
+
+    def get_password(scrt_id)
+      begin
+        secret = get_secret(scrt_id)
+        secret_items = secret[:secret][:items][:secret_item]
+        return get_secret_item_by_field_name(secret_items,"Password")[:value]
+      rescue Savon::Error => err
+        raise "There was an error getting the password for secret #{scrt_id}: #{err}"
+      end
+    end
+
+    def write_secret_to_file(path, secret_response)
+      File.open(File.join(path, secret_response[:file_name]), 'wb') do |file|
+        file.puts Base64.decode64(secret_response[:file_attachment])
+      end
+    end
+
+    def get_secret_item_by_field_name(secret_items, field_name)
+      secret_items.each do |item|
+        return item if item[:field_name] == field_name
+      end
+    end
+
+    ## Get the secret item id that relates to a key file or attachment.
+    # Will raise on error
+    # @param [Integer] the secret id
+    # @param [String] the type of secret item to get, one of privatekey, publickey, attachment
+    # @return [Integer] the secret item id
+
+    def get_scrt_item_id(scrt_id, type, token)
+      secret = get_secret(scrt_id, token)
+      secret_items = secret[:secret][:items][:secret_item]
+      begin
+        return get_secret_item_by_field_name(secret_items, type)[:id]
+      rescue
+        raise "Unknown type, #{type}."
+      end
+    end
+
+    ## Downloads a file for a secret and places it where Zanzibar is running, or :path if specified
+    # Raise on error
+    # @param [Hash] args, :scrt_id, :type (one of "Private Key", "Public Key", "Attachment"), :scrt_item_id - optional, :path - optional
+
+
+    def download_secret_file(args = {})
+      token = get_token
+      FileUtils.mkdir_p(args[:path]) if args[:path]
+      path = args[:path] ? args[:path] : '.' ## The File.join below doesn't handle nils well, so let's take that possibility away.
+      begin
+        response = @@client.call(:download_file_attachment_by_item_id, message:
+          { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], args[:type], token)})
+            .hash[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result]
+        raise "There was an error getting the #{args[:type]} for secret #{args[:scrt_id]}: #{response[:errors][:string]}"  if response[:errors]
+        write_secret_to_file(path, response)
+      rescue Savon::Error => err
+        raise "There was an error getting the #{args[:type]} for secret #{args[:scrt_id]}: #{err}"
+      end
+    end
+
+
+    ## Methods to maintain backwards compatibility
+    def download_private_key(args = {})
+      args[:type] = 'Private Key'
+      download_secret_file(args)
+    end
+
+    def download_public_key(args = {})
+      args[:type] = 'Public Key'
+      download_secret_file(args)
+    end
+
+    def download_attachment(args = {})
+      args[:type] = 'Attachment'
+      download_secret_file(args)
+    end
+
+  end
+end

data/lib/zanzibar/version.rb

@@ -1,3 +1,3 @@
 module Zanzibar
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/spec/zanzibar_spec.rb

@@ -30,7 +30,7 @@ describe "Zanzibar Test" do
       to_return(:body => auth_xml, :status => 200).then.
         to_return(:body => secret_xml, :status => 200)
 
-    expect(client.get_secret(1234)[:envelope][:body][:get_secret_response][:get_secret_result][:secret][:name]).to eq("Zanzi Test Secret")
+    expect(client.get_secret(1234)[:secret][:name]).to eq("Zanzi Test Secret")
   end
 
   it 'should get a password' do
@@ -47,12 +47,24 @@ describe "Zanzibar Test" do
           to_return(:body => secret_with_key_xml, :status => 200).then.
             to_return(:body => private_key_xml, :status => 200)
 
-      client.download_private_key(:scrt_id => 2345)
+      client.download_secret_file(:scrt_id => 2345, :type => 'Private Key')
       expect(File.exist? 'zanzi_key')
       expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n")
       File.delete('zanzi_key')
     end
 
+    it 'should download a private key legacy' do
+      stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx").
+        to_return(:body => auth_xml, :status => 200).then.
+            to_return(:body => secret_with_key_xml, :status => 200).then.
+              to_return(:body => private_key_xml, :status => 200)
+
+        client.download_private_key(:scrt_id => 2345)
+        expect(File.exist? 'zanzi_key')
+        expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n")
+        File.delete('zanzi_key')
+      end
+
 
   it 'should download a public key' do
     stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx").
@@ -60,18 +72,42 @@ describe "Zanzibar Test" do
           to_return(:body => secret_with_key_xml, :status => 200).then.
             to_return(:body => public_key_xml, :status => 200)
 
-      client.download_public_key(:scrt_id => 2345)
+      client.download_secret_file(:scrt_id => 2345, :type => 'Public Key')
       expect(File.exist? 'zanzi_key.pub')
       expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n")
       File.delete('zanzi_key.pub')
     end
 
+    it 'should download a public key legacy' do
+      stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx").
+        to_return(:body => auth_xml, :status => 200).then.
+            to_return(:body => secret_with_key_xml, :status => 200).then.
+              to_return(:body => public_key_xml, :status => 200)
+
+        client.download_public_key(:scrt_id => 2345)
+        expect(File.exist? 'zanzi_key.pub')
+        expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n")
+        File.delete('zanzi_key.pub')
+      end
+
   it 'should download an attachment' do
     stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx").
       to_return(:body => auth_xml, :status => 200).then.
           to_return(:body => secret_with_attachment_xml, :status => 200).then.
             to_return(:body => attachment_xml, :status => 200)
 
+    client.download_secret_file(:scrt_id => 3456, :type => 'Attachment')
+    expect(File.exist? 'attachment.txt')
+    expect(File.read('attachment.txt')).to eq("I am a secret attachment\n")
+    File.delete('attachment.txt')
+  end
+
+  it 'should download an attachment legacy' do
+    stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx").
+      to_return(:body => auth_xml, :status => 200).then.
+          to_return(:body => secret_with_attachment_xml, :status => 200).then.
+            to_return(:body => attachment_xml, :status => 200)
+
     client.download_attachment(:scrt_id => 3456)
     expect(File.exist? 'attachment.txt')
     expect(File.read('attachment.txt')).to eq("I am a secret attachment\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zanzibar
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Jason Davis-Cooke