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
/* * Copyright (c) 2019 Reyk Floeter. All rights reserved. * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved. * Copyright (c) 2008 Alexander von Gernler. All rights reserved. * Copyright (c) 2010,2011 Damien Miller. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ //! Bubble Babble Binary Data Encoding //! //! Convert `bytes` to the "Bubble Babble" data encoding that was defined //! as a mechanism to encode SSH public key fingerprints or any binary data //! in a human-readable format. //! //! # Examples //! //! ```rust //! use bubblebabble::*; //! use std::net::Ipv6Addr; //! //! // Convert 128-bit binary to bubblebabble //! let data = [ //! 0x2a, 0x0a, 0xe5, 0xc0, 0, 0x2, 0, 0x5, 0x5c, 0xf9, 0xcc, 0xc8, 0x7c, 0x48, 0x97, 0xc0, //! ]; //! let babble = bubblebabble(&data); //! assert_eq!(babble, "xepib-panus-bubub-dubyb-hilyz-nefas-myzug-mihos-bexux"); //! //! // Convert IPv6 address to stablebabble //! let localhost: Ipv6Addr = "::1".parse().unwrap(); //! let babbleaddr = stablebabble(&localhost.octets()); //! assert_eq!(babbleaddr, "xebab-7wa-caxax"); //! ``` //! //! # See Also //! //! [The Bubble Babble Binary Data Encoding, Antti Huima, 2011](http://web.mit.edu/kenta/www/one/bubblebabble/spec/jrtrjwzi/draft-huima-01.txt) /// Convert bytes to Bubble Babble `String`. /// /// This is the standard and human-readable format. The Bubble Babble /// includes a checksum that is carried through each generated word. pub fn bubblebabble(bytes: &[u8]) -> String { bubblebabble_impl(bytes, true) } /// Convert bytes to stable Babble `String`. /// /// This modified format lacks the checksum but keeps every word /// stable as they don't include the state. It also compresses repeated /// words by printing them with a prepended counter. pub fn stablebabble(bytes: &[u8]) -> String { bubblebabble_impl(bytes, false) } fn bubblebabble_impl(bytes: &[u8], use_seed: bool) -> String { let vowels = ['a', 'e', 'i', 'o', 'u', 'y']; let consonants = [ 'b', 'c', 'd', 'f', 'g', 'h', 'k', 'l', 'm', 'n', 'p', 'r', 's', 't', 'v', 'z', 'x', ]; let rounds = (bytes.len() / 2) + 1; let mut bubble = String::with_capacity(rounds * 6); let mut seed = 1; bubble.push('x'); // taken from OpenSSH ssh/sshkey.c for i in 0..rounds { let mut idx = [0usize; 5]; if (i + 1 < rounds) || bytes.len() % 2 != 0 { idx[0] = ((((bytes[2 * i]) as usize >> 6) & 3) + seed) % 6; idx[1] = ((bytes[2 * i]) >> 2) as usize & 15; idx[2] = (((bytes[2 * i]) & 3) as usize + (seed / 6)) % 6; bubble.push(vowels[idx[0]]); bubble.push(consonants[idx[1]]); bubble.push(vowels[idx[2]]); if (i + 1) < rounds { idx[3] = ((bytes[(2 * i) + 1]) as usize >> 4) & 15; idx[4] = ((bytes[(2 * i) + 1]) as usize) & 15; bubble.push(consonants[idx[3]]); bubble.push('-'); bubble.push(consonants[idx[4]]); seed = if use_seed { // The seed changes each word and serves as kind of a checksum ((seed * 5) + (((bytes[2 * i]) as usize * 7) as usize + ((bytes[(2 * i) as usize + 1]) as usize))) % 36 } else { 0 }; } } else { idx[0] = seed % 6; idx[1] = 16; idx[2] = seed / 6; bubble.push(vowels[idx[0]]); bubble.push(consonants[idx[1]]); bubble.push(vowels[idx[2]]); } } bubble.push('x'); if use_seed { return bubble; } // Find and replace repetitioins let mut result = String::new(); let mut last = ""; let mut count = 1; for (i, word) in bubble.split('-').enumerate() { if last == word { count += 1; } else if i > 0 { if i > 1 { result.push('-'); } if count > 1 { result.push_str(&count.to_string()); } result.push_str(last); count = 1; } last = word; } result.push('-'); result.push_str(last); // Use "wa" to represent a 0 result.replace("babab", "wa") } #[cfg(test)] mod tests { use super::*; use std::net::Ipv6Addr; #[test] fn test_bubblebabble() { let tests = [ ( Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0), "xebab-bybab-bebub-bybib-bebib-bybub-bebab-bybab-bexux", ), ( Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), "xebab-bybab-bebub-bybib-bebib-bybub-bebab-bybab-cixux", ), ( Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 2), "xebab-bybab-bebub-bybib-bebib-bybub-bebab-bybab-doxux", ), ( "2a0a:e5c0:2:5:5cf9:ccc8:7c48:97c0".parse().unwrap(), "xepib-panus-bubub-dubyb-hilyz-nefas-myzug-mihos-bexux", ), ( "fe80::4685:ff:fe76:1722".parse().unwrap(), "xuzim-bobab-bobib-bobab-bucum-hibiz-zuzil-kyhed-duxix", ), ]; for addr in tests.iter() { assert_eq!(bubblebabble(&(addr.0).octets()), addr.1); } } #[test] fn test_stablebabble() { let tests = [ (Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0), "xebab-7wa-baxax"), (Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), "xebab-7wa-caxax"), (Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 2), "xebab-7wa-daxax"), ( "2a0a:e5c0:2:5:5cf9:ccc8:7c48:97c0".parse().unwrap(), "xepib-pones-wa-dabab-helaz-nofas-mezag-mihos-baxax", ), ( "fe80::4685:ff:fe76:1722".parse().unwrap(), "xuzim-3wa-becim-habaz-zozil-kahod-daxax", ), ]; for addr in tests.iter() { assert_eq!(stablebabble(&(addr.0).octets()), addr.1); } } }