application_controller.rb 8.99 KB
Newer Older
1
require 'gon'
Jared Szechy's avatar
Jared Szechy committed
2
require 'fogbugz'
3

4
class ApplicationController < ActionController::Base
5
  include Gitlab::CurrentSettings
6
  include Gitlab::GonHelper
7
8
  include GitlabRoutingHelper
  include PageLayoutHelper
Stan Hu's avatar
Stan Hu committed
9
  include SentryHelper
10
  include WorkhorseHelper
11

Timothy Andrew's avatar
Timothy Andrew committed
12
  before_action :authenticate_user_from_private_token!
13
  before_action :authenticate_user!
tduehr's avatar
tduehr committed
14
  before_action :validate_user_service_ticket!
15
  before_action :check_password_expiration
16
  before_action :check_2fa_requirement
17
  before_action :ldap_security_check
18
  before_action :sentry_context
19
20
21
22
  before_action :default_headers
  before_action :add_gon_variables
  before_action :configure_permitted_parameters, if: :devise_controller?
  before_action :require_email, unless: :devise_controller?
23

24
  protect_from_forgery with: :exception
25

http://jneen.net/'s avatar
http://jneen.net/ committed
26
  helper_method :can?, :current_application_settings
27
  helper_method :import_sources_enabled?, :github_import_enabled?, :gitea_import_enabled?, :github_import_configured?, :gitlab_import_enabled?, :gitlab_import_configured?, :bitbucket_import_enabled?, :bitbucket_import_configured?, :google_code_import_enabled?, :fogbugz_import_enabled?, :git_import_enabled?, :gitlab_project_import_enabled?
gitlabhq's avatar
gitlabhq committed
28

29
  rescue_from Encoding::CompatibilityError do |exception|
Riyad Preukschas's avatar
Riyad Preukschas committed
30
    log_exception(exception)
Cyril's avatar
Cyril committed
31
    render "errors/encoding", layout: "errors", status: 500
32
33
  end

34
  rescue_from ActiveRecord::RecordNotFound do |exception|
Riyad Preukschas's avatar
Riyad Preukschas committed
35
    log_exception(exception)
36
    render_404
gitlabhq's avatar
gitlabhq committed
37
38
  end

39
40
41
42
  rescue_from Gitlab::Access::AccessDeniedError do |exception|
    render_403
  end

43
44
45
46
  def redirect_back_or_default(default: root_path, options: {})
    redirect_to request.referer.present? ? :back : default, options
  end

47
48
49
50
  def not_found
    render_404
  end

51
52
53
54
55
56
57
58
  def route_not_found
    if current_user
      not_found
    else
      redirect_to new_user_session_path
    end
  end

Nihad Abbasov's avatar
Nihad Abbasov committed
59
  protected
gitlabhq's avatar
gitlabhq committed
60

Timothy Andrew's avatar
Timothy Andrew committed
61
62
63
64
65
  # This filter handles both private tokens and personal access tokens
  def authenticate_user_from_private_token!
    token_string = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence
    user = User.find_by_authentication_token(token_string) || User.find_by_personal_access_token(token_string)

66
67
68
69
70
71
72
73
74
    if user
      # Notice we are passing store false, so the user is not
      # actually stored in the session and a token is needed
      # for every request. If you want the token to work as a
      # sign in token, you can simply remove store: false.
      sign_in user, store: false
    end
  end

75
  def authenticate_user!(*args)
76
    if redirect_to_home_page_url?
Douwe Maan's avatar
Douwe Maan committed
77
      return redirect_to current_application_settings.home_page_url
78
79
    end

80
    super(*args)
81
82
  end

Riyad Preukschas's avatar
Riyad Preukschas committed
83
84
85
86
87
88
  def log_exception(exception)
    application_trace = ActionDispatch::ExceptionWrapper.new(env, exception).application_trace
    application_trace.map!{ |t| "  #{t}\n" }
    logger.error "\n#{exception.class.name} (#{exception.message}):\n#{application_trace.join}"
  end

89
  def after_sign_in_path_for(resource)
90
    stored_location_for(:redirect) || stored_location_for(resource) || root_path
randx's avatar
randx committed
91
92
  end

93
  def after_sign_out_path_for(resource)
