kuzzle 2.49.1 → 2.50.0-beta.3

package/lib/kerror/codes/6-protocol.json

@@ -1,28 +0,0 @@
-{
-  "code": 6,
-  "subDomains": {
-    "runtime": {
-      "code": 1,
-      "errors": {
-        "invalid_connection": {
-          "description": "Connection objects must have both their id and protocol set",
-          "code": 1,
-          "message": "Invalid connection: %s (missing id or protocol)",
-          "class": "PluginImplementationError"
-        },
-        "unknown_connection": {
-          "description": "The provided connection identifier is unknown",
-          "code": 2,
-          "message": "Unable to remove connection - unknown connection identifier: %s",
-          "class": "PluginImplementationError"
-        },
-        "already_exists": {
-          "description": "A protocol of the same name already exists",
-          "code": 3,
-          "message": "A protocol of the same name already exists: %s",
-          "class": "PluginImplementationError"
-        }
-      }
-    }
-  }
-}

package/lib/kerror/codes/7-security.json

@@ -1,283 +0,0 @@
-{
-  "code": 7,
-  "subDomains": {
-    "token": {
-      "code": 1,
-      "errors": {
-        "invalid": {
-          "description": "Invalid authentication token.",
-          "code": 1,
-          "message": "Invalid token.",
-          "class": "UnauthorizedError"
-        },
-        "unknown_user": {
-          "description": "Missing user or missing user identifier",
-          "code": 2,
-          "message": "Unknown User : cannot generate token",
-          "class": "InternalError"
-        },
-        "unknown_connection": {
-          "description": "Missing connection identifier",
-          "code": 3,
-          "message": "Unknown connection : cannot generate token",
-          "class": "InternalError"
-        },
-        "ttl_exceeded": {
-          "description": "An authentication token was requested with a TTL larger than the configured maximum value",
-          "code": 4,
-          "message": "expiresIn value exceeds maximum allowed value",
-          "class": "BadRequestError"
-        },
-        "generation_failed": {
-          "description": "Unable to generate the requested authentication token",
-          "code": 5,
-          "message": "Error while generating token: %s",
-          "class": "InternalError"
-        },
-        "expired": {
-          "description": "The provided authentication token has expired",
-          "code": 6,
-          "message": "Token expired",
-          "class": "UnauthorizedError"
-        },
-        "verification_error": {
-          "description": "An unexpected error occured while verifying an authentication token",
-          "code": 7,
-          "message": "Error verifying token: %s",
-          "class": "InternalError"
-        },
-        "refresh_forbidden": {
-          "description": "The provided token cannot be refreshed",
-          "code": 8,
-          "message": "%s cannot be refreshed.",
-          "class": "UnauthorizedError"
-        },
-        "invalid_expiration": {
-          "description": "The specified expiration time is invalid",
-          "code": 9,
-          "message": "Token can not be created with this expiration time: %s",
-          "class": "BadRequestError"
-        }
-      }
-    },
-    "credentials": {
-      "code": 2,
-      "errors": {
-        "unknown_strategy": {
-          "description": "Unknown authentication strategy",
-          "code": 1,
-          "message": "Unknown authentication strategy \"%s\"",
-          "class": "BadRequestError"
-        },
-        "database_inconsistency": {
-          "description": "Inconsistency detected: credentials were found on a non-existing user",
-          "code": 2,
-          "message": "Internal database inconsistency detected: existing credentials found on non-existing user %s.",
-          "class": "PluginImplementationError"
-        },
-        "rejected": {
-          "description": "User's credentials were rejected during",
-          "code": 3,
-          "message": "Credentials rejected: %s",
-          "class": "BadRequestError"
-        }
-      }
-    },
-    "rights": {
-      "code": 3,
-      "errors": {
-        "unauthorized": {
-          "description": "Authentication required to execute this action",
-          "code": 1,
-          "message": "Unauthorized: authentication required to execute the action \"%s:%s\".",
-          "class": "UnauthorizedError"
-        },
-        "forbidden": {
-          "description": "Insufficient permissions to execute this action",
-          "code": 2,
-          "message": "Insufficient permissions to execute the action \"%s:%s\" (User \"%s\").",
-          "class": "ForbiddenError"
-        },
-        "failsafe_mode_admin_only": {
-          "description": "Only administrators (\"admin\" profile) can use the API in failsafe mode. Authenticate as admin or reboot without failsafe mode (\"config.plugins.common.failsafeMode\") to access the API.",
-          "code": 3,
-          "message": "Only administrators (\"admin\" profile) can use the API in failsafe mode.",
-          "class": "ForbiddenError"
-        }
-      }
-    },
-    "user": {
-      "code": 4,
-      "errors": {
-        "already_exists": {
-          "description": "Cannot create the user as it already exists",
-          "code": 1,
-          "message": "User %s already exists.",
-          "class": "PreconditionError"
-        },
-        "not_found": {
-          "description": "Attempted to access to a non-existing user",
-          "code": 2,
-          "message": "User \"%s\" not found.",
-          "class": "NotFoundError"
-        },
-        "anonymous_profile_required": {
-          "description": "The anonymous user must be assigned to the anonymous profile",
-          "code": 3,
-          "message": "The anonymous user must be assigned to the anonymous profile",
-          "class": "BadRequestError"
-        },
-        "cannot_hydrate": {
-          "description": "Database inconsistency error: a user is referencing non-existing profiles",
-          "code": 4,
-          "message": "Unable to hydrate the user \"%s\": missing profile(s) in the database",
-          "class": "InternalError"
-        },
-        "uninitialized": {
-          "description": "Attempted to access to an unitialized User object",
-          "code": 5,
-          "message": "Cannot get profiles for uninitialized user \"%s\"",
-          "class": "InternalError"
-        },
-        "prevent_overwrite": {
-          "description": "Attempted to overwrite existing users. Change \"onExistingUsers\" params to modify this method behavior.",
-          "code": 6,
-          "message": "Cannot overwrite existing users.",
-          "class": "BadRequestError"
-        },
-        "no_profile": {
-          "description": "Database inconsistency error: a user does not have profiles associated to it",
-          "code": 7,
-          "message": "Cannot load user \"%s\": there is no security profiles associated to it",
-          "class": "InternalError"
-        }
-      }
-    },
-    "role": {
-      "code": 5,
-      "errors": {
-        "not_found": {
-          "description": "Attempted to access to a non-existing role",
-          "code": 1,
-          "message": "Role \"%s\" not found.",
-          "class": "NotFoundError"
-        },
-        "login_required": {
-          "description": "Cannot remove the \"login\" action from the anonymous role",
-          "code": 2,
-          "message": "Cannot remove the \"login\" action from the anonymous role.",
-          "class": "BadRequestError"
-        },
-        "cannot_delete": {
-          "description": "Attempted to delete a base role (anonymous, default, admin)",
-          "code": 3,
-          "message": "The following roles are protected and cannot be deleted: anonymous, default, admin",
-          "class": "BadRequestError"
-        },
-        "in_use": {
-          "description": "A role still assigned to profiles cannot be deleted",
-          "code": 4,
-          "message": "The role \"%s\" is still used and cannot be deleted.",
-          "class": "PreconditionError"
-        },
-        "uninitialized": {
-          "description": "Attempted to access to an unitialized Role object",
-          "code": 5,
-          "message": "Cannot check permissions on the uninitialized role \"%s\"",
-          "class": "InternalError"
-        },
-        "invalid_rights": {
-          "description": "Invalid rights",
-          "code": 6,
-          "message": "Invalid rights for role \"%s\" (path: \"%s\"): %s",
-          "class": "BadRequestError",
-          "deprecated": "2.2.0"
-        },
-        "closure_exec_failed": {
-          "description": "Execution failed on the provided closure",
-          "code": 7,
-          "message": "Invalid definition for [%s, %s]: %s",
-          "class": "BadRequestError",
-          "deprecated": "2.2.0"
-        },
-        "closure_missing_test": {
-          "description": "Closures must specify a \"test\" attribute",
-          "code": 8,
-          "message": "Missing or malformed \"test\" attribute  for role %s (%s) : %s",
-          "class": "BadRequestError",
-          "deprecated": "2.2.0"
-        },
-        "unknown_controller": {
-          "description": "Trying to set a role with a non-existing controller",
-          "code": 9,
-          "message": "Trying to set role %s with a non-existing controller '%s'. %s",
-          "class": "BadRequestError"
-        },
-        "unknown_action": {
-          "description": "Trying to set a role with a non-existing controller action",
-          "code": 10,
-          "message": "Trying to set role %s with a non-existing action '%s' in controller '%s'. %s",
-          "class": "BadRequestError"
-        }
-      }
-    },
-    "profile": {
-      "code": 6,
-      "errors": {
-        "not_found": {
-          "description": "Attempted to access to a non-existing profile",
-          "code": 1,
-          "message": "Profile \"%s\" not found.",
-          "class": "NotFoundError"
-        },
-        "cannot_delete": {
-          "description": "Attempted to delete a base profile (anonymous, default, admin)",
-          "code": 2,
-          "message": "The following profiles are protected and cannot be deleted: anonymous, default, admin",
-          "class": "BadRequestError"
-        },
-        "in_use": {
-          "description": "A profile still assigned to users cannot be deleted",
-          "code": 3,
-          "message": "The profile \"%s\" is still used and cannot be deleted.",
-          "class": "PreconditionError"
-        },
-        "cannot_hydrate": {
-          "description": "Database inconsistency error: a profile is referencing non-existing roles",
-          "code": 4,
-          "message": "Unable to hydrate the profile \"%s\": missing role(s) in the database",
-          "class": "InternalError"
-        },
-        "missing_anonymous_role": {
-          "description": "The anonymous profile must include the anonymous role",
-          "code": 5,
-          "message": "The anonymous profile must include the anonymous role",
-          "class": "BadRequestError"
-        },
-        "uninitialized": {
-          "description": "Attempted to access to an unitialized Profile object",
-          "code": 6,
-          "message": "Cannot get roles for uninitialized profile \"%s\"",
-          "class": "InternalError"
-        }
-      }
-    },
-    "cookie": {
-      "code": 7,
-      "errors": {
-        "invalid": {
-          "description": "Invalid authentication cookie.",
-          "code": 1,
-          "message": "Invalid cookie.",
-          "class": "UnauthorizedError"
-        },
-        "unsupported": {
-          "description": "Cookie authentication not supported.",
-          "code": 2,
-          "message": "Cookie authentication not supported.",
-          "class": "InternalError"
-        }
-      }
-    }
-  }
-}

