Move policy decision types to permission-common

Co-authored-by: Mike Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
This commit is contained in:
Joe Porpeglia
2022-03-21 21:56:49 -04:00
committed by Joe Porpeglia
parent ac0a6cb827
commit 970814ed38
8 changed files with 54 additions and 59 deletions
@@ -16,10 +16,10 @@
import {
AuthorizeResult,
ConditionalPolicyDecision,
PermissionCondition,
PermissionCriteria,
} from '@backstage/plugin-permission-common';
import { ConditionalPolicyDecision } from '../policy';
import { PermissionRule } from '../types';
import { createConditionFactory } from './createConditionFactory';
@@ -21,6 +21,7 @@ import { InputError } from '@backstage/errors';
import { errorHandler } from '@backstage/backend-common';
import {
AuthorizeResult,
DefinitivePolicyDecision,
IdentifiedPermissionMessage,
PermissionCondition,
PermissionCriteria,
@@ -32,7 +33,6 @@ import {
isNotCriteria,
isOrCriteria,
} from './util';
import { DefinitivePolicyDecision } from '../policy/types';
const permissionCriteriaSchema: z.ZodSchema<
PermissionCriteria<PermissionCondition>
+1 -7
View File
@@ -14,10 +14,4 @@
* limitations under the License.
*/
export type {
ConditionalPolicyDecision,
DefinitivePolicyDecision,
PermissionPolicy,
PolicyAuthorizeQuery,
PolicyDecision,
} from './types';
export type { PermissionPolicy, PolicyAuthorizeQuery } from './types';
+1 -45
View File
@@ -16,9 +16,7 @@
import {
AuthorizeQuery,
AuthorizeResult,
PermissionCondition,
PermissionCriteria,
PolicyDecision,
} from '@backstage/plugin-permission-common';
import { BackstageIdentityResponse } from '@backstage/plugin-auth-node';
@@ -35,48 +33,6 @@ import { BackstageIdentityResponse } from '@backstage/plugin-auth-node';
*/
export type PolicyAuthorizeQuery = Omit<AuthorizeQuery, 'resourceRef'>;
/**
* A definitive result to an authorization request, returned by the {@link PermissionPolicy}.
*
* @remarks
*
* This indicates that the policy unconditionally allows (or denies) the request.
*
* @public
*/
export type DefinitivePolicyDecision = {
result: AuthorizeResult.ALLOW | AuthorizeResult.DENY;
};
/**
* A conditional result to an authorization request, returned by the {@link PermissionPolicy}.
*
* @remarks
*
* This indicates that the policy allows authorization for the request, given that the returned
* conditions hold when evaluated. The conditions will be evaluated by the corresponding plugin
* which knows about the referenced permission rules.
*
* Similar to {@link @backstage/permission-common#AuthorizeDecision}, but with the plugin and resource
* identifiers needed to evaluate the returned conditions.
* @public
*/
export type ConditionalPolicyDecision = {
result: AuthorizeResult.CONDITIONAL;
pluginId: string;
resourceType: string;
conditions: PermissionCriteria<PermissionCondition>;
};
/**
* The result of evaluating an authorization request with a {@link PermissionPolicy}.
*
* @public
*/
export type PolicyDecision =
| DefinitivePolicyDecision
| ConditionalPolicyDecision;
/**
* A policy to evaluate authorization requests for any permissioned action performed in Backstage.
*