application_controller.rb 7.97 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

Timothy Andrew's avatar
Timothy Andrew committed
13
  before_action :authenticate_user_from_private_token!
14
  before_action :authenticate_user!
tduehr's avatar
tduehr committed
15
  before_action :validate_user_service_ticket!
16
17
  before_action :check_password_expiration
  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
25
  around_action :set_locale

26
  protect_from_forgery with: :exception
27

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

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

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

41
42
43
44
  rescue_from Gitlab::Access::AccessDeniedError do |exception|
    render_403
  end

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

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

53
54
55
56
  def not_found
    render_404
  end

57
58
59
60
61
62
63
64
  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
65
  protected
gitlabhq's avatar
gitlabhq committed
66

Timothy Andrew's avatar
Timothy Andrew committed
67
68
  # This filter handles both private tokens and personal access tokens
  def authenticate_user_from_private_token!
69
70
71
72
73
    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
74

75
    if user && can?(user, :log_in)
76
77
78
79
80
81
82
83
      # 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

Riyad Preukschas's avatar
Riyad Preukschas committed
84
85
86
87
88
89
  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

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

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

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

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

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

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

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

123
124
125
126
  def respond_422
    head :unprocessable_entity
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
127
128
129
130
131
  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
132

133
134
135
  def default_headers
    headers['X-Frame-Options'] = 'DENY'
    headers['X-XSS-Protection'] = '1; mode=block'
xyb's avatar
xyb committed
136
    headers['X-UA-Compatible'] = 'IE=edge'
137
    headers['X-Content-Type-Options'] = 'nosniff'
138
  end
139

tduehr's avatar
tduehr committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
  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

154
  def check_password_expiration
155
    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
156
      return redirect_to new_profile_password_path
157
158
    end
  end
159

160
  def ldap_security_check
161
    if current_user && current_user.requires_ldap_check?
Jacob Vosmaer's avatar
Jacob Vosmaer committed
162
      return unless current_user.try_obtain_ldap_lease
Jacob Vosmaer's avatar
Jacob Vosmaer committed
163

164
165
166
167
      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
168
169
170
171
      end
    end
  end

172
  def event_filter
173
174
    # Split using comma to maintain backward compatibility Ex/ "filter1,filter2"
    filters = cookies['event_filter'].split(',')[0] if cookies['event_filter'].present?
175
176
    @event_filter ||= EventFilter.new(filters)
  end
177

178
  def gitlab_ldap_access(&block)
179
    Gitlab::LDAP::Access.open { |access| yield(access) }
180
181
  end

182
  # JSON for infinite scroll via Pager object
183
  def pager_json(partial, count, locals = {})
184
185
    html = render_to_string(
      partial,
186
      locals: locals,
187
188
189
190
191
192
193
194
195
      layout: false,
      formats: [:html]
    )

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

Josh Frye's avatar
Josh Frye committed
197
  def view_to_html_string(partial, locals = {})
198
    render_to_string(
Josh Frye's avatar
Josh Frye committed
199
      partial,
200
      locals: locals,
201
202
203
204
      layout: false,
      formats: [:html]
    )
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
205
206

  def configure_permitted_parameters
207
    devise_parameter_sanitizer.permit(:sign_in, keys: [:username, :email, :password, :login, :remember_me, :otp_attempt])
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
208
  end
209
210
211
212

  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
213
214

  def require_email
215
    if current_user && current_user.temp_oauth_email? && session[:impersonator_id].nil?
Douwe Maan's avatar
Douwe Maan committed
216
      return redirect_to profile_path, notice: 'Please complete your profile with email address'
217
218
    end
  end
219

220
221
222
223
  def import_sources_enabled?
    !current_application_settings.import_sources.empty?
  end

Douwe Maan's avatar
Douwe Maan committed
224
  def github_import_enabled?
225
226
227
    current_application_settings.import_sources.include?('github')
  end

228
229
  def gitea_import_enabled?
    current_application_settings.import_sources.include?('gitea')
Kim "BKC" Carlbäcker's avatar
Kim "BKC" Carlbäcker committed
230
231
  end

232
  def github_import_configured?
233
    Gitlab::OAuth::Provider.enabled?(:github)
Douwe Maan's avatar
Douwe Maan committed
234
235
236
  end

  def gitlab_import_enabled?
237
238
239
240
    request.host != 'gitlab.com' && current_application_settings.import_sources.include?('gitlab')
  end

  def gitlab_import_configured?
241
    Gitlab::OAuth::Provider.enabled?(:gitlab)
Douwe Maan's avatar
Douwe Maan committed
242
243
244
  end

  def bitbucket_import_enabled?
245
246
247
248
    current_application_settings.import_sources.include?('bitbucket')
  end

  def bitbucket_import_configured?
249
    Gitlab::OAuth::Provider.enabled?(:bitbucket)
Douwe Maan's avatar
Douwe Maan committed
250
  end
251
252
253
254
255

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

Jared Szechy's avatar
Jared Szechy committed
256
257
258
259
  def fogbugz_import_enabled?
    current_application_settings.import_sources.include?('fogbugz')
  end

260
261
262
  def git_import_enabled?
    current_application_settings.import_sources.include?('git')
  end
263

264
265
266
267
  def gitlab_project_import_enabled?
    current_application_settings.import_sources.include?('gitlab_project')
  end

Timothy Andrew's avatar
Timothy Andrew committed
268
269
270
271
272
273
  # 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
274
275

  def set_locale
276
277
278
279
280
281
282
283
284
    begin
      requested_locale = current_user&.preferred_language || I18n.default_locale
      locale = FastGettext.set_locale(requested_locale)
      I18n.locale = locale

      yield
    ensure
      I18n.locale = I18n.default_locale
    end
285
  end
gitlabhq's avatar
gitlabhq committed
286
end