@zuplo/runtime 5.2189.0 → 5.2191.0

package/out/types/index.d.ts

@@ -184,6 +184,34 @@ declare type Attribute = {
     value: string;
 }[];
 
+/**
+ * A list of attributes that will be included in the authorization request.
+ */
+declare type Attribute1 = {
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * The value of the attribute.
+     */
+    value: string;
+}[];
+
+/**
+ * A list of attributes that will be included in the authorization request.
+ */
+declare type Attribute2 = {
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * The value of the attribute.
+     */
+    value: string;
+}[];
+
 declare interface Attribute_2 {
     AttributeId: string;
     Value: string | boolean | number | string[] | boolean[] | number[];
@@ -421,7 +449,54 @@ export declare class AWSLoggingPlugin extends LogPlugin {
     /* Excluded from this release type: getTransport */
 }
 
-/* Excluded from this release type: AxiomaticsAuthZInboundPolicy */
+/**
+ * Authorize requests using Axiomatics Policy Server.
+ *
+ * @remarks
+ * This policy will authorize requests using Axiomatics Policy Server. If the
+ * request is not authorized, a 403 response will be returned.
+ *
+ * This policy is designed to be highly customizable in order to tailor the
+ * authorization requests to the specific needs of your application. You can
+ * add default attributes on the policy that are included in every request, or
+ * you can programmatically add attributes to the request using the
+ * `setAuthAttributes` method.
+ *
+ * Using this policy in conjunction with an authorization policy will automatically
+ * set AttributeSubject attributes for the user in the request.
+ *
+ * @title Axiomatics Authorization Inbound
+ * @beta
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class AxiomaticsAuthZInboundPolicy extends InboundPolicy<AxiomaticsAuthZInboundPolicyOptions> {
+    #private;
+    private pdpService;
+    static setAuthAttributes(context: ZuploContext, attributes: XacmlRequest["Request"]): void;
+    constructor(options: AxiomaticsAuthZInboundPolicyOptions, policyName: string);
+    /**
+     * The handler that is called each time this policy is invoked
+     *
+     * @param request - The incoming Request
+     * @param context - The current context of the Request
+     * @returns A Response or Request object
+     */
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+    /**
+     * Gets the attributes for the authz request from the policy options
+     */
+    populateOptionAttributes({ optionName, authzRequestCategory, authzRequest, context, }: {
+        optionName: keyof Pick<AxiomaticsAuthZInboundPolicyOptions, "accessSubjectAttributes" | "resourceAttributes" | "actionAttributes">;
+        authzRequestCategory: keyof Omit<XacmlRequest["Request"], "ReturnPolicyIdList" | "CombinedDecision" | "XPathVersion" | "MultiRequests" | "Category">;
+        authzRequest: XacmlRequest;
+        context: ZuploContext;
+    }): void;
+    addAttributesToCategory(authzRequest: XacmlRequest, authzRequestCategory: keyof Omit<XacmlRequest["Request"], "ReturnPolicyIdList" | "CombinedDecision" | "XPathVersion" | "MultiRequests" | "Category">, attributes: Attribute_2[]): void;
+}
 
 /**
  * The options for this policy.
@@ -460,8 +535,8 @@ export declare interface AxiomaticsAuthZInboundPolicyOptions {
      */
     tokenHeaderName?: string;
     accessSubjectAttributes?: Attribute;
-    resourceAttributes?: Attribute;
-    actionAttributes?: Attribute;
+    resourceAttributes?: Attribute1;
+    actionAttributes?: Attribute2;
 }
 
 export declare class BackgroundDispatcher<TPayload> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/runtime",
-  "version": "5.2189.0",
+  "version": "5.2191.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {