insomnia-plugin-ovhcloud-signature v1.0.0

OVH Cloud API Signature for Insomnia

This is a plugin for Insomnia that generates the X-Ovh-Signature signature header for API calls to the OVH Cloud API.

OVH Cloud API calls require that once you have obtained your three keys (AK, AS, CK), you need to sign all API requests. The signature is calculated as follows:

SHA1_HEX(AS+"+"+CK+"+"+METHOD+"+"+QUERY+"+"+BODY+"+"+TSTAMP)

Installation

Install the insomnia-plugin-ovhcloud-signature plugin from Preferences -> Plugins.

How to use

Setup for OVH API Calls

Generate your Application Keys. Once you have created the keys, you will be issued three keys:

• The Application Key, called AK
• The Application Secret, not to be disclosed, called AS
• The Secret Consumer Key, not to be disclosed, called CK

You will need to add your own headers for:

• X-Ovh-Application with the value of the Application Key
• X-Ovh-Consumer with the value of the Secret Consumer Key

You can template these in a private environment like:

{
  "ApplicationKey": "1234567890abcdef",
  "ApplicationSecret": "1029384756abcdef",
  "ConsumerKey": "0987654321defabc"
}

Then using a plugin like the Global Headers you can set your Base Environment to be something like:

{
  "basePath": "https://api.ovh.com/1.0",
  "GLOBAL_HEADERS": {
    "Accept": "application/json",
    "Content-Type": "application/json;charset=utf-8",
    "X-Ovh-Application": "{{ApplicationKey}}",
    "X-Ovh-Consumer": "{{ConsumerKey}}"
  }
}

Setup this plugin

Add the OVH Signature template tag to a request header.

Provide the values manually or from your private environment variables:

NB: Ignore the Live Preview error

The plugin will generate and add the headers:

• X-Ovh-Timestamp
• X-Ovh-Signature

Important Minification in JSON Body Text

Because of the way PUT and POST methods need the JSON body included in the signature, currently the body of your request needs to be minified with no spaces, for example when editing a credential with PUT on the /1.0/me/api/credential/<credentialId> endpoint:

The body might be like this, and must be fully minified.

{"allowedIPs":["127.0.0.1/32","127.0.0.2/32"]}

This results in the insomnia request Timeline being:

> PUT /1.0/me/api/credential/553184188 HTTP/1.1
> Host: api.ovh.com
> User-Agent: insomnia/2022.6.0
> Content-Type: application/json
> Accept: application/json
> X-Ovh-Application: 1234567890abcdef
> X-Ovh-Consumer: 0987654321defabc
> X-Ovh-Timestamp: 1667135223
> X-Ovh-Signature: $1$0987654321123456789009876543211234567890
> Content-Length: 51

| {"allowedIPs":["127.0.0.1/32","127.0.0.2/32"]}

If there are spaces in your JSON body, the plugin currently can't generate a matching signature. A future TODO for sure.