]> git.openstreetmap.org Git - rails.git/blob - app/controllers/users_controller.rb
Add support for using an cloudflare turnstile widget during signup
[rails.git] / app / controllers / users_controller.rb
1 # frozen_string_literal: true
2
3 class UsersController < ApplicationController
4   include EmailMethods
5   include SessionMethods
6   include UserMethods
7
8   layout :site_layout
9
10   skip_before_action :verify_authenticity_token, :only => [:auth_success]
11   before_action :authorize_web
12   before_action :set_locale
13   before_action :check_database_readable
14
15   authorize_resource
16
17   before_action :check_database_writable, :only => [:new, :go_public]
18   before_action :require_cookies, :only => [:new]
19
20   allow_thirdparty_images :only => :show
21   allow_social_login :only => :new
22
23   content_security_policy(:only => :new) do |policy|
24     if Settings.turnstile_site_key
25       policy.frame_src(*policy.frame_src, "challenges.cloudflare.com")
26       policy.script_src(*policy.script_src, "challenges.cloudflare.com")
27     end
28   end
29
30   def show
31     @user = User.find_by(:display_name => params[:display_name])
32
33     if @user && (@user.visible? || current_user&.administrator?)
34       @title = @user.display_name
35       @heatmap_frame = @user.public_heatmap?
36     else
37       render_unknown_user params[:display_name]
38     end
39   end
40
41   def new
42     @title = t ".title"
43     @referer = safe_referer(params[:referer])
44
45     parse_oauth_referer @referer
46
47     if current_user
48       # The user is logged in already, so don't show them the signup
49       # page, instead send them to the home page
50       redirect_to @referer || { :controller => "site", :action => "index" }
51     elsif params.key?(:auth_provider) && params.key?(:auth_uid)
52       @email_hmac = params[:email_hmac]
53
54       self.current_user = User.new(:email => params[:email],
55                                    :display_name => params[:nickname],
56                                    :auth_provider => params[:auth_provider],
57                                    :auth_uid => params[:auth_uid])
58
59       if current_user.valid? || current_user.errors[:email].empty?
60         flash.now[:notice] = render_to_string :partial => "auth_association"
61       else
62         flash.now[:warning] = t ".duplicate_social_email"
63       end
64     elsif check_signup_allowed?
65       self.current_user = User.new
66     else
67       render :action => "blocked"
68     end
69   end
70
71   def create
72     self.current_user = User.new(user_params)
73
74     if check_signup_allowed?(current_user.email)
75       if current_user.auth_uid.present?
76         # We are creating an account with external authentication and
77         # no password was specified so create a random one
78         current_user.pass_crypt = SecureRandom.base64(16)
79         current_user.pass_crypt_confirmation = current_user.pass_crypt
80       end
81
82       if current_user.invalid?
83         # Something is wrong with a new user, so rerender the form
84         render :action => "new"
85       elsif Settings.turnstile_site_key && !valid_turnstile_response?(params["cf-turnstile-response"])
86         # Invalid turnstile response, so rerender the form
87         flash.now[:error] = t ".not_human"
88         render :action => "new"
89       else
90         # Save the user record
91         if save_new_user params[:email_hmac]
92           SIGNUP_IP_LIMITER&.update(request.remote_ip)
93           SIGNUP_EMAIL_LIMITER&.update(canonical_email(current_user.email))
94
95           flash[:matomo_goal] = Settings.matomo["goals"]["signup"] if defined?(Settings.matomo)
96
97           referer = welcome_path(welcome_options(params[:referer]))
98
99           if current_user.status == "active"
100             successful_login(current_user, referer)
101           else
102             session[:pending_user] = current_user.id
103             UserMailer.signup_confirm(current_user, current_user.generate_token_for(:new_user), referer).deliver_later
104             redirect_to :controller => :confirmations, :action => :confirm, :display_name => current_user.display_name
105           end
106         else
107           render :action => "new", :referer => params[:referer]
108         end
109       end
110     else
111       render :action => "blocked"
112     end
113   end
114
115   def go_public
116     current_user.data_public = true
117     current_user.save
118     flash[:notice] = t ".flash success"
119     redirect_to account_path
120   end
121
122   ##
123   # omniauth success callback
124   def auth_success
125     referer = request.env["omniauth.params"]["referer"]
126     auth_info = request.env["omniauth.auth"]
127
128     provider = auth_info[:provider]
129     uid = auth_info[:uid]
130     name = auth_info[:info][:name]
131     email = auth_info[:info][:email]
132
133     email_verified = case provider
134                      when "google", "apple", "facebook", "microsoft", "github", "wikipedia"
135                        true
136                      else
137                        false
138                      end
139
140     if settings = session.delete(:new_user_settings)
141       current_user.auth_provider = provider
142       current_user.auth_uid = uid
143
144       update_user(current_user, settings)
145
146       flash.discard
147
148       session[:user_errors] = current_user.errors.as_json
149
150       redirect_to account_path
151     else
152       user = User.find_by(:auth_provider => provider, :auth_uid => uid)
153
154       if user.nil? && provider == "google"
155         openid_url = auth_info[:extra][:id_info]["openid_id"]
156         user = User.find_by(:auth_provider => "openid", :auth_uid => openid_url) if openid_url
157         user&.update(:auth_provider => provider, :auth_uid => uid)
158       end
159
160       if user
161         case user.status
162         when "pending"
163           unconfirmed_login(user, referer)
164         when "active", "confirmed"
165           successful_login(user, referer)
166         when "suspended"
167           failed_login({ :partial => "sessions/suspended_flash" }, user.display_name, referer)
168         else
169           failed_login(t("sessions.new.auth failure"), user.display_name, referer)
170         end
171       else
172         email_hmac = UsersController.message_hmac(email) if email_verified && email
173         redirect_to :action => "new", :nickname => name, :email => email, :email_hmac => email_hmac,
174                     :auth_provider => provider, :auth_uid => uid, :referer => referer
175       end
176     end
177   end
178
179   ##
180   # omniauth failure callback
181   def auth_failure
182     flash[:error] = t(params[:message], :scope => "users.auth_failure", :default => t(".unknown_error"))
183
184     origin = safe_referer(params[:origin]) if params[:origin]
185
186     redirect_to origin || login_url
187   end
188
189   def self.message_hmac(text)
190     sha256 = Digest::SHA256.new
191     sha256 << Rails.application.key_generator.generate_key("openstreetmap/email_address")
192     sha256 << text
193     Base64.urlsafe_encode64(sha256.digest)
194   end
195
196   private
197
198   def save_new_user(email_hmac)
199     current_user.data_public = true
200     current_user.description = "" if current_user.description.nil?
201     current_user.creation_address = request.remote_ip
202     current_user.languages = if request.cookies["_osm_locale"]
203                                Locale.list(request.cookies["_osm_locale"])
204                              else
205                                http_accept_language.user_preferred_languages
206                              end
207     current_user.terms_agreed = Time.now.utc
208     current_user.tou_agreed = Time.now.utc
209     current_user.terms_seen = true
210
211     if current_user.auth_uid.blank?
212       current_user.auth_provider = nil
213       current_user.auth_uid = nil
214     elsif email_hmac && ActiveSupport::SecurityUtils.secure_compare(email_hmac, UsersController.message_hmac(current_user.email))
215       current_user.activate
216     end
217
218     current_user.save
219   end
220
221   def welcome_options(referer = nil)
222     uri = URI(referer) if referer.present?
223
224     return { "oauth_return_url" => uri&.to_s } if uri&.path == oauth_authorization_path
225
226     begin
227       %r{map=(.*)/(.*)/(.*)}.match(uri.fragment) do |m|
228         editor = Rack::Utils.parse_query(uri.query).slice("editor")
229         return { "zoom" => m[1], "lat" => m[2], "lon" => m[3] }.merge(editor)
230       end
231     rescue StandardError
232       # Use default
233     end
234   end
235
236   ##
237   # return permitted user parameters
238   def user_params
239     params.expect(:user => [:email, :display_name,
240                             :auth_provider, :auth_uid,
241                             :pass_crypt, :pass_crypt_confirmation])
242   end
243
244   ##
245   # check signup acls
246   def check_signup_allowed?(email = nil)
247     domain = if email.nil?
248                nil
249              else
250                email.split("@").last
251              end
252
253     mx_servers = if domain.nil?
254                    nil
255                  else
256                    domain_mx_servers(domain)
257                  end
258
259     return true if Acl.allow_account_creation?(request.remote_ip, :domain => domain, :mx => mx_servers)
260
261     blocked = Acl.no_account_creation?(request.remote_ip, :domain => domain, :mx => mx_servers)
262
263     blocked ||= SIGNUP_IP_LIMITER && !SIGNUP_IP_LIMITER.allow?(request.remote_ip)
264
265     blocked ||= email && SIGNUP_EMAIL_LIMITER && !SIGNUP_EMAIL_LIMITER.allow?(canonical_email(email))
266
267     logger.info "Blocked signup from #{request.remote_ip} for #{email}" if blocked
268
269     !blocked
270   end
271
272   ##
273   # check if a turnstile response is valid
274   def valid_turnstile_response?(turnstile_response)
275     response = OSM.http_client.post("https://challenges.cloudflare.com/turnstile/v0/siteverify", {
276                                       :secret => Settings.turnstile_secret_key,
277                                       :response => turnstile_response,
278                                       :remoteip => request.remote_ip
279                                     })
280
281     return false unless response.success?
282
283     parsed_response = JSON.parse(response.body)
284
285     parsed_response["success"]
286   end
287 end