JSON Binding of the Incident Object Description Exchange Format
RFC 8727

Document Type RFC - Proposed Standard (August 2020; No errata)
Last updated 2020-08-05
Replaces draft-takahashi-mile-jsoniodef
Stream IETF
Formats plain text html xml pdf htmlized bibtex
Reviews
Stream WG state Submitted to IESG for Publication
Document shepherd Nancy Cam-Winget
Shepherd write-up Show (last changed 2019-04-08)
IESG IESG state RFC 8727 (Proposed Standard)
Consensus Boilerplate Yes
Telechat date
Responsible AD Alexey Melnikov
Send notices to Nancy Cam-Winget <ncamwing@cisco.com>
IANA IANA review state Version Changed - Review Needed
IANA action state No IANA Actions


Internet Engineering Task Force (IETF)                      T. Takahashi
Request for Comments: 8727                                          NICT
Category: Standards Track                                     R. Danyliw
ISSN: 2070-1721                                                     CERT
                                                               M. Suzuki
                                                                    NICT
                                                             August 2020

    JSON Binding of the Incident Object Description Exchange Format

Abstract

   The Incident Object Description Exchange Format (IODEF) defined in
   RFC 7970 provides an information model and a corresponding XML data
   model for exchanging incident and indicator information.  This
   document gives implementers and operators an alternative format to
   exchange the same information by defining an alternative data model
   implementation in JSON and its encoding in Concise Binary Object
   Representation (CBOR).

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   https://www.rfc-editor.org/info/rfc8727.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction
     1.1.  Requirements Language
   2.  IODEF Data Types
     2.1.  Abstract Data Type to JSON Data Type Mapping
     2.2.  Complex JSON Types
       2.2.1.  Integer
       2.2.2.  Multilingual Strings
       2.2.3.  Enum
       2.2.4.  Software and Software Reference
       2.2.5.  Structured Information
       2.2.6.  EXTENSION
   3.  IODEF JSON Data Model
     3.1.  Classes and Elements
     3.2.  Mapping between JSON and XML IODEF
   4.  Examples
     4.1.  Minimal Example
     4.2.  Indicators from a Campaign
   5.  Mapkeys
   6.  The IODEF Data Model (CDDL)
   7.  IANA Considerations
   8.  Security Considerations
   9.  References
     9.1.  Normative References
     9.2.  Informative References
   Appendix A.  Data Types Used in This Document
   Appendix B.  The IODEF Data Model (JSON Schema)
   Acknowledgments
   Authors' Addresses

1.  Introduction

   The Incident Object Description Exchange Format (IODEF) [RFC7970]
   defines a data representation for security incident reports and
   indicators commonly exchanged by operational security teams.  It
   facilitates the automated exchange of this information to enable
   mitigation and watch-and-warning.  An information model using Unified
   Modeling Language (UML) is defined in Section 3 of [RFC7970] and a
   corresponding Extensible Markup Language (XML) schema data model is
   defined in Section 8 of [RFC7970].  This UML-based information model
   and XML-based data model are referred to as IODEF UML and IODEF XML,
   respectively, in this document.

   IODEF documents are structured and thus suitable for machine
   processing.  They will streamline incident response operations.
   Another well-used and structured format that is suitable for machine
   processing is JavaScript Object Notation (JSON) [RFC8259].  To
   facilitate the automation of incident response operations, IODEF
   documents and implementations should support JSON representation and
   its encoding in Concise Binary Object Representation (CBOR)
   [RFC7049].

   This document defines an alternate implementation of the IODEF UML
   information model by specifying a JSON data model using Concise Data
   Definition Language (CDDL) [RFC8610] and a JSON Schema [JSON-SCHEMA].
   This JSON data model is referred to as IODEF JSON in this document.
   IODEF JSON provides all of the expressivity of IODEF XML.  It gives
   implementers and operators an alternative format to exchange the same
   information.

   The normative IODEF JSON data model is found in Section 6.  Sections
   2 and 3 describe the data types and elements of this data model.
   Section 4 provides examples.
Show full document text