In line 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 uncomfortable side effects that an API ensures to any caller, making certain 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 put up explores contract programming and particularly how that applies to the constructing, upkeep, and safety of APIs.
API misuse typically happens resulting from not figuring out 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 also can 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 could not present the identical performance that’s mandated by the tremendous class or interface. Within the design and implementation of software program methods there exists a concept of contracts that may assist to unravel a few of these points.
An API is, in a common sense, a contract between a supplier of a software program and the patron 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 operate or technique that the system exposes ((within the context of this paper, the phrases “operate” and “technique” are used interchangeably). This specification contains noting pre-conditions, post-conditions, and invariants. Whereas typically a superb design follow for enhancing the verifiability of methods, this contract programming assemble additionally permits 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 operate that should maintain.
Preconditions are the set of standards required earlier than a operate will be executed. These are issues that the service or API supplier count on to be true earlier than a operate is named. An instance of this, within the context of an API, is {that a} precondition for accessing a protected endpoint be that the caller offers a sound authentication token. One other instance is a operate that requires a sound (i.e., not null) pointer be handed to it. In both of those circumstances, if the precondition just isn’t 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 operate is executed. Postconditions for an API could be the return of some specified knowledge and an HTTP 200 standing code. A caller or shopper that makes use of an API operate whose preconditions aren’t met just isn’t entitled to the postconditions. The system that’s furnishing the API is predicted to supply the put up circumstances. Lastly, invariants are the info or state that can’t be modified by operate execution whatever the operation or transformation utilized by the operate.
Subsequently, to honor the contract means to reply the three questions of a Hoare triple:
- What does the contract count on?
- What does the contract assure?
- What does the contract keep?
Defining an API Interface
As an interface, an API usually is outlined in knowledge definition language (DDL), interface description language (IDL), or simply plain textual content. Consequently, an interface’s implementation might not be true to the specification. Formal strategies present a way of verifying that an implementation refines a specification. Guaranteeing 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 are able to generalize the next constraints for a operate:
- Preconditions can’t be strengthened (i.e., an implementation could not settle for a narrower vary of enter than the specification dictates). For instance, an implementation of a pop() technique on a Stack can’t add a precondition that the stack should have a minimal measurement of 5 components earlier than permitting a name to pop().
- Postconditions can’t be weakened (i.e., an implementation could not return a bigger vary of output than the specification dictates). For instance, after calling push(aspect) on a Stack the stack should mirror the addition of precisely one new aspect, however no more.
- Invariants can’t be weakened (i.e., an implementation could not alter the state of invariants listed within the specification). For instance, the dimensions of a stack must not ever be damaging, whatever the variety of pop() or push() operations carried out.
Along with errors on the patron aspect of an API, errors can be attributable to not absolutely implementing the interface of the API or doing so incorrectly. For instance, the Open Worldwide Utility Safety Mission (OWASP) basis publishes a listing of the highest 10 API safety dangers. For 2023 the highest threat was Damaged Object Stage Authorization (BOLA). BOLA is an instance of an implementation not honoring a contract precondition, corresponding to a request to a given API operate or endpoint should include an authorization token that’s legitimate for the actual object being requested.
Who Ought to Examine the Pre-and Postconditions?
This query is determined by the model and structure of the codebase that’s implementing an API. In lots of circumstances the supplier of the API would require sturdy 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 little thing is legitimate and within the correct state earlier than calling an API. Then again, the strategies of defensive programming recommend that it’s doubtlessly higher to deal with unexpected circumstances extra gracefully. Meyer suggests when designing by contract that dealing with one case effectively and requiring sturdy preconditions is a greatest follow that has proved profitable.
Programming Language Instruments for Defining API Contracts
How contracts are outlined in a specific language varies. In Java using Javadoc feedback to doc the parameters, return worth, exceptions, and the capabilities goal is a standard (although much less formal) means of documenting a contract. There are additionally a wide range 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 effectively 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 knowledge, and examples of the info.
Particularly, within the realm of API safety, OpenAPI additionally permits for specification of the authentication and authorization necessities for every endpoint. Within 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 quick is within the capacity to specify invariants of a operate. As an example, in a REST API, GET requests must be idempotent. There’s, nonetheless, no approach to doc outdoors of a textual content description what an endpoint could or could not change when it comes to 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 can assist. The benefit of a machine-readable contract, nonetheless, is the flexibility to generate take a look at circumstances for the contract.
There are a number of open-source instruments, corresponding to RESTler and Dredd, that may devour an OpenAPI spec and robotically generate and execute take a look at circumstances in opposition to an implementation. Equally with Java and the Java Modeling Language (JML), there are purposes that may remodel the Javadoc feedback into runtime assertions. An instance of this strategy is the JML compiler that provides in assertions to the Java bytecode.
Advantages to API Testing
As we’ve explored, there are various instruments for supporting contract programming. Nonetheless, these instruments include a price. Specifically, 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 one more dependency that have to be maintained and up to date. Along with the patron advantages of offering a contract, what advantages can the API builders get from utilizing these instruments? I contend that the most important benefit to builders working below the contract programming paradigm is the flexibility 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 permits the group to check out an API specification and write instance consumer code that makes use of the capabilities or endpoints very early on within the growth cycle. This strategy eliminates any time spent implementing a selected operate after which discovering out the operate is awkward or onerous to make use of type the consumer perspective.
This idea additionally extends to integration testing of various software program modules. For giant, complicated methods it may be onerous to assemble all of the customers to carry out stay testing of every part. Equally, some methods can show onerous to simulate a take a look at surroundings for. Maybe the goal system is extremely costly to function on (corresponding to quantum computer systems at ~ $1.60 per second) or the system just isn’t even constructed but. In each circumstances having a contract that precisely represents a software program module or library can support the combination testing executed by each producers and customers of the software program.
Rising API Usability Will increase Safety
Whereas APIs can be utilized by each people and different purposes, 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 rising API usability can bolster safety. For instance, a research by Sascha Fahl et. al discovered that in 13,500 fashionable free Android apps, eight % had misused the APIs for the Safe Sockets Layer (SSL) or its successor, the Transport Layer Safety (TLS), and have been thus susceptible to man-in-the-middle and different assaults. A follow-on research of Apple iOS apps discovered that 9.7 % have been susceptible with causes together with vital difficulties utilizing safety APIs accurately. The authors of the research advocate quite a few modifications that may improve the usability and safety of the APIs.
Brad Myers contends that API safety is a operate of unhealthy code written by programmers who’re human. Simpler-to-use APIs subsequently assist safety by making good code simpler to jot down and unhealthy code more durable. To assist this strategy, contract pushed programming could be a means to ease the burden of counting on documentation outdoors of the supply code as a result of it has been proven that many software program builders favor to make use of supply code over official documentation.
Each API doesn’t present supply code. Nonetheless, even for these which are absolutely open, centralizing the API guidelines and expectations inside a contract can assist streamline the developer expertise. This idea of a code-driven strategy to studying meshes effectively with the truth that most contract programming mechanisms are immediately embedded withing the supply code that implements the contract. Having a transparent, easy-to-find and easy-to-use API contract can forestall unintentional misuse.
One other instance of a damaged contract that had safety implications is Heartbleed. Within the implementation of OpenSSL, the heartbeat request message could possibly be exploited to overread the buffer when asking for extra knowledge 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 traditional buffer over-read, however it affected many methods. If a contract has explicitly outlined the precondition that the payload and payload size have to be the identical, the error could have been extra apparent to the implementer. Whereas there are different means to unravel this identical downside by means of automated code restore or utilizing languages with extra strict compilers, contract pushed programming might present a language agnostic approach to keep away from comparable errors in implementation.
The Way forward for API Contract Programming
Contract programming within the context of APIs is a strong idea that may assist guarantee an API conforms to a specification. APIs by their nature signify a black field the place an implementation and the how of the system is opaque to the consumer. Given the character of APIs, you will need to inform API customers what precisely is required and what to anticipate. A standardized strategy to representing these contracts helps testers automate and validate APIs. Effectively-defined contracts also can support within the developer expertise of an API and supply extra formal verification of methods that require much more assurance.
