> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usenabla.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Analyze firmware binary for security

> Perform security analysis on firmware/binary files. Detects format, identifies security features (NX, ASLR, stack canaries, CFI), extracts strings, generates control flow graphs, and maps findings to NIST SP 800-193.



## OpenAPI

````yaml api-reference/openapi.json post /v1/evidence/firmware
openapi: 3.1.0
info:
  title: Nabla Evidence Engine API
  version: 1.0.0
  description: >-
    Compliance evidence orchestration and security analysis API. Analyze
    firmware binaries, infrastructure-as-code, and cloud configurations for
    FedRAMP, CMMC, FIPS, and other compliance frameworks.
  contact:
    name: Nabla
    url: https://www.usenabla.com
servers:
  - url: https://api.usenabla.com
    description: Production
  - url: https://api.gov.usenabla.com
    description: GovCloud
  - url: http://localhost:8080
    description: Local Development
security:
  - CustomerKey: []
tags:
  - name: Evidence
    description: Compliance evidence generation and analysis
  - name: Firmware
    description: Binary firmware security analysis
  - name: FIPS
    description: FIPS 140-2/140-3 cryptographic compliance
paths:
  /v1/evidence/firmware:
    post:
      tags:
        - Firmware
      summary: Analyze firmware binary for security
      description: >-
        Perform security analysis on firmware/binary files. Detects format,
        identifies security features (NX, ASLR, stack canaries, CFI), extracts
        strings, generates control flow graphs, and maps findings to NIST SP
        800-193.
      operationId: analyzeFirmwareBinary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - content_base64
              properties:
                name:
                  type: string
                  description: Name for the firmware analysis
                  example: iot-device-firmware
                file_name:
                  type: string
                  description: Original filename (optional)
                  example: firmware-v2.6.11.bin
                content_base64:
                  type: string
                  description: Base64-encoded firmware binary
                  example: f0VMRgIBAQAAAAAAAAAAAA==
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name for the firmware analysis
                file:
                  type: string
                  format: binary
                  description: Firmware binary file
      responses:
        '200':
          description: Firmware analysis completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmwareResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - CustomerKey: []
components:
  schemas:
    FirmwareResponse:
      type: object
      required:
        - id
        - name
        - detected_format
        - strings
        - security_features
        - findings
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Firmware name
        detected_format:
          type: string
          enum:
            - elf
            - pe
            - mach_o
            - wasm
            - raw
          description: Detected binary format
        architecture:
          type: string
          description: CPU architecture
          example: x86_64
        entry_point:
          type: string
          description: Entry point address
          example: '0x401000'
        strings:
          type: array
          items:
            type: string
          description: Extracted ASCII strings (max 200)
        security_features:
          type: array
          items:
            type: string
            enum:
              - nx
              - aslr
              - stack_canary
              - cfi
              - fortify
              - pie
              - relro
              - signed
          description: Detected security features
        findings:
          type: array
          items:
            type: string
          description: Security findings with severity (CRITICAL, HIGH, MED, LOW, INFO)
          example:
            - 'MED: NX/DEP bit not enabled'
            - 'LOW: Stack canaries not detected'
        cfg_mermaid:
          type: string
          description: Control Flow Graph in Mermaid format (if available)
        mappings:
          type: array
          items:
            $ref: '#/components/schemas/MappingHit'
          description: Mappings to compliance frameworks
        pfr_assessment:
          type: object
          description: NIST SP 800-193 Platform Firmware Resilience assessment
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/Artifact'
    MappingHit:
      type: object
      required:
        - framework
        - control
        - rationale
      properties:
        framework:
          type: string
          example: nist_800_53
        control:
          type: string
          example: SI-16
        rationale:
          type: string
          example: Binary hardening feature 'nx' contributes to memory protection
    Artifact:
      type: object
      required:
        - filename
        - content_type
        - content_base64
        - size_bytes
      properties:
        filename:
          type: string
          description: Artifact filename
          example: nist80053-assessment.json
        content_type:
          type: string
          description: MIME type
          example: application/json
        content_base64:
          type: string
          description: Base64-encoded artifact content
        size_bytes:
          type: integer
          description: Size in bytes
        diagram:
          type: string
          description: Mermaid diagram content (if applicable)
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Error message
        code:
          type: string
          description: HTTP status code
        requestId:
          type: string
          description: Request identifier for debugging
  responses:
    BadRequest:
      description: Bad request - invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    CustomerKey:
      type: apiKey
      in: header
      name: X-Customer-Key
      description: Customer API key for authentication

````