Class: Zxcvbn::Matching

Inherits:
Object
  • Object
show all
Defined in:
lib/zxcvbn/matching.rb

Constant Summary collapse

REGEXEN = 
{
  # alpha_lower: /[a-z]/,
  # recent_year: /19\d\d|200\d|201\d/g
  "recent_year" => /19\d\d|200\d|201\d/
}.freeze
DATE_MAX_YEAR = 
2050
DATE_MIN_YEAR = 
1000
DATE_SPLITS = 
{
  4 => [ # for length-4 strings, eg 1191 or 9111, two ways to split:
    [
      1,
      2 # 1 1 91 (2nd split starts at index 1, 3rd at index 2)
    ],
    [
      2,
      3 # 91 1 1
    ]
  ],
  5 => [
    [
      1,
      3 # 1 11 91
    ],
    [
      2,
      3 # 11 1 91
    ]
  ],
  6 => [
    [
      1,
      2 # 1 1 1991
    ],
    [
      2,
      4 # 11 11 91
    ],
    [
      4,
      5 # 1991 1 1
    ]
  ],
  7 => [
    [
      1,
      3 # 1 11 1991
    ],
    [
      2,
      3 # 11 1 1991
    ],
    [
      4,
      5 # 1991 1 11
    ],
    [
      4,
      6 # 1991 11 1
    ]
  ],
  8 => [
    [
      2,
      4 # 11 11 1991
    ],
    [
      4,
      6 # 1991 11 11
    ]
  ]
}.freeze
SHIFTED_RX = 
/[~!@#$%^&*()_+QWERTYUIOP{}|ASDFGHJKL:"ZXCVBNM<>?]/.freeze
MAX_DELTA = 
5

Instance Method Summary collapse

Instance Method Details

#build_ranked_dict(ordered_list) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/zxcvbn/matching.rb', line 5

def build_ranked_dict(ordered_list)
  result = {}
  # rank starts at 1, not 0
  ordered_list.each_with_index do |word, idx|
    result[word] = idx + 1
  end
  result
end

#build_user_input_dictionary(user_inputs_or_dict) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/zxcvbn/matching.rb', line 207

def build_user_input_dictionary(user_inputs_or_dict)
  # optimization: if we receive a hash, we've been given the dict back (from the repeat matcher)
  return user_inputs_or_dict if user_inputs_or_dict.is_a?(Hash)

  sanitized_inputs = []
  user_inputs_or_dict.each do |arg|
    sanitized_inputs << arg.to_s.downcase if arg.is_a?(String) || arg.is_a?(Numeric) || arg == true || arg == false
  end
  build_ranked_dict(sanitized_inputs)
end

#check_dictionary(matches, password, dictionary_name, ranked_dict) ⇒ Object 



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
 
# File 'lib/zxcvbn/matching.rb', line 166

def check_dictionary(matches, password, dictionary_name, ranked_dict)
  len = password.length
  password_lower = password.downcase
  longest_word_size = ranked_dictionaries_max_word_size.fetch(dictionary_name) do
    ranked_dict.each_key.max_by(&:size)&.size || 0
  end
  search_width = [longest_word_size, len].min
  (0...len).each do |i|
    search_end = [i + search_width, len].min
    (i...search_end).each do |j|
      if ranked_dict.key?(password_lower[i..j])
        word = password_lower[i..j]
        rank = ranked_dict[word]
        matches << {
          "pattern" => "dictionary",
          "i" => i,
          "j" => j,
          "token" => password[i..j],
          "matched_word" => word,
          "rank" => rank,
          "dictionary_name" => dictionary_name,
          "reversed" => false,
          "l33t" => false
        }
      end
    end
  end
end

#date_match(password) ⇒ Object

date matching —————————————————————-



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/zxcvbn/matching.rb', line 567

def date_match(password)
  # a "date" is recognized as:
  #   any 3-tuple that starts or ends with a 2- or 4-digit year,
  #   with 2 or 0 separator chars (1.1.91 or 1191),
  #   maybe zero-padded (01-01-91 vs 1-1-91),
  #   a month between 1 and 12,
  #   a day between 1 and 31.

  # NOTE: this isn't true date parsing in that "feb 31st" is allowed,
  # this doesn't check for leap years, etc.

  # recipe:
  # start with regex to find maybe-dates, then attempt to map the integers
  # onto month-day-year to filter the maybe-dates into dates.
  # finally, remove matches that are substrings of other matches to reduce noise.

  # NOTE: instead of using a lazy or greedy regex to find many dates over the full string,
  # this uses a ^...$ regex against every substring of the password -- less performant but leads
  # to every possible date match.
  matches = []
  maybe_date_no_separator = /^\d{4,8}$/

  # maybe_date_with_separator = %r{
  #   ^
  #   ( \d{1,4} )    # day, month, year
  #   ( [\s/\\_.-] ) # separator
  #   ( \d{1,2} )    # day, month
  #   \2             # same separator
  #   ( \d{1,4} )    # day, month, year
  #   $
  # }
  maybe_date_with_separator = %r{^(\d{1,4})([\s/\\_.-])(\d{1,2})\2(\d{1,4})$}

  (0..(password.length - 4)).each do |i|
    (i + 3..i + 7).each do |j|
      break if j >= password.length

      token = password[i..j]
      next if !maybe_date_no_separator.match(token)

      candidates = []
      DATE_SPLITS[token.length].each do |(k, l)|
        dmy = map_ints_to_dmy([token[0...k].to_i, token[k...l].to_i, token[l..-1].to_i])
        candidates << dmy if dmy
      end

      next if candidates.empty?

      # at this point: different possible dmy mappings for the same i,j substring.
      # match the candidate date that likely takes the fewest guesses: a year closest to 2000.
      # (scoring.REFERENCE_YEAR).

      # ie, considering '111504', prefer 11-15-04 to 1-1-1504
      # (interpreting '04' as 2004)
      best_candidate = candidates.min_by { |candidate| (candidate["year"] - Scoring::REFERENCE_YEAR).abs }
      matches << {
        "pattern" => "date",
        "token" => token,
        "i" => i,
        "j" => j,
        "separator" => "",
        "year" => best_candidate["year"],
        "month" => best_candidate["month"],
        "day" => best_candidate["day"]
      }
    end
  end
  # dates with separators are between length 6 '1/1/91' and 10 '11/11/1991'
  (0..password.length - 6).each do |i|
    (i + 5..i + 9).each do |j|
      break if j >= password.length

      token = password[i..j]
      rx_match = maybe_date_with_separator.match(token)
      next if !rx_match

      dmy = map_ints_to_dmy([rx_match[1].to_i, rx_match[3].to_i, rx_match[4].to_i])
      next if !dmy

      matches << {
        "pattern" => "date",
        "token" => token,
        "i" => i,
        "j" => j,
        "separator" => rx_match[2],
        "year" => dmy["year"],
        "month" => dmy["month"],
        "day" => dmy["day"]
      }
    end
  end
  # matches now contains all valid date strings in a way that is tricky to capture
  # with regexes only. while thorough, it will contain some unintuitive noise:

  # '2015_06_04', in addition to matching 2015_06_04, will also contain
  # 5(!) other date matches: 15_06_04, 5_06_04, ..., even 2015 (matched as 5/1/2020)

  # to reduce noise, remove date matches that are strict substrings of others
  sorted(matches.uniq.reject do |match|
    matches.find do |other_match|
      (match["i"] > other_match["i"] && match["j"] <= other_match["j"]) ||
      (match["i"] >= other_match["i"] && match["j"] < other_match["j"])
    end
  end)
end

#dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries) ⇒ Object

dictionary match (common passwords, english, last names, etc) —————-



156
157
158
159
160
161
162
163
164
 
# File 'lib/zxcvbn/matching.rb', line 156

def dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries)
  # _ranked_dictionaries variable is for unit testing purposes
  matches = []
  _ranked_dictionaries.each do |dictionary_name, ranked_dict|
    check_dictionary(matches, password, dictionary_name, ranked_dict)
  end
  check_dictionary(matches, password, "user_inputs", user_dict)
  sorted(matches)
