application_controller.rb 8.89 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
  include GitlabRoutingHelper
8
  include PageLayoutHelper
Stan Hu's avatar
Stan Hu committed
9
  include SentryHelper
10
  include WorkhorseHelper
11
  include EnforcesTwoFactorAuthentication
12
  include Peek::Rblineprof::CustomControllerHelpers
13

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

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)
Cyril's avatar
Cyril committed
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 Gitlab::Access::AccessDeniedError do |exception|
    render_403
  end

47
  rescue_from Gitlab::Auth::TooManyIps do |e|
48
    head :forbidden, retry_after: Gitlab::Auth::UniqueIpsLimiter.config.unique_ips_limit_time_window
49 50
  end

51 52 53 54
  def redirect_back_or_default(default: root_path, options: {})
    redirect_to request.referer.present? ? :back : default, options
  end

55 56 57 58
  def not_found
    render_404
  end

59 60 61 62
  def route_not_found
    if current_user
      not_found
    else
63
      authenticate_user!
64 65 66
    end
  end

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  def peek_enabled?
    return false unless Gitlab::PerformanceBar.enabled?
    return false unless current_user

    if RequestStore.active?
      if RequestStore.store.key?(:peek_enabled)
        RequestStore.store[:peek_enabled]
      else
        RequestStore.store[:peek_enabled] = cookies[:perf_bar_enabled].present?
      end
    else
      cookies[:perf_bar_enabled].present?
    end
  end

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

84 85
  # This filter handles both private tokens and personal access tokens
  def authenticate_user_from_private_token!
86 87 88 89 90
    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)
91

92 93 94 95 96 97 98 99 100 101 102 103 104 105
    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)
106 107
  end

Riyad Preukschas's avatar
Riyad Preukschas committed
108 109 110 111 112 113
  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

114
  def after_sign_in_path_for(resource)
115
    stored_location_for(:redirect) || stored_location_for(resource) || root_path
randx's avatar
randx committed
116 117
  end

118
  def after_sign_out_path_for(resource)
119
    if Gitlab::Geo.secondary?
120
      Gitlab::Geo.primary_node.oauth_logout_url(@geo_logout_state)
121
    else
122
      current_application_settings.after_sign_out_path.presence || new_user_session_path
123
    end
124 125
  end

126
  def can?(object, action, subject = :global)
127
    Ability.allowed?(object, action, subject)
gitlabhq's avatar
gitlabhq committed
128 129
  end

gitlabhq's avatar
gitlabhq committed
130
  def access_denied!
131 132 133 134
    respond_to do |format|
      format.json { head :not_found }
      format.any { render "errors/access_denied", layout: "errors", status: 404 }
    end
135 136 137
  end

  def git_not_found!
138
    render "errors/git_not_found.html", layout: "errors", status: 404
gitlabhq's avatar
gitlabhq committed
139 140
  end

141 142
  def render_403
    head :forbidden
gitlabhq's avatar
gitlabhq committed
143
  end
gitlabhq's avatar
gitlabhq committed
144

145
  def render_404
146
    respond_to do |format|
Sean McGivern's avatar
Sean McGivern committed
147
      format.html do
148 149
        render file: Rails.root.join("public", "404"), layout: false, status: "404"
      end
Sean McGivern's avatar
Sean McGivern committed
150
      format.any { head :not_found }
151
    end
152 153
  end

154 155 156 157
  def respond_422
    head :unprocessable_entity
  end

158 159 160 161 162
  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
163

164 165 166
  def default_headers
    headers['X-Frame-Options'] = 'DENY'
    headers['X-XSS-Protection'] = '1; mode=block'
xyb's avatar
xyb committed
167
    headers['X-UA-Compatible'] = 'IE=edge'
168
    headers['X-Content-Type-Options'] = 'nosniff'
169
  end
170

tduehr's avatar
tduehr committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184
  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

185
  def check_password_expiration
186
    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
187
      return redirect_to new_profile_password_path
188 189
    end
  end
190

191
  def ldap_security_check
192
    if current_user && current_user.requires_ldap_check?
Jacob Vosmaer's avatar
Jacob Vosmaer committed
193
      return unless current_user.try_obtain_ldap_lease
194

195 196 197 198
      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
199 200 201 202
      end
    end
  end

203
  def event_filter
204 205
    # Split using comma to maintain backward compatibility Ex/ "filter1,filter2"
    filters = cookies['event_filter'].split(',')[0] if cookies['event_filter'].present?
206 207
    @event_filter ||= EventFilter.new(filters)
  end
208

209
  def gitlab_ldap_access(&block)
210
    Gitlab::LDAP::Access.open { |access| yield(access) }
211 212
  end

213
  # JSON for infinite scroll via Pager object
214
  def pager_json(partial, count, locals = {})
215 216
    html = render_to_string(
      partial,
217
      locals: locals,
218 219 220 221 222 223 224 225 226
      layout: false,
      formats: [:html]
    )

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

Josh Frye's avatar
Josh Frye committed
228
  def view_to_html_string(partial, locals = {})
229 230
    render_to_string(
      partial,
231
      locals: locals,
232 233 234 235
      layout: false,
      formats: [:html]
    )
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
236 237

  def configure_permitted_parameters
238
    devise_parameter_sanitizer.permit(:sign_in, keys: [:username, :email, :password, :login, :remember_me, :otp_attempt])
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
239
  end
240 241 242 243

  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
244 245

  def require_email
246
    if current_user && current_user.temp_oauth_email? && session[:impersonator_id].nil?
Douwe Maan's avatar
Douwe Maan committed
247
      return redirect_to profile_path, notice: 'Please complete your profile with email address'
248 249
    end
  end
250

251 252 253 254
  def import_sources_enabled?
    !current_application_settings.import_sources.empty?
  end

Douwe Maan's avatar
Douwe Maan committed
255
  def github_import_enabled?
256 257 258
    current_application_settings.import_sources.include?('github')
  end

259 260
  def gitea_import_enabled?
    current_application_settings.import_sources.include?('gitea')
Kim "BKC" Carlbäcker's avatar
Kim "BKC" Carlbäcker committed
261 262
  end

263
  def github_import_configured?
264
    Gitlab::OAuth::Provider.enabled?(:github)
Douwe Maan's avatar
Douwe Maan committed
265 266 267
  end

  def gitlab_import_enabled?
268 269 270 271
    request.host != 'gitlab.com' && current_application_settings.import_sources.include?('gitlab')
  end

  def gitlab_import_configured?
272
    Gitlab::OAuth::Provider.enabled?(:gitlab)
Douwe Maan's avatar
Douwe Maan committed
273 274 275
  end

  def bitbucket_import_enabled?
276 277 278 279
    current_application_settings.import_sources.include?('bitbucket')
  end

  def bitbucket_import_configured?
280
    Gitlab::OAuth::Provider.enabled?(:bitbucket)
Douwe Maan's avatar
Douwe Maan committed
281
  end
282 283 284 285 286

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

Jared Szechy's avatar
Jared Szechy committed
287 288 289 290
  def fogbugz_import_enabled?
    current_application_settings.import_sources.include?('fogbugz')
  end

291 292 293
  def git_import_enabled?
    current_application_settings.import_sources.include?('git')
  end
294

295 296 297 298
  def gitlab_project_import_enabled?
    current_application_settings.import_sources.include?('gitlab_project')
  end

299 300 301 302 303 304
  # 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
305

306 307
  def set_locale(&block)
    Gitlab::I18n.with_user_locale(current_user, &block)
308
  end
309 310 311 312 313 314 315 316 317 318

  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
319
end