xmlenc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 869074b32ca2144be9a0c5b4344e2a962b067096
-  data.tar.gz: e33dd060461d348bec6c2160ae83c7997341e572
+  metadata.gz: 8dc37fb9c2a756e30492c8713cadbbd5757db889
+  data.tar.gz: 2217523b1fca27126ee8eb4cee15d95343c3c27f
 SHA512:
-  metadata.gz: 3216e9fef6a70ed78735a8cc6587dd22e1a1c8ced0d6ef21ec125203e0778f2379374a3bbfa9a2f9b4ed962cb49146fd71d319f42ceda0f2e4319e2284b83cc6
-  data.tar.gz: 7e80bcaaa65527a1bea1b932ee159bcd225c5335bb58601239e8de4aa64ed6993c90987a9c884d60fc90292253f98da1cebf979fc45c36a9a7d1cd130e2d26b6
+  metadata.gz: 5e3395a8f9d927b54334c5ce9fc981e54956708fff72f5b6ce05cfd0ed46b481eef7753bbd0e12ab56e74828ce8b55d3084e11206abe015c211fdee81fcdb4e7
+  data.tar.gz: 84b10748b719e2f0a844d83249cfe4da5cbb59304daeb523e27bfa8a5035c698dcea445a946e26d76d5f442937f5ac4678fc06e729de785bac9791230750f36b

data/lib/xmlenc.rb

@@ -27,6 +27,7 @@ module Xmlenc
     autoload :DigestMethod, 'xmlenc/builder/digest_method'
     autoload :ReferenceList, 'xmlenc/builder/reference_list'
     autoload :DataReference, 'xmlenc/builder/data_reference'
+    autoload :RetrievalMethod, 'xmlenc/builder/retrieval_method'
 
     module ComplexTypes
       autoload :EncryptedType, 'xmlenc/builder/complex_types/encrypted_type'

data/lib/xmlenc/builder/encrypted_data.rb

@@ -23,21 +23,33 @@ module Xmlenc
         'http://www.w3.org/2001/04/xmlenc#Element'
       end
 
-      def initialize(attributes = {})
-        super
-        self.id = SecureRandom.hex(5)
+      def initialize(*args)
+        options = args.extract_options!
+        if options.key?(:id)
+          self.id = options.delete(:id)
+        else
+          self.id = SecureRandom.hex(5)
+        end
+        super(*(args << options))
       end
 
-      def encrypt(data)
+      def encrypt(data, key_options = {})
         encryptor = algorithm.setup
         encrypted = encryptor.encrypt(data, :node => encryption_method)
         cipher_data.cipher_value = Base64.encode64(encrypted)
-
-        encrypted_key = EncryptedKey.new(:data => encryptor.key)
+        key_params = { :data => encryptor.key }
+        encrypted_key = EncryptedKey.new(key_params.merge(key_options))
         encrypted_key.add_data_reference(id)
         encrypted_key
       end
 
+      def set_key_retrieval_method(retrieval_method)
+        if retrieval_method
+          self.key_info ||= KeyInfo.new
+          self.key_info.retrieval_method = retrieval_method
+        end
+      end
+
       private
 
       def algorithm

data/lib/xmlenc/builder/encrypted_key.rb

@@ -11,6 +11,9 @@ module Xmlenc
       tag "EncryptedKey"
       namespace "xenc"
 
+      attribute :id, String, tag: 'Id'
+      attribute :recipient, String, tag: 'Recipient'
+
       has_one :reference_list, Xmlenc::Builder::ReferenceList, :xpath => "./"
 
       attr_accessor :data
@@ -26,6 +29,13 @@ module Xmlenc
         self.reference_list.add_data_reference(data_id)
       end
 
+      def initialize(*args)
+        options = args.extract_options!
+        @recipient = options.delete(:recipient)
+        @id = options.delete(:id)
+        super(*(args << options))
+      end
+
       private
 
       def algorithm

data/lib/xmlenc/builder/encryption_method.rb

@@ -15,7 +15,9 @@ module Xmlenc
 
       def initialize(attributes = {})
         digest_method_algorithm = attributes.delete(:digest_method_algorithm)
-        attributes[:digest_method] = Xmlenc::Builder::DigestMethod.new(:algorithm => digest_method_algorithm)
+        if digest_method_algorithm
+          attributes[:digest_method] = Xmlenc::Builder::DigestMethod.new(:algorithm => digest_method_algorithm)
+        end
         super
       end
     end

