auth0-deploy-cli 9.0.0-beta.2 → 9.0.0

package/lib/tools/auth0/handlers/networkACLKeys.js

@@ -0,0 +1,177 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const default_1 = __importStar(require("./default"));
+const logger_1 = __importDefault(require("../../../logger"));
+exports.schema = {
+    type: 'array',
+    description: 'List of Network ACL keys for HMAC signature verification',
+    items: {
+        type: 'object',
+        required: ['name', 'alg'],
+        properties: {
+            id: { type: 'string' },
+            name: { type: 'string', maxLength: 255 },
+            alg: { type: 'string', enum: ['hmac-sha256'] },
+            // value is write-only and never returned by the API.
+            // Provide it at deploy time via keyword replacement (e.g. ##HMAC_KEY_VALUE##).
+            // It is not exported and is omitted from exported configs.
+            value: { type: 'string' },
+            fingerprint: { type: 'string' },
+        },
+        additionalProperties: false,
+    },
+};
+class NetworkACLKeysHandler extends default_1.default {
+    constructor(config) {
+        super({
+            ...config,
+            type: 'networkACLKeys',
+            id: 'id',
+            identifiers: ['name'],
+            // value is write-only (never returned by API) and fingerprint/timestamps are
+            // API-generated — ignore all of them when computing dry-run diffs so keys
+            // with a local `value` don't show phantom UPDATEs.
+            ignoreDryRunFields: ['value', 'fingerprint', 'created_at', 'updated_at'],
+        });
+    }
+    objString(key) {
+        return super.objString({ name: key.name, alg: key.alg });
+    }
+    async getType() {
+        if (this.existing)
+            return this.existing;
+        try {
+            // Not paginated — tenant cap is 10 keys. Returns { keys: [...] }.
+            const result = await this.client.keys.networkAcls.list();
+            this.existing = result.keys;
+            return this.existing;
+        }
+        catch (err) {
+            if (err.statusCode === 404 || err.statusCode === 501) {
+                return null;
+            }
+            if (err.statusCode === 403) {
+                logger_1.default.debug('Network ACL key management is not enabled for this tenant. Please verify `scope` or contact Auth0 support.');
+                return null;
+            }
+            throw err;
+        }
+    }
+    async processChanges(assets) {
+        const { networkACLKeys } = assets;
+        // Do nothing if not set
+        if (!networkACLKeys)
+            return;
+        const { del, create } = await this.calcChanges(assets);
+        // Keys are immutable after creation — there is no update operation.
+        // A detected "update" (same name, different config) is a no-op: the existing key is kept as-is.
+        logger_1.default.debug(`Start processChanges for networkACLKeys [delete:${del.length}] [create:${create.length}]`);
+        await Promise.all([this.deleteNetworkACLKeys(del), this.createNetworkACLKeys(create)]);
+    }
+    async createNetworkACLKey(key) {
+        if (!key.value) {
+            logger_1.default.warn(`Skipping creation of Network ACL key "${key.name}": ` +
+                `'value' is required to create a key but is not present in the config. ` +
+                `Supply the key material via keyword replacement (e.g. ##HMAC_KEY_VALUE##) or create the key out-of-band.`);
+            return;
+        }
+        await this.client.keys.networkAcls.create({
+            name: key.name,
+            alg: key.alg,
+            value: key.value,
+        });
+        this.didCreate(key);
+        this.created += 1;
+    }
+    async createNetworkACLKeys(creates) {
+        await this.client.pool
+            .addEachTask({
+            data: creates || [],
+            generator: (item) => this.createNetworkACLKey(item).catch((err) => {
+                throw new Error(`Problem creating ${this.type} ${this.objString(item)}\n${err}`);
+            }),
+        })
+            .promise();
+    }
+    async deleteNetworkACLKey(key) {
+        if (!key.id) {
+            throw new Error(`Missing id for ${this.type} ${this.objString(key)}`);
+        }
+        await this.client.keys.networkAcls.delete(key.id);
+    }
+    async deleteNetworkACLKeys(data) {
+        if (!data || data.length === 0)
+            return;
+        if (this.config('AUTH0_ALLOW_DELETE') === 'true' ||
+            this.config('AUTH0_ALLOW_DELETE') === true) {
+            await this.client.pool
+                .addEachTask({
+                data: data || [],
+                generator: (item) => this.deleteNetworkACLKey(item)
+                    .then(() => {
+                    this.didDelete(item);
+                    this.deleted += 1;
+                })
+                    .catch((err) => {
+                    if (err.statusCode === 409) {
+                        throw new Error(`Cannot delete Network ACL key "${item.name}" — it is still referenced by one or more ACL rules. ` +
+                            `Remove the key reference from all ACL rules first.\n${err}`);
+                    }
+                    throw new Error(`Problem deleting ${this.type} ${this.objString(item)}\n${err}`);
+                }),
+            })
+                .promise();
+        }
+        else {
+            logger_1.default.warn(`Detected the following ${this.type} should be deleted. Doing so may be destructive.\nYou can enable deletes by setting 'AUTH0_ALLOW_DELETE' to true in the config
+      \n${data.map((i) => this.objString(i)).join('\n')}`);
+        }
+    }
+}
+exports.default = NetworkACLKeysHandler;
+__decorate([
+    (0, default_1.order)(60)
+], NetworkACLKeysHandler.prototype, "processChanges", null);