end

#enumerate_l33t_subs(table) ⇒ Object

returns the list of possible 1337 replacement dictionaries for a given password



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
 
# File 'lib/zxcvbn/matching.rb', line 239

def enumerate_l33t_subs(table)
  dedup = lambda do |subs|
    deduped = []
    members = {}
    subs.each do |sub|
      assoc = sub.map { |k, v| [k, v] }
      assoc.sort!
      label = assoc.map { |k, v| "#{k},#{v}" }.join("-")

      if !members.key?(label)
        members[label] = true
        deduped << sub
      end
    end
    return deduped
  end

  subs = [[]]

  helper = lambda do |keys|
    return if keys.empty?

    first_key = keys[0]
    rest_keys = keys[1..-1]
    next_subs = []
    table[first_key].each do |l33t_chr|
      subs.each do |sub|
        dup_l33t_index = -1
        (0...sub.length).each do |i|
          if sub[i][0] == l33t_chr
            dup_l33t_index = i
            break
          end
        end
        if dup_l33t_index == -1
          sub_extension = sub + [[l33t_chr, first_key]]
          next_subs << sub_extension
        else
          sub_alternative = sub.dup
          sub_alternative.delete_at(dup_l33t_index)
          sub_alternative << [l33t_chr, first_key]
          next_subs << sub
          next_subs << sub_alternative
        end
      end
    end
    subs = dedup.call(next_subs)
    helper.call(rest_keys)
  end

  keys = table.keys
  helper.call(keys)

  sub_dicts = [] # convert from assoc lists to dicts
  subs.each do |sub|
    sub_dict = {}
    sub.each do |(l33t_chr, chr)|
      sub_dict[l33t_chr] = chr
    end
    sub_dicts << sub_dict
  end

  sub_dicts