package/lib/kerror/codes/8-cluster.json

@@ -1,16 +0,0 @@
-{
-  "code": 8,
-  "subDomains": {
-    "fatal": {
-      "code": 0,
-      "errors": {
-        "desync": {
-          "description": "Caught a synchronization inconsistency. Triggers a suicide from the node detecting it.",
-          "code": 1,
-          "message": "Caught a desync error: %s.",
-          "class": "InternalError"
-        }
-      }
-    }
-  }
-}

package/lib/kerror/codes/index.js

@@ -1,208 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * 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
- *
- * https://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.
- */
-
-"use strict";
-
-const assert = require("assert");
-
-const errors = require("../errors");
-const { has, isPlainObject } = require("../../util/safeObject");
-
-// codes
-const domains = {
-  api: require("./2-api"),
-  cluster: require("./8-cluster.json"),
-  core: require("./0-core"),
-  network: require("./3-network"),
-  plugin: require("./4-plugin"),
-  protocol: require("./6-protocol"),
-  security: require("./7-security"),
-  services: require("./1-services"),
-  validation: require("./5-validation"),
-};
-
-/** Check the format of the error codes files
- *  @param {object} - error config file domain
- */
-
-function checkErrors(subdomain, domain, options) {
-  const codes = new Set();
-
-  for (const [name, error] of Object.entries(subdomain.errors)) {
-    assert(
-      has(error, "code"),
-      `Error configuration file : Missing required 'code' field (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      Number.isInteger(error.code),
-      `Error configuration file : Field 'code' must be an integer (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      error.code > 0x0000 && error.code <= 0xffff,
-      `Error configuration file : Field 'code' must be between 1 and 65535 (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      !codes.has(error.code),
-      `Error configuration file : code ${error.code} for error '${name}' is not unique (domain: ${domain.code}, subdomain: ${subdomain.code}).`,
-    );
-
-    codes.add(error.code);
-
-    assert(
-      has(error, "message"),
-      `Error configuration file : Missing required 'message' field (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      typeof error.message === "string" && error.message.length > 0,
-      `Error configuration file : Field 'message' must be a non-empty string (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-
-    assert(
-      has(error, "class"),
-      `Error configuration file : Missing required 'class' field (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      typeof error.class === "string",
-      `Error configuration file : Field 'class' must be a string (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-    );
-    assert(
-      has(errors, error.class),
-      `Error configuration file : Field 'class' must target a known KuzzleError object (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}), '${name.class}' does not exist.`,
-    );
-
-    // plugin errors aren't required to have descriptions
-    if (!options.plugin) {
-      assert(
-        typeof error.description === "string" && error.description.length > 0,
-        `Error configuration file : Field 'description' must be a non-empty string (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-      );
-    }
-
-    if (error.deprecated !== undefined && error.deprecated !== null) {
-      assert(
-        typeof error.deprecated === "string" && error.deprecated.length > 0,
-        `Error configuration file : Field 'deprecated' must be a non-empty string (domain: ${domain.code}, subdomain: ${subdomain.code}, error: ${name}).`,
-      );
-    }
-  }
-}
-
-function checkSubdomains(domain, options) {
-  const subdomainCodes = new Set();
-
-  for (const subdomainName of Object.keys(domain.subDomains)) {
-    const subdomain = domain.subDomains[subdomainName];
-
-    // Subdomain code for plugins is not required and is automatically set to 0
-    if (!options.plugin) {
-      assert(
-        has(subdomain, "code"),
-        `Error configuration file : Missing required 'code' field (domain: ${domain.code}, subdomain: ${subdomainName}).`,
-      );
-    } else if (!has(subdomain, "code")) {
-      subdomain.code = 0;
-    }
-
-    assert(
-      Number.isInteger(subdomain.code),
-      `Error configuration file : Field 'code' must be an integer (domain: ${domain.code}, subdomain: ${subdomainName}).`,
-    );
-    assert(
-      subdomain.code >= 0x00 && subdomain.code <= 0xff,
-      `Error configuration file : Field 'code' must be between 0 and 255 (domain: ${domain.code}, subdomain: ${subdomainName}).`,
-    );
-    assert(
-      !subdomainCodes.has(subdomain.code),
-      `Error configuration file : code ${subdomain.code} for subdomain '${subdomainName}' is not unique (domain: ${domain.code}).`,
-    );
-
-    // We don't allow duplicates, except for defaulted plugin subdomain codes
-    if (!options.plugin || subdomain.code > 0) {
-      subdomainCodes.add(subdomain.code);
-    }
-
-    assert(
-      has(subdomain, "errors"),
-      `Error configuration file : Missing required 'errors' field (domain: ${domain.code}, subdomain: ${subdomainName}).`,
-    );
-    assert(
-      isPlainObject(subdomain.errors),
-      `Error configuration file : Field 'errors' must be an object (domain: ${domain.code}, subdomain: ${subdomainName}).`,
-    );
-
-    checkErrors(subdomain, domain, options);
-  }
-}
-
-function checkDomains(errorCodesFiles, options = { plugin: false }) {
-  const domainCodes = new Set();
-
-  for (const domainName of Object.keys(errorCodesFiles)) {
-    const domain = errorCodesFiles[domainName];
-
-    assert(
-      has(domain, "code"),
-      `Error configuration file : Missing required 'code' field. (domain: '${domainName}').`,
-    );
-    assert(
-      Number.isInteger(domain.code),
-      `Error configuration file : Field 'code' must be an integer. (domain: '${domainName}').`,
-    );
-    assert(
-      domain.code >= 0x00 && domain.code <= 0xff,
-      `Error configuration file : Field 'code' must be between 0 and 255. (domain: '${domainName}').`,
-    );
-    assert(
-      !domainCodes.has(domain.code),
-      `Error configuration file : code ${domain.code} for domain ${domainName} is not unique.`,
-    );
-
-    domainCodes.add(domain.code);
-
-    assert(
-      has(domain, "subDomains"),
-      `Error configuration file : Missing required 'subDomains' field. (domain: '${domainName}').`,
-    );
-    assert(
-      isPlainObject(domain.subDomains),
-      `Error configuration file : Field 'subDomains' must be an object. (domain: '${domainName}').`,
-    );
-
-    checkSubdomains(domain, options);
-  }
-}
-
-function loadPluginsErrors(pluginManifest, pluginCode) {
-  // @todo this should be in its own, independant domain
-  domains.plugin.subDomains[pluginManifest.name] = {
-    code: pluginCode,
-    errors: pluginManifest.errors,
-  };
-  checkDomains({ plugin: domains.plugin }, { plugin: true });
-}
-
-checkDomains(domains);
-
-module.exports = {
-  checkDomains,
-  domains,
-  loadPluginsErrors,
-};