94
    current_application_settings.after_sign_out_path.presence || new_user_session_path
95
96
  end

gitlabhq's avatar
gitlabhq committed
97
  def can?(object, action, subject)
http://jneen.net/'s avatar
http://jneen.net/ committed
98
    Ability.allowed?(object, action, subject)
gitlabhq's avatar
gitlabhq committed
99
100
  end

gitlabhq's avatar
gitlabhq committed
101
  def access_denied!
Cyril's avatar
Cyril committed
102
    render "errors/access_denied", layout: "errors", status: 404
103
104
105
  end

  def git_not_found!
106
    render "errors/git_not_found.html", layout: "errors", status: 404
gitlabhq's avatar
gitlabhq committed
107
108
  end

109
110
  def render_403
    head :forbidden
gitlabhq's avatar
gitlabhq committed
111
  end
gitlabhq's avatar
gitlabhq committed
112

113
  def render_404
114
    respond_to do |format|
Sean McGivern's avatar
Sean McGivern committed
115
      format.html do
116
117
        render file: Rails.root.join("public", "404"), layout: false, status: "404"
      end
Sean McGivern's avatar
Sean McGivern committed
118
      format.any { head :not_found }
119
    end
120
121
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
122
123
124
125
126
  def no_cache_headers
    response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
    response.headers["Pragma"] = "no-cache"
    response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
  end
127

128
129
130
  def default_headers
    headers['X-Frame-Options'] = 'DENY'
    headers['X-XSS-Protection'] = '1; mode=block'
xyb's avatar
xyb committed
131
    headers['X-UA-Compatible'] = 'IE=edge'
132
    headers['X-Content-Type-Options'] = 'nosniff'
133
    # Enabling HSTS for non-standard ports would send clients to the wrong port
Douwe Maan's avatar
Douwe Maan committed
134
    if Gitlab.config.gitlab.https && Gitlab.config.gitlab.port == 443
135
136
      headers['Strict-Transport-Security'] = 'max-age=31536000'
    end
137
  end
138

tduehr's avatar
tduehr committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
  def validate_user_service_ticket!
    return unless signed_in? && session[:service_tickets]

    valid = session[:service_tickets].all? do |provider, ticket|
      Gitlab::OAuth::Session.valid?(provider, ticket)
    end

    unless valid
      session[:service_tickets] = nil
      sign_out current_user
      redirect_to new_user_session_path
    end
  end

153
  def check_password_expiration
154
    if current_user && current_user.password_expires_at && current_user.password_expires_at < Time.now && !current_user.ldap_user?
Douwe Maan's avatar
Douwe Maan committed
155
      return redirect_to new_profile_password_path
156
157
    end
  end
158

159
  def check_2fa_requirement
160
161
    if two_factor_authentication_required? && current_user && !current_user.two_factor_enabled? && !skip_two_factor?
      redirect_to profile_two_factor_auth_path
162
163
164
    end
  end

165
  def ldap_security_check
166
    if current_user && current_user.requires_ldap_check?
Jacob Vosmaer's avatar
Jacob Vosmaer committed
167
      return unless current_user.try_obtain_ldap_lease
Jacob Vosmaer's avatar
Jacob Vosmaer committed
168

169
170
171
172
      unless Gitlab::LDAP::Access.allowed?(current_user)
        sign_out current_user
        flash[:alert] = "Access denied for your LDAP account."
        redirect_to new_user_session_path
173
174
175
176
      end
    end
  end

177
  def event_filter
178
179
    # Split using comma to maintain backward compatibility Ex/ "filter1,filter2"
    filters = cookies['event_filter'].split(',')[0] if cookies['event_filter'].present?
180
181
    @event_filter ||= EventFilter.new(filters)
  end
182

183
  def gitlab_ldap_access(&block)
184
    Gitlab::LDAP::Access.open { |access| yield(access) }
185
186
  end

187
  # JSON for infinite scroll via Pager object
188
  def pager_json(partial, count, locals = {})
189
190
    html = render_to_string(
      partial,
191
      locals: locals,
192
193
194
195
196
197
198
199
200
      layout: false,
      formats: [:html]
    )

    render json: {
      html: html,
      count: count
    }
  end
