Shadow, Orphan, Zombie API ¶

The API Discovery module automatically identifies shadow, orphan and zombie APIs by comparing your uploaded specification to the live traffic.

Setup¶

To start finding the rogue APIs, you need to upload specification, select it to be used for rogue API detection and set detection parameters.

As both specification and API itself changes in time, consider the following:

• Comparison starts after first setup

• Comparison re-starts if any changes in API are found

• Comparison re-starts if you save new settings for it

• Comparison re-starts if you pick new file (by name or full URI)

• Comparison re-starts if file uploaded from URI has changes and the Regularly update the specification (every hour) option is selected

• You can re‑start comparison at any moment via specification menu → Restart comparison.

Also, you can download the previously uploaded specification via API Specifications → specification details window → Download specification.

Step 1: Upload specification¶

1. In the API Specifications section in US Cloud or EU Cloud, click Upload specification.

2. Set specification upload parameters and start uploading.

   

Note that you will not be able to start configuring rogue API detection, until the specification file is successfully uploaded.

Step 2: Set rogue API detection parameters¶

1. Click the Rogue APIs detection tab.

   API specification enforcement

   Besides rogue API detection, specifications may be used for API specification enforcement.

2. Select Use for rogue APIs detection.

3. Select Applications and Hosts - only endpoints related to the selected hosts will be searched for rogue APIs.

   

Disabling¶

Rogue API detection is based on uploaded specification or several specifications each having the Use for rogue APIs detection option selected. Consider that unchecking this option for some specification or deleting this specification will result in:

• Stopping of rogue API detection based on this specification and

• Removing all data about rogue API found based on this specification previously

Viewing found rogue APIs¶

As comparison is finished, the number of rogue (shadow, orphan and zombie) APIs will be displayed for each specification in the list of API Specifications.

Also rogue APIs will be displayed in the API Discovery section. Use the Rogue APIs filter to see only shadow, orphan and/or zombie APIs related to the selected comparisons and filter out the remaining endpoints.

In the details of such endpoints, in the Specification conflicts section, the specification(s) with the help of which shadow/zombie/orphan was detected will be indicated.

Shadow APIs are also displayed among the riskiest endpoints at the API Discovery Dashboard.

Specification versions and zombie APIs¶

Unlike shadow and orphan APIs, zombie APIs require comparison of different specification versions:

• If during setup the Regularly update the specification option was selected, just put new version to the URL where you host your specification - it will be processed by an hourly schedule or immediately if you select Restart comparison from the specification menu.

• If the Regularly update the specification option was not selected:

  • If uploading from URL and having a new content there, just click Restart comparison
  • If uploading from the local machine, open the specification dialog, select new file and save changes. File must have a different name.

All listed will consider the new content to be a next version of the specification. The versions will be compared and zombie API will be displayed.

Working with multiple specifications¶

In case you use several separate specifications to describe different aspects of your API, you can upload several or all of them to Wallarm.

In the API Discovery section, use the Compare to... filter to select specification comparisons - only for them the rogue APIs will be highlighted by the special marks in the Issues column.

Getting notified¶

To get immediate notifications about newly discovered rogue APIs to your SIEM, SOAR, log management system or messenger, in the Triggers section of Wallarm Console, configure one or more triggers with the Rogue API detected condition.

You can get messages about newly discovered shadow, orphan or zombie APIs or about all of them. You can also narrow notifications by application or host that you want to monitor and by the specification used for their detection.

How notifications come

• Each new found rogue API causes 1 notification message

• If you already got notification about some rogue API, it is not be sent again, no matter how many times the comparison is run

• If you update settings of the uploaded specification, notifications about all orphan APIs are re-sent (this does not apply to shadow or zombie APIs)

Trigger example: notification about newly discovered shadow endpoints in Slack

In this example, if API Discovery finds new endpoints that are not listed in the Specification-01 (shadow APIs), the notification about this is sent to your configured Slack channel.

To test the trigger:

1. Go to Wallarm Console → Integrations in the US or EU cloud, and configure integration with Slack.

2. In the API Discovery section, filter endpoints by API host of your choice, then download results as a specification and name it Specification-01.

3. In the API Specifications section, upload Specification-01 for comparison.

4. In the Triggers section, create a trigger as shown above.

5. Delete some endpoint from your local Specification-01 file.

6. In the API Specifications, re-upload your Specification-01 for comparison.

7. Check that your endpoint obtained the shadow API mark in the Issues column.

8. Check messages in your Slack channel like:

   [wallarm] A new shadow endpoint has been discovered in your API
   
   Notification type: api_comparison_result
   
   The new GET example.com/users shadow endpoint has been discovered in your API.
   
       Client: Client-01
       Cloud: US
   
       Details:
   
         application: Application-01
         api_host: example.com
         endpoint_path: /users
         http_method: GET
         type_of_endpoint: shadow
         link: https://my.wallarm.com/api-discovery?instance=1802&method=GET&q=example.com%2Fusers
         specification_name: Specification-01
   

Rogue API types and risks¶

Shadow API¶

Shadow API refers to an undocumented API that exists within an organization's infrastructure without proper authorization or oversight.

The shadow APIs put businesses at risk, as attackers can exploit them to gain access to critical systems, steal valuable data, or disrupt operations, further compounded by the fact that APIs often act as gatekeepers to critical data and that a range of OWASP API vulnerabilities can be exploited to bypass API security.

In terms of your uploaded API specifications, shadow API is an endpoint presented in actual traffic (detected by API Discovery) and not presented in your specification.

As you find shadow APIs with Wallarm, you can update your specifications to include missing endpoints and further perform monitoring and security activities towards your API inventory in its full view.

Orphan API¶

Orphan API refers to a documented API that does not receive traffic.

The presence of orphan APIs can be a reason for a verification process which involves:

• Inspecting the Wallarm traffic checking settings to understand whether the traffic is truly not being received, or if it is simply not visible to the Wallarm nodes because they were deployed in such a way that not all traffic passes through them (this may be incorrect traffic routing, or another Web Gateway is presented that was forgotten to put the node on, and so on).

• Determining whether certain applications should not receive any traffic at these specific endpoints or it is some kind of misconfiguration.

• Making decision on obsolete endpoints: used in previous application versions and not used in the current - should they be deleted from the specification to reduce security check effort.

Zombie API¶

Zombie API refers to deprecated APIs that everyone assumes have been disabled but actually they are still in use.

Zombie API risks are similar to the rest of undocumented (shadow) API but may be worse as the reason for disabling is often the insecure designs that are easier to crack.

In terms of your uploaded API specifications, zombie API is an endpoint presented in the previous version of your specification, not presented in the current version (that is, there was an intention of deletion of this endpoint) but still presented in actual traffic (detected by API Discovery).

Finding zombie API with Wallarm may be the reason to re‑check API configuration of you applications to actually disable such endpoints.

Was this page helpful?

How can we improve this article? (Optional)

Information is unclear or confusing

Insufficient information

Outdated or incorrect information

0/240

Send