Tutorials

Fixing API Security Issues identified in the Audit Report

In our previous tutorial, we took a look at the audit report from API Contract Security Audit. This one proceeds onto fixing the issues found in the audit and see how we can iteratively work on our OpenAPI / Swagger definition.

Navigating Issues

The best place to start are the high priority issues, they are the fastest way to improve the audit score. For example, in the audit report, click Go to Issue on the first issue in the priority list. You get a view similar to the image on the right.

Here we can see we have seven different places where the issue in question occurs (1) . To go and fix the issue in this particular place, click on Fix issue in Editor (2) . This takes you to the correct spot in your API definition in our built-in Security Editor (3) . By default, the details of the issue and remediation recommendations are shown on the right, but if you have minimized the sidebar, just click How to Fix to view them again.

Fixing Issues

In our example, you can see that the property maxLength of the string is missing and the remediation suggestions on the right (1). Once you have edited the file to fix the issue, click Save and Re-Test to update the OpenAPI (Swagger) definition.

The issue is fixed, audit is re-run, and the audit score increases accordingly (3).

You can continue to move down the list from here to fix the highest priority issues, or return back to your report and filter the issues as you want.

Updating the Definition

You can work on your API outside 42Crunch Platform as well, like in your IDE or any other editor, and then upload the updated definition manually in the platform. Or you can automate a workflow to push your changes to your API to the platform as well.

update-def-04 (Custom)

Latest Resources

WEBINAR

Webinar Series - Defending APIs with Jim Manico

Defending APIs with Jim Manico – Episode 1

Episode 1: Request Forgery on the Web – CSRF & SSRF

November 10, 2022 | 9am PST | 5pm BST

Join Jim Manico, CEO of Manicode and Colin Domoney from 42Crunch, as they deliver a 2-part webinar series to help developers better defend APIs.

BLOG

Empathy for the API Developer

By Colin Domoney | July 25, 2022

Colin Domoney from 42Crunch, in his recent article on DevOps.com, addresses the disconnect between development and security teams and explains the key challenges facing developers in creating secure API code. Better understanding of the challenges on both sides can help create greater empathy which in turn can help […]

DataSheet

Datasheet Cover Images P1-02

Product Datasheet Addressing API Security Challenges

APIs are the core building block of every enterprise’s digital strategy, yet they are also the number one attack surface for hackers. 42Crunch makes developers’ and security practitioners' lives easier by protecting APIs, with a platform that automates security into the API development pipeline and gives full oversight of security policy enforcement at every stage of the API lifecycle.

Ready to Learn More?

Developer-first solution for delivering API security as code.