201

Josh Frye's avatar
Josh Frye committed
202
  def view_to_html_string(partial, locals = {})
203
    render_to_string(
Josh Frye's avatar
Josh Frye committed
204
      partial,
205
      locals: locals,
206
207
208
209
      layout: false,
      formats: [:html]
    )
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
210
211

  def configure_permitted_parameters
212
    devise_parameter_sanitizer.permit(:sign_in, keys: [:username, :email, :password, :login, :remember_me, :otp_attempt])
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
213
  end
214
215
216
217

  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
218
219

  def require_email
220
    if current_user && current_user.temp_oauth_email? && session[:impersonator_id].nil?
Douwe Maan's avatar
Douwe Maan committed
221
      return redirect_to profile_path, notice: 'Please complete your profile with email address'
222
223
    end
  end
224

225
226
227
228
  def import_sources_enabled?
    !current_application_settings.import_sources.empty?
  end

Douwe Maan's avatar
Douwe Maan committed
229
  def github_import_enabled?
230
231
232
    current_application_settings.import_sources.include?('github')
  end

233
234
  def gitea_import_enabled?
    current_application_settings.import_sources.include?('gitea')
Kim "BKC" Carlbäcker's avatar
Kim "BKC" Carlbäcker committed
235
236
  end

237
  def github_import_configured?
238
    Gitlab::OAuth::Provider.enabled?(:github)
Douwe Maan's avatar
Douwe Maan committed
239
240
241
  end

  def gitlab_import_enabled?
242
243
244
245
    request.host != 'gitlab.com' && current_application_settings.import_sources.include?('gitlab')
  end

  def gitlab_import_configured?
246
    Gitlab::OAuth::Provider.enabled?(:gitlab)
Douwe Maan's avatar
Douwe Maan committed
247
248
249
  end

  def bitbucket_import_enabled?
250
251
252
253
    current_application_settings.import_sources.include?('bitbucket')
  end

  def bitbucket_import_configured?
254
    Gitlab::OAuth::Provider.enabled?(:bitbucket)
Douwe Maan's avatar
Douwe Maan committed
255
  end
256
257
258
259
260

  def google_code_import_enabled?
    current_application_settings.import_sources.include?('google_code')
  end

Jared Szechy's avatar
Jared Szechy committed
261
262
263
264
  def fogbugz_import_enabled?
    current_application_settings.import_sources.include?('fogbugz')
  end

265
266
267
  def git_import_enabled?
    current_application_settings.import_sources.include?('git')
  end
268

269
270
271
272
  def gitlab_project_import_enabled?
    current_application_settings.import_sources.include?('gitlab_project')
  end

273
274
275
276
  def two_factor_authentication_required?
    current_application_settings.require_two_factor_authentication
  end

Gabriel Mazetto's avatar
Gabriel Mazetto committed
277
278
279
280
  def two_factor_grace_period
    current_application_settings.two_factor_grace_period
  end

281
282
  def two_factor_grace_period_expired?
    date = current_user.otp_grace_period_started_at
Gabriel Mazetto's avatar
Gabriel Mazetto committed
283
284
285
286
287
288
289
    date && (date + two_factor_grace_period.hours) < Time.current
  end

  def skip_two_factor?
    session[:skip_tfa] && session[:skip_tfa] > Time.current
  end

290
291
292
293
294
295
296
297
298
299
300
301
  def redirect_to_home_page_url?
    # If user is not signed-in and tries to access root_path - redirect him to landing page
    # Don't redirect to the default URL to prevent endless redirections
    return false unless current_application_settings.home_page_url.present?

    home_page_url = current_application_settings.home_page_url.chomp('/')
    root_urls = [Gitlab.config.gitlab['url'].chomp('/'), root_url.chomp('/')]

    return false if root_urls.include?(home_page_url)

    current_user.nil? && root_path == request.path
  end
302

Timothy Andrew's avatar
Timothy Andrew committed
303
304
305
306
307
308
  # U2F (universal 2nd factor) devices need a unique identifier for the application
  # to perform authentication.
  # https://developers.yubico.com/U2F/App_ID.html
  def u2f_app_id
    request.base_url
  end
gitlabhq's avatar
gitlabhq committed
309
end