@spotify/backstage-plugin-rbac-common 0.5.8 → 0.5.10

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @spotify/backstage-plugin-rbac-common
 
+## 0.5.10
+
+### Patch Changes
+
+- Upgraded Backstage to v1.22.0
+- Improved error handling and messaging when testing policies
+
+## 0.5.9
+
+### Patch Changes
+
+- Added a policy tester for checking the behavior of RBAC policies. The policy tester is designed to display simulated policy decisions for a given set of permissions, helping you ensure that the configured policy returns the expected decisions. For each [Permission](https://backstage.io/docs/permissions/concepts#permission) selected in the UI, the policy tester will output the decision that would be returned by the policy in question for a user assigned to all of the selected policy roles. If the given permission request requires certain conditions to be met, the policy tester will list exactly which conditions would be required. You can find the policy tester in the Policy page of any active, draft, or previous policy.
+
 ## 0.5.8
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var c=require("@backstage/catalog-model"),P=require("uuid"),s=require("zod"),I=require("@backstage/plugin-permission-common");const f=(i,e)=>`${i} must be at least ${e} characters`,p=(i,e)=>`${i} must be less than ${e} characters`,y="Untitled policy",v=":backstageUser",h=s.z.object({rule:s.z.string(),params:s.z.record(s.z.any()).optional()}),n=s.z.lazy(()=>s.z.union([s.z.object({allOf:s.z.array(n).nonempty()}).strict(),s.z.object({anyOf:s.z.array(n).nonempty()}).strict(),s.z.object({not:n}).strict(),h])),g=s.z.object({pluginId:s.z.string().min(1).describe("Plugin ID that defines the permission and rules used."),resourceType:s.z.string().min(1).describe("Resource type associated with the conditions used."),conditions:n}),z=s.z.union([s.z.literal("allow"),s.z.literal("deny")]),b=s.z.union([z,g]),R=s.z.union([s.z.literal("*"),s.z.object({name:s.z.string().optional().describe("Name that must match the incoming permission request."),actions:s.z.array(s.z.string()).optional().describe("Actions that must be present on the incoming permission's attributes."),resourceType:s.z.string().min(1).optional().describe("Resource type that must match that of the incoming permission request.")})]),C=s.z.object({id:s.z.string().default(()=>P.v4().split("-")[0]).describe("ID of the permission."),match:R.describe("Values used to match against the incoming permission request."),decision:b.describe("Authorization result or conditions to send if this role permission applies.")}).refine(({decision:i,match:e})=>O(i)?e!=="*"&&(e==null?void 0:e.resourceType)!==void 0:!0,{path:["match","resourceType"],message:"match.resourceType is required for conditional decisions."}),D=s.z.array(C).superRefine((i,e)=>{const r=d(i,"id");r>=0&&e.addIssue({code:s.z.ZodIssueCode.custom,message:"Permission ids must be unique",path:[r,"id"]})}).describe("Permission decisions used to determine authorization responses."),T=s.z.string().refine(E,{message:"Invalid entity ref for member.",path:[]}).transform(i=>c.stringifyEntityRef(c.parseEntityRef(i,{defaultKind:"group",defaultNamespace:"default"}))),q=s.z.object({name:s.z.string().min(1,{message:f("Role name",1)}).max(1024,{message:p("Role name",1024)}).describe("Name of the role."),id:s.z.string().default(()=>P.v4().split("-")[0]).describe("ID of the role."),members:s.z.union([s.z.literal("*"),s.z.array(T).min(1)]).describe("Entity references used to map users to this role. These entities don't need to exist in the catalog."),permissions:D}),l=s.z.array(q).default([]).superRefine((i,e)=>{const r=d(i,"name");r>=0&&e.addIssue({code:s.z.ZodIssueCode.custom,message:"Role names must be unique",path:[r,"name"]});const t=d(i,"id");t>=0&&e.addIssue({code:s.z.ZodIssueCode.custom,message:"Role ids must be unique",path:[t,"id"]})}),u=s.z.string().min(1,{message:f("Policy name",1)}).max(1024,{message:p("Policy name",1024)}).default(y).describe("Name of the policy."),j=s.z.union([s.z.literal("first-match"),s.z.literal("any-allow")]),m=s.z.object({resolutionStrategy:j}).default({resolutionStrategy:"first-match"}),a=s.z.object({name:u,options:m,roles:l}),N=a.default({roles:[]});function E(i){try{return c.parseEntityRef(i,{defaultKind:"group",defaultNamespace:"default"}),!0}catch{return!1}}function d(i,e){let r=0;const t=new Set;for(;r<i.length;){const o=i[r][e];if(t.has(o))return r;t.add(o),r++}return-1}function O(i){return typeof i!="string"}function M(i){const e=Object.entries(i);return e.length===1&&e[0][0]==="allOf"&&Array.isArray(e[0][1])}function U(i){const e=Object.entries(i);return e.length===1&&e[0][0]==="anyOf"&&Array.isArray(e[0][1])}function k(i){const e=Object.entries(i);return e.length===1&&e[0][0]==="not"&&!Array.isArray(e[0][1])}const x=a,A=a.extend({name:u.optional(),options:m.optional(),roles:l.optional()}),S=s.z.object({description:s.z.string().optional(),update:A.optional()}),$=(i,e)=>e?e===i.name:!0,w=(i,e)=>e?I.isResourcePermission(i)&&e===i.resourceType:!0,V=(i,e)=>e?e.some(r=>r===i.attributes.action):!0,Z=(i,e)=>e==="*"?!0:$(i,e.name)&&w(i,e.resourceType)&&V(i,e.actions),B=(i,e)=>i.kind!==e.kind||i.namespace!==e.namespace?!1:e.name==="*"?!0:i.name===e.name;function K(i,e){const r={};if(i)for(const[t,o]of Object.entries(i))r[t]=e(o);return r}exports.BackstageUserPlaceholder=v,exports.ConditionalDecisionParser=g,exports.CreateDraftRequestParser=x,exports.DefaultingPolicyConfigParser=N,exports.LiteralDecisionParser=z,exports.PermissionConditionParser=h,exports.PermissionDecisionParser=b,exports.PermissionMatchParser=R,exports.PolicyConfigOptionsParser=m,exports.PolicyConfigParser=a,exports.PolicyDefaultName=y,exports.PolicyRoleResolutionStrategyParser=j,exports.PolicyTitleParser=u,exports.PublishVersionRequestParser=S,exports.RoleParser=q,exports.RolePermissionParser=C,exports.RolePermissionsParser=D,exports.RolesParser=l,exports.UpdateDraftRequestParser=A,exports.isAllOfPermissionCriteria=M,exports.isAnyOfPermissionCriteria=U,exports.isConditionalDecision=O,exports.isMatchingPermission=Z,exports.isNotPermissionCriteria=k,exports.mapParams=K,exports.matchesEntityRef=B;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var a=require("@backstage/plugin-permission-common"),e=require("zod"),u=require("@backstage/catalog-model"),f=require("uuid");const g=(r,s)=>`${r} must be at least ${s} characters`,h=(r,s)=>`${r} must be less than ${s} characters`,b="Untitled policy",U=":backstageUser",R=e.z.object({rule:e.z.string(),params:e.z.record(e.z.any()).optional()}),c=e.z.lazy(()=>e.z.union([e.z.object({allOf:e.z.array(c).nonempty()}).strict(),e.z.object({anyOf:e.z.array(c).nonempty()}).strict(),e.z.object({not:c}).strict(),R])),m=e.z.object({pluginId:e.z.string().min(1).describe("Plugin ID that defines the permission and rules used."),resourceType:e.z.string().min(1).describe("Resource type associated with the conditions used."),conditions:c}),D=e.z.union([e.z.literal("allow"),e.z.literal("deny")]),d=e.z.union([D,m]),j=e.z.union([e.z.literal("*"),e.z.object({name:e.z.string().optional().describe("Name that must match the incoming permission request."),actions:e.z.array(e.z.string()).optional().describe("Actions that must be present on the incoming permission's attributes."),resourceType:e.z.string().min(1).optional().describe("Resource type that must match that of the incoming permission request.")})]),C=e.z.string().default(()=>f.v4().split("-")[0]).describe("ID of the permission."),A=e.z.object({id:C,match:j.describe("Values used to match against the incoming permission request."),decision:d.describe("Authorization result or conditions to send if this role permission applies.")}).refine(({decision:r,match:s})=>M(r)?s!=="*"&&(s==null?void 0:s.resourceType)!==void 0:!0,{path:["match","resourceType"],message:"match.resourceType is required for conditional decisions."}),O=e.z.array(A).superRefine((r,s)=>{const i=y(r,"id");i>=0&&s.addIssue({code:e.z.ZodIssueCode.custom,message:"Permission ids must be unique",path:[i,"id"]})}).describe("Permission decisions used to determine authorization responses."),w=e.z.string().refine(L,{message:"Invalid entity ref for member.",path:[]}).transform(r=>u.stringifyEntityRef(u.parseEntityRef(r,{defaultKind:"group",defaultNamespace:"default"}))),T=e.z.string().default(()=>f.v4().split("-")[0]).describe("ID of the role."),q=e.z.object({name:e.z.string().min(1,{message:g("Role name",1)}).max(1024,{message:h("Role name",1024)}).describe("Name of the role."),id:T,members:e.z.union([e.z.literal("*"),e.z.array(w).min(1)]).describe("Entity references used to map users to this role. These entities don't need to exist in the catalog."),permissions:O}),P=e.z.array(q).default([]).superRefine((r,s)=>{const i=y(r,"name");i>=0&&s.addIssue({code:e.z.ZodIssueCode.custom,message:"Role names must be unique",path:[i,"name"]});const t=y(r,"id");t>=0&&s.addIssue({code:e.z.ZodIssueCode.custom,message:"Role ids must be unique",path:[t,"id"]})}),I=e.z.object({decision:d.describe("The authorization result or conditions the corresponding role resulted in"),roleId:T.describe("The id of the role that resulted in the decision"),rolePermissionId:C.describe("The id of the role permission that resulted in the decisions.")}),z=e.z.string().min(1,{message:g("Policy name",1)}).max(1024,{message:h("Policy name",1024)}).default(b).describe("Name of the policy."),v=e.z.union([e.z.literal("first-match"),e.z.literal("any-allow")]),p=e.z.object({resolutionStrategy:v}).default({resolutionStrategy:"first-match"}),o=e.z.object({name:z,options:p,roles:P}),B=o.default({roles:[]});function L(r){try{return u.parseEntityRef(r,{defaultKind:"group",defaultNamespace:"default"}),!0}catch{return!1}}function y(r,s){let i=0;const t=new Set;for(;i<r.length;){const n=r[i][s];if(t.has(n))return i;t.add(n),i++}return-1}function M(r){return typeof r!="string"}function $(r){const s=Object.entries(r);return s.length===1&&s[0][0]==="allOf"&&Array.isArray(s[0][1])}function V(r){const s=Object.entries(r);return s.length===1&&s[0][0]==="anyOf"&&Array.isArray(s[0][1])}function Z(r){const s=Object.entries(r);return s.length===1&&s[0][0]==="not"&&!Array.isArray(s[0][1])}const N=o.extend({id:e.z.string(),createdAt:e.z.string(),createdBy:e.z.string(),updatedAt:e.z.string(),updatedBy:e.z.string(),description:e.z.string().optional().nullable(),lastPublishedAt:e.z.string().optional().nullable(),lastPublishedBy:e.z.string().optional().nullable(),status:e.z.enum(["draft","active","inactive"])}),x=e.z.object({action:e.z.union([e.z.literal("create"),e.z.literal("read"),e.z.literal("update"),e.z.literal("delete")]).optional()}),K=e.z.union([e.z.object({type:e.z.literal("basic"),name:e.z.string(),attributes:x}),e.z.object({type:e.z.literal("resource"),name:e.z.string(),attributes:x,resourceType:e.z.string()})]),l=e.z.lazy(()=>e.z.object({rule:e.z.string(),resourceType:e.z.string(),params:e.z.record(e.z.any()).optional()}).or(e.z.object({anyOf:e.z.array(l).nonempty()})).or(e.z.object({allOf:e.z.array(l).nonempty()})).or(e.z.object({not:l}))),_=e.z.object({result:e.z.union([e.z.literal(a.AuthorizeResult.ALLOW),e.z.literal(a.AuthorizeResult.DENY)])}),W=m.extend({result:e.z.literal(a.AuthorizeResult.CONDITIONAL),conditions:l}),Y=e.z.union([_,W]),F=o,E=o.extend({name:z.optional(),options:p.optional(),roles:P.optional()}),G=e.z.object({description:e.z.string().optional(),update:E.optional()}),H=e.z.object({decision:Y,decisionOrigin:e.z.array(I)}),J=e.z.object({permission:K,policyConfig:o,roleIds:e.z.array(e.z.string())}),Q=e.z.object({id:e.z.string()}),X=e.z.object({authorized:e.z.boolean()}),S=e.z.object({name:e.z.string().optional(),type:e.z.enum(["user","group","all","unknown"]),entityRef:e.z.string()}),ee=e.z.object({members:e.z.array(S)}),se=e.z.object({items:e.z.array(N),nextCursor:e.z.string().optional(),prevCursor:e.z.string().optional(),totalItems:e.z.number()}),re=(r,s)=>s?s===r.name:!0,ie=(r,s)=>s?a.isResourcePermission(r)&&s===r.resourceType:!0,te=(r,s)=>s?s.some(i=>i===r.attributes.action):!0,k=(r,s)=>s==="*"?!0:re(r,s.name)&&ie(r,s.resourceType)&&te(r,s.actions),oe=(r,s)=>r.permissions.filter(({match:i})=>k(s,i)),ne=(r,s)=>r.kind!==s.kind||r.namespace!==s.namespace?!1:s.name==="*"?!0:r.name===s.name;function ae(r,s){const i={};if(r)for(const[t,n]of Object.entries(r))i[t]=s(n);return i}exports.AuthorizeResponseParser=X,exports.BackstageUserPlaceholder=U,exports.ConditionalDecisionParser=m,exports.CreateDraftRequestParser=F,exports.DefaultingPolicyConfigParser=B,exports.DraftResponseParser=Q,exports.LiteralDecisionParser=D,exports.MemberResponseParser=S,exports.PermissionConditionParser=R,exports.PermissionDecisionParser=d,exports.PermissionMatchParser=j,exports.PolicyConfigOptionsParser=p,exports.PolicyConfigParser=o,exports.PolicyDefaultName=b,exports.PolicyParser=N,exports.PolicyResponseParser=se,exports.PolicyRoleResolutionStrategyParser=v,exports.PolicyTitleParser=z,exports.PublishVersionRequestParser=G,exports.RoleDecisionParser=I,exports.RoleParser=q,exports.RolePermissionParser=A,exports.RolePermissionsParser=O,exports.RolesParser=P,exports.SearchMemberResponseParser=ee,exports.TestPolicyDecisionRequestParser=J,exports.TestPolicyDecisionResponseParser=H,exports.UpdateDraftRequestParser=E,exports.getMatchingRolePermissions=oe,exports.isAllOfPermissionCriteria=$,exports.isAnyOfPermissionCriteria=V,exports.isConditionalDecision=M,exports.isMatchingPermission=k,exports.isNotPermissionCriteria=Z,exports.mapParams=ae,exports.matchesEntityRef=ne;
 //# sourceMappingURL=index.cjs.js.map