Enforce API Schema
Last updated
Was this helpful?
Last updated
Was this helpful?
CloudGuard WAF's Schema Validation engine validates that API input conforms to the schema provided by the admin.
The admin provides the schema (using the OpenAPI specification, or OAS in short) and enhances the ability of CloudGuard WAF to detect and prevent illegal requests that do not comply.
The defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
As long as schema validation is not active yet, API discovery can differentiate real APIs from requests by online scanners, by disregarding all APIs that do not receive a 200 OK HTTP response code.
Once schema validation is active in prevent mode, it will block all responses that do not conform to the schema. For this reason, the only way to detect new APIs that are missing from the schema is to use data from requests that are blocked by schema validation as well.
Once schema validation is active in Prevent mode, the need to carefully review new API changes in the following versions of the detected schema becomes much more important. The user must not accept changes of new APIs that are not used by the web server.
Use the multi-select option explained below to remove new APIs that are not supported by your server.
The recommended flow, even if you already had a highly maintained openAPI schema file of your APIs, is to allow API discovery learning mechanism to detect the actually used APIs in your server.
Follow the instructions for and , to see when it is recommended to enforce the detected schema.
Once the asset edit window opens, select the API Protection tab, choose the Mode you would like this practice will work on, and scroll to the Schema Validation sub-practice.
The recommended option is to select Use Discovered Schema and click Select. The schema selection window will appear:
The top will show the Currently enforced scheme name (or "No revision" upon the first time activating the schema validation feature).
Select:
Whether the "Changes" column will show APIs that have changed in any of their parameters and configuration, or just compare the endpoints (HTTP Method and URI) without query parameters, request body structure, etc.
The less recommended option is to select Use Custom Schema and Click on the Upload button the file selection window will appear:
Click the "Add File" icon to add a new file.
Optionally - you can click the "Download" icon to verify an existing file's content.
Select the file you wish to be used for schema validation.
Click OK.
When making the first change to the default Web API Best Practice's configuration such as uploading your unique OpenAPI schema file for Schema Validation purposes, you will be prompted to change the name of the Practice to your own custom practice name.
It possible to enforce the schema at 2 levels:
Full schema - The entire schema file is enforced
API endpoints only - everything in the schema file, except the HTTP methods and URIs is disregarded. Requests are being compared to the schema for enforcement solely based on their HTTP method and URI.
Setting the Mode to As Top Level means inheriting the primary mode of the practice.
Otherwise you can override it only for this specific sub-practice to Detect/Prevent/Disable.
Click Enforce on the top banner of the Infinity Portal.
Important reminder - The API discovery engine was designed to learn what API is actually being used. Even if you have a well-maintained schema file for your API, it is still recommended to wait before activating the Schema Validation Security engine, until the API discovery practice has learned the actual API usage in your system and suggested a schema.
At that point we recommend comparing the suggested schema with the schema file you had, and deciding on the exact schema to enforce accordingly.
If you decide to skip API discovery (not recommended) and move directly to schema validation with your own well-maintained schema file, skip directly to the following documentation and use the option of uploading your own schema file:
Which detected revision of the schema to select. Use the icon to change the table view to a multi-selection table. This will allow you to pick and choose which APIs will be enforced. You will be asked to provide a new name if you choose this option.
Once there is a well-maintained schema file, such as the schema the API discovery engine provides once it learned traffic to a high enough level, adding a schema file and activating the Schema Validation enforcement engine can further increase the security level by adding an schema file for your API. CloudGuard WAF will enforce the different unique applicative validations described in the schema file and alert upon attempts to use APIs in a way that does not match your schema.