end

#graphs ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/zxcvbn/matching.rb', line 26

def graphs
  @graphs ||= {
    "qwerty" => ADJACENCY_GRAPHS["qwerty"],
    "dvorak" => ADJACENCY_GRAPHS["dvorak"],
    "keypad" => ADJACENCY_GRAPHS["keypad"],
    "mac_keypad" => ADJACENCY_GRAPHS["mac_keypad"]
  }.freeze
end

#l33t_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries, _l33t_table = l33t_table) ⇒ Object 



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
 
# File 'lib/zxcvbn/matching.rb', line 304

def l33t_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries, _l33t_table = l33t_table)
  matches = []
  enumerate_l33t_subs(relevant_l33t_subtable(password, _l33t_table)).each do |sub|
    break if sub.empty? # corner case: password has no relevant subs.

    subbed_password = translate(password, sub)
    dictionary_match(subbed_password, user_dict, _ranked_dictionaries).each do |match|
      token = password[match["i"]..match["j"]]
      if token.downcase == match["matched_word"]
        next # only return the matches that contain an actual substitution
      end

      match_sub = {} # subset of mappings in sub that are in use for this match
      sub.each do |subbed_chr, chr|
        match_sub[subbed_chr] = chr if token.index(subbed_chr)
      end
      match["l33t"] = true
      match["token"] = token
      match["sub"] = match_sub
      match["sub_display"] = match_sub.map { |k, v| "#{k} -> #{v}" }.join(", ")
      matches << match
    end
  end
  sorted(matches.select do |match|
    # filter single-character l33t matches to reduce noise.
    # otherwise '1' matches 'i', '4' matches 'a', both very common English words
    # with low dictionary rank.
    match["token"].length > 1
  end)
end

#l33t_table ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/zxcvbn/matching.rb', line 35

def l33t_table
  @l33t_table ||= {
    "a" => ["4", "@"],
    "b" => ["8"],
    "c" => ["(", "{", "[", "<"],
    "e" => ["3"],
    "g" => ["6", "9"],
    "i" => ["1", "!", "|"],
    "l" => ["1", "|", "7"],
    "o" => ["0"],
    "s" => ["$", "5"],
    "t" => ["+", "7"],
    "x" => ["%"],
    "z" => ["2"]
  }.freeze
end

#map_ints_to_dm(ints) ⇒ Object 



733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/zxcvbn/matching.rb', line 733

