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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use indexmap::set::Iter;
use indexmap::IndexSet;
use rand::Rng;
use std::char::ParseCharError;
use std::fmt;
use std::iter::FromIterator;
use std::ops::{Deref, DerefMut};
use std::str::FromStr;

/// Collection of unique chars. This is wrapper for [`IndexSet<char>`]
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Pool(IndexSet<char>);

impl Deref for Pool {
    type Target = IndexSet<char>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Pool {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl FromIterator<char> for Pool {
    fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> Self {
        let mut pool = Pool::new();
        pool.0 = IndexSet::from_iter(iter);

        pool
    }
}

impl Extend<char> for Pool {
    fn extend<T: IntoIterator<Item = char>>(&mut self, iter: T) {
        self.0.extend(iter)
    }
}

impl FromStr for Pool {
    type Err = ParseCharError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Pool(s.chars().collect::<IndexSet<char>>()))
    }
}

impl fmt::Display for Pool {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0.iter().collect::<String>())
    }
}

impl Pool {
    /// Create new empty pool
    pub fn new() -> Self {
        Pool(IndexSet::new())
    }

    /// Return number of chars in the pool
    ///
    /// # Examples
    /// ```
    /// # use upwd_lib::Pool;
    /// let pool: Pool = "0123456789".parse().unwrap();
    ///
    /// assert_eq!(pool.len(), 10)
    /// ```
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Extracts all chars from string and adds them to the pool
    pub fn extend_from_string(&mut self, s: &str) -> &mut Self {
        self.0.extend(s.chars().collect::<IndexSet<char>>());

        self
    }

    /// Returns true if pool contains no elements
    ///
    /// # Examples
    /// ```
    /// # use upwd_lib::Pool;
    /// let pool = Pool::new();
    ///
    /// assert!(pool.is_empty())
    /// ```
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Get char by index
    pub(crate) fn get(&self, index: usize) -> Option<&char> {
        self.0.get_index(index)
    }

    /// Check if char exists in the pool
    ///
    /// # Examples
    /// ```
    /// # use upwd_lib::Pool;
    /// let pool: Pool = "ABCDEFG".parse().unwrap();
    ///
    /// assert!(pool.contains('D'))
    /// ```
    pub fn contains(&self, ch: char) -> bool {
        self.0.contains(&ch)
    }

    /// Returns true if pool contains each char from the string `elements`
    ///
    /// # Examples
    /// ```
    /// # use upwd_lib::Pool;
    /// let pool: Pool = "ABCDEFG".parse().unwrap();
    ///
    /// assert!(pool.contains_all("DAG"))
    /// ```
    pub fn contains_all(&self, elements: &str) -> bool {
        self.0
            .is_superset(&elements.chars().collect::<IndexSet<char>>())
    }

    /// Insert char to pool.
    /// If an equivalent char already exists in the pool, then the pool is not changed.
    #[allow(dead_code)]
    pub(crate) fn insert(&mut self, ch: char) {
        self.0.insert(ch);
    }

    /// Returns iterator
    pub fn iter(&self) -> Iter<'_, char> {
        self.0.iter()
    }

    /// Remove char from pool. Like a [Vec::swap_remove]
    pub fn swap_remove(&mut self, ch: &char) -> bool {
        self.0.swap_remove(ch)
    }

    /// Remove char from pool. Like a [Vec::remove]
    pub fn shift_remove(&mut self, ch: &char) -> bool {
        self.0.shift_remove(ch)
    }

    /// Remove all chars of the string `elements` from pool
    pub fn remove_all(&mut self, elements: &str) {
        elements.chars().for_each(|ch| {
            self.swap_remove(&ch);
        });
    }

    /// Sorts the chars in the pool
    ///
    /// # Examples
    /// ```
    /// # use upwd_lib::Pool;
    /// # use std::str::FromStr;
    /// let mut pool = Pool::from_str("31524").unwrap();
    /// pool.sort();
    ///
    /// assert_eq!(pool, Pool::from_str("12345").unwrap())
    /// ```
    pub fn sort(&mut self) {
        self.0.sort()
    }
}

