application_controller.rb 9.56 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
29
  after_action :set_page_title_header, if: -> { request.format == :json }

30
  protect_from_forgery with: :exception
31

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

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

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

45
46
47
48
  rescue_from(ActionController::UnknownFormat) do
    render_404
  end

49
50
51
52
  rescue_from Gitlab::Access::AccessDeniedError do |exception|
    render_403
  end

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

57
  rescue_from Gitlab::Git::Storage::Inaccessible, GRPC::Unavailable, Gitlab::Git::CommandError do |exception|
58
59
60
61
62
63
64
65
    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

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

70
71
72
73
  def not_found
    render_404
  end

74
75
76
77
  def route_not_found
    if current_user
      not_found
    else
78
      authenticate_user!
79
80
81
    end
  end

Nihad Abbasov's avatar
Nihad Abbasov committed
82
  protected
gitlabhq's avatar
gitlabhq committed
83

84
85
86
87
88
89
90
91
92
93
  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
94
95
  # This filter handles both private tokens and personal access tokens
  def authenticate_user_from_private_token!
96
97
98
99
100
    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
101

102
103
104
105
106
107
108
109
110
111
112
113
114
115
    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)
116
117
  end

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

Riyad Preukschas's avatar
Riyad Preukschas committed
121
    application_trace = ActionDispatch::ExceptionWrapper.new(env, exception).application_trace
122
    application_trace.map! { |t| "  #{t}\n" }
Riyad Preukschas's avatar
Riyad Preukschas committed
123
124
125
    logger.error "\n#{exception.class.name} (#{exception.message}):\n#{application_trace.join}"
  end

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

130
  def after_sign_out_path_for(resource)
131
    current_application_settings.after_sign_out_path.presence || new_user_session_path
132
133
  end

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

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

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

149
150
  def render_403
    head :forbidden
gitlabhq's avatar
gitlabhq committed
151
  end
gitlabhq's avatar
gitlabhq committed
152

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

162
163
164
165
  def respond_422
    head :unprocessable_entity
  end

166
167
168
169
170
171
172
173
174
175
176
177
178
  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
179
180
181
182
183
  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
184

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

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

206
  def check_password_expiration
207
    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
208
      return redirect_to new_profile_password_path
209
210
    end
  end
211

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

216
217
218
219
      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
220
221
222
223
      end
    end
  end

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

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

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

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

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

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

  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
265
266

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

272
273
274
275
  def import_sources_enabled?
    !current_application_settings.import_sources.empty?
  end

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

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

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

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

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

  def bitbucket_import_enabled?
297
298
299
300
    current_application_settings.import_sources.include?('bitbucket')
  end

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

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

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

312
313
314
  def git_import_enabled?
    current_application_settings.import_sources.include?('git')
  end
315

316
317
318
319
  def gitlab_project_import_enabled?
    current_application_settings.import_sources.include?('gitlab_project')
  end

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

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

  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
340
341

  def set_page_title_header
342
343
    # Per https://tools.ietf.org/html/rfc5987, headers need to be ISO-8859-1, not UTF-8
    response.headers['Page-Title'] = page_title('GitLab').encode('ISO-8859-1')
344
  end
gitlabhq's avatar
gitlabhq committed
345
end