nocebo/diaspora_federation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactoring RelayableRetraction and SignedRetraction signing

Browse source
This commit is contained in:
Benjamin Neff 2016-01-21 05:12:20 +01:00
parent adf14283e3
commit 1aead0ac5b
11 changed files with 52 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
lib/diaspora_federation/entities/relayable_retraction.rb
View file

@ -58,41 +58,39 @@ module DiasporaFederation
# @return [Nokogiri::XML::Element] root element containing properties as child elements
def to_xml
entity_xml.tap do |xml|
hash = to_h
RelayableRetraction.update_signatures!(hash)
hash = to_signed_h
xml.at_xpath("target_author_signature").content = hash[:target_author_signature]
xml.at_xpath("parent_author_signature").content = hash[:parent_author_signature]
end
end
# Adds signatures to a given hash with the keys of the author and the parent
# Adds signatures to the hash with the keys of the author and the parent
# if the signatures are not in the hash yet and if the keys are available.
#
# @param [Hash] hash hash given for a signing
def self.update_signatures!(hash)
target_author = DiasporaFederation.callbacks.trigger(
:fetch_entity_author_id_by_guid,
hash[:target_type],
hash[:target_guid]
)
privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, hash[:diaspora_id])
# @return [Hash] entity data hash with updated signatures
def to_signed_h
target_author = DiasporaFederation.callbacks.trigger(:fetch_entity_author_id_by_guid, target_type, target_guid)
privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, diaspora_id)
to_h.tap do |hash|
fill_required_signature(target_author, privkey, hash) unless privkey.nil?
end
end
private
# @param [String] target_author the author of the entity to retract
# @param [OpenSSL::PKey::RSA] privkey private key of sender
# @param [Hash] hash hash given for a signing
def self.fill_required_signature(target_author, privkey, hash)
if target_author == hash[:diaspora_id] && hash[:target_author_signature].nil?
def fill_required_signature(target_author, privkey, hash)
if target_author == diaspora_id && target_author_signature.nil?
hash[:target_author_signature] =
Signing.sign_with_key(SignedRetraction.apply_signable_exceptions(hash), privkey)
elsif target_author != hash[:diaspora_id] && hash[:parent_author_signature].nil?
elsif target_author != diaspora_id && parent_author_signature.nil?
hash[:parent_author_signature] =
Signing.sign_with_key(SignedRetraction.apply_signable_exceptions(hash), privkey)
end
end
private_class_method :fill_required_signature
end
end
end

20
lib/diaspora_federation/entities/signed_retraction.rb
View file

@ -35,22 +35,22 @@ module DiasporaFederation
# @return [Nokogiri::XML::Element] root element containing properties as child elements
def to_xml
entity_xml.tap do |xml|
hash = to_h
SignedRetraction.update_signatures!(hash)
xml.at_xpath("target_author_signature").content = hash[:target_author_signature]
xml.at_xpath("target_author_signature").content = to_signed_h[:target_author_signature]
end
end
# Adds signature to a given hash with the key of the author
# Adds signature to the hash with the key of the author
# if the signature is not in the hash yet and if the key is available.
#
# @param [Hash] data hash given for a signing
def self.update_signatures!(data)
if data[:target_author_signature].nil?
privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, data[:diaspora_id])
# @return [Hash] entity data hash with updated signatures
def to_signed_h
to_h.tap do |hash|
if target_author_signature.nil?
privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, diaspora_id)
unless privkey.nil?
data[:target_author_signature] = Signing.sign_with_key(apply_signable_exceptions(data), privkey)
hash[:target_author_signature] =
Signing.sign_with_key(SignedRetraction.apply_signable_exceptions(hash), privkey)
end
end
end
end

39
lib/diaspora_federation/test.rb
View file