/// Generate random password.
///
/// # Examples
/// ```
/// # use upwd_lib::{Pool, generate_password};
/// let pool = "0123456789".parse().unwrap();
/// let password = generate_password(&pool, 15);
///
/// assert_eq!(password.chars().count(), 15);
/// ```
///
/// # Panics
/// Panics if `pool` is empty.
pub fn generate_password(pool: &Pool, length: usize) -> String {
    assert!(!pool.is_empty(), "Pool contains no elements!");

    let mut rng = rand::thread_rng();

    (0..length)
        .map(|_| {
            let idx = rng.gen_range(0, pool.len());
            *pool.get(idx).unwrap()
        })
        .collect()
}

/// Calculates entropy.
///
/// # Examples
/// ```
/// # use upwd_lib::calculate_entropy;
///
/// assert_eq!(calculate_entropy(12, 64), 72_f64);
/// ```
pub fn calculate_entropy(length: usize, pool_size: usize) -> f64 {
    length as f64 * (pool_size as f64).log2()
}

/// Calculates the minimum password length required to obtain a given entropy.
///
/// # Examples
/// ```
/// # use upwd_lib::calculate_length;
///
/// assert_eq!(calculate_length(128_f64, 64_f64), 22_f64);
/// ```
pub fn calculate_length(entropy: f64, pool_size: f64) -> f64 {
    (entropy / pool_size.log2()).ceil()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn pool_deref_mut() {
        let mut pool = Pool::from_str("12345").unwrap();
        *pool = "abcde".chars().collect::<IndexSet<char>>();

        assert_eq!(*pool, "abcde".chars().collect::<IndexSet<char>>())
    }

    #[test]
    fn pool_deref() {
        let pool = Pool::from_str("12345").unwrap();

        assert_eq!(*pool, "12345".chars().collect::<IndexSet<char>>())
    }

    #[test]
    fn pool_sort() {
        let mut pool = Pool::from_str("31524").unwrap();
        pool.sort();

        assert_eq!(pool, Pool::from_str("12345").unwrap())
    }

    #[test]
    fn pool_extend() {
        let mut pool = Pool::from_str("abc").unwrap();
        pool.extend(vec!['d', 'e']);

        assert_eq!(pool, Pool::from_str("abcde").unwrap())
    }

    #[test]
    fn pool_from_iter() {
        let iter = vec!['a', 'b', 'c'].into_iter();

        assert_eq!(iter.collect::<Pool>(), Pool::from_str("abc").unwrap());
    }

    #[test]
    fn pool_remove_all() {
        let mut pool: Pool = "abcde".parse().unwrap();
        pool.remove_all("ace");

        assert_eq!(pool, "bd".parse::<Pool>().unwrap());
    }

    #[test]
    fn pool_swap_remove() {
        let mut pool: Pool = "abcdefz".parse().unwrap();

        assert!(pool.swap_remove(&'b'));
        assert_eq!(pool.get(1), Some(&'z'));
        assert_eq!(pool.get(6), None);
    }

    #[test]
    fn pool_shift_remove() {
        let mut pool: Pool = "abcdefz".parse().unwrap();

        assert!(pool.shift_remove(&'b'));
        assert_eq!(pool.get(1), Some(&'c'));
        assert_eq!(pool.get(6), None);
    }

    #[test]
    fn pool_iter() {
        let pool: Pool = "abcdefz".parse().unwrap();
        let mut iter = pool.iter();

        assert_eq!(iter.next(), Some(&'a'));
        assert_eq!(iter.next(), Some(&'b'));
        assert_eq!(iter.last(), Some(&'z'));
    }

    #[test]
    fn pool_display() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert_eq!(pool.to_string(), "0123456789".to_owned());
    }

    #[test]
    fn pool_contains_all() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert!(pool.contains_all("2357"));
    }

    #[test]
    fn pool_contains_all_assert_false() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert!(!pool.contains_all("0123F"));
    }

    #[test]
    fn pool_contains() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert!(pool.contains('5'));
    }

    #[test]
    fn pool_contains_assert_false() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert!(!pool.contains('A'));
    }

    #[test]
    fn pool_get() {
        let pool: Pool = "ABCD".parse().unwrap();

        assert_eq!(pool.get(0), Some(&'A'))
    }

    #[test]
    fn pool_is_empty() {
        let pool = Pool::new();

        assert!(pool.is_empty());
    }

    #[test]
    fn pool_is_empty_assert_false() {
        let pool = Pool::from_str("0123456789").unwrap();

        assert!(!pool.is_empty());
    }

    #[test]
    fn pool_len() {
        let pool: Pool = "0123456789".parse().unwrap();

        assert_eq!(pool.len(), 10)
    }

    #[test]
    fn pool_insert() {
        let mut pool = "ABC".parse::<Pool>().unwrap();
        pool.insert('D');

        assert_eq!(pool, "ABCD".parse::<Pool>().unwrap())
    }

    #[test]
    fn pool_extend_from_string() {
        let mut pool = "ABC".parse::<Pool>().unwrap();
        let mut other_pool = pool.clone();

        other_pool.insert('D');
        pool.extend_from_string("D");

        assert_eq!(other_pool, pool)
    }

    #[test]
    fn pool_from_string() {
        let indexset: IndexSet<_> = "0123456789".chars().collect();

        assert_eq!(Pool(indexset), "0123456789".to_owned().parse().unwrap())
    }

    #[test]
    fn pool_from_str() {
        let indexset: IndexSet<_> = "0123456789".chars().collect();

        assert_eq!(Pool(indexset), "0123456789".parse().unwrap())
    }

    #[test]
    fn generate_password_assert_len() {
        let pool = "0123456789".chars().collect::<IndexSet<char>>();
        let password = generate_password(&Pool(pool), 15);

        assert_eq!(password.chars().count(), 15);
    }

    #[test]
    #[should_panic(expected = "Pool contains no elements!")]
    fn generate_password_passed_empty_pool() {
        let pool = "".chars().collect::<IndexSet<char>>();

        generate_password(&Pool(pool), 15);
    }

    #[test]
    fn calculate_entropy_assert_true() {
        let entropy = calculate_entropy(12, 64);

        assert_eq!(entropy, 72_f64);
    }

    #[test]
    fn calculate_entropy_passed_length_is_0() {
        let entropy = calculate_entropy(0, 64);

        assert_eq!(entropy, 0_f64)
    }

    #[test]
    fn calculate_entropy_passed_pool_size_is_0() {
        let entropy = calculate_entropy(12, 0);

        assert_eq!(entropy, f64::NEG_INFINITY)
    }

    #[test]
    fn calculate_entropy_passed_pool_size_is_1() {
        let entropy = calculate_entropy(12, 1);

        assert_eq!(entropy, 0_f64)
    }

    #[test]
    fn calculate_length_assert_true() {
        let length = calculate_length(128_f64, 64_f64);

        assert_eq!(length, 22_f64);
    }

    #[test]
    fn calculate_length_entropy_is_0() {
        let length = calculate_length(0_f64, 64_f64);

        assert_eq!(length, 0_f64);
    }

    #[test]
    fn calculate_length_pool_size_is_0() {
        let length = calculate_length(128_f64, 0_f64);

        assert_eq!(length, 0_f64);
    }

    #[test]
    fn calculate_length_entropy_and_pool_size_is_0() {
        let length = calculate_length(0_f64, 0_f64);

        assert_eq!(length, 0_f64);
    }

    #[test]
    fn calculate_length_entropy_is_0_and_pool_size_is_1() {
        let length = calculate_length(0_f64, 1_f64);

        assert!(length.is_nan());
    }

    #[test]
    fn calculate_length_entropy_is_1_and_pool_size_is_1() {
        let length = calculate_length(1_f64, 1_f64);

        assert_eq!(length, f64::INFINITY);
    }
}