application_controller.rb

require 'cloud_controller/blobstore/errors'
require 'cloud_controller/errors/compound_error'

module V3ErrorsHelper
  def invalid_request!(message)
    raise CloudController::Errors::ApiError.new_from_details('InvalidRequest', message)
  end

  def invalid_param!(message)
    raise CloudController::Errors::ApiError.new_from_details('BadQueryParameter', message)
  end

  def unprocessable(message)
    CloudController::Errors::ApiError.new_from_details('UnprocessableEntity', message)
  end

  def unprocessable!(message)
    raise unprocessable(message)
  end

  def unauthorized!
    raise CloudController::Errors::ApiError.new_from_details('NotAuthorized')
  end

  def suspended!
    raise CloudController::Errors::ApiError.new_from_details('OrgSuspended')
  end

  def resource_not_found_with_message!(message)
    raise CloudController::Errors::ApiError.new_from_details('ResourceNotFound', message)
  end

  def bad_request!(message)
    raise CloudController::Errors::ApiError.new_from_details('BadRequest', message)
  end

  def check_utf8_encoding!(yaml_data)
    if yaml_data.is_a?(Hash)
      yaml_data.each_value do |value|
        check_utf8_encoding!(value)
      end
    elsif yaml_data.is_a?(Array)
      yaml_data.each do |value|
        check_utf8_encoding!(value)
      end
    else
      return unless yaml_data.is_a?(String) && !yaml_data.force_encoding('UTF-8').valid_encoding?

      message_parse_error!('Invalid UTF-8 encoding in YAML data')
    end
  end

  def message_parse_error!(message)
    raise CloudController::Errors::ApiError.new_from_details('MessageParseError', message)
  end

  def service_unavailable!(message)
    raise CloudController::Errors::ApiError.new_from_details('ServiceUnavailable', message)
  end

  def resource_not_found!(resource)
    raise CloudController::Errors::NotFound.new_from_details('ResourceNotFound', "#{resource.to_s.humanize} not found")
  end

  def not_found!
    raise CloudController::Errors::NotFound.new_from_details('NotFound')
  end
end

