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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
#[cfg(test)]
extern crate rand;

use std::cmp::Ordering;
use std::ops::Deref;

mod words;
use words::WORDS;

#[derive(Debug)]
enum FromTransformSubkeyError {
    InvalidWord(String),
    IncorrectParity,
    TooShort, // aka. too few words (not enough to pull six)
    NothingToTransform
}

#[derive(Debug)]
pub enum FromRfc1751Error {
    InvalidWord(String),
    IncorrectParity(Vec<u8>), // we still hand back what we got, despite wrong parity
    NotMultipleOfSixWords // not a multiple of six words
}

#[derive(Debug)]
pub enum ToRfc1751Error {
    NotMultipleOfEight
}

pub trait FromRfc1751 {
    fn from_rfc1751(&self) -> Result<Vec<u8>, FromRfc1751Error>;
}

pub trait ToRfc1751 {
    fn to_rfc1751(&self) -> Result<String, ToRfc1751Error>;
}

fn get_word_index(word: &str) -> Result<usize, FromTransformSubkeyError> {
    match word.len() {
        // we know that all valid words are 1 to 4 letters long
        1...4 => {
            // binary search for the word's index (aka. bit value)
            WORDS.binary_search_by(|g| 
                if g.len() < 4 && word.len() == 4 {
                    Ordering::Less
                } else if g.len() == 4 && word.len() < 4 {
                    Ordering::Greater
                } else {
                    g.cmp(&word)
                }
            ).map_err(|_| FromTransformSubkeyError::InvalidWord(word.to_owned()))
        },
        _ => Err(FromTransformSubkeyError::InvalidWord(word.to_owned()))
    }
}

#[allow(unused_parens)]
fn from_rfc1751_transform_append_subkey<I, T>(iter: &mut I,
        append_to: &mut Vec<u8>) -> Result<(), FromTransformSubkeyError> 
        where I: Iterator<Item=T>, T: AsRef<str> {

    let mut count = 0; // counter for ensuring we have enough for six words
                       // (we just use the first six if we have emore)
    let mut build: usize = 0;
    let mut have = 0;
    let mut sum_for_parity: usize = 0;
    loop {
        if have > 8 {
            // if we have 8 bits or more available, grab the first 8
            let d = have - 8;
            let mut commit = (build >> d);
            append_to.push(commit as u8);

            build = build % (2 << (d-1));
            have = d;

            // two-bit parity calculation
            while commit > 0 {
                sum_for_parity += (commit % 4);
                commit /= 4;
            }
        } else {
            // don't pull more than six words
            if count == 6 {
                break;
            }

            // otherwise pull another word to get more bits
            let pull_word = match iter.next() {
                Some(w) => {
                    count += 1;
                    w
                },
                None => break
            };
            let addition = try!(get_word_index(pull_word.as_ref()));

            // shift our existing bits to make room for the addition if necessary
            if have > 0 {
                build *= (2 << 10);
            }

            // append the new bits
            build += addition;
            have += 11;
        }
    }

    if count == 0 {
        Err(FromTransformSubkeyError::NothingToTransform)
    } else if count != 6 {
        // check for count (need 6 words)
        Err(FromTransformSubkeyError::TooShort)
    } else if build != (sum_for_parity % 4) {
        // check for parity (the last two bits were left in build)
        Err(FromTransformSubkeyError::IncorrectParity)
    } else {
        Ok(())
    }
}

fn from_rfc1751_transform_general<I, T>(mut iter: I) -> Result<Vec<u8>, FromRfc1751Error>
        where I: Iterator<Item=T>, T:AsRef<str> {
    let mut fill = Vec::new();
    loop {
        let result = from_rfc1751_transform_append_subkey(&mut iter, &mut fill);
        if result.is_err() {
            match result.unwrap_err() {
                FromTransformSubkeyError::NothingToTransform => break,
                FromTransformSubkeyError::InvalidWord(w) =>
                    return Err(FromRfc1751Error::InvalidWord(w)),
                FromTransformSubkeyError::TooShort =>
                    return Err(FromRfc1751Error::NotMultipleOfSixWords),
                FromTransformSubkeyError::IncorrectParity =>
                    return Err(FromRfc1751Error::IncorrectParity(fill))
            }
        }
    }
    Ok(fill)
}

// impl<C, T> FromRfc1751 for C where C: Deref<Target=[T]>, T: AsRef<str> {
    // fn from_rfc1751(&self) -> Result<Vec<u8>, FromRfc1751Error> {
        // from_rfc1751_transform_general(self.iter())
    // }