data/lib/xmlenc/builder/key_info.rb

@@ -9,6 +9,7 @@ module Xmlenc
       namespace "ds"
 
       element :key_name, String, :namespace => "ds", :tag => "KeyName"
+      has_many :retrieval_method, Xmlenc::Builder::RetrievalMethod, :tag => "RetrievalMethod"
 
       has_one :encrypted_key, Xmlenc::Builder::EncryptedKey, :xpath => "./"
     end

data/lib/xmlenc/builder/retrieval_method.rb

@@ -0,0 +1,17 @@
+module Xmlenc
+  module Builder
+    class RetrievalMethod
+      include Xmlenc::Builder::Base
+
+      tag "RetrievalMethod"
+
+      attribute :type, String, :tag => "Type"
+      attribute :uri, String, :tag => "URI"
+
+      def type
+        'http://www.w3.org/2001/04/xmlenc#EncryptedKey'
+      end
+    end
+  end
+end
+

data/lib/xmlenc/version.rb

@@ -1,3 +1,3 @@
 module Xmlenc
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/lib/xmlenc/builder/encrypted_data_spec.rb

@@ -71,4 +71,57 @@ describe Xmlenc::Builder::EncryptedData do
       end
     end
   end
+
+  describe "#initialize" do
+    it 'sets a default #id' do
+      expect(described_class.new().id).to be_a String
+    end
+
+    it 'sets #id to specified id' do
+      expect(described_class.new(id: 'TEST').id).to eq 'TEST'
+    end
+  end
+
+  describe "#encrypt" do
+    subject { described_class.new() }
+
+    before { subject.set_encryption_method(algorithm: 'http://www.w3.org/2001/04/xmlenc#aes256-cbc') }
+
+    it 'returns an EncryptedKey' do
+      expect(subject.encrypt('TEST')).to be_a Xmlenc::Builder::EncryptedKey
+    end
+
+    context "extra key_options are passed" do
+      let(:key_options) { { :id => '_SOME_ID', :recipient => 'SOME_RECIPIENT' } }
+
+      before do
+        subject.set_encryption_method(algorithm: 'http://www.w3.org/2001/04/xmlenc#aes256-cbc')
+        allow_message_expectations_on_nil
+        allow(nil).to receive(:add_data_reference)
+      end
+
+      it 'and then used to create the EncryptedKey' do
+        expect(Xmlenc::Builder::EncryptedKey).to receive(:new).with(hash_including(key_options))
+        subject.encrypt('TEST', key_options)
+      end
+    end
+  end
+
+  describe "#set_key_retrieval_method" do
+    it "sets the key info with the key name" do
+      subject.set_key_retrieval_method 'retrieval_method'
+      expect(subject.key_info.retrieval_method).to eq "retrieval_method"
+    end
+
+    it "does not override old key info data" do
+      subject.set_key_retrieval_method("key retrieval_method")
+      expect(subject.key_info.encrypted_key).not_to be_nil
+    end
+
+    it "does not set the key info element if the key retrieval_method is nil" do
+      subject.key_info = nil
+      subject.set_key_retrieval_method(nil)
+      expect(subject.key_info).to be_nil
+    end
+  end
 end

data/spec/lib/xmlenc/builder/encrypted_key_spec.rb

@@ -6,19 +6,21 @@ describe Xmlenc::Builder::EncryptedKey do
   subject   { described_class.parse(xml, :single => true) }
 
   describe "required fields" do
-    it "should have the cipher data field" do
-      expect(subject).to respond_to :cipher_data
-    end
+    [:cipher_data].each do |field|
+      it "should have the #{field} field" do
+        expect(subject).to respond_to :cipher_data
+      end
 
-    it "should check the presence of cipher data" do
-      subject.cipher_data = nil
-      expect(subject).to_not be_valid
-      expect(subject.errors[:cipher_data].size).to eq(1)
+      it "should check the presence of #{field}" do
+        subject.cipher_data = nil
+        expect(subject).to_not be_valid
+        expect(subject.errors[:cipher_data].size).to eq(1)
+      end
     end
   end
 
   describe "optional fields" do
-    [:encryption_method, :key_info].each do |field|
+    [:id, :recipient, :encryption_method, :key_info].each do |field|
       it "should have the #{field} field" do
         expect(subject).to respond_to field
       end
@@ -72,6 +74,12 @@ describe Xmlenc::Builder::EncryptedKey do
     end
   end
 
