Skip to main content
POST
/
v1
/
evidence
/
firmware
Analyze firmware binary for security
curl --request POST \
  --url https://api.usenabla.com/v1/evidence/firmware \
  --header 'Content-Type: application/json' \
  --header 'X-Customer-Key: <api-key>' \
  --data '
{
  "name": "iot-device-firmware",
  "content_base64": "f0VMRgIBAQAAAAAAAAAAAA==",
  "file_name": "firmware-v2.6.11.bin"
}
'
import requests

url = "https://api.usenabla.com/v1/evidence/firmware"

payload = {
"name": "iot-device-firmware",
"content_base64": "f0VMRgIBAQAAAAAAAAAAAA==",
"file_name": "firmware-v2.6.11.bin"
}
headers = {
"X-Customer-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Customer-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'iot-device-firmware',
content_base64: 'f0VMRgIBAQAAAAAAAAAAAA==',
file_name: 'firmware-v2.6.11.bin'
})
};

fetch('https://api.usenabla.com/v1/evidence/firmware', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usenabla.com/v1/evidence/firmware",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'iot-device-firmware',
'content_base64' => 'f0VMRgIBAQAAAAAAAAAAAA==',
'file_name' => 'firmware-v2.6.11.bin'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Customer-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.usenabla.com/v1/evidence/firmware"

payload := strings.NewReader("{\n \"name\": \"iot-device-firmware\",\n \"content_base64\": \"f0VMRgIBAQAAAAAAAAAAAA==\",\n \"file_name\": \"firmware-v2.6.11.bin\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Customer-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.usenabla.com/v1/evidence/firmware")
.header("X-Customer-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"iot-device-firmware\",\n \"content_base64\": \"f0VMRgIBAQAAAAAAAAAAAA==\",\n \"file_name\": \"firmware-v2.6.11.bin\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.usenabla.com/v1/evidence/firmware")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Customer-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"iot-device-firmware\",\n \"content_base64\": \"f0VMRgIBAQAAAAAAAAAAAA==\",\n \"file_name\": \"firmware-v2.6.11.bin\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "strings": [
    "<string>"
  ],
  "security_features": [],
  "findings": [
    "MED: NX/DEP bit not enabled",
    "LOW: Stack canaries not detected"
  ],
  "architecture": "x86_64",
  "entry_point": "0x401000",
  "cfg_mermaid": "<string>",
  "mappings": [
    {
      "framework": "nist_800_53",
      "control": "SI-16",
      "rationale": "Binary hardening feature 'nx' contributes to memory protection"
    }
  ],
  "pfr_assessment": {},
  "artifacts": [
    {
      "filename": "nist80053-assessment.json",
      "content_type": "application/json",
      "content_base64": "<string>",
      "size_bytes": 123,
      "diagram": "<string>"
    }
  ]
}
{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>"
}
{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>"
}

Authorizations

X-Customer-Key
string
header
required

Customer API key for authentication

Body

name
string
required

Name for the firmware analysis

Example:

"iot-device-firmware"

content_base64
string
required

Base64-encoded firmware binary

Example:

"f0VMRgIBAQAAAAAAAAAAAA=="

file_name
string

Original filename (optional)

Example:

"firmware-v2.6.11.bin"

Response

Firmware analysis completed

id
string<uuid>
required
name
string
required

Firmware name

detected_format
enum<string>
required

Detected binary format

Available options:
elf,
pe,
mach_o,
wasm,
raw
strings
string[]
required

Extracted ASCII strings (max 200)

security_features
enum<string>[]
required

Detected security features

Available options:
nx,
aslr,
stack_canary,
cfi,
fortify,
pie,
relro,
signed
findings
string[]
required

Security findings with severity (CRITICAL, HIGH, MED, LOW, INFO)

Example:
[
"MED: NX/DEP bit not enabled",
"LOW: Stack canaries not detected"
]
architecture
string

CPU architecture

Example:

"x86_64"

entry_point
string

Entry point address

Example:

"0x401000"

cfg_mermaid
string

Control Flow Graph in Mermaid format (if available)

mappings
object[]

Mappings to compliance frameworks

pfr_assessment
object

NIST SP 800-193 Platform Firmware Resilience assessment

artifacts
object[]