Initial code for plugin

Author: lantrix

.github/assets/insomnia-add-header.png

@@ -0,0 +1,67 @@
+#  OVH Cloud API Signature for Insomnia
+
+This is a plugin for [Insomnia](https://insomnia.rest/) that generates the `X-Ovh-Signature` signature header for API calls to the [OVH Cloud API](https://docs.ovh.com/gb/en/api/first-steps-with-ovh-api/#first-api-usage).
+
+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](https://docs.ovh.com/gb/en/api/first-steps-with-ovh-api/#advanced-usage-pair-ovhcloud-apis-with-an-application_2). 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:
+
+```json
+{
+  "ApplicationKey": "1234567890abcdef",
+  "ApplicationSecret": "1029384756abcdef",
+  "ConsumerKey": "0987654321defabc"
+}
+```
+
+Then using a plugin like the [Global Headers](https://insomnia.rest/plugins/insomnia-plugin-global-headers) you can set your _Base Environment_ to be something like:
+
+```json
+{
+  "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.
+
+![request example](./.github/assets/insomnia-add-header.png)
+
+Provide the values manually or from your private environment variables:
+
+![request example](./.github/assets/insomnia-edit-tag.png)
+
+The plugin will generate and add the headers:
+
+ - `X-Ovh-Timestamp`
+ - `X-Ovh-Signature`

.github/assets/insomnia-edit-tag.png

@@ -0,0 +1,16 @@
+{
+  "name": "insomnia-plugin-ovhcloud-signature",
+  "version": "1.0.0",
+  "license": "BSD-3-Clause",
+  "author": "Lantrix",
+  "main": "plugin.js",
+  "insomnia": {
+    "name": "ovhCloudSignature",
+    "displayName": "OVH Cloud Signature Generator",
+    "description": "Generates the X-Ovh-Signature for OVH Cloud API requests."
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {}
+}

README.md

@@ -0,0 +1,64 @@
+const crypto = require('crypto')
+const lodash = require('lodash')
+
+module.exports.templateTags = [
+  {
+    name: 'ovhsignature',
+    displayName: 'OVH Signature',
+    description: 'Sign OVH CLoud API requests',
+
+    args: [
+      {
+        displayName: 'Application Secret Key',
+        type: 'string',
+      },
+      {
+        displayName: 'Consumer Key',
+        type: 'string',
+      },
+    ],
+
+    async run(context, as, ck, headers) {
+
+      if (!as) throw new Error('missing Application Secret Key')
+      if (!ck) throw new Error('missing Consumer Key')
+
+    await Promise.all([
+        context.store.setItem("ovhcloud-as", as),
+        context.store.setItem("ovhcloud-ck", ck),
+      ])
+
+      return
+    },
+  },
+]
+
+function signOvhRequest(as, ck, httpMethod, url, body, timestamp) {
+    let signed = [ as, ck, httpMethod, url, '', timestamp ];
+    return '$1$' + crypto.createHash('sha1').update(signed.join('+')).digest('hex');
+}
+
+module.exports.requestHooks = [async (context) => {
+  console.log("Inserting X-Ovh-Signature into http headers")
+  const as = await context.store.getItem("ovhcloud-as")
+  console.log("as " + as)
+  const ck = await context.store.getItem("ovhcloud-ck")
+  console.log("ck " + ck)
+  const requestUrl = context.request.getUrl();
+  console.log("requestUrl " + requestUrl)
+  const body = context.request.getBody();
+  let requestBody;
+  if(lodash.isEmpty(body)) {
+   requestBody = ""
+  } else {
+    requestBody = body
+  }
+  console.log("requestBody " + requestBody);
+  const httpMethod = context.request.getMethod().toUpperCase();
+  console.log("httpMethod " + httpMethod)
+  const timestamp = Math.round(Date.now() / 1000)
+  context.request.setHeader("X-Ovh-Timestamp", timestamp);
+  const signature = signOvhRequest(as, ck, httpMethod, requestUrl, requestBody, timestamp)
+  context.request.setHeader("X-Ovh-Signature", signature);
+}]
+