This uses a new feature I developed for Sequel with Ubicloud in mind. I found that explicit casts for array parameters used in this case are not required, as long as PostgreSQL can implicitly cast elements of the array to the type of the LHS of the expression. Taking an example query from the query parameterization analysis: ```sql DELETE FROM "applied_action_tag" WHERE (("tag_id" = $1) AND ("action_id" = ANY($2))) ``` In this case, $2 is a PostgreSQL array containing uuids. As action_id is a uuid type, PostgreSQL will assume $2 is uuid[], and things will work correctly. It took me a while to figure this out, because PostgreSQL's behavior is different when using ARRAY. When not auto parameterizing, Sequel literalizes arrays using ARRAY. Initial work on auto parameterization used ARRAY and parameterized the elements, and this let me to believe that explicitly casting was necessary for arrays, when it turns out not to be. As an example, this doesn't work (assuming $2 is a uuid string): ```sql DELETE FROM "applied_action_tag" WHERE (("tag_id" = $1) AND ("action_id" = ANY(ARRAY[$2]))) ``` For some reason, PostgreSQL thinks the array is text[] instead of uuid[], even though the LHS is uuid. The previous work around was to assume string arrays could be represented as PostgreSQL text[] types. I've used this successfully in other applications, but in those, I wasn't using uuids or enum types. As the majority of Ubicloud's usage in these cases is either uuid[] type or enum array types, the assumption of text[] was not a good one for Ubicloud. I previously added the Sequel.any_{type,uuid} methods to Ubicloud to make it easier to fix the failing cases. However, this is really a leaky abstraction, and it's likely something that would trip up other developers. By avoiding the explicit cast for string arrays used as parameters, we can remove all usage of Sequel.any_{type,uuid} and have everything work correctly. This approach should be safe to run in all environments. I've made it so that the conversion is performed for arrays with one or more elements only in frozen testing mode, since that is how the query parameterization analysis is run and it can result in a reduced number of distinct queries. It can also catch potential issues if the tests only test with single element arrays, but we are using multiple element arrays in production. By default, only arrays of two elements or more are use this conversion, because PostgreSQL will use a more optimized query plan for a single element value list than for a multiple element value list. Over 10% of Ubicloud's distinct parameterized queries use this new feature (126/1130).
153 lines
6.2 KiB
Ruby
153 lines
6.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Authorization
|
|
class Unauthorized < CloverError
|
|
def initialize
|
|
super(403, "Forbidden", "Sorry, you don't have permission to continue with this request.")
|
|
end
|
|
end
|
|
|
|
def self.has_permission?(project_id, subject_id, actions, object_id)
|
|
!matched_policies_dataset(project_id, subject_id, actions, object_id).empty?
|
|
end
|
|
|
|
def self.authorize(project_id, subject_id, actions, object_id)
|
|
unless has_permission?(project_id, subject_id, actions, object_id)
|
|
fail Unauthorized
|
|
end
|
|
end
|
|
|
|
def self.all_permissions(project_id, subject_id, object_id)
|
|
DB[:action_type]
|
|
.with(:action_ids, matched_policies_dataset(project_id, subject_id, nil, object_id).select(:action_id))
|
|
.with_recursive(:rec_action_ids,
|
|
DB[:applied_action_tag].select(:action_id, 0).where(tag_id: DB[:action_ids]),
|
|
DB[:applied_action_tag].join(:rec_action_ids, action_id: :tag_id)
|
|
.select(Sequel[:applied_action_tag][:action_id], Sequel[:level] + 1)
|
|
.where { level < Config.recursive_tag_limit },
|
|
args: [:action_id, :level])
|
|
.where(Sequel.or([DB[:action_ids], DB[:rec_action_ids].select(:action_id)].map { [:id, it] }) | DB[:action_ids].where(action_id: nil).exists)
|
|
.select_order_map(:name)
|
|
end
|
|
|
|
# Used to avoid dynamic symbol creation at runtime
|
|
RECURSIVE_TAG_QUERY_MAP = {
|
|
subject: [:applied_subject_tag, :subject_id],
|
|
action: [:applied_action_tag, :action_id],
|
|
object: [:applied_object_tag, :object_id]
|
|
}.freeze
|
|
private_class_method def self.recursive_tag_query(type, values, project_id: nil)
|
|
table, column = RECURSIVE_TAG_QUERY_MAP.fetch(type, values)
|
|
|
|
base_ds = DB[table]
|
|
.select(:tag_id, 0)
|
|
.where(column => values)
|
|
|
|
if project_id
|
|
# We only look for applied_action_tag entries with an action_tag for the project or global action_tags.
|
|
# This is done for actions and not subjects and objects because actions are shared
|
|
# across projects, unlike subjects and objects.
|
|
base_ds = base_ds.where(tag_id: DB[:action_tag].where(project_id:).or(project_id: nil).select(:id))
|
|
end
|
|
|
|
DB[:tag]
|
|
.with_recursive(:tag,
|
|
base_ds,
|
|
DB[table].join(:tag, tag_id: column)
|
|
.select(Sequel[table][:tag_id], Sequel[:level] + 1)
|
|
.where { level < Config.recursive_tag_limit },
|
|
args: [:tag_id, :level]).select(:tag_id)
|
|
end
|
|
|
|
def self.matched_policies_dataset(project_id, subject_id, actions = nil, object_id = nil)
|
|
dataset = DB[:access_control_entry]
|
|
.where(project_id:)
|
|
.where(Sequel.or([subject_id, recursive_tag_query(:subject, subject_id)].map { [:subject_id, it] }))
|
|
|
|
if actions
|
|
actions = Array(actions).map { ActionType::NAME_MAP.fetch(it) }
|
|
dataset = dataset.where(Sequel.or([nil, actions, recursive_tag_query(:action, actions, project_id:)].map { [:action_id, it] }))
|
|
end
|
|
|
|
if object_id
|
|
# Recognize UUID format
|
|
if /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/.match?(object_id)
|
|
ubid = UBID.from_uuidish(object_id).to_s
|
|
else
|
|
ubid = object_id
|
|
# Otherwise, should be valid UBID, raise error if not
|
|
object_id = UBID.parse(object_id).to_uuid
|
|
end
|
|
|
|
klass = UBID.class_for_ubid(ubid)
|
|
klass = ApiKey if ubid.start_with?("et")
|
|
in_project_cond = if klass
|
|
# This checks that the object being authorized is actually related to the project.
|
|
# This is probably a redundant check, but I think it helps to have defense in depth
|
|
# here. This makes it so if a project-level restriction is missed before the
|
|
# authorization call, this will make authorization fail.
|
|
check_project_id = if klass == Project
|
|
object_id
|
|
elsif klass == ObjectMetatag
|
|
ObjectTag.dataset.where(id: klass.from_meta_uuid(object_id)).select(:project_id)
|
|
else
|
|
klass.where(id: object_id).select(:project_id)
|
|
end
|
|
|
|
{project_id: check_project_id}
|
|
else
|
|
false
|
|
end
|
|
|
|
dataset = dataset.where(Sequel.or([nil, object_id, recursive_tag_query(:object, object_id)].map { [:object_id, it] }) & in_project_cond)
|
|
end
|
|
|
|
dataset
|
|
end
|
|
|
|
def self.matched_policies(project_id, subject_id, actions = nil, object_id = nil)
|
|
matched_policies_dataset(project_id, subject_id, actions, object_id).all
|
|
end
|
|
|
|
def self.dataset_authorize(dataset, project_id, subject_id, actions)
|
|
# We can't use "id" column directly, because it's ambiguous in big joined queries.
|
|
# We need to determine table of id explicitly.
|
|
from = dataset.opts[:from].first
|
|
|
|
ds = DB[:object_ids]
|
|
.with_recursive(:object_ids,
|
|
Authorization.matched_policies_dataset(project_id, subject_id, actions).select(:object_id, 0),
|
|
DB[:applied_object_tag].join(:object_ids, object_id: :tag_id)
|
|
.select(Sequel[:applied_object_tag][:object_id], Sequel[:level] + 1)
|
|
.where { level < Config.recursive_tag_limit },
|
|
args: [:object_id, :level]).select(:object_id)
|
|
|
|
if dataset.model == ObjectTag
|
|
# Authorization for accessing ObjectTag itself is done by providing the metatag for the object.
|
|
# Convert metatag id returned from the applied_object_tag lookup into tag ids, so that the correct
|
|
# object tags will be found. Convert non-metatag ids into UUIDs that would be invalid UBIDs,
|
|
# preventing them from matching any existing ObjectTag instances. This makes it so that users
|
|
# authorized to manage members of the tag are not automatically authorized to manage the tag itself.
|
|
ds = ds
|
|
.select(Sequel.cast(:object_id, String))
|
|
.from_self
|
|
.select {
|
|
Sequel.join([
|
|
substr(:object_id, 0, 18),
|
|
Sequel.case({"2" => "0"}, "3", substr(:object_id, 18, 1)),
|
|
substr(:object_id, 19, 18)
|
|
]).cast(:uuid).as(:object_id)
|
|
}
|
|
end
|
|
|
|
dataset.where(Sequel.|(
|
|
# Allow where there is a specific entry for the object,
|
|
{Sequel[from][:id] => ds},
|
|
# or where the action is allowed for all objects in the project,
|
|
ds.where(object_id: nil).exists &
|
|
# and the object is related to the project
|
|
{project_id => Sequel[from][:project_id]}
|
|
))
|
|
end
|
|
end
|