application_controller.rb 9.28 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
  include EnforcesTwoFactorAuthentication
12
  include WithPerformanceBar
13

Timothy Andrew's avatar
Timothy Andrew committed
14
  before_action :authenticate_user_from_private_token!
15
  before_action :authenticate_user_from_rss_token!
16
  before_action :authenticate_user!
tduehr's avatar
tduehr committed
17
  before_action :validate_user_service_ticket!
18
19
  before_action :check_password_expiration
  before_action :ldap_security_check
20
  before_action :sentry_context
21
  before_action :default_headers
Rémy Coutable's avatar
Rémy Coutable committed
22
  before_action :add_gon_variables, unless: -> { request.path.start_with?('/-/peek') }
23
24
  before_action :configure_permitted_parameters, if: :devise_controller?
  before_action :require_email, unless: :devise_controller?
25

26
27
  around_action :set_locale

28
  protect_from_forgery with: :exception
29

http://jneen.net/'s avatar
http://jneen.net/ committed
30
  helper_method :can?, :current_application_settings
31
  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
32

33
  rescue_from Encoding::CompatibilityError do |exception|
Riyad Preukschas's avatar
Riyad Preukschas committed
34
    log_exception(exception)
35
    render "errors/encoding", layout: "errors", status: 500
36
37
  end

38
  rescue_from ActiveRecord::RecordNotFound do |exception|
Riyad Preukschas's avatar
Riyad Preukschas committed
39
    log_exception(exception)
40
    render_404
gitlabhq's avatar
gitlabhq committed
41
42
  end

43
44
45
46
  rescue_from(ActionController::UnknownFormat) do
    render_404
  end

47
48
49
50
  rescue_from Gitlab::Access::AccessDeniedError do |exception|
    render_403
  end

51
  rescue_from Gitlab::Auth::TooManyIps do |e|
52
    head :forbidden, retry_after: Gitlab::Auth::UniqueIpsLimiter.config.unique_ips_limit_time_window
53
54
  end

55
56
57
58
59
60
61
62
63
  rescue_from Gitlab::Git::Storage::Inaccessible, GRPC::Unavailable do |exception|
    Raven.capture_exception(exception) if sentry_enabled?
    log_exception(exception)

    headers['Retry-After'] = exception.retry_after if exception.respond_to?(:retry_after)

    render_503
  end

64
65
66
67
  def redirect_back_or_default(default: root_path, options: {})
    redirect_to request.referer.present? ? :back : default, options
  end

68
69
70
71
  def not_found
    render_404
  end

72
73
74
75
  def route_not_found
    if current_user
      not_found
    else
76
      authenticate_user!
77
78
79
    end
  end

Nihad Abbasov's avatar
Nihad Abbasov committed
80
  protected
gitlabhq's avatar
gitlabhq committed
81

82
83
84
85
86
87
88
89
90
91
  def append_info_to_payload(payload)
    super
    payload[:remote_ip] = request.remote_ip

    if current_user.present?
      payload[:user_id] = current_user.id
      payload[:username] = current_user.username
    end
  end

Timothy Andrew's avatar
Timothy Andrew committed
92
93
  # This filter handles both private tokens and personal access tokens
  def authenticate_user_from_private_token!
94
95
96
97
98
    token = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence

    return unless token.present?

    user = User.find_by_authentication_token(token) || User.find_by_personal_access_token(token)
Timothy Andrew's avatar
Timothy Andrew committed
99

100
101
102
103
104
105
106
107
108
109
110
111
112
113
    sessionless_sign_in(user)
  end

  # This filter handles authentication for atom request with an rss_token
  def authenticate_user_from_rss_token!
    return unless request.format.atom?

    token = params[:rss_token].presence

    return unless token.present?

    user = User.find_by_rss_token(token)

    sessionless_sign_in(user)
114
115
  end

Riyad Preukschas's avatar
Riyad Preukschas committed
116
  def log_exception(exception)
Stan Hu's avatar
Stan Hu committed
117
118
    Raven.capture_exception(exception) if sentry_enabled?

Riyad Preukschas's avatar
Riyad Preukschas committed
119
120
121
122
123
    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

124
  def after_sign_in_path_for(resource)
125
    stored_location_for(:redirect) || stored_location_for(resource) || root_path
randx's avatar
randx committed
126
127
  end

128
  def after_sign_out_path_for(resource)
129
    current_application_settings.after_sign_out_path.presence || new_user_session_path
130
131
  end

132
  def can?(object, action, subject = :global)
http://jneen.net/'s avatar
http://jneen.net/ committed
133
    Ability.allowed?(object, action, subject)
gitlabhq's avatar
gitlabhq committed
134
135
  end

gitlabhq's avatar
gitlabhq committed
136
  def access_denied!
Fatih Acet's avatar
Fatih Acet committed
137
138
139
140
    respond_to do |format|
      format.json { head :not_found }
      format.any { render "errors/access_denied", layout: "errors", status: 404 }
    end
141
142
143
  end

  def git_not_found!
144
    render "errors/git_not_found.html", layout: "errors", status: 404
gitlabhq's avatar
gitlabhq committed
145
146
  end

147
148
  def render_403
    head :forbidden
gitlabhq's avatar
gitlabhq committed
149
  end
gitlabhq's avatar
gitlabhq committed
150

151
  def render_404
152
    respond_to do |format|
