Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2021 Collate
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openmetadata.service.security.policyevaluator;
import static org.openmetadata.common.utils.CommonUtil.listOrEmpty;
import static org.openmetadata.schema.type.Include.NON_DELETED;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.UUID;
import java.util.stream.Collectors;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.entity.policies.Policy;
import org.openmetadata.schema.entity.policies.accessControl.Rule;
import org.openmetadata.schema.entity.teams.Role;
import org.openmetadata.schema.entity.teams.Team;
import org.openmetadata.schema.entity.teams.User;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.Include;
import org.openmetadata.service.Entity;
/** Subject context used for Access Control Policies */
@Slf4j
public record SubjectContext(User user) {
private static final String USER_FIELDS = "roles,teams,isAdmin,profile";
public static final String TEAM_FIELDS = "defaultRoles, policies, parents, profile";
public static SubjectContext getSubjectContext(String userName) {
User user = Entity.getEntityByName(Entity.USER, userName, USER_FIELDS, NON_DELETED);
return new SubjectContext(user);
}
public boolean isAdmin() {
return Boolean.TRUE.equals(user.getIsAdmin());
}
public boolean isBot() {
return Boolean.TRUE.equals(user.getIsBot());
}
public boolean isOwner(EntityReference owner) {
if (owner == null) {
return false;
}
if (owner.getType().equals(Entity.USER) && owner.getName().equals(user.getName())) {
return true; // Owner is same as user.
}
if (owner.getType().equals(Entity.TEAM)) {
for (EntityReference userTeam : listOrEmpty(user.getTeams())) {
if (userTeam.getName().equals(owner.getName())) {
return true; // Owner is a team, and the user is part of this team.
}
}
}
return false;
}
/** Returns true if the user of this SubjectContext is under the team hierarchy of parentTeam */
public boolean isUserUnderTeam(String parentTeam) {
for (EntityReference userTeam : listOrEmpty(user.getTeams())) {
if (isInTeam(parentTeam, userTeam)) {
return true;
}
}
return false;
}
/** Returns true if the given resource owner is under the team hierarchy of parentTeam */
public boolean isTeamAsset(String parentTeam, EntityReference owner) {
if (owner.getType().equals(Entity.USER)) {
SubjectContext subjectContext = getSubjectContext(owner.getName());
return subjectContext.isUserUnderTeam(parentTeam);
} else if (owner.getType().equals(Entity.TEAM)) {
try {
Team team = Entity.getEntity(Entity.TEAM, owner.getId(), TEAM_FIELDS, Include.NON_DELETED);
return isInTeam(parentTeam, team.getEntityReference());
} catch (Exception ex) {
// Ignore and return false
}
}
return false;
}
/** Return true if the team is part of the hierarchy of parentTeam */
public static boolean isInTeam(String parentTeam, EntityReference team) {
Deque stack = new ArrayDeque<>();
stack.push(team); // Start with team and see if the parent matches
while (!stack.isEmpty()) {
try {
Team parent = Entity.getEntity(Entity.TEAM, stack.pop().getId(), "parents", NON_DELETED);
if (parent.getName().equals(parentTeam)) {
return true;
}
listOrEmpty(parent.getParents())
.forEach(stack::push); // Continue to go up the chain of parents
} catch (Exception ex) {
// Ignore and return false
}
}
return false;
}
public static List getRolesForTeams(List teams) {
List roles = new ArrayList<>();
for (EntityReference teamRef : listOrEmpty(teams)) {
try {
Team team = Entity.getEntity(Entity.TEAM, teamRef.getId(), TEAM_FIELDS, NON_DELETED);
roles.addAll(team.getDefaultRoles());
roles.addAll(getRolesForTeams(team.getParents()));
} catch (Exception ex) {
// Ignore and continue
}
}
return roles.stream().distinct().collect(Collectors.toList());
}
// Iterate over all the policies of the team hierarchy the user belongs to
public Iterator getPolicies(EntityReference resourceOwner) {
return new UserPolicyIterator(user, resourceOwner, new ArrayList<>());
}
public List getTeams() {
return user.getTeams();
}
/** Returns true if the user has any of the roles (either direct or inherited roles) */
public boolean hasAnyRole(String roles) {
return hasRole(user(), roles);
}
/** Return true if the given user has any roles the list of roles */
public static boolean hasRole(User user, String role) {
Deque stack = new ArrayDeque<>();
// If user has one of the roles directly assigned then return true
if (hasRole(user.getRoles(), role)) {
return true;
}
listOrEmpty(user.getTeams()).forEach(stack::push); // Continue to go up the chain of parents
while (!stack.isEmpty()) {
try {
Team parent = Entity.getEntity(Entity.TEAM, stack.pop().getId(), TEAM_FIELDS, NON_DELETED);
if (hasRole(parent.getDefaultRoles(), role)) {
return true;
}
listOrEmpty(parent.getParents())
.forEach(stack::push); // Continue to go up the chain of parents
} catch (Exception ex) {
// Ignore the exception and return false
}
}
return false;
}
private static boolean hasRole(List userRoles, String expectedRole) {
return listOrEmpty(userRoles).stream()
.anyMatch(userRole -> userRole.getName().equals(expectedRole));
}
@Getter
static class PolicyContext {
private final String entityType;
private final String entityName;
private final String roleName;
private final String policyName;
private final List rules;
PolicyContext(
String entityType,
String entityName,
String role,
String policy,
List rules) {
this.entityType = entityType;
this.entityName = entityName;
this.roleName = role;
this.policyName = policy;
this.rules = rules;
}
}
/** PolicyIterator goes over policies from a set of policies one by one. */
static class PolicyIterator implements Iterator {
// When executing roles from a policy, entity type User or Team to which the Role is attached
// to. In case of executing a policy attached to a team, the entityType is Team.
private final String entityType;
// User or Team name to which the Role or Policy is attached to
private final String entityName;
// Name of the role from which the policy is from. If policy is not part of the role, but from
// directly attaching it to a Team, then null
private final String roleName;
// Index to the current policy being evaluation
private int policyIndex = 0;
// List of policies to execute
private final List policies;
PolicyIterator(
String entityType, String entityName, String roleName, List policies) {
this.entityType = entityType;
this.entityName = entityName;
this.roleName = roleName;
this.policies = listOrEmpty(policies);
}
@Override
public boolean hasNext() {
if (policyIndex >= policies.size()) {
LOG.debug(
"iteration over policy attached to entity {}:{} role {} is completed",
entityType,
entityName,
roleName);
}
return policyIndex < policies.size();
}
@Override
public PolicyContext next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
EntityReference policy = policies.get(policyIndex++);
return new PolicyContext(
entityType, entityName, roleName, policy.getName(), getPolicyRules(policy.getId()));
}
private static List getPolicyRules(UUID policyId) {
Policy policy = Entity.getEntity(Entity.POLICY, policyId, "rules", Include.NON_DELETED);
List rules = new ArrayList<>();
for (Rule r : policy.getRules()) {
rules.add(new CompiledRule(r));
}
return rules;
}
}
/** RolePolicyIterator goes over policies in a set of roles one by one. */
static class RolePolicyIterator implements Iterator {
// Either User or Team to which the policies from a Role are attached to
private final String entityType;
// Either User or Team name to which the policies from a Role are attached to
private final String entityName;
// Index in the iterator points to the current policy being evaluated
private int iteratorIndex = 0;
// List of policies from the role to evaluate
private final List policyIterators = new ArrayList<>();
RolePolicyIterator(String entityType, String entityName, List roles) {
this.entityType = entityType;
this.entityName = entityName;
for (EntityReference role : listOrEmpty(roles)) {
Role roleEntity =
Entity.getEntity(Entity.ROLE, role.getId(), "policies", Include.NON_DELETED);
policyIterators.add(
new PolicyIterator(entityType, entityName, role.getName(), roleEntity.getPolicies()));
}
}
@Override
public boolean hasNext() {
while (iteratorIndex < policyIterators.size()) {
if (policyIterators.get(iteratorIndex).hasNext()) {
return true;
}
iteratorIndex++;
}
LOG.debug(
"iteration over roles attached to entity {}:{} is completed", entityType, entityName);
return false;
}
@Override
public PolicyContext next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
return policyIterators.get(iteratorIndex).next();
}
}
/**
* A class that allows iterating over policies of a user using iterator of iterators. For a user, the policies in user
* roles are visited one by one, followed by policies in the teams that a user belongs to.
*/
static class UserPolicyIterator implements Iterator {
private final User user;
private int iteratorIndex = 0;
private final List> iterators = new ArrayList<>();
/** Policy iterator for a user */
UserPolicyIterator(User user, EntityReference resourceOwner, List teamsVisited) {
this.user = user;
// Iterate over policies in user role
if (!listOrEmpty(user.getRoles()).isEmpty()) {
iterators.add(new RolePolicyIterator(Entity.USER, user.getName(), user.getRoles()));
}
// Next, iterate over policies of teams to which the user belongs to
// Note that ** Bots don't inherit policies or default roles from teams **
if (!Boolean.TRUE.equals(user.getIsBot())) {
for (EntityReference team : user.getTeams()) {
iterators.add(new TeamPolicyIterator(team.getId(), teamsVisited, false));
}
}
// Finally, iterate over policies of teams that own the resource
if (resourceOwner != null && resourceOwner.getType().equals(Entity.TEAM)) {
try {
Team team =
Entity.getEntity(
Entity.TEAM, resourceOwner.getId(), TEAM_FIELDS, Include.NON_DELETED);
iterators.add(new TeamPolicyIterator(team.getId(), teamsVisited, true));
} catch (Exception ex) {
// Ignore
}
}
}
@Override
public boolean hasNext() {
while (iteratorIndex < iterators.size()) {
if (iterators.get(iteratorIndex).hasNext()) {
return true;
}
iteratorIndex++;
}
LOG.debug("Subject {} policy iteration done", user.getName());
return false;
}
@Override
public PolicyContext next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
return iterators.get(iteratorIndex).next();
}
}
/**
* A class that allows iterating over policies of a team using iterator of iterators. For a team, the policies in team
* roles are visited one by one, followed by the policies in the parent teams.
*/
static class TeamPolicyIterator implements Iterator {
private int iteratorIndex = 0;
private final List> iterators = new ArrayList<>();
/** Policy iterator for a team */
TeamPolicyIterator(UUID teamId, List teamsVisited, boolean skipRoles) {
Team team = Entity.getEntity(Entity.TEAM, teamId, TEAM_FIELDS, Include.NON_DELETED);
// If a team is already visited (because user can belong to multiple teams
// and a team can belong to multiple teams) then don't visit the roles/policies of that team
if (!teamsVisited.contains(teamId)) {
teamsVisited.add(teamId);
if (!skipRoles && team.getDefaultRoles() != null) {
iterators.add(
new RolePolicyIterator(Entity.TEAM, team.getName(), team.getDefaultRoles()));
}
if (team.getPolicies() != null) {
iterators.add(new PolicyIterator(Entity.TEAM, team.getName(), null, team.getPolicies()));
}
for (EntityReference parentTeam : listOrEmpty(team.getParents())) {
iterators.add(new TeamPolicyIterator(parentTeam.getId(), teamsVisited, skipRoles));
}
}
}
@Override
public boolean hasNext() {
while (iteratorIndex < iterators.size()) {
if (iterators.get(iteratorIndex).hasNext()) {
return true;
}
iteratorIndex++;
}
return false;
}
@Override
public PolicyContext next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
return iterators.get(iteratorIndex).next();
}
}
}