def map_ints_to_dm(ints)
  [ints, ints.reverse].each do |(d, m)|
    if (d >= 1 && d <= 31) && (m >= 1 && m <= 12)
      return {
        "day" => d,
        "month" => m
      }
    end
  end
  nil
end

#map_ints_to_dmy(ints) ⇒ Object 



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/zxcvbn/matching.rb', line 673

def map_ints_to_dmy(ints)
  # given a 3-tuple, discard if:
  #   middle int is over 31 (for all dmy formats, years are never allowed in the middle)
  #   middle int is zero
  #   any int is over the max allowable year
  #   any int is over two digits but under the min allowable year
  #   2 ints are over 31, the max allowable day
  #   2 ints are zero
  #   all ints are over 12, the max allowable month
  return if ints[1] > 31 || ints[1] <= 0

  over_12 = 0
  over_31 = 0
  under_1 = 0
  ints.each do |int|
    return nil if (int > 99 && int < DATE_MIN_YEAR) || int > DATE_MAX_YEAR

    over_31 += 1 if int > 31
    over_12 += 1 if int > 12
    under_1 += 1 if int <= 0
  end
  return if over_31 >= 2 || over_12 == 3 || under_1 >= 2

  possible_year_splits = [
    [ints[2], ints[0..1]], # year last
    [ints[0], ints[1..2]] # year first
  ]
  possible_year_splits.each do |(y, rest)|
    if DATE_MIN_YEAR <= y && y <= DATE_MAX_YEAR
      dm = map_ints_to_dm(rest)

      # for a candidate that includes a four-digit year,
      # when the remaining ints don't match to a day and month,
      # it is not a date.
      return nil if !dm

      return {
        "year" => y,
        "month" => dm["month"],
        "day" => dm["day"]
      }
    end
  end

  # given no four-digit year, two digit years are the most flexible int to match, so
  # try to parse a day-month out of ints[0..1] or ints[1..0]
  possible_year_splits.each do |(y, rest)| # rubocop:disable Style/CombinableLoops
    dm = map_ints_to_dm(rest)
    if dm
      y = two_to_four_digit_year(y)
      return {
        "year" => y,
        "month" => dm["month"],
        "day" => dm["day"]
      }
    end
  end
  nil
end

#omnimatch(password, user_inputs = []) ⇒ Object

omnimatch – combine everything ———————————————-



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/zxcvbn/matching.rb', line 139

def omnimatch(password, user_inputs = [])
  user_dict = build_user_input_dictionary(user_inputs)
  matches = []
  matches += dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries)
  matches += reverse_dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries)
  matches += l33t_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries, _l33t_table = l33t_table)
  matches += spatial_match(password, _graphs = graphs)
  matches += repeat_match(password, user_dict)
  matches += sequence_match(password)
  matches += regex_match(password, _regexen = REGEXEN)
  matches += date_match(password)
  sorted(matches)
end

#ranked_dictionaries ⇒ Object 



14
15
16
17
18
 
# File 'lib/zxcvbn/matching.rb', line 14

def ranked_dictionaries
  @ranked_dictionaries ||= Zxcvbn.frequency_lists.transform_values do |lst|
    build_ranked_dict(lst)
  end
end

#ranked_dictionaries_max_word_size ⇒ Object 



20
21
22
23
24
 
# File 'lib/zxcvbn/matching.rb', line 20

def ranked_dictionaries_max_word_size
  @ranked_dictionaries_max_word_size ||= ranked_dictionaries.transform_values do |word_scores|
    word_scores.each_key.max_by(&:size)&.size || 0
  end
end

#regex_match(password, _regexen = REGEXEN) ⇒ Object

regex matching —————————————————————



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/zxcvbn/matching.rb', line 543

def regex_match(password, _regexen = REGEXEN)
  matches = []
  _regexen.each do |name, regex|
    # regex.lastIndex = 0; # keeps regex_match stateless
    match_index = 0
    while (rx_match = regex.match(password, match_index))
      token = rx_match[0]
      matches << {
        "pattern" => "regex",
        "token" => token,
        "i" => rx_match.begin(0),
        "j" => rx_match.end(0) - 1,
        "regex_name" => name,
        "regex_match" => rx_match.to_a
      }
      match_index = rx_match.begin(0) + 1
    end
  end
  sorted(matches)