Sean McGivern's avatar
Sean McGivern committed
153
      format.html do
154
155
        render file: Rails.root.join("public", "404"), layout: false, status: "404"
      end
Sean McGivern's avatar
Sean McGivern committed
156
      format.any { head :not_found }
157
    end
158
159
  end

160
161
162
163
  def respond_422
    head :unprocessable_entity
  end

164
165
166
167
168
169
170
171
172
173
174
175
176
  def render_503
    respond_to do |format|
      format.html do
        render(
          file: Rails.root.join("public", "503"),
          layout: false,
          status: :service_unavailable
        )
      end
      format.any { head :service_unavailable }
    end
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
177
178
179
180
181
  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
182

183
184
185
  def default_headers
    headers['X-Frame-Options'] = 'DENY'
    headers['X-XSS-Protection'] = '1; mode=block'
xyb's avatar
xyb committed
186
    headers['X-UA-Compatible'] = 'IE=edge'
187
    headers['X-Content-Type-Options'] = 'nosniff'
188
  end
189

tduehr's avatar
tduehr committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
  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

204
  def check_password_expiration
205
    if current_user && current_user.password_expires_at && current_user.password_expires_at < Time.now && current_user.allow_password_authentication?
Douwe Maan's avatar
Douwe Maan committed
206
      return redirect_to new_profile_password_path
207
208
    end
  end
209

210
  def ldap_security_check
211
    if current_user && current_user.requires_ldap_check?
Jacob Vosmaer's avatar
Jacob Vosmaer committed
212
      return unless current_user.try_obtain_ldap_lease
Jacob Vosmaer's avatar
Jacob Vosmaer committed
213

214
215
216
217
      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
218
219
220
221
      end
    end
  end

222
  def event_filter
223
224
    # Split using comma to maintain backward compatibility Ex/ "filter1,filter2"
    filters = cookies['event_filter'].split(',')[0] if cookies['event_filter'].present?
225
226
    @event_filter ||= EventFilter.new(filters)
  end
227

228
  def gitlab_ldap_access(&block)
229
    Gitlab::LDAP::Access.open { |access| yield(access) }
230
231
  end

232
  # JSON for infinite scroll via Pager object
233
  def pager_json(partial, count, locals = {})
234
235
    html = render_to_string(
      partial,
236
      locals: locals,
237
238
239
240
241
242
243
244
245
      layout: false,
      formats: [:html]
    )

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

Josh Frye's avatar
Josh Frye committed
247
  def view_to_html_string(partial, locals = {})
248
    render_to_string(
Josh Frye's avatar
Josh Frye committed
249
      partial,
250
      locals: locals,
251
252
253
254
      layout: false,
      formats: [:html]
    )
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
255
256

  def configure_permitted_parameters
257
    devise_parameter_sanitizer.permit(:sign_in, keys: [:username, :email, :password, :login, :remember_me, :otp_attempt])
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
258
  end
259
260
261
262

  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
263
264

  def require_email
265
    if current_user && current_user.temp_oauth_email? && session[:impersonator_id].nil?
Douwe Maan's avatar
Douwe Maan committed
266
      return redirect_to profile_path, notice: 'Please complete your profile with email address'
267
268
    end
  end
269

270
271
272
273
  def import_sources_enabled?
    !current_application_settings.import_sources.empty?
  end

Douwe Maan's avatar
Douwe Maan committed
274
  def github_import_enabled?
275
276
277
    current_application_settings.import_sources.include?('github')
  end

278
279
  def gitea_import_enabled?
    current_application_settings.import_sources.include?('gitea')
Kim "BKC" Carlbäcker's avatar
Kim "BKC" Carlbäcker committed
280
281
  end

282
  def github_import_configured?
283
    Gitlab::OAuth::Provider.enabled?(:github)
Douwe Maan's avatar
Douwe Maan committed
284
285
286
  end

  def gitlab_import_enabled?
287
288
289
290
    request.host != 'gitlab.com' && current_application_settings.import_sources.include?('gitlab')
  end

  def gitlab_import_configured?
291
    Gitlab::OAuth::Provider.enabled?(:gitlab)
Douwe Maan's avatar
Douwe Maan committed
292
293
294
  end

  def bitbucket_import_enabled?
295
296
297
298
    current_application_settings.import_sources.include?('bitbucket')
  end

  def bitbucket_import_configured?
299
    Gitlab::OAuth::Provider.enabled?(:bitbucket)
Douwe Maan's avatar
Douwe Maan committed
300
  end
301
302
303
304
305

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

Jared Szechy's avatar
Jared Szechy committed
306
307
308
309
  def fogbugz_import_enabled?
    current_application_settings.import_sources.include?('fogbugz')
  end

310
311
312
  def git_import_enabled?
    current_application_settings.import_sources.include?('git')
  end
313

314
315
316
317
  def gitlab_project_import_enabled?
    current_application_settings.import_sources.include?('gitlab_project')
  end

Timothy Andrew's avatar
Timothy Andrew committed
318
319
320
321
322
323
  # 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
324

325
326
  def set_locale(&block)
    Gitlab::I18n.with_user_locale(current_user, &block)
327
  end
328
329
330
331
332
333
334
335
336
337

  def sessionless_sign_in(user)
    if user && can?(user, :log_in)
      # 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
gitlabhq's avatar
gitlabhq committed
338
end