@ -3,49 +3,12 @@ require "diaspora_federation/test/factories"
module DiasporaFederation
# This module encapsulates helper functions maybe wanted by a testsuite of a diaspora_federation gem user application
module Test
# Sort hash according to an entity class's property sequence.
# This is used for rspec tests in order to generate correct input hash to
# compare results with.
#
# @param [Hash] data input hash for sorting
# @param [Entity.Class] klass entity type to sort according to
# @return [Hash] sorted hash
def self.sort_hash(data, klass)
Hash[klass.class_props.map {|prop|
[prop[:name], data[prop[:name]]] unless data[prop[:name]].nil?
}.compact]
end
# Generates attributes for entity constructor with correct signatures in it
#
# @param [Symbol] factory_name the factory to generate attributes for (normally entity name)
# @return [Hash] hash with correct signatures
def self.relayable_attributes_with_signatures(factory_name)
def self.attributes_with_signatures(factory_name)
FactoryGirl.build(factory_name).to_signed_h
end
# Generates attributes for signed retraction entity constructor with correct signatures in it
#
# @return [Hash] hash with correct signatures
def self.signed_retraction_attributes_with_signatures
sort_hash(FactoryGirl.attributes_for(:signed_retraction_entity), Entities::SignedRetraction).tap do |data|
Entities::SignedRetraction.update_signatures!(data)
end
end
# Generates attributes for relayable retraction entity constructor with correct signatures in it
#
# @return [Hash] hash with correct signatures
def self.relayable_retraction_attributes_with_signatures
sort_hash(
FactoryGirl.attributes_for(
:relayable_retraction_entity,
target_author_signature: "false sig"
),
Entities::RelayableRetraction
).tap do |data|
Entities::RelayableRetraction.update_signatures!(data)
end
end
end
end

