2019-05-02 18:17:27 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-12-20 16:34:34 -05:00
|
|
|
# CommonPasswords will check a given password against a list of the most commonly used passwords.
|
2016-03-03 07:06:50 -05:00
|
|
|
# The list comes from https://github.com/danielmiessler/SecLists/tree/master/Passwords
|
|
|
|
# specifically the list of 10 million passwords, top 100k, filtered by length
|
|
|
|
#
|
2013-12-20 16:34:34 -05:00
|
|
|
# The list is stored in Redis at a key that is shared by all sites in a multisite config.
|
|
|
|
#
|
|
|
|
# If the password file is changed, you need to add a migration that deletes the list from redis
|
|
|
|
# so it gets re-populated:
|
|
|
|
#
|
|
|
|
# $redis.without_namespace.del CommonPasswords::LIST_KEY
|
|
|
|
|
|
|
|
class CommonPasswords
|
|
|
|
|
2016-03-03 07:06:50 -05:00
|
|
|
PASSWORD_FILE = File.join(Rails.root, 'lib', 'common_passwords', '10-char-common-passwords.txt')
|
2013-12-20 16:34:34 -05:00
|
|
|
LIST_KEY = 'discourse-common-passwords'
|
|
|
|
|
|
|
|
@mutex = Mutex.new
|
|
|
|
|
|
|
|
def self.common_password?(password)
|
|
|
|
return false unless password.present?
|
|
|
|
password_list.include?(password)
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
2018-06-07 01:28:18 -04:00
|
|
|
class RedisPasswordList
|
|
|
|
def include?(password)
|
|
|
|
CommonPasswords.redis.sismember CommonPasswords::LIST_KEY, password
|
2013-12-20 16:34:34 -05:00
|
|
|
end
|
2018-06-07 01:28:18 -04:00
|
|
|
end
|
2013-12-20 16:34:34 -05:00
|
|
|
|
2018-06-07 01:28:18 -04:00
|
|
|
def self.password_list
|
|
|
|
@mutex.synchronize do
|
|
|
|
load_passwords unless redis.scard(LIST_KEY) > 0
|
2013-12-20 16:34:34 -05:00
|
|
|
end
|
2018-06-07 01:28:18 -04:00
|
|
|
RedisPasswordList.new
|
|
|
|
end
|
2013-12-20 16:34:34 -05:00
|
|
|
|
2018-06-07 01:28:18 -04:00
|
|
|
def self.redis
|
|
|
|
$redis.without_namespace
|
|
|
|
end
|
2013-12-20 16:34:34 -05:00
|
|
|
|
2018-06-07 01:28:18 -04:00
|
|
|
def self.load_passwords
|
|
|
|
passwords = File.readlines(PASSWORD_FILE)
|
|
|
|
passwords.map!(&:chomp).each do |pwd|
|
|
|
|
# slower, but a tad more compatible
|
|
|
|
redis.sadd LIST_KEY, pwd
|
2013-12-20 16:34:34 -05:00
|
|
|
end
|
2018-06-07 01:28:18 -04:00
|
|
|
rescue Errno::ENOENT
|
|
|
|
# tolerate this so we don't block signups
|
|
|
|
Rails.logger.error "Common passwords file #{PASSWORD_FILE} is not found! Common password checking is skipped."
|
|
|
|
end
|
2013-12-20 16:34:34 -05:00
|
|
|
|
|
|
|
end
|