-
Notifications
You must be signed in to change notification settings - Fork 392
/
merkerl.erl
369 lines (344 loc) · 12.7 KB
/
merkerl.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
%% -------------------------------------------------------------------
%%
%% merkerl: simple in-memory Merkle Trees
%%
%% Copyright (c) 2007-2010 Basho Technologies, Inc. All Rights Reserved.
%%
%% This file is provided to you 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.
%%
%% -------------------------------------------------------------------
%% @doc An implementation of Merkle Trees for anti-entropy.
%%
%% Intended use is for synchronizing two key/value stores with similar but
%% potentially-divergent content.
%%
%% Typical usage is when a pair (or more) of nodes or systems have views of a
%% set of key/value objects which can change independently. Whenever a new
%% object is created or an existing one is modified (there is no difference from
%% the merkle point of view) the node seeing the change performs an insert/2 to
%% record the change. At any time, one node can send a representation of its
%% tree to another node. The receiving node can diff/2 the trees to see which
%% objects differ on the two systems. From this information, a system knows
%% exactly which objects to send or request in order to converge toward a common
%% view of the world. Of course, if the objects contain versioning information
%% it will be much easier to resolve which node's view for any given object is
%% newer.
%%
%% See the code of merkle_test/0 for trivial example usage.
%%
%% Application usage note: the 'crypto' OTP application must be started before
%% any of this module's functions will work.
%%
%% @reference Ralph C. Merkle, A Digital Signature Based on a Conventional
%% Encryption Function, A Conference on the Theory and Applications of
%% Cryptographic Techniques on Advances in Cryptology, p.369-378, August 16-20,
%% 1987
-module(merkerl).
-export([insert/2,delete/2,build_tree/1,diff/2,allkeys/1]).
% TODO: fix doc, userdata is the ONLY user-exposed key
-record(merk, {nodetype, % atom: expected values are 'leaf' or 'inner'
key=undefined, % if nodetype=leaf, then this is binary/160
% (keys are 160b binaries)
userdata=undefined, % (if user specified a non-binary key)
hashval, % hash of value if leaf, of children if inner
offset=undefined, % if inner, then offset to reach here
children=undefined % if nodetype=inner, then this is orddict
}).
% TODO in doc: note that these are an internal-only form
-record(merkitem, {userdata=undefined, % for non-binary "keys"
hkey, % SHA-1 of userdata
hval % SHA-1 of value (user-supplied)
}).
% @type tree() = treeleaf() | treeinner() | undefined.
% The tree() type here is used as the internal representation of
% a Merkle tree. It can be used locally with insert/2 or pickled
% via term_to_binary and inverse for use remotely in diff/2.
% @type treeleaf() = term().
% Not externally useful, this is one of two record types making up tree().
% @type treeinner() = term().
% Not externally useful, this is one of two record types making up tree().
% (NEED TO EDOC THE RECORD TYPES)
% The merkitem records...
% These make up the "real" leaves in the Merkle tree.
%
% This is the input that most clients of the library will need to provide.
% @type key() = binary().
% This is the key, or "name" for an object tracked by a Merkle tree.
% It should remain constant through changes to the object it references.
% It is expected to be a 160b binary, as produced by
% crypto:sha/1 -- if the natural names of objects are not such values,
% then simply crypto:sha(term_to_binary(the-name>).
% @type hash() = binary().
% This is a hash representing a unique content value for an object
% tracked by a Merkle tree.
% It should change if the object it references changes in value.
% It is expected to be a 160b binary, as produced by
% crypto:sha/1 -- crypto:sha(term_to_binary(value)) is the canonical
% way to produce a hash().
% %spec build_tree([kh()]) -> tree()
% @doc Build a Merkle tree from a list of KH's of objects.
build_tree([]) ->
undefined;
build_tree([{K,H}|KHL]) ->
insert({K,H},build_tree(KHL)).
delete(Key, Tree) when is_record(Tree, merk) ->
mi_delete({0, #merkitem{userdata=Key,hkey=sha(Key),hval=undefined}}, Tree).
mi_delete({Offset, MI}, Tree) ->
HKey = MI#merkitem.hkey,
case Tree#merk.nodetype of
leaf ->
case Tree#merk.key of
HKey ->
undefined;
_ ->
Tree
end;
inner ->
Kids = Tree#merk.children,
OKey = offset_key(Offset,HKey),
NewKids = case orddict:is_key(OKey,Kids) of
false ->
Kids;
true ->
SubTree = orddict:fetch(OKey,Kids),
orddict:store(OKey,
mi_delete({Offset+8,MI},SubTree),Kids)
end,
mkinner(Offset,NewKids)
end.
% TODO: fix @spec to be merkitems instead of kh's
% spec insert(KH :: kh(),T :: tree()) -> tree()
% @doc Insert the KH for a new or changed object into T.
%
% This is used much like a typical tree-insert function.
% To create a new tree, this can be called with T set to the atom 'undefined'.
insert({Userdata, Hashval}, T) ->
mi_insert(#merkitem{userdata=Userdata,hkey=sha(Userdata),hval=Hashval}, T).
mi_insert(MI,T) when is_record(MI, merkitem) ->
mi_insert({0,MI},T);
mi_insert({_Offset,MI},undefined) ->
mkleaf(MI);
mi_insert({160,MI},_Tree) ->
% we're all the way deep! replace.
mkleaf(MI);
mi_insert({Offset,MI},Tree) ->
Key = MI#merkitem.hkey,
case Tree#merk.nodetype of
leaf ->
case Tree#merk.key of
Key -> % replacing!
mkleaf(MI);
_ -> % turning a leaf into an inner
Kid = orddict:store(offset_key(Offset,Tree#merk.key),
Tree,orddict:new()),
NewInner = mkinner(Offset,Kid),
mi_insert1({Offset,MI},NewInner)
end;
inner ->
mi_insert1({Offset,MI},Tree)
end.
mi_insert1({Offset,MI},Tree) ->
Kids = Tree#merk.children,
OKey = offset_key(Offset,MI#merkitem.hkey),
NewKids = case orddict:is_key(OKey,Kids) of
false ->
orddict:store(OKey,mkleaf(MI),Kids);
true ->
SubTree = orddict:fetch(OKey,Kids),
orddict:store(OKey,
mi_insert({Offset+8,MI},SubTree),Kids)
end,
mkinner(Offset,NewKids).
mkleaf(MI) ->
#merk{nodetype=leaf,
key=MI#merkitem.hkey,
userdata=MI#merkitem.userdata,
hashval=MI#merkitem.hval}.
mkinner(Offset,Kids) ->
#merk{nodetype=inner,hashval=sha(Kids),offset=Offset,
children=[{K,V} || {K,V} <- Kids, V =/= undefined]}.
offset_key(Offset,Key) ->
% offset is a 8b-divisible integer from 0 to 152, inclusive
% Key is a 160b binary
<<_L:Offset/integer,RightKey/binary>> = Key,
<<OKey:8/integer,_R/binary>> = RightKey,
OKey.
% TODO FIX TO NOTE THAT WE RETURN USERDATA INSTEAD
% @spec diff(tree(), tree()) -> [key()]
% @doc Find the keys of objects which differ between the two trees.
%
% For this purpose, "differ" means that an object either exists in
% only one of the two trees or it exists in both but with different
% hash() values.
%
% No information about the differing objects is provided except the keys.
% (Objects with vector-clock versioning are helpful here)
diff(undefined, X) -> allkeys(X);
diff(X, undefined) -> allkeys(X);
diff(TreeA,TreeB) when is_record(TreeA,merk),is_record(TreeB,merk) ->
% return the list of 'userdata' fields from inner nodes that differ
lists:usort(diff1(TreeA,TreeB)).
diff1(TreeA,TreeB) ->
% precondition: TreeA and TreeB are both merks at same offset
case TreeA#merk.hashval == TreeB#merk.hashval of
true ->
[];
false ->
diff2(TreeA,TreeB)
end.
diff2(TreeA,TreeB) ->
% precondition: TreeA and TreeB are both merks at same offset
% precondition: TreeA and TreeB have different hashval
case TreeA#merk.nodetype == TreeB#merk.nodetype andalso
TreeA#merk.nodetype == leaf of
true ->
[TreeA#merk.userdata,TreeB#merk.userdata];
false ->
diff3(TreeA,TreeB)
end.
diff3(TreeA,TreeB) ->
% precondition: TreeA and TreeB are both merks at same offset
% precondition: TreeA and TreeB have different hashval
% precondition: at least one of TreeA and TreeB is not a leaf
case TreeA#merk.nodetype == leaf of
true ->
allbutmaybe(TreeB,TreeA);
false ->
case TreeB#merk.nodetype == leaf of
true ->
allbutmaybe(TreeA,TreeB);
false ->
diff4(TreeA,TreeB)
end
end.
diff4(TreeA,TreeB) ->
% precondition: TreeA and TreeB are both merks at same offset
% precondition: TreeA and TreeB have different hashval
% precondition: TreeA and TreeB are both inner nodes
diff4a(TreeA#merk.children,TreeB#merk.children,0,[]).
diff4a(KidsA,KidsB,Idx,Acc) ->
% this is the ugly bit.
case Idx > 255 of
true ->
Acc;
false ->
case KidsA of
[] ->
lists:append(Acc,lists:flatten([allkeys(X) ||
{_Okey, X} <- KidsB]));
_ ->
case KidsB of
[] ->
lists:append(Acc,lists:append(
[allkeys(X) ||
{_Okey, X} <- KidsA]));
_ ->
diff4b(KidsA,KidsB,Idx,Acc)
end
end
end.
diff4b(KidsA,KidsB,Idx,Acc) ->
% precondition: neither KidsA nor KidsB is empty
[{OkeyA,NodeA}|RestA] = KidsA,
[{OkeyB,NodeB}|RestB] = KidsB,
case OkeyA == Idx of
true ->
case OkeyB == Idx of
true ->
diff4a(RestA,RestB,Idx+1,
lists:append(Acc,diff1(
NodeA,NodeB)));
false ->
diff4a(RestA,KidsB,Idx+1,
lists:append(Acc,allkeys(
NodeA)))
end;
false ->
case OkeyB == Idx of
true ->
diff4a(KidsA,RestB,Idx+1,
lists:append(Acc,allkeys(
NodeB)));
false ->
diff4a(KidsA,KidsB,Idx+1,Acc)
end
end.
allkeys(undefined) -> [];
allkeys(Tree) when is_record(Tree, merk) ->
case Tree#merk.nodetype of
leaf ->
[Tree#merk.userdata];
_ ->
lists:append([allkeys(Kid) || Kid <- getkids(Tree)])
end.
allbutmaybe(Tree,Leaf) when is_record(Tree, merk),is_record(Leaf,merk) ->
% return all keys in Tree, maybe the one for Leaf
% (depending on whether it is present&identical in Tree)
case contains_node(Tree,Leaf) of
true ->
lists:delete(Leaf#merk.userdata,allkeys(Tree));
false ->
lists:append([Leaf#merk.userdata],allkeys(Tree))
end.
contains_node(Tree,Node) ->
case Tree#merk.nodetype of
leaf ->
Tree#merk.hashval == Node#merk.hashval;
_ ->
lists:any(fun(T) -> contains_node(T,Node) end, getkids(Tree))
end.
getkids(Tree) ->
[V || {_K,V} <- orddict:to_list(Tree#merk.children)].
sha(X) ->
crypto:sha(term_to_binary(X)).
-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").
% @spec merkle_test() -> bool()
% @doc A test function and example code.
%
% This should be changed into a proper unit test suite.
merkle_test() ->
case lists:keymember(crypto, 1, application:loaded_applications()) of
true -> ok;
false -> ok = application:start(crypto)
end,
A = [{one,"one data"},{two,"two data"},{three,"three data"},
{four,"four data"},{five,"five data"}],
B = [{one,"one data"},{two,"other two"},{three,"three data"},
{four,"other four"},{five,"five data"}],
A2 = build_tree(A),
B2 = build_tree(B),
?assertEqual(lists:usort([two, four]), diff(A2,B2)),
C = [{one,"one data"}],
C2 = build_tree(C),
?assertEqual(lists:usort([two, three, four, five]), diff(A2,C2)),
D = insert({four, sha("changed!")}, A2),
?assertEqual([four], diff(A2,D)),
E = insert({five, sha("changed more!")}, D),
?assertEqual([five], diff(D,E)),
?assertEqual(lists:usort([four, five]), diff(A2,E)),
F = delete(five,D),
G = delete(five,E),
?assertEqual([], diff(F,G)),
H = delete(two,A2),
?assertEqual([two], diff(A2,H)),
?assertEqual([one], diff(C2,undefined)),
STree1 = build_tree([{"hello", "hi"},{"and", "what"}]),
STree2 = build_tree([{"hello", "hi"},{"goodbye", "bye"}]),
?assertEqual(lists:usort(["and", "goodbye"]), diff(STree1, STree2)),
I = [{<<"riak.com42">>,sha("should not")},{<<"riak.com452">>,sha("clobber")}],
I2 = build_tree(I),
?assertEqual(2, length(allkeys(I2))).
-endif.