end

#relevant_l33t_subtable(password, table) ⇒ Object

dictionary match with common l33t substitutions ——————————

makes a pruned copy of l33t_table that only includes password’s possible substitutions



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zxcvbn/matching.rb', line 222

def relevant_l33t_subtable(password, table)
  password_chars = {}
  password.chars.each do |chr|
    password_chars[chr] = true
  end
  subtable = {}
  table.each do |letter, subs|
    relevant_subs = []
    subs.each do |sub|
      relevant_subs << sub if password_chars[sub]
    end
    subtable[letter] = relevant_subs if !relevant_subs.empty?
  end
  subtable
end

#repeat_match(password, user_dict) ⇒ Object

repeats (aaa, abcabcabc) and sequences (abcdef) ——————————



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
 
# File 'lib/zxcvbn/matching.rb', line 420

def repeat_match(password, user_dict)
  matches = []
  greedy = /(.+)\1+/
  lazy = /(.+?)\1+/
  lazy_anchored = /^(.+?)\1+$/
  last_index = 0
  while last_index < password.length
    # greedy_last_index = lazy_last_index = last_index
    greedy_match = greedy.match(password, last_index)
    lazy_match = lazy.match(password, last_index)
    break if !greedy_match

    # coverage ???
    if greedy_match[0].length > lazy_match[0].length
      # greedy beats lazy for 'aabaab'
      #   greedy: [aabaab, aab]
      #   lazy:   [aa,     a]
      match = greedy_match
      # greedy's repeated string might itself be repeated, eg.
      # aabaab in aabaabaabaab.
      # run an anchored lazy match on greedy's repeated string
      # to find the shortest repeated string
      base_token = lazy_anchored.match(match[0])[1]
    else
      # lazy beats greedy for 'aaaaa'
      #   greedy: [aaaa,  aa]
      #   lazy:   [aaaaa, a]
      match = lazy_match
      base_token = match[1]
    end
    i = match.begin(0)
    j = match.end(0) - 1
    # recursively match and score the base string
    base_analysis = Scoring.most_guessable_match_sequence(base_token, omnimatch(base_token, user_dict))
    base_matches = base_analysis["sequence"]
    base_guesses = base_analysis["guesses"]
    matches << {
      "pattern" => "repeat",
      "i" => i,
      "j" => j,
      "token" => match[0],
      "base_token" => base_token,
      "base_guesses" => base_guesses,
      "base_matches" => base_matches,
      "repeat_count" => match[0].length / base_token.length
    }
    last_index = j + 1
  end
  matches
end

#reverse_dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/zxcvbn/matching.rb', line 195

def reverse_dictionary_match(password, user_dict, _ranked_dictionaries = ranked_dictionaries)
  reversed_password = password.reverse
  matches = dictionary_match(reversed_password, user_dict, _ranked_dictionaries)
  matches.each do |match|
    match["token"] = match["token"].reverse
    match["reversed"] = true
    # map coordinates back to original string
    match["i"], match["j"] = [password.length - 1 - match["j"], password.length - 1 - match["i"]]
  end
  sorted(matches)
end

#sequence_match(password) ⇒ Object 



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/zxcvbn/matching.rb', line 473