// }

impl<S> FromRfc1751 for S where S: AsRef<str> {
    fn from_rfc1751(&self) -> Result<Vec<u8>, FromRfc1751Error> {
        from_rfc1751_transform_general(self.as_ref().split_whitespace())
    }
}

#[allow(unused_parens)]
fn to_rfc1751_transform_append_subkey(input: &[u8], append_to: &mut String) {
    let mut build: usize = 0;
    let mut have = 0;
    let mut sum_for_parity = 0;
    let mut iter = input.iter();
    loop {
        if have > 11 {
            let d = have - 11;
            let commit = (build >> d);
            append_to.push_str(WORDS[commit]);
            append_to.push(' ');

            build = build % (2 << (d-1));
            have = d
        } else {
            let mut addition = match iter.next() {
                Some(&x) => x as usize,
                None => break
            };

            if have > 0 {
                build *= (2 << 7);
            }

            build += addition;
            have += 8;

            // two-bit parity calculation
            while addition > 0 {
                sum_for_parity += (addition % 4);
                addition /= 4;
            }
        }

    }

    // make room for the two-bit parity
    build *= 4;
    // append the parity
    build += (sum_for_parity % 4);
    // commit the final word (that includes the parity bits)
    append_to.push_str(WORDS[build]);
}

impl ToRfc1751 for [u8] {
    fn to_rfc1751(&self) -> Result<String, ToRfc1751Error> {
        if self.len() % 8 != 0 {
            return Err(self::ToRfc1751Error::NotMultipleOfEight);
        }

        let mut result = String::new();
        for subkey in self.chunks(8) {
            to_rfc1751_transform_append_subkey(subkey, &mut result);
            result.push(' ');
        }
        // pop trailing space
        result.pop();

        Ok(result)
    }
}


#[cfg(test)]
mod tests {
    macro_rules! parameterized_tests {
        ( $func:path; $( $i:ident: $( $param:expr ),*  => $expected:expr )* ) => {
            $(
                #[test]
                fn $i() {
                    $func($( $param ),*, $expected);
                }
            )*
        }
    }

    use rand::{thread_rng, Rng};
    use words::WORDS;
    use super::FromRfc1751;
    use super::ToRfc1751;

