In keeping with MITRE, the commonest type of API (software programming interface) misuse happens when the caller doesn’t honor its finish of a contract. Within the context of this text, a “contract” refers to a proper, exact settlement that outlines the anticipated behaviors, inputs, outputs, and unintended effects that an API ensures to any caller, guaranteeing that each the API and its purchasers adhere to specified constraints and usages. This idea is essential in stopping misuse by clearly defining the boundaries and necessities for each events concerned within the interplay. This weblog submit explores contract programming and particularly how that applies to the constructing, upkeep, and safety of APIs.
API misuse typically happens as a result of not understanding the state of the system behind an API, which can result in incorrect ordering of calls and finish in an error state that may be a vulnerability. This misuse can even occur when an implementation of an API doesn’t meet the specification. For instance, a shopper could also be anticipating a sure output per the specification however obtain one thing completely different. Lastly, misuse of an API can occur in an object-oriented programming (OOP) context with particular subclass implementations. These implementations might not present the identical performance that’s mandated by the tremendous class or interface. Within the design and implementation of software program programs there exists a concept of contracts that may assist to resolve a few of these points.
An API is, in a basic sense, a contract between a supplier of a software program and the buyer of that software program about what the system will do. This concept of contract programming or Design by Contract was coined by Bertrand Meyer in 1986. On this paradigm, a software program engineer defines formally the specification for every perform or methodology that the system exposes ((within the context of this paper, the phrases “perform” and “methodology” are used interchangeably). This specification contains noting pre-conditions, post-conditions, and invariants. Whereas usually an excellent design follow for enhancing the verifiability of programs, this contract programming assemble additionally allows API safety.
Pre- and Postconditions of a Contract
We outline a capabilities contract because the set of pre- and post- circumstances and the invariants of the perform that should maintain.
Preconditions are the set of standards required earlier than a perform might be executed. These are issues that the service or API supplier anticipate to be true earlier than a perform known as. An instance of this, within the context of an API, is {that a} precondition for accessing a protected endpoint be that the caller gives a sound authentication token. One other instance is a perform that requires a sound (i.e., not null) pointer be handed to it. In both of those circumstances, if the precondition will not be met (i.e., the token is invalid, or the pointer is null), then the contract is damaged.
Postconditions are the state or set of standards that have to be true after a perform is executed. Postconditions for an API stands out as the return of some specified information and an HTTP 200 standing code. A caller or shopper that makes use of an API perform whose preconditions usually are not met will not be entitled to the postconditions. The system that’s furnishing the API is predicted to supply the submit circumstances. Lastly, invariants are the information or state that can’t be modified by perform execution whatever the operation or transformation utilized by the perform.
Due to this fact, to honor the contract means to reply the three questions of a Hoare triple:
- What does the contract anticipate?
- What does the contract assure?
- What does the contract keep?
Defining an API Interface
As an interface, an API usually is outlined in information definition language (DDL), interface description language (IDL), or simply plain textual content. Consequently, an interface’s implementation will not be true to the specification. Formal strategies present a method of verifying that an implementation refines a specification. Making certain an implementation meets all expectations of an interface can be intently tied to the Liskov Substitution Precept. In discussing each refinement of a specification and the Liskov substitution precept we will generalize the next constraints for a perform:
- Preconditions can’t be strengthened (i.e., an implementation might not settle for a narrower vary of enter than the specification dictates). For instance, an implementation of a pop() methodology on a Stack can’t add a precondition that the stack should have a minimal dimension of 5 parts earlier than permitting a name to pop().
- Postconditions can’t be weakened (i.e., an implementation might not return a bigger vary of output than the specification dictates). For instance, after calling push(component) on a Stack the stack should replicate the addition of precisely one new component, however no more.
- Invariants can’t be weakened (i.e., an implementation might not alter the state of invariants listed within the specification). For instance, the dimensions of a stack must not ever be adverse, whatever the variety of pop() or push() operations carried out.
Along with errors on the buyer facet of an API, errors may also be brought on by not totally implementing the interface of the API or doing so incorrectly. For instance, the Open Worldwide Utility Safety Challenge (OWASP) basis publishes an inventory of the prime 10 API safety dangers. For 2023 the highest danger was Damaged Object Stage Authorization (BOLA). BOLA is an instance of an implementation not honoring a contract precondition, akin to a request to a given API perform or endpoint should include an authorization token that’s legitimate for the actual object being requested.
Who Ought to Verify the Pre-and Postconditions?
This query relies on the model and structure of the codebase that’s implementing an API. In lots of circumstances the supplier of the API would require robust preconditions and won’t even try and work if they aren’t met. This constraint places the burden on the consumer to make sure that every thing is legitimate and within the correct state earlier than calling an API. Alternatively, the methods of defensive programming counsel that it’s doubtlessly higher to deal with unexpected circumstances extra gracefully. Meyer suggests when designing by contract that dealing with one case properly and requiring robust preconditions is a finest follow that has proved profitable.
Programming Language Instruments for Defining API Contracts
How contracts are outlined in a selected language varies. In Java the usage of Javadoc feedback to doc the parameters, return worth, exceptions, and the capabilities objective is a typical (although much less formal) method of documenting a contract. There are additionally quite a lot of instruments that supply various ranges of ritual for outlining contracts that may assist to allow verification of API utilization. Some notable examples are:
- Eiffel
- Java through Java Modeling Language (JML)
- Kotlin (natively)
- Rust through the contracts crate
- Ada 2012 (natively)
- API Blueprint
- OpenAPI
Given the prevalence of HTTP-based REST APIs, OpenAPI is a related instrument and format for specifying endpoints, enter and output for every operation, authentication strategies, and different data. Using the OpenAPI specification to outline an API aligns properly with the design-by-contract paradigm of specifying the preconditions, such because the area of inputs and an outline of the endpoint. OpenAPI additionally permits for specifying the return from an endpoint together with the return code, an outline of what that return code means, the schema of any returned information, and examples of the information.
Particularly, within the realm of API safety, OpenAPI additionally permits for specification of the authentication and authorization necessities for every endpoint. In the documentation, OpenAPI refers to this as a safety scheme. Within the 3.0 model, this safety scheme contains HTTP authentication, API Keys, OAuth2, and OpenID Join.
Doubtlessly a spot that OpenAPI falls brief is within the means to specify invariants of a perform. For example, in a REST API, GET requests ought to be idempotent. There’s, nonetheless, no strategy to doc exterior of a textual content description what an endpoint might or might not change by way of state.
Whereas Open API and the opposite listed instruments all provide a machine readable or parseable format, as beforehand talked about, even a textual content description of a capabilities contract will help. The benefit of a machine-readable contract, nonetheless, is the power to generate take a look at circumstances for the contract.
There are a number of open-source instruments, akin to RESTler and Dredd, that can eat an OpenAPI spec and routinely generate and execute take a look at circumstances in opposition to an implementation. Equally with Java and the Java Modeling Language (JML), there are functions that may remodel the Javadoc feedback into runtime assertions. An instance of this method is the JML compiler that provides in assertions to the Java bytecode.
Advantages to API Testing
As we’ve explored, there are a lot of instruments for supporting contract programming. Nonetheless, these instruments include a price. Particularly, builders have to be skilled on their use; the instruments have to be built-in right into a product’s DevSecOps pipeline, and they’re yet one more dependency that have to be maintained and up to date. Along with the buyer advantages of offering a contract, what advantages can the API builders get from utilizing these instruments? I contend that the largest benefit to builders working below the contract programming paradigm is the power to check the interface with out testing the implementation.
Josh Bloch, CMU professor and previously of Google and Solar Microsystems wrote, “Code the use-cases in opposition to your API earlier than you implement it.” A product with a well-defined contract allows the staff to check out an API specification and write instance consumer code that makes use of the capabilities or endpoints very early on within the improvement cycle. This method eliminates any time spent implementing a particular perform after which discovering out the perform is awkward or arduous to make use of kind the consumer perspective.
This idea additionally extends to integration testing of various software program modules. For giant, complicated programs it may be arduous to assemble all of the customers to carry out stay testing of every part. Equally, some programs can show arduous to simulate a take a look at surroundings for. Maybe the goal system is extremely costly to function on (akin to quantum computer systems at ~ $1.60 per second) or the system will not be even constructed but. In each circumstances having a contract that precisely represents a software program module or library can support the mixing testing accomplished by each producers and shoppers of the software program.
Rising API Usability Will increase Safety
Whereas APIs can be utilized by each people and different functions, they’re in the end designed and applied by people. Ignoring the usability or developer expertise of an API can result in safety considerations whereas growing API usability can bolster safety. For instance, a examine by Sascha Fahl et. al discovered that in 13,500 well-liked free Android apps, eight p.c had misused the APIs for the Safe Sockets Layer (SSL) or its successor, the Transport Layer Safety (TLS), and had been thus susceptible to man-in-the-middle and different assaults. A follow-on examine of Apple iOS apps discovered that 9.7 p.c had been susceptible with causes together with vital difficulties utilizing safety APIs accurately. The authors of the examine suggest quite a few adjustments that will improve the usability and safety of the APIs.
Brad Myers contends that API safety is a perform of unhealthy code written by programmers who’re human. Simpler-to-use APIs subsequently assist safety by making good code simpler to put in writing and unhealthy code tougher. To help this method, contract pushed programming generally is a means to ease the burden of counting on documentation exterior of the supply code as a result of it has been proven that many software program builders choose to make use of supply code over official documentation.
Each API doesn’t present supply code. Nonetheless, even for these which are totally open, centralizing the API guidelines and expectations inside a contract will help streamline the developer expertise. This idea of a code-driven method to studying meshes properly with the truth that most contract programming mechanisms are straight embedded withing the supply code that implements the contract. Having a transparent, easy-to-find and easy-to-use API contract can stop unintentional misuse.
One other instance of a damaged contract that had safety implications is Heartbleed. Within the implementation of OpenSSL, the heartbeat request message might be exploited to overread the buffer when asking for extra information than the payload wanted. This exploit was a violation of the contract within the sense that the payload_length discipline ought to have been the identical because the payload however was not. Looking back, this error is a basic buffer over-read, but it surely affected many programs. If a contract has explicitly outlined the precondition that the payload and payload size have to be the identical, the error might have been extra apparent to the implementer. Whereas there are different means to resolve this similar downside by means of automated code restore or utilizing languages with extra strict compilers, contract pushed programming may present a language agnostic strategy to keep away from related errors in implementation.
The Way forward for API Contract Programming
Contract programming within the context of APIs is a robust idea that may assist guarantee an API conforms to a specification. APIs by their nature characterize a black field the place an implementation and the how of the system is opaque to the person. Given the character of APIs, you will need to inform API customers what precisely is required and what to anticipate. A standardized method to representing these contracts helps testers automate and validate APIs. Effectively-defined contracts can even support within the developer expertise of an API and supply extra formal verification of programs that require much more assurance.