def sequence_match(password)
  # Identifies sequences by looking for repeated differences in unicode codepoint.
  # this allows skipping, such as 9753, and also matches some extended unicode sequences
  # such as Greek and Cyrillic alphabets.

  # for example, consider the input 'abcdb975zy'

  # password: a   b   c   d   b    9   7   5   z   y
  # index:    0   1   2   3   4    5   6   7   8   9
  # delta:      1   1   1  -2  -41  -2  -2  69   1

  # expected result:
  # [(i, j, delta), ...] = [(0, 3, 1), (5, 7, -2), (8, 9, 1)]
  return [] if password.length == 1

  result = []

  update = lambda do |i, j, delta|
    delta ||= 0
    if (j - i > 1 || delta.abs == 1) && (delta.abs > 0 && delta.abs <= MAX_DELTA)
      token = password[i..j]
      case token
      when /^[a-z]+$/
        sequence_name = "lower"
        sequence_space = 26
      when /^[A-Z]+$/
        sequence_name = "upper"
        sequence_space = 26
      when /^\d+$/
        sequence_name = "digits"
        sequence_space = 10
      else
        # conservatively stick with roman alphabet size.
        # (this could be improved)
        sequence_name = "unicode"
        sequence_space = 26
      end
      return result << {
        "pattern" => "sequence",
        "i" => i,
        "j" => j,
        "token" => password[i..j],
        "sequence_name" => sequence_name,
        "sequence_space" => sequence_space,
        "ascending" => delta > 0
      }
    end
  end

  result = []
  i = 0
  last_delta = nil

  (1...password.length).each do |k|
    delta = password[k].ord - password[k - 1].ord
    last_delta ||= delta
    next if delta == last_delta

    j = k - 1
    update.call(i, j, last_delta)
    i = j
    last_delta = delta
  end
  update.call(i, password.length - 1, last_delta)
  result
end

#sorted(matches) ⇒ Object 



131
132
133
134
 
# File 'lib/zxcvbn/matching.rb', line 131

def sorted(matches)
  # sort on i primary, j secondary
  matches.sort_by! { |match| [match["i"], match["j"]] }
end

#spatial_match(password, _graphs = graphs) ⇒ Object

spatial match (qwerty/dvorak/keypad) —————————————–



338
339
340
341
342
343
344
 
# File 'lib/zxcvbn/matching.rb', line 338

def spatial_match(password, _graphs = graphs)
  matches = []
  _graphs.each do |graph_name, graph|
    matches += spatial_match_helper(password, graph, graph_name)
  end
  sorted(matches)
end

#spatial_match_helper(password, graph, graph_name) ⇒ Object 



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
 
# File 'lib/zxcvbn/matching.rb', line 348

def spatial_match_helper(password, graph, graph_name)
  matches = []
  i = 0
  while i < password.length - 1
    j = i + 1
    last_direction = nil
    turns = 0
    shifted_count = if ["qwerty", "dvorak"].include?(graph_name) && SHIFTED_RX.match?(password[i])
      # initial character is shifted
      1
    else
      0
    end
    loop do
      prev_char = password[j - 1]
      found = false
      found_direction = -1
      cur_direction = -1
      adjacents = graph[prev_char] || []
      # consider growing pattern by one character if j hasn't gone over the edge.
      if j < password.length
        cur_char = password[j]
        adjacents.each do |adj|
          cur_direction += 1
          if adj&.index(cur_char)
            found = true
            found_direction = cur_direction
            if adj.index(cur_char) == 1
              # index 1 in the adjacency means the key is shifted,
              # 0 means unshifted: A vs a, % vs 5, etc.
              # for example, 'q' is adjacent to the entry '2@'.
              # @ is shifted w/ index 1, 2 is unshifted.
              shifted_count += 1
            end
            if last_direction != found_direction
              # adding a turn is correct even in the initial case when last_direction is null:
              # every spatial pattern starts with a turn.
              turns += 1
              last_direction = found_direction
            end
            break
          end
        end
      end
      # if the current pattern continued, extend j and try to grow again
      if found
        j += 1
      else
        # otherwise push the pattern discovered so far, if any...
        if j - i > 2 # don't consider length 1 or 2 chains.
          matches << {
            "pattern" => "spatial",
            "i" => i,
            "j" => j - 1,
            "token" => password[i...j],
            "graph" => graph_name,
            "turns" => turns,
            "shifted_count" => shifted_count
          }
        end
        # ...and then start a new search for the rest of the password.
        i = j
        break
      end
    end
  end
  matches
end

#translate(string, chr_map) ⇒ Object 



127
128
129
 
# File 'lib/zxcvbn/matching.rb', line 127

def translate(string, chr_map)
  string.chars.map { |chr| chr_map[chr] || chr }.join
end

#two_to_four_digit_year(year) ⇒ Object 



745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/zxcvbn/matching.rb', line 745

def two_to_four_digit_year(year)
  if year > 99
    year
  elsif year > 50
    # 87 -> 1987
    year + 1900
  else
    # 15 -> 2015
    year + 2000
  end
end