routing 0.4.0

A secured storage DHT
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

// Copyright 2015 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement, version 1.0.  This, along with the
// Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

/// Formatted string from a vector of bytes.
pub fn get_debug_id(input: Vec<u8>) -> ::std::string::String {
  format!("BYTES:{:02x}{:02x}{:02x}..{:02x}{:02x}{:02x}",
          input[0],
          input[1],
          input[2],
          input[input.len()-3],
          input[input.len()-2],
          input[input.len()-1])
}

/// Encode a value of type T to a vector of bytes.
pub fn encode<T>(value: &T) -> Result<Vec<u8>, ::cbor::CborError>
    where T: ::rustc_serialize::Encodable
{
    let mut enc = ::cbor::Encoder::from_memory();
    try!(enc.encode(&[value]));
    Ok(enc.into_bytes())
}

/// Decode a vcetor of bytes to a value of type T, otherwise error on failure.
pub fn decode<T>(bytes: &Vec<u8>) -> Result<T, ::cbor::CborError>
    where T: ::rustc_serialize::Decodable
{
    let mut dec = ::cbor::Decoder::from_bytes(&bytes[..]);
    match dec.decode().next() {
        Some(result) => result,
        None => Err(::cbor::CborError::UnexpectedEOF),
    }
}

/// The name client name is the SHA512 of the public signing key
pub fn public_key_to_client_name(key: &::sodiumoxide::crypto::sign::PublicKey) -> ::NameType {
    ::NameType(::sodiumoxide::crypto::hash::sha512::hash(&key[..]).0)
}

/// relocated_name = Hash(original_name + 1st closest node id + 2nd closest node id)
/// In case of only one close node provided (in initial network setup scenario),
/// relocated_name = Hash(original_name + 1st closest node id)
pub fn calculate_relocated_name(mut close_nodes: Vec<::NameType>, original_name: &::NameType)
        -> Result<::NameType, ::error::RoutingError> {
    if close_nodes.is_empty() {
        return Err(::error::RoutingError::RoutingTableEmpty);
    }
    close_nodes.sort_by(|a, b| if ::name_type::closer_to_target(&a, &b, original_name) {
                                    ::std::cmp::Ordering::Less
                                } else {
                                    ::std::cmp::Ordering::Greater
                                });
    close_nodes.truncate(2usize);
    close_nodes.insert(0, original_name.clone());

    let mut combined: Vec<u8> = Vec::new();
    for node_id in close_nodes {
        for i in node_id.get_id().iter() {
            combined.push(*i);
        }
    }
    Ok(::NameType(::sodiumoxide::crypto::hash::sha512::hash(&combined).0))
}

#[cfg(test)]
mod test {

    #[test]
    fn public_key_to_client_name() {
        let sign_keys = ::sodiumoxide::crypto::sign::gen_keypair();
        let client_name = super::public_key_to_client_name(&sign_keys.0);
        let name = ::NameType(::sodiumoxide::crypto::hash::sha512::hash(&sign_keys.0[..]).0);

        assert_eq!(client_name, name);
    }

    #[test]
    fn encode_decode() {
        let name: ::NameType = ::test_utils::Random::generate_random();
        let encoded = match super::encode(&name) {
            Ok(encoded) => encoded,
            Err(_) => panic!("Unexpected serialisation error.")
        };
        let decoded = match super::decode(&encoded) {
            Ok(decoded) => decoded,
            Err(_) => panic!("Unexpected deserialisation error.")
        };

        assert_eq!(name, ::NameType(::types::vector_as_u8_64_array(decoded)));
    }

    #[test]
    fn calculate_relocated_name() {
        let original_name : ::NameType = ::test_utils::Random::generate_random();

        // empty close nodes
        assert!(super::calculate_relocated_name(Vec::new(), &original_name).is_err());

        // one entry
        let mut close_nodes_one_entry : Vec<::NameType> = Vec::new();
        close_nodes_one_entry.push(::test_utils::Random::generate_random());
        let actual_relocated_name_one_entry =
                super::calculate_relocated_name(close_nodes_one_entry.clone(),
        &original_name).unwrap();
        assert!(original_name != actual_relocated_name_one_entry);

        let mut combined_one_node_vec : Vec<::NameType> = Vec::new();
        combined_one_node_vec.push(original_name.clone());
        combined_one_node_vec.push(close_nodes_one_entry[0].clone());

        let mut combined_one_node: Vec<u8> = Vec::new();
        for node_id in combined_one_node_vec {
            for i in node_id.get_id().iter() {
                combined_one_node.push(*i);
            }
        }

        let expected_relocated_name_one_node =
            ::NameType(::sodiumoxide::crypto::hash::sha512::hash(&combined_one_node).0);

        assert_eq!(actual_relocated_name_one_entry, expected_relocated_name_one_node);

        // populated closed nodes
        let mut close_nodes : Vec<::NameType> = Vec::new();
        for _ in 0..::types::GROUP_SIZE {
            close_nodes.push(::test_utils::Random::generate_random());
        }
        let actual_relocated_name = super::calculate_relocated_name(close_nodes.clone(),
        &original_name).unwrap();
        assert!(original_name != actual_relocated_name);
        close_nodes.sort_by(|a, b| if ::name_type::closer_to_target(&a, &b, &original_name) {
            ::std::cmp::Ordering::Less
        } else {
            ::std::cmp::Ordering::Greater
        });
        let first_closest = close_nodes[0].clone();
        let second_closest = close_nodes[1].clone();
        let mut combined: Vec<u8> = Vec::new();

        for i in original_name.get_id().into_iter() {
            combined.push(*i);
        }
        for i in first_closest.get_id().into_iter() {
            combined.push(*i);
        }
        for i in second_closest.get_id().into_iter() {
            combined.push(*i);
        }

        let expected_relocated_name =
            ::NameType(::sodiumoxide::crypto::hash::sha512::hash(&combined).0);
        assert_eq!(expected_relocated_name, actual_relocated_name);

        let mut invalid_combined: Vec<u8> = Vec::new();
        for i in first_closest.get_id().into_iter() {
            invalid_combined.push(*i);
        }
        for i in second_closest.get_id().into_iter() {
            invalid_combined.push(*i);
        }
        for i in original_name.get_id().into_iter() {
            invalid_combined.push(*i);
        }
        let invalid_relocated_name =
            ::NameType(::sodiumoxide::crypto::hash::sha512::hash(&invalid_combined).0);
        assert!(invalid_relocated_name != actual_relocated_name);
    }
}