    parameterized_tests! {
        from_subkey_test;

        from_subkey_test_01: &["TIDE", "ITCH", "SLOW", "REIN", "RULE", "MOT"] =>
                             &[0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53]
        from_subkey_test_02: &["RASH", "BUSH", "MILK", "LOOK", "BAD", "BRIM"] =>
                             &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE]
        from_subkey_test_03: &["AVID", "GAFF", "BAIT", "ROT", "POD", "LOVE"] =>
                             &[0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66]
        from_subkey_test_04: &["TROD", "MUTE", "TAIL", "WARM", "CHAR", "KONG"] =>
                             &[0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50]
        from_subkey_test_05: &["HAAG", "CITY", "BORE", "O", "TEAL", "AWL"] =>
                             &[0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09]
    }

    fn from_subkey_test(input: &[&'static str], expected: &[u8]) {
        let mut fill = Vec::new();
        let mut iter = input.iter();
        let result = super::from_rfc1751_transform_append_subkey(&mut iter, &mut fill);
        assert!(result.is_ok());
        assert_eq!(fill, expected);
    }

    #[test]
    fn from_subkey_test_too_short() {
        let mut fill = Vec::new();
        let input = &["TROD", "MUTE", "TAIL", "WARM", "CHAR"]; // only five words
        let mut iter = input.iter();
        let result = super::from_rfc1751_transform_append_subkey(&mut iter, &mut fill);
        assert!(result.is_err());
        assert!(match result.unwrap_err() {
            super::FromTransformSubkeyError::TooShort => true,
            _ => false
        });
    }

    #[test]
    fn from_subkey_test_nothing() {
        let mut fill = Vec::new();
        let input: &[&str] = &[]; // empty!
        let mut iter = input.iter();
        let result = super::from_rfc1751_transform_append_subkey(&mut iter, &mut fill);
        assert!(result.is_err());
        assert!(match result.unwrap_err() {
            super::FromTransformSubkeyError::NothingToTransform => true,
            _ => false
        });
    }

    parameterized_tests! {
        from_test;

        from_test_01: "TIDE ITCH SLOW REIN RULE MOT" =>
                      &[0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53]
        from_test_02: "RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE" =>
                      &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE,
                        0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66]
        from_test_03: "TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL" =>
                      &[0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50,
                        0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09]
        from_test_04: concat!(
                        "RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE ",
                        "TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL ",
                        "TIDE ITCH SLOW REIN RULE MOT"
                      ) =>
                      &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE,
                        0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66,
                        0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50,
                        0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09,
                        0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53]
    }

    fn from_test(input: &'static str, expected: &[u8]) {
        let result = input.from_rfc1751();
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), expected);

        let owned = input.to_owned();
        let result_owned = owned.from_rfc1751();
        assert!(result_owned.is_ok());
        assert_eq!(result_owned.unwrap(), expected);
    }

    parameterized_tests! {
        to_subkey_test;

        to_subkey_test_01: &[0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53] =>
                           "TIDE ITCH SLOW REIN RULE MOT"
        to_subkey_test_02: &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE] =>
                           "RASH BUSH MILK LOOK BAD BRIM"
        to_subkey_test_03: &[0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66] =>
                           "AVID GAFF BAIT ROT POD LOVE"
        to_subkey_test_04: &[0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50] =>
                           "TROD MUTE TAIL WARM CHAR KONG"
        to_subkey_test_05: &[0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09] =>
                           "HAAG CITY BORE O TEAL AWL"
    }

    fn to_subkey_test(target: &[u8], expected: &'static str) {
        let mut result = String::new();
        super::to_rfc1751_transform_append_subkey(target, &mut result);
        assert_eq!(result, expected);
    }

    parameterized_tests! {
        to_test;

        to_test_01: &[0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53] =>
                    "TIDE ITCH SLOW REIN RULE MOT"
        to_test_02: &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE, 
                      0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66] =>
                    "RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE"
        to_test_03: &[0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50, 
                      0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09] =>
                    "TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL"
        to_test_04: &[0xCC, 0xAC, 0x2A, 0xED, 0x59, 0x10, 0x56, 0xBE, 
                      0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66,
                      0xEF, 0xF8, 0x1F, 0x9B, 0xFB, 0xC6, 0x53, 0x50, 
                      0x92, 0x0C, 0xDD, 0x74, 0x16, 0xDE, 0x80, 0x09,
                      0xEB, 0x33, 0xF7, 0x7E, 0xE7, 0x3D, 0x40, 0x53] => 
                    concat!(
                        "RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE ",
                        "TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL ",
                        "TIDE ITCH SLOW REIN RULE MOT"
                    )
    }

    fn to_test(target: &[u8], expected: &'static str) {
        let result = target.to_rfc1751();
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), expected);
    }

    #[test]
    fn to_test_wrong_length() {
        // this input has length of 10, not a multiple of eight
        let target = &[0xFF, 0x4F, 0x90, 0xFD, 0x44, 0x1C, 0x53, 0x47, 0x66, 0xFF];
        let result = target.to_rfc1751();
        assert!(result.is_err());
        assert!(match result.unwrap_err() {
            super::ToRfc1751Error::NotMultipleOfEight => true,
            // There's currently only one ToRfc1751Error, so this branch would be unreachable
            // _ => false
        });
    }

    parameterized_tests! {
        word_index_test;

        word_index_test_01: "TIDE" => Ok(1881)
        word_index_test_02: "BAIT" => Ok(648)
        word_index_test_03: "AWL" => Ok(39)
        word_index_test_04: "tide" => Err(()) // we are case-sensitive, clients deal with case
        word_index_test_05: "BABABA" => Err(())
        word_index_test_06: "" => Err(())
        word_index_test_07: "AX" => Ok(41)
    }

    fn word_index_test(word: &'static str, expected: Result<usize, ()>) {
        let result = super::get_word_index(word);
        match expected {
            Ok(x) => {
                assert!(result.is_ok());
                assert_eq!(result.unwrap(), x);
            },
            Err(_) => {
                assert!(result.is_err());
                assert!(match result.unwrap_err() {
                    super::FromTransformSubkeyError::InvalidWord(w) => (word == w),
                    _ => false
                });
            }
        }
    }

    #[test]
    fn word_index_test_ten_random() {
        let mut rng = thread_rng();
        for _ in 0..10 {
            let n: usize = rng.gen_range(0, WORDS.len());
            let word = WORDS[n];
            let result = super::get_word_index(word);
            println!("word_index_test_five_random: case {} <--> {}; result {:?}",
                     n, word, result);
            assert!(result.is_ok());
            assert_eq!(result.unwrap(), n);
        }
    }

}