package/lib/tools/auth0/handlers/networkACLs.d.ts

@@ -21,7 +21,7 @@ export declare const schema: {
                 minimum: number;
             };
             rule: {
-                anyOf: {
+                anyOf: ({
                     type: string;
                     required: string[];
                     properties: {
@@ -85,6 +85,15 @@ export declare const schema: {
                                     uniqueItems: boolean;
                                     minItems: number;
                                 };
+                                auth0_managed: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        pattern: string;
+                                    };
+                                    uniqueItems: boolean;
+                                    minItems: number;
+                                };
                                 geo_country_codes: {
                                     type: string;
                                     items: {
@@ -162,6 +171,29 @@ export declare const schema: {
                                     };
                                     uniqueItems: boolean;
                                 };
+                                http_message_signature: {
+                                    type: string;
+                                    properties: {
+                                        keys: {
+                                            type: string;
+                                            minItems: number;
+                                            maxItems: number;
+                                            uniqueItems: boolean;
+                                            items: {
+                                                type: string;
+                                                properties: {
+                                                    id: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                additionalProperties: boolean;
+                                            };
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: boolean;
+                                };
                             };
                             additionalProperties: boolean;
                         };
@@ -176,6 +208,15 @@ export declare const schema: {
                                     uniqueItems: boolean;
                                     minItems: number;
                                 };
+                                auth0_managed: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        pattern: string;
+                                    };
+                                    uniqueItems: boolean;
+                                    minItems: number;
+                                };
                                 geo_country_codes: {
                                     type: string;
                                     items: {
@@ -253,6 +294,29 @@ export declare const schema: {
                                     };
                                     uniqueItems: boolean;
                                 };
+                                http_message_signature: {
+                                    type: string;
+                                    properties: {
+                                        keys: {
+                                            type: string;
+                                            minItems: number;
+                                            maxItems: number;
+                                            uniqueItems: boolean;
+                                            items: {
+                                                type: string;
+                                                properties: {
+                                                    id: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                additionalProperties: boolean;
+                                            };
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: boolean;
+                                };
                             };
                             additionalProperties: boolean;
                         };
@@ -260,9 +324,75 @@ export declare const schema: {
                             enum: string[];
                             type: string;
                         };
+                        match_all?: undefined;
+                    };
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        action: {
+                            type: string;
+                            anyOf: ({
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    block: {
+                                        type: string;
+                                        enum: boolean[];
+                                    };
+                                };
+                                additionalProperties: boolean;
+                            } | {
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    allow: {
+                                        type: string;
+                                        enum: boolean[];
+                                    };
+                                };
+                                additionalProperties: boolean;
+                            } | {
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    log: {
+                                        type: string;
+                                        enum: boolean[];
+                                    };
+                                };
+                                additionalProperties: boolean;
+                            } | {
+                                type: string;
+                                required: string[];
+                                properties: {
+                                    redirect: {
+                                        type: string;
+                                        enum: boolean[];
+                                    };
+                                    redirect_uri: {
+                                        type: string;
+                                        minLength: number;
+                                        maxLength: number;
+                                    };
+                                };
+                                additionalProperties: boolean;
+                            })[];
+                        };
+                        match_all: {
+                            type: string;
+                            enum: boolean[];
+                        };
+                        scope: {
+                            enum: string[];
+                            type: string;
+                        };
+                        match?: undefined;
+                        not_match?: undefined;
                     };
                     additionalProperties: boolean;