2
spec/lib/diaspora_federation/entities/comment_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::Comment do
let(:data) { Test.relayable_attributes_with_signatures(:comment_entity) }
let(:data) { Test.attributes_with_signatures(:comment_entity) }
let(:xml) {
<<-XML

4
spec/lib/diaspora_federation/entities/conversation_spec.rb
View file

@ -1,7 +1,7 @@
module DiasporaFederation
describe Entities::Conversation do
let(:msg1_data) { Test.relayable_attributes_with_signatures(:message_entity) }
let(:msg2_data) { Test.relayable_attributes_with_signatures(:message_entity) }
let(:msg1_data) { Test.attributes_with_signatures(:message_entity) }
let(:msg2_data) { Test.attributes_with_signatures(:message_entity) }
let(:msg1) { FactoryGirl.build(:message_entity, msg1_data) }
let(:msg2) { FactoryGirl.build(:message_entity, msg2_data) }
let(:data) {

2
spec/lib/diaspora_federation/entities/like_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::Like do
let(:data) { Test.relayable_attributes_with_signatures(:like_entity) }
let(:data) { Test.attributes_with_signatures(:like_entity) }
let(:xml) {
<<-XML

2
spec/lib/diaspora_federation/entities/message_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::Message do
let(:data) { Test.relayable_attributes_with_signatures(:message_entity) }
let(:data) { Test.attributes_with_signatures(:message_entity) }
let(:xml) {
<<-XML

2
spec/lib/diaspora_federation/entities/participation_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::Participation do
let(:data) { Test.relayable_attributes_with_signatures(:participation_entity) }
let(:data) { Test.attributes_with_signatures(:participation_entity) }
let(:xml) {
<<-XML

2
spec/lib/diaspora_federation/entities/poll_participation_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::PollParticipation do
let(:data) { Test.relayable_attributes_with_signatures(:poll_participation_entity) }
let(:data) { Test.attributes_with_signatures(:poll_participation_entity) }
let(:xml) {
<<-XML

24
spec/lib/diaspora_federation/entities/relayable_retraction_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::RelayableRetraction do
let(:data) { Test.relayable_retraction_attributes_with_signatures }
let(:data) { Test.attributes_with_signatures(:relayable_retraction_entity) }
let(:xml) {
<<-XML
@ -9,7 +9,7 @@ module DiasporaFederation
<target_guid>#{data[:target_guid]}</target_guid>
<target_type>#{data[:target_type]}</target_type>
<sender_handle>#{data[:diaspora_id]}</sender_handle>
<target_author_signature>#{data[:target_author_signature]}</target_author_signature>
<target_author_signature/>
</relayable_retraction>
XML
}
@ -18,7 +18,7 @@ XML
it_behaves_like "an XML Entity"
describe ".update_singatures!" do
describe "#to_signed_h" do
let(:author_pkey) { OpenSSL::PKey::RSA.generate(1024) }
let(:hash) { FactoryGirl.attributes_for(:relayable_retraction_entity) }
@ -31,12 +31,12 @@ XML
:fetch_private_key_by_diaspora_id, hash[:diaspora_id]
).and_return(author_pkey)
Entities::RelayableRetraction.update_signatures!(hash)
signed_hash = Entities::RelayableRetraction.new(hash).to_signed_h
signable_hash = hash.select do |key, _|
%i(target_guid target_type).include?(key)
end
expect(Signing.verify_signature(signable_hash, hash[:target_author_signature], author_pkey)).to be_truthy
expect(Signing.verify_signature(signable_hash, signed_hash[:target_author_signature], author_pkey)).to be_truthy
end
it "updates parent author signature when it was nil, key was supplied and sender is not author of the target" do
@ -48,20 +48,18 @@ XML
:fetch_private_key_by_diaspora_id, hash[:diaspora_id]
).and_return(author_pkey)
Entities::RelayableRetraction.update_signatures!(hash)
signed_hash = Entities::RelayableRetraction.new(hash).to_signed_h
signable_hash = hash.select do |key, _|
%i(target_guid target_type).include?(key)
end
expect(Signing.verify_signature(signable_hash, hash[:parent_author_signature], author_pkey)).to be_truthy
expect(Signing.verify_signature(signable_hash, signed_hash[:parent_author_signature], author_pkey)).to be_truthy
end
it "doesn't change signatures if they are already set" do
signatures = {target_author_signature: "aa"}
hash.merge!(signatures)
hash.merge!(target_author_signature: "aa", parent_author_signature: "bb")
Entities::RelayableRetraction.update_signatures!(hash)
expect(hash[:target_author_signature]).to eq(signatures[:target_author_signature])
expect(Entities::RelayableRetraction.new(hash).to_signed_h).to eq(hash)
end
it "doesn't change signatures if keys weren't supplied" do
@ -73,8 +71,8 @@ XML
:fetch_entity_author_id_by_guid, "Comment", hash[:target_guid]
).and_return(hash[:diaspora_id])
Entities::RelayableRetraction.update_signatures!(hash)
expect(hash[:target_author_signature]).to eq(nil)
signed_hash = Entities::RelayableRetraction.new(hash).to_signed_h
expect(signed_hash[:target_author_signature]).to eq(nil)
end
end
end

18
spec/lib/diaspora_federation/entities/signed_retraction_spec.rb
View file

@ -1,6 +1,6 @@
module DiasporaFederation
describe Entities::SignedRetraction do
let(:data) { Test.signed_retraction_attributes_with_signatures }
let(:data) { Test.attributes_with_signatures(:signed_retraction_entity) }
let(:xml) {
<<-XML
@ -17,7 +17,7 @@ XML
it_behaves_like "an XML Entity"
describe ".update_singatures!" do
describe "#to_signed_h" do
let(:author_pkey) { OpenSSL::PKey::RSA.generate(1024) }
let(:hash) { FactoryGirl.attributes_for(:signed_retraction_entity) }
@ -30,17 +30,15 @@ XML
%i(target_guid target_type).include?(key)
end
Entities::SignedRetraction.update_signatures!(hash)
signed_hash = Entities::SignedRetraction.new(hash).to_signed_h
expect(Signing.verify_signature(signable_hash, hash[:target_author_signature], author_pkey)).to be_truthy
expect(Signing.verify_signature(signable_hash, signed_hash[:target_author_signature], author_pkey)).to be_truthy
end
it "doesn't change signature if it is already set" do
signatures = {target_author_signature: "aa"}
hash.merge!(signatures)
hash[:target_author_signature] = "aa"
Entities::SignedRetraction.update_signatures!(hash)
expect(hash[:target_author_signature]).to eq(signatures[:target_author_signature])
expect(Entities::SignedRetraction.new(hash).to_signed_h).to eq(hash)
end
it "doesn't change signature if a key wasn't supplied" do
@ -48,8 +46,8 @@ XML
:fetch_private_key_by_diaspora_id, hash[:diaspora_id]
).and_return(nil)
Entities::SignedRetraction.update_signatures!(hash)
expect(hash[:author_signature]).to eq(nil)
signed_hash = Entities::SignedRetraction.new(hash).to_signed_h
expect(signed_hash[:author_signature]).to eq(nil)
end
end
end