File: login_password_requirements_base.rb

package info (click to toggle)
ruby-rodauth 2.42.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 812 kB
  • sloc: ruby: 7,524; javascript: 100; makefile: 4
file content (205 lines) | stat: -rw-r--r-- 6,954 bytes parent folder | download | duplicates (2)
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
# frozen-string-literal: true

module Rodauth
  Feature.define(:login_password_requirements_base, :LoginPasswordRequirementsBase) do
    translatable_method :already_an_account_with_this_login_message, 'already an account with this login'
    auth_value_method :login_confirm_param, 'login-confirm'
    auth_value_method :login_email_regexp, /\A[^,;@ \r\n]+@[^,@; \r\n]+\.[^,@; \r\n]+\z/
    auth_value_method :login_minimum_length, 3
    auth_value_method :login_maximum_length, 255
    auth_value_method :login_maximum_bytes, 255
    translatable_method :login_not_valid_email_message, 'not a valid email address'
    translatable_method :logins_do_not_match_message, 'logins do not match'
    auth_value_method :password_confirm_param, 'password-confirm'
    auth_value_method :password_minimum_length, 6
    auth_value_method :password_maximum_bytes, nil
    auth_value_method :password_maximum_length, nil
    translatable_method :passwords_do_not_match_message, 'passwords do not match'
    auth_value_method :require_email_address_logins?, true
    auth_value_method :require_login_confirmation?, true
    auth_value_method :require_password_confirmation?, true
    translatable_method :same_as_existing_password_message, "invalid password, same as current password"
    translatable_method :contains_null_byte_message, 'contains null byte'

    auth_value_methods(
      :login_confirm_label,
      :login_does_not_meet_requirements_message,
      :login_too_long_message,
      :login_too_many_bytes_message,
      :login_too_short_message,
      :password_confirm_label,
      :password_does_not_meet_requirements_message,
      :password_hash_cost,
      :password_too_long_message,
      :password_too_many_bytes_message,
      :password_too_short_message
    )

    auth_methods(
      :login_confirmation_matches?,
      :login_meets_requirements?,
      :login_valid_email?,
      :password_hash,
      :password_meets_requirements?,
      :set_password
    )

    def login_confirm_label
      "Confirm #{login_label}"
    end

    def password_confirm_label
      "Confirm #{password_label}"
    end

    def login_meets_requirements?(login)
      login_meets_length_requirements?(login) && \
        login_meets_email_requirements?(login)
    end

    def password_meets_requirements?(password)
      password_meets_length_requirements?(password) && \
        password_does_not_contain_null_byte?(password)
    end

    def set_password(password)
      hash = password_hash(password)
      if account_password_hash_column
        update_account(account_password_hash_column=>hash)
      elsif password_hash_ds.update(password_hash_column=>hash) == 0
        # This shouldn't raise a uniqueness error, as the update should only fail for a new user,
        # and an existing user should always have a valid password hash row.  If this does
        # fail, retrying it will cause problems, it will override a concurrently running update
        # with potentially a different password.
        db[password_hash_table].insert(password_hash_id_column=>account_id, password_hash_column=>hash)
      end
      hash
    end

    def password_hash(password)
      BCrypt::Password.create(password, :cost=>password_hash_cost)
    end

    private
    
    attr_reader :login_requirement_message
    attr_reader :password_requirement_message

    def password_does_not_meet_requirements_message
      "invalid password, does not meet requirements#{" (#{password_requirement_message})" if password_requirement_message}"
    end

    def password_too_long_message
      "maximum #{password_maximum_length} characters"
    end
    
    def password_too_many_bytes_message
      "maximum #{password_maximum_bytes} bytes"
    end
    
    def password_too_short_message
      "minimum #{password_minimum_length} characters"
    end
    
    def set_password_requirement_error_message(reason, message)
      set_error_reason(reason)
      @password_requirement_message = message
    end

    def login_does_not_meet_requirements_message
      "invalid login#{", #{login_requirement_message}" if login_requirement_message}"
    end

    def login_too_long_message
      "maximum #{login_maximum_length} characters"
    end

    def login_too_many_bytes_message
      "maximum #{login_maximum_bytes} bytes"
    end

    def login_too_short_message
      "minimum #{login_minimum_length} characters"
    end
    
    def set_login_requirement_error_message(reason, message)
      set_error_reason(reason)
      @login_requirement_message = message
    end

    if RUBY_VERSION >= '2.4'
      def login_confirmation_matches?(login, login_confirmation)
        login.casecmp?(login_confirmation)
      end
    # :nocov:
    else
      def login_confirmation_matches?(login, login_confirmation)
        login.casecmp(login_confirmation) == 0
      end
    # :nocov:
    end

    def login_meets_length_requirements?(login)
      if login_minimum_length > login.length
        set_login_requirement_error_message(:login_too_short, login_too_short_message)
        false
      elsif login_maximum_length < login.length
        set_login_requirement_error_message(:login_too_long, login_too_long_message)
        false
      elsif login_maximum_bytes < login.bytesize
        set_login_requirement_error_message(:login_too_many_bytes, login_too_many_bytes_message)
        false
      else
        true
      end
    end

    def login_meets_email_requirements?(login)
      return true unless require_email_address_logins?
      return true if login_valid_email?(login)
      set_login_requirement_error_message(:login_not_valid_email, login_not_valid_email_message)
      return false
    end

    def login_valid_email?(login)
      login =~ login_email_regexp
    end

    def password_meets_length_requirements?(password)
      if password_minimum_length > password.length
        set_password_requirement_error_message(:password_too_short, password_too_short_message)
        false
      elsif password_maximum_length && password_maximum_length < password.length
        set_password_requirement_error_message(:password_too_long, password_too_long_message)
        false
      elsif password_maximum_bytes && password_maximum_bytes < password.bytesize
        set_password_requirement_error_message(:password_too_many_bytes, password_too_many_bytes_message)
        false
      else
        true
      end
    end

    def password_does_not_contain_null_byte?(password)
      return true unless password.include?("\0")
      set_password_requirement_error_message(:password_contains_null_byte, contains_null_byte_message)
      false
    end

    if ENV['RACK_ENV'] == 'test'
      def password_hash_cost
        BCrypt::Engine::MIN_COST
      end
    else
      # :nocov:
      def password_hash_cost
        BCrypt::Engine::DEFAULT_COST
      end
      # :nocov:
    end

    def extract_password_hash_cost(hash)
      hash[4, 2].to_i
    end
  end
end