-                }[];
+                })[];
             };
         };
         additionalProperties: boolean;

package/lib/tools/auth0/handlers/networkACLs.js

@@ -1,10 +1,49 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = void 0;
-const default_1 = __importDefault(require("./default"));
+const default_1 = __importStar(require("./default"));
 const client_1 = require("../client");
 const logger_1 = __importDefault(require("../../../logger"));
 // Define action types
@@ -57,6 +96,15 @@ const RedirectAction = {
     },
     additionalProperties: false,
 };
+// Shared sub-schemas reused across every rule branch below.
+const ActionSchema = {
+    type: 'object',
+    anyOf: [BlockAction, AllowAction, LogAction, RedirectAction],
+};
+const ScopeSchema = {
+    enum: ['management', 'authentication', 'tenant'],
+    type: 'string',
+};
 // Define MatchSchema
 const MatchSchema = {
     type: 'object',
@@ -69,6 +117,15 @@ const MatchSchema = {
             uniqueItems: true,
             minItems: 1,
         },
+        auth0_managed: {
+            type: 'array',
+            items: {
+                type: 'string',
+                pattern: '^auth0\\.[^.\\s]+$',
+            },
+            uniqueItems: true,
+            minItems: 1,
+        },
         geo_country_codes: {
             type: 'array',
             items: {
@@ -146,6 +203,27 @@ const MatchSchema = {
             },
             uniqueItems: true,
         },
+        http_message_signature: {
+            type: 'object',
+            properties: {
+                keys: {
+                    type: 'array',
+                    minItems: 1,
+                    maxItems: 10,
+                    uniqueItems: true,
+                    items: {
+                        type: 'object',
+                        properties: {
+                            id: { type: 'string' },
+                        },
+                        required: ['id'],
+                        additionalProperties: false,
+                    },
+                },
+            },
+            required: ['keys'],
+            additionalProperties: false,
+        },
     },
     additionalProperties: false,
 };
@@ -173,16 +251,10 @@ exports.schema = {
                         type: 'object',
                         required: ['action', 'scope', 'match'],
                         properties: {
-                            action: {
-                                type: 'object',
-                                anyOf: [BlockAction, AllowAction, LogAction, RedirectAction],
-                            },
+                            action: ActionSchema,
                             match: MatchSchema,
                             not_match: MatchSchema,
-                            scope: {
-                                enum: ['management', 'authentication', 'tenant'],
-                                type: 'string',
-                            },
+                            scope: ScopeSchema,
                         },
                         additionalProperties: false,
                     },