class ApplicationController < ActionController::Base
  include VCAP::CloudController
  include V3ErrorsHelper
  include VCAP::CloudController::ParamsHashifier

  ANONYMOUSLY_AVAILABLE = %w[not_found internal_error bad_request v3_info].map(&:freeze).freeze
  UNSCOPED_PAGES = %w[not_found internal_error bad_request v3_root v3_info].map(&:freeze).freeze
  READ_SCOPE_HTTP_METHODS = %w[GET HEAD].map(&:freeze).freeze
  YAML_CONTENT_TYPE = 'application/x-yaml'.freeze

  wrap_parameters :body, format: %i[json url_encoded_form multipart_form]

  before_action :validate_token!, if: :enforce_authentication?
  before_action :check_read_permissions!, if: :enforce_read_scope?
  before_action :check_write_permissions!, if: :enforce_write_scope?
  before_action :hashify_params
  before_action :null_coalesce_body

  rescue_from CloudController::Blobstore::BlobstoreError, with: :handle_blobstore_error
  rescue_from CloudController::Errors::NotAuthenticated, with: :handle_not_authenticated
  rescue_from CloudController::Errors::NotFound, with: :handle_not_found
  rescue_from CloudController::Errors::InvalidAuthToken, with: :handle_invalid_auth_token
  rescue_from CloudController::Errors::ApiError, with: :handle_api_error
  rescue_from CloudController::Errors::CompoundError, with: :handle_compound_error
  rescue_from ActionDispatch::Http::Parameters::ParseError, with: :handle_invalid_request_body
  rescue_from Sequel::DatabaseConnectionError, Sequel::DatabaseDisconnectError, with: :handle_db_connection_error
  rescue_from OpenSSL::Cipher::CipherError, with: :handle_key_derivation_error

  def configuration
    Config.config
  end

  def query_params
    request.query_parameters.with_indifferent_access
  end

  def parsed_yaml
    return @parsed_yaml if @parsed_yaml

    bad_request!('Manifest size is too large. The maximum supported size is 1MB.') if request.body.size > 1.megabyte

    allow_yaml_aliases = false
    yaml = Psych.safe_load(request.body.read, permitted_classes: [], permitted_symbols: [], aliases: allow_yaml_aliases, strict_integer: true)

    message_parse_error!('invalid request body') unless yaml.is_a? Hash
    check_utf8_encoding!(yaml)
    @parsed_yaml = yaml
  rescue Psych::BadAlias
    bad_request!('Manifest does not support Anchors and Aliases')
  end

  def roles
    VCAP::CloudController::SecurityContext.roles
  end

  def current_user
    VCAP::CloudController::SecurityContext.current_user
  end

  def current_user_email
    VCAP::CloudController::SecurityContext.current_user_email
  end

  def user_audit_info
    VCAP::CloudController::UserAuditInfo.from_context(VCAP::CloudController::SecurityContext)
  end

  def url_builder
    @url_builder ||= VCAP::CloudController::Presenters::ApiUrlBuilder
  end

  def request_id
    ::VCAP::Request.current_id
  end

  def logger
    @logger ||= Steno.logger('cc.api')
  end

  def permission_queryer
    @permission_queryer ||= VCAP::CloudController::Permissions.new(VCAP::CloudController::SecurityContext.current_user)
  end

  def add_warning_headers(warnings)
    return if warnings.nil?
    raise ArgumentError.new('warnings should be an array') unless warnings.is_a?(Array)

    warnings.each do |warning|
      response.add_header('X-Cf-Warnings', CGI.escape(warning))
    end
  end

  private

  ###
  ### FILTERS
  ###

  def enforce_authentication?
    ANONYMOUSLY_AVAILABLE.exclude?(action_name)
  end

  def enforce_read_scope?
    return false if UNSCOPED_PAGES.include?(action_name)

    READ_SCOPE_HTTP_METHODS.include?(request.method)
  end

  def enforce_write_scope?
    return false if UNSCOPED_PAGES.include?(action_name)

    READ_SCOPE_HTTP_METHODS.exclude?(request.method)
  end

  def read_scope
    roles.cloud_controller_reader?
  end

  def write_scope
    roles.cloud_controller_writer?
  end

  def check_read_permissions!
    raise CloudController::Errors::ApiError.new_from_details('NotAuthorized') if !roles.admin? && !roles.admin_read_only? && !roles.global_auditor? && !read_scope
  end

  def check_write_permissions!
    raise CloudController::Errors::ApiError.new_from_details('NotAuthorized') if !roles.admin? && !write_scope
  end

  def validate_token!
    return if current_user

    raise CloudController::Errors::NotAuthenticated if VCAP::CloudController::SecurityContext.missing_token?

    raise CloudController::Errors::InvalidAuthToken
  end

  def handle_blobstore_error(error)
    error = CloudController::Errors::ApiError.new_from_details('BlobstoreError', error.message)
    handle_api_error(error)
  end

  def handle_invalid_request_body(_error)
    error = CloudController::Errors::ApiError.new_from_details('MessageParseError', 'invalid request body')
    handle_api_error(error)
  end

  def handle_db_connection_error(_)
    error = CloudController::Errors::ApiError.new_from_details('ServiceUnavailable', 'Database connection failure')
    handle_api_error(error)
  end

  def handle_key_derivation_error(_)
    error = CloudController::Errors::V3::ApiError.new_from_details('InternalServerError', 'Failed to decrypt credentials')
    handle_api_error(error)
  end

  def handle_exception(error)
    presenter = ErrorPresenter.new(error, Rails.env.test?, V3ErrorHasher.new(error))
    logger.info(presenter.log_message)
    render status: presenter.response_code, json: presenter
  end
  alias_method :handle_not_authenticated, :handle_exception
  alias_method :handle_api_error, :handle_exception
  alias_method :handle_compound_error, :handle_exception
  alias_method :handle_not_found, :handle_exception
  alias_method :handle_invalid_auth_token, :handle_exception

  def null_coalesce_body
    hashed_params[:body] ||= {}
  end

  def membership
    @membership ||= Membership.new(current_user)
  end
end