+  describe "#encrypt" do
+    it "has method" do
+      expect(subject).to respond_to :encrypt
+    end
+  end
+
   describe "#add_data_reference" do
     it "has method" do
       expect(subject).to respond_to :add_data_reference
@@ -87,9 +95,18 @@ describe Xmlenc::Builder::EncryptedKey do
     end
   end
 
-  describe "#encrypt" do
-    it "has method" do
-      expect(subject).to respond_to :encrypt
+  describe "#initialize" do
+    it 'initializes an EncryptedKey' do
+      expect(described_class.new()).to be_a described_class
+    end
+
+    context 'with extra options' do
+      subject { described_class.new(id: 'AN_ID', recipient: 'A_RECIPIENT') }
+
+      it 'sets @recipient and @id' do
+        expect(subject.id).to eq 'AN_ID'
+        expect(subject.recipient).to eq 'A_RECIPIENT'
+      end
     end
   end
 end

data/spec/lib/xmlenc/builder/encryption_method_spec.rb

@@ -27,4 +27,20 @@ describe Xmlenc::Builder::EncryptionMethod do
     end
   end
 
+  describe "#digest_method" do
+    subject { described_class.new() }
+
+    it 'has an empty digest_method' do
+      expect(subject.digest_method).to eq nil
+    end
+
+    context "digest_method_algorithm given" do
+      subject { described_class.new(digest_method_algorithm: 'ALGO') }
+
+      it 'has no empty digest_method' do
+        expect(subject.digest_method).not_to eq nil
+      end
+    end
+  end
+
 end

data/spec/lib/xmlenc/builder/key_info_spec.rb

@@ -5,6 +5,21 @@ describe Xmlenc::Builder::KeyInfo do
   let(:xml) { File.read File.join("spec", "fixtures", "encrypted_document.xml") }
   subject   { described_class.parse(xml) }
 
+  describe "optional fields" do
+    subject { described_class.new }
+    
+    [:key_name, :retrieval_method, :encrypted_key].each do |field|
+      it "should have the #{field} field" do
+        expect(subject).to respond_to field
+      end
+
+      it "should allow #{field} to be blank" do
+        subject.send("#{field}=", nil)
+        expect(subject).to be_valid
+      end
+    end
+  end
+
   describe "#parse" do
     it "should create two KeyInfo elements" do
       subject.each do |element|

data/spec/lib/xmlenc/builder/retrieval_method_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Xmlenc::Builder::RetrievalMethod do
+
+  let(:xml) { File.read File.join("spec", "fixtures", "encrypted_document.xml") }
+  subject   { described_class.parse(xml) }
+
+  describe "optional fields" do
+    subject { described_class.new }
+
+    [:type, :uri].each do |field|
+      it "should have the #{field} field" do
+        expect(subject).to respond_to field
+      end
+
+      it "should allow #{field} to be blank" do
+        subject.send("#{field}=", nil)
+        expect(subject).to be_valid
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xmlenc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Benoist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,7 @@ files:
 - lib/xmlenc/builder/encryption_method.rb
 - lib/xmlenc/builder/key_info.rb
 - lib/xmlenc/builder/reference_list.rb
+- lib/xmlenc/builder/retrieval_method.rb
 - lib/xmlenc/encrypted_data.rb
 - lib/xmlenc/encrypted_document.rb
 - lib/xmlenc/encrypted_key.rb
@@ -169,6 +170,7 @@ files:
 - spec/lib/xmlenc/builder/encryption_method_spec.rb
 - spec/lib/xmlenc/builder/key_info_spec.rb
 - spec/lib/xmlenc/builder/reference_list_spec.rb
+- spec/lib/xmlenc/builder/retrieval_method_spec.rb
 - spec/lib/xmlenc/encrypted_data_spec.rb
 - spec/lib/xmlenc/encrypted_document_spec.rb
 - spec/lib/xmlenc/encrypted_key_spec.rb
@@ -230,6 +232,7 @@ test_files:
 - spec/lib/xmlenc/builder/encryption_method_spec.rb
 - spec/lib/xmlenc/builder/key_info_spec.rb
 - spec/lib/xmlenc/builder/reference_list_spec.rb
+- spec/lib/xmlenc/builder/retrieval_method_spec.rb
 - spec/lib/xmlenc/encrypted_data_spec.rb
 - spec/lib/xmlenc/encrypted_document_spec.rb
 - spec/lib/xmlenc/encrypted_key_spec.rb