@@ -190,16 +262,25 @@ exports.schema = {
                         type: 'object',
                         required: ['action', 'scope', 'not_match'],
                         properties: {
-                            action: {
-                                type: 'object',
-                                anyOf: [BlockAction, AllowAction, LogAction, RedirectAction],
-                            },
+                            action: ActionSchema,
                             not_match: MatchSchema,
                             match: MatchSchema,
-                            scope: {
-                                enum: ['management', 'authentication', 'tenant'],
-                                type: 'string',
+                            scope: ScopeSchema,
+                        },
+                        additionalProperties: false,
+                    },
+                    {
+                        // Unconditional match: `match_all` is mutually exclusive with `match`/`not_match`.
+                        type: 'object',
+                        required: ['action', 'scope', 'match_all'],
+                        properties: {
+                            action: ActionSchema,
+                            match_all: {
+                                // Schema only permits `true`; omit the property instead of sending `false`.
+                                type: 'boolean',
+                                enum: [true],
                             },
+                            scope: ScopeSchema,
                         },
                         additionalProperties: false,
                     },
@@ -346,3 +427,6 @@ class NetworkACLsHandler extends default_1.default {
     }
 }
 exports.default = NetworkACLsHandler;
+__decorate([
+    (0, default_1.order)(65)
+], NetworkACLsHandler.prototype, "processChanges", null);

package/lib/tools/auth0/handlers/organizations.d.ts

@@ -1,6 +1,7 @@
 import { Management } from 'auth0';
 import DefaultHandler from './default';
 import { Asset, Assets, CalculatedChanges } from '../../../types';
+import { Client } from './clients';
 export declare const schema: {
     type: string;
     items: {
@@ -104,6 +105,29 @@ export declare const schema: {
                     required: string[];
                 };
             };
+            third_party_client_access: {
+                type: string;
+                enum: ("allow" | "block")[];
+            };
+            is_app_entitlement_active: {
+                type: string;
+            };
+            clients: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        client_id: {
+                            type: string;
+                        };
+                        use_for_member_access: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+                default: never[];
+            };
         };
         required: string[];
     };
@@ -115,6 +139,7 @@ type FormattedClientGrants = {
 export default class OrganizationsHandler extends DefaultHandler {
     existing: Asset[];
     formattedClientGrants: FormattedClientGrants[];
+    allClients: Client[];
     constructor(config: DefaultHandler);
     deleteOrganization(org: any): Promise<void>;
     deleteOrganizations(data: Asset[]): Promise<void>;
@@ -122,8 +147,9 @@ export default class OrganizationsHandler extends DefaultHandler {
     createOrganizations(creates: CalculatedChanges['create']): Promise<void>;
     updateOrganization(org: any, organizations: any): Promise<{
         id: any;
-    }>;
+    } | null>;
     getClientGrantIDByClientName(clientsName: string): string;
+    getClientIdByClientName(clientName: string): string;
     getFormattedClientGrants(): Promise<FormattedClientGrants[]>;
     updateOrganizations(updates: CalculatedChanges['update'], orgs: Asset[]): Promise<void>;
     getType(): Promise<Asset[]>;
@@ -137,5 +163,11 @@ export default class OrganizationsHandler extends DefaultHandler {
     createOrganizationDiscoveryDomain(organizationId: string, discoveryDomain: Management.CreateOrganizationDiscoveryDomainRequestContent): Promise<Management.CreateOrganizationDiscoveryDomainResponseContent>;
     updateOrganizationDiscoveryDomain(organizationId: string, discoveryDomainId: string, discoveryDomain: string, discoveryDomainUpdate: Management.UpdateOrganizationDiscoveryDomainRequestContent): Promise<Management.UpdateOrganizationDiscoveryDomainResponseContent>;
     deleteOrganizationDiscoveryDomain(organizationId: string, discoveryDomain: string, discoveryDomainId: string): Promise<void>;
+    getAllOrganizationClients(organizationId: string): Promise<Management.OrganizationClient[] | null>;
+    createOrganizationClients(organizationId: string, clients: Array<{
+        client_id: string;
+        use_for_member_access: boolean;
+    }>): Promise<void>;
+    deleteOrganizationClients(organizationId: string, clientIds: string[]): Promise<void>;
 }
 export {};