[Docs] [txt|pdf|xml|html] [Tracker] [Email] [Diff1] [Diff2] [Nits]

Versions: 00 01 02 03 draft-ietf-mile-rolie-csirt

MILE Working Group                                           S. Banghart
Internet-Draft                                                      NIST
Intended status: Informational                                  J. Field
Expires: September 6, 2018                                       Pivotal
                                                           March 5, 2018


                  Definition of ROLIE CSIRT Extension
                   draft-banghart-mile-rolie-csirt-03

Abstract

   This document extends the Resource-Oriented Lightweight Information
   Exchange (ROLIE) core to add the information type categories and
   related requirements needed to support Computer Security Incident
   Response Team (CSIRT) use cases.  The indicator and incident
   information types are defined as ROLIE extensions.  Additional
   supporting requirements are also defined that describe the use of
   specific formats and link relations pertaining to the new information
   types.

Status of This Memo

   This Internet-Draft is submitted to IETF in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on September 6, 2018.

Copyright Notice

   Copyright (c) 2018 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




Banghart & Field        Expires September 6, 2018               [Page 1]


Internet-Draft                 ROLIE CSIRT                    March 2018


   carefully, as they describe your rights and restrictions with respect
   to this document.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Additional Requirements for the Atom Publishing Protocol  . .   4
     3.1.  Use of HTTP requests  . . . . . . . . . . . . . . . . . .   4
       3.1.1.  / (forward slash) Resource URL  . . . . . . . . . . .   4
   4.  Additional Requirements for the Atom Syndication Format . . .   4
   5.  Information-type Extensions . . . . . . . . . . . . . . . . .   4
     5.1.  The "incident" information type . . . . . . . . . . . . .   4
     5.2.  The "indicator" information type  . . . . . . . . . . . .   5
     5.3.  Use of the rolie:format element . . . . . . . . . . . . .   5
       5.3.1.  IODEF Format  . . . . . . . . . . . . . . . . . . . .   6
       5.3.2.  STIX Format . . . . . . . . . . . . . . . . . . . . .   6
   6.  rolie:property Extensions . . . . . . . . . . . . . . . . . .   6
     6.1.  urn:ietf:params:rolie:property:csirt:ID . . . . . . . . .   6
   7.  Use of the atom:link element  . . . . . . . . . . . . . . . .   6
     7.1.  Link relations for the 'incident'
           information-type  . . . . . . . . . . . . . . . . . . . .   7
     7.2.  Link relations for the 'indicator'
           information-type  . . . . . . . . . . . . . . . . . . . .   7
     7.3.  Link relations for both information-types . . . . . . . .   8
   8.  Other Extensions  . . . . . . . . . . . . . . . . . . . . . .   8
     8.1.  Use of atom:category  . . . . . . . . . . . . . . . . . .   8
       8.1.1.  Newly registered category values  . . . . . . . . . .   8
       8.1.2.  Expectation and Impact Classes  . . . . . . . . . . .   9
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   9
     9.1.  information-type registrations  . . . . . . . . . . . . .   9
       9.1.1.  incident information-type . . . . . . . . . . . . . .   9
       9.1.2.  indicator information-type  . . . . . . . . . . . . .   9
     9.2.  atom:category scheme registrations  . . . . . . . . . . .  10
       9.2.1.  category:csirt:iodef:purpose  . . . . . . . . . . . .  10
       9.2.2.  category:csirt:iodef:restriction  . . . . . . . . . .  10
     9.3.  rolie:property name registrations . . . . . . . . . . . .  10
       9.3.1.  property:csirt:id . . . . . . . . . . . . . . . . . .  10
   10. Security Considerations . . . . . . . . . . . . . . . . . . .  11
   11. Normative References  . . . . . . . . . . . . . . . . . . . .  11
   Appendix A.  Non-Normative Examples . . . . . . . . . . . . . . .  12
     A.1.  Use of Link Relations . . . . . . . . . . . . . . . . . .  12
       A.1.1.  Use Case: Incident Sharing  . . . . . . . . . . . . .  13
       A.1.2.  Use Case: Collaborative Investigation . . . . . . . .  15
       A.1.3.  Use Case:  Cyber Data Repository  . . . . . . . . . .  17
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  20





Banghart & Field        Expires September 6, 2018               [Page 2]


Internet-Draft                 ROLIE CSIRT                    March 2018


1.  Introduction

   Threats to computer security are evolving ever more rapidly as time
   goes on.  As software increases in complexity, the number of
   vulnerabilities in systems and networks can increase exponentially.
   Threat actors looking to exploit these vulnerabilities are making
   more frequent and more widely distributed attacks across a large
   variety of systems.  The adoption of liberal information sharing
   amongst attackers allows a discovered vulnerability to be shared and
   used to attack a vulnerable system within a narrow window of time.
   As the skills and knowledge required to identify and combat these
   attacks become more and more specialized, even a well established and
   secure system may find itself unable to quickly respond to an
   incident.  Effective identification of and response to a
   sophisticated attack requires open cooperation and collaboration
   between defending operators, software vendors, and end-users.  To
   improve the timeliness of responses, automation must be used to
   acquire, contextualize, and put to use shared computer security
   information.

   CSIRTS share two primary forms of information: incidents and
   indicators.  Using these forms of information, analysts are able to
   perform a wide range of activities both proactive and reactive to
   ensure the security of their systems.

   Incident information describes a cyber security incident.  Such
   information may include attack characteristics, information about the
   attacker, and attack vector data.  Sharing this information helps
   analysts within the sharing community to inoculate their systems
   against similar attacks, providing proactive protection.

   Indicator information describes the symptoms or necessary pre-
   conditions of an attack.  Everything from system vulnerabilities to
   unexpected network traffic can help analysts secure systems and
   prepare for an attack.  Making this information available for sharing
   aids in the proactive defense of systems both within an operating
   unit but also for any CSIRTs that are part of a sharing consortium.

   As a means to bring automation of content discovery and dissemination
   into the CSIRT domain, this specification provides an extension to
   the Resource-Oriented Lightweight Information Exchange (ROLIE) core
   [RFC8322] designed to address CSIRT use cases.  The primary purpose
   of this extension is to define two new information types: incident,
   and indicator, along with formats and link relations that support
   these information-types.






Banghart & Field        Expires September 6, 2018               [Page 3]


Internet-Draft                 ROLIE CSIRT                    March 2018


2.  Terminology

   The key words "MUST," "MUST NOT," "REQUIRED," "SHALL," "SHALL NOT,"
   "SHOULD," "SHOULD NOT," "RECOMMENDED," "MAY," and "OPTIONAL" in this
   document are to be interpreted as described in [RFC2119].

   Definitions for some of the common computer security-related
   terminology used in this document can be found in Section 2 of
   [RFC5070].

3.  Additional Requirements for the Atom Publishing Protocol

   This document specifies the following additional requirements for use
   of the Atom Publishing Protocol.[RFC5023]

3.1.  Use of HTTP requests

   This document defines the following requirements on HTTP request
   behavior:

3.1.1.  / (forward slash) Resource URL

   The forward slash resource URL SHOULD be supported as defined in
   Section 5.5 [RFC8322].  Note that this is a stricter requirement than
   [RFC8322].

4.  Additional Requirements for the Atom Syndication Format

   This document does not specify any additional requirements for the
   Atom Syndication Format.  [RFC4287]

5.  Information-type Extensions

5.1.  The "incident" information type

   The "incident" information type represents any information describing
   or pertaining to a computer security incident.  This document uses
   the definition of incident provided by [RFC4949].  Provided below is
   a non-exhaustive list of information that may be considered to be an
   incident information type.

   o  Timing information: start and end times for the incident and/or
      the response.

   o  Descriptive information: plain text or machine readable data that
      provides some degree of description of the incident itself.





Banghart & Field        Expires September 6, 2018               [Page 4]


Internet-Draft                 ROLIE CSIRT                    March 2018


   o  Response information: the methods and results of a response to the
      incident.

   o  Meta and contact information: data about the CSIRT that recorded
      the information, or the operator that enacted the response.

   o  Effect and result information: data that describes the effects of
      an incident, or what the final results of the incident are.

   Note again that this list is not exhaustive, any information that in
   is the abstract realm of an incident should be classified under this
   information-type.

5.2.  The "indicator" information type

   The "indicator" information type represents computer security
   indicators or any information surrounding them.  This document uses
   the definition of indicator provided by [RFC4949].  Some examples of
   indicator information is provided below, but note that indicator is
   defined in an abstract sense, to be understood as a flexible and
   widely-applicable definition.

   o  Specific vulnerabilities that indicate a vector for attack.

   o  Signs of malicious reconnaissance.

   o  Definitions of patterns of other indicators.

   o  Events that may indicate an attack and information regarding those
      events.

   o  Meta information about the collecting agent.

   This list is intended to provide examples of the indicator
   information-type, not to define it.

5.3.  Use of the rolie:format element

   This document does not contain any additional requirements for the
   rolie:format element; the formats that follow are provided as
   examples of formats that describe the incident and indicator
   information type.  The formats are in no particular order, and are
   not requirements, nor suggestions by the authors.








Banghart & Field        Expires September 6, 2018               [Page 5]


Internet-Draft                 ROLIE CSIRT                    March 2018


5.3.1.  IODEF Format

   The Incident Object Description Exchange Format (IODEF) is a format
   for representing computer security information commonly exchanged
   between Computer Security Incident Response Teams (CSIRTs) or other
   operational security teams.

   IODEF conveys indicators, incident reports, response activities, and
   related meta-data in an XML serialization.  This information is
   formally structured in order to support and encourage automated
   machine-to-machine security communication, as well as enhanced
   processing at the endpoint.

   The full IODEF specification provides further high-level discussion
   and technical details.

5.3.2.  STIX Format

   STIX is a structured language for describing a wide range of security
   resources.  STIX approaches the problem with a focus on flexibility,
   automation, readability, and extensibility.

   The use of STIX as the content of an Entry does not impose any
   additional requirements on ROLIE implementations.

6.  rolie:property Extensions

   This document provides new registrations for valid rolie:property
   names.  These properties provide optional exposure point for valuable
   information in the linked content document.  Exposing this
   information in a rolie:property element means that clients do not
   need to download the linked document to determine if it contains the
   information they are looking for.

6.1.  urn:ietf:params:rolie:property:csirt:ID

   Provides an XML element that can be populated with an identifier from
   the indicator or incident document linked to by an atom:content
   element.  This value SHOULD be a uniquely identifying value for the
   document linked to in this entry's atom:content element.

7.  Use of the atom:link element

   These sections define requirements for atom:link elements in Entries.
   Note that the requirements are determined by the information type
   that appears in either the Entry or in the parent Feed.





Banghart & Field        Expires September 6, 2018               [Page 6]


Internet-Draft                 ROLIE CSIRT                    March 2018


7.1.  Link relations for the 'incident' information-type

   If the category of an Entry is the incident information type, then
   the following requirements MUST be followed for inclusion of
   atom:link elements.

   +------------+----------------------------------------+-------------+
   | Name       | Description                            | Conformance |
   +------------+----------------------------------------+-------------+
   | indicators | Provides a link to a collection of     | SHOULD      |
   |            | zero or more instances of cyber        |             |
   |            | security indicators that are           |             |
   |            | associated with the resource.          |             |
   | evidence   | Provides a link to a collection of     | SHOULD      |
   |            | zero or more resources that provides   |             |
   |            | some proof of attribution for an       |             |
   |            | incident. The evidence may or may not  |             |
   |            | have any identified chain of custody.  |             |
   | attacker   | Provides a link to a collection of     | SHOULD      |
   |            | zero or more resources that provides a |             |
   |            | representation of the attacker.        |             |
   | vector     | Provides a link to a collection of     | SHOULD      |
   |            | zero or more resources that provides a |             |
   |            | representation of the method used by   |             |
   |            | the attacker.                          |             |
   +------------+----------------------------------------+-------------+

    Table 1: Link Relations for Resource-Oriented Lightweight Indicator
                                 Exchange

7.2.  Link relations for the 'indicator' information-type

   If the category of an Entry is the indicator information type, then
   the following requirements MUST be followed for inclusion of
   atom:link elements.

   +-----------+-----------------------------------------+-------------+
   | Name      | Description                             | Conformance |
   +-----------+-----------------------------------------+-------------+
   | incidents | Provides a link to a collection of zero | SHOULD      |
   |           | or more instances of incident           |             |
   |           | representations associated with the     |             |
   |           | resource.                               |             |
   +-----------+-----------------------------------------+-------------+

    Table 2: Link Relations for Resource-Oriented Lightweight Indicator
                                 Exchange




Banghart & Field        Expires September 6, 2018               [Page 7]


Internet-Draft                 ROLIE CSIRT                    March 2018


7.3.  Link relations for both information-types

   If the category of an Entry is either information-type, the following
   requirements MUST be followed for inclusion of atom:link elements.

   +-----------------------+-----------------------------+-------------+
   | Name                  | Description                 | Conformance |
   +-----------------------+-----------------------------+-------------+
   | assessments           | Provides a link to a        | MAY         |
   |                       | collection of zero or more  |             |
   |                       | resources that represent    |             |
   |                       | the results of executing a  |             |
   |                       | benchmark.                  |             |
   | reports               | Provides a link to a        | MAY         |
   |                       | collection of zero or more  |             |
   |                       | resources that represent    |             |
   |                       | RID reports.                |             |
   | traceRequests         | Provides a link to a        | MAY         |
   |                       | collection of zero or more  |             |
   |                       | resources that represent    |             |
   |                       | RID traceRequests.          |             |
   | investigationRequests | Provides a link to a        | MAY         |
   |                       | collection of zero or more  |             |
   |                       | resources that represent    |             |
   |                       | RID investigationRequests.  |             |
   +-----------------------+-----------------------------+-------------+

    Table 3: Link Relations for Resource-Oriented Lightweight Indicator
                                 Exchange

8.  Other Extensions

   This document defines additional extensions as follows:

8.1.  Use of atom:category

8.1.1.  Newly registered category values

   This document registers two additional registered atom:category
   names: 'urn:ietf:params:rolie:category:csirt:iodef:purpose' and
   'urn:ietf:params:rolie:category:csirt:iodef:restriction'.  These
   categories IODEF content exposure provides valuable metadata for the
   searching and organization of IODEF documents.

   When the name attribute of the category is
   'urn:ietf:params:rolie:category:csirt:iodef:purpose', the value
   attribute SHOULD be constrained as per section 3.2 of IODEF
   [RFC7970], e.g. traceback, mitigation, reporting, or other.



Banghart & Field        Expires September 6, 2018               [Page 8]


Internet-Draft                 ROLIE CSIRT                    March 2018


   When the name attribute of the category is
   'urn:ietf:params:rolie:category:csirt:iodef:restriction', the value
   attribute SHOULD be constrained as per section 3.2 of IODEF
   [RFC7970], e.g. public, need-to-know, private, default.

8.1.2.  Expectation and Impact Classes

   It is frequently the case that an organization will need to triage
   their investigation and response activities based upon, e.g., the
   state of the current threat environment, or simply as a result of
   having limited resources.

   In order to enable operators to effectively prioritize their response
   activity, it is RECOMMENDED that feed implementers provide Atom
   categories that correspond to the IODEF Expectation and Impact
   classes.  The availability of these feed categories will enable
   clients to more easily retrieve and prioritize cyber security
   information that has already been identified as having a specific
   potential impact, or having a specific expectation.

   Support for these categories may also enable efficiencies for
   organizations that already have established (or plan to establish)
   operational processes and workflows that are based on these IODEF
   classes.

9.  IANA Considerations

9.1.  information-type registrations

   IANA has added the following entries to the "ROLIE Security Resource
   Information Type Sub-Registry" registry located at
   <https://www.iana.org/assignments/rolie/category/information-type> .

9.1.1.  incident information-type

   The entry is as follows:

      name: incident

      index: TBD

      reference: This document, Section 5.1

9.1.2.  indicator information-type

   The entry is as follows:

      name: indicator



Banghart & Field        Expires September 6, 2018               [Page 9]


Internet-Draft                 ROLIE CSIRT                    March 2018


      index: TBD

      reference: This document, Section 5.2

9.2.  atom:category scheme registrations

   IANA has added the following entries to the "ROLIE URN Parameters"
   registry located in <https://www.iana.org/assignments/rolie/>.

9.2.1.  category:csirt:iodef:purpose

   The entry is as follows:

      name: category:csirt:iodef:purpose

      Extension IRI: urn:ietf:params:rolie:category:csirt:iodef:purpose

      Reference: This document, Section 8.1.1

      Subregistry: None

9.2.2.  category:csirt:iodef:restriction

   The entry is as follows:

      name: category:csirt:iodef:restriction

      Extension IRI:
      urn:ietf:params:rolie:category:csirt:iodef:restriction

      Reference: This document, Section 8.1.1

      Subregistry: None

9.3.  rolie:property name registrations

   IANA has added the following entries to the "ROLIE URN Parameters"
   registry located in <https://www.iana.org/assignments/rolie/>.

9.3.1.  property:csirt:id

   The entry is as follows:

      name: property:csirt:id

      Extension IRI: urn:ietf:params:rolie:property:csirt:id

      Reference: This document, section 6.3.1



Banghart & Field        Expires September 6, 2018              [Page 10]


Internet-Draft                 ROLIE CSIRT                    March 2018


      Subregistry: None

10.  Security Considerations

   This document implies the use of ROLIE in high-security use cases, as
   such, added care should be taken to fortify and secure ROLIE
   repositories and clients using this extension.  The guidance in the
   ROLIE core specification is strongly recommended, and implementers
   should consider adding additional security measures as they see fit.

   When providing a private workspace for closed sharing, it is
   recommended that the ROLIE repository checks user authorization when
   the user sends a GET request to the service document.  If the user is
   not authorized to send any requests to a given workspace or
   collection, that workspace or collection should be truncated from the
   service document in the response.  In this way the existence of
   unauthorized content remains unknown to potential attackers,
   hopefully reducing attack surface.

11.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

   [RFC4287]  Nottingham, M., Ed. and R. Sayre, Ed., "The Atom
              Syndication Format", RFC 4287, DOI 10.17487/RFC4287,
              December 2005, <https://www.rfc-editor.org/info/rfc4287>.

   [RFC4949]  Shirey, R., "Internet Security Glossary, Version 2",
              FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007,
              <https://www.rfc-editor.org/info/rfc4949>.

   [RFC5023]  Gregorio, J., Ed. and B. de hOra, Ed., "The Atom
              Publishing Protocol", RFC 5023, DOI 10.17487/RFC5023,
              October 2007, <https://www.rfc-editor.org/info/rfc5023>.

   [RFC5070]  Danyliw, R., Meijer, J., and Y. Demchenko, "The Incident
              Object Description Exchange Format", RFC 5070,
              DOI 10.17487/RFC5070, December 2007,
              <https://www.rfc-editor.org/info/rfc5070>.

   [RFC7970]  Danyliw, R., "The Incident Object Description Exchange
              Format Version 2", RFC 7970, DOI 10.17487/RFC7970,
              November 2016, <https://www.rfc-editor.org/info/rfc7970>.





Banghart & Field        Expires September 6, 2018              [Page 11]


Internet-Draft                 ROLIE CSIRT                    March 2018


   [RFC8322]  Field, J., Banghart, S., and D. Waltermire, "Resource-
              Oriented Lightweight Information Exchange (ROLIE)",
              RFC 8322, DOI 10.17487/RFC8322, February 2018,
              <https://www.rfc-editor.org/info/rfc8322>.

Appendix A.  Non-Normative Examples

   The following provide examples of some potential use cases of the
   CSIRT ROLIE extension, and provides a showcase for some of its
   benefits over traditional solutions.

   The general non-normative examples provided in the core ROLIE
   document remain an excellent reference resource for typical ROLIE
   usage.

A.1.  Use of Link Relations

   A key benefit of using the RESTful architectural style is the ability
   to enable the client to navigate to related resources through the use
   of hypermedia links.  In the Atom Syndication Format, the type of the
   related resource identified in a <link> element is indicated via the
   "rel" attribute, where the value of this attribute identifies the
   kind of related resource available at the corresponding "href"
   attribute.  Thus, in lieu of a well-known URI template the URI itself
   is effectively opaque to the client, and therefore the client must
   understand the semantic meaning of the "rel" attribute in order to
   successfully navigate.  Broad interoperability may be based upon a
   sharing consortium defining a well-known set of Atom Link Relation
   types.  These Link Relation types may either be registered with IANA,
   or held in a private registry.

   Individual CSIRTs may always define their own link relation types in
   order to support specific use cases, however support for a core set
   of well-known link relation types is encouraged as this will maximize
   interoperability.

   In addition, it may be beneficial to define use case profiles that
   correspond to specific groupings of supported link relationship
   types.  In this way, a CSIRT may unambiguously specify the classes of
   use cases for which a client can expect to find support.

   The following sections provide non-normative examples of link
   relation usage.  Three distinct cyber security information sharing
   use case scenarios are described.  In each use case, the unique
   benefits of adopting a resource-oriented approach to information
   sharing are illustrated.  It is important to note that these use
   cases are intended to be a small representative set and is by no
   means meant to be an exhaustive list.  The intent is to illustrate



Banghart & Field        Expires September 6, 2018              [Page 12]


Internet-Draft                 ROLIE CSIRT                    March 2018


   how the use of link relationship types will enable this resource-
   oriented approach to cyber security information sharing to
   successfully support the complete range of existing use cases, and
   also to motivate an initial list of well-defined link relationship
   types.

A.1.1.  Use Case: Incident Sharing

   This section provides a non-normative example of an incident sharing
   use case.

   In this use case, a member CSIRT shares incident information with
   another member CSIRT in the same consortium.  The client CSIRT
   retrieves a feed of incidents, and is able to identify one particular
   entry of interest.  The client then does an HTTP GET on that entry,
   and the representation of that resource contains link relationships
   for both the associated "indicators" and the incident "history", and
   so on.  The client CSIRT recognizes that some of the indicator and
   history may be relevant within her local environment, and can respond
   proactively.

   Example HTTP GET response for an incident entry:





























Banghart & Field        Expires September 6, 2018              [Page 13]


Internet-Draft                 ROLIE CSIRT                    March 2018


<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"
  xmlns:rolie="urn:ietf:params:xml:ns:rolie-1.0">
  <id>http://www.example.org/csirt/private/incidents/123456</id>
  <title>Sample Incident</title>
  <link href="http://www.example.org/csirt/private/incidents/123456"
    rel="self"/>
  <link href="http://www.example.org/csirt/private/incidents/123456"
    rel="alternate"/>
  <published>2012-08-04T18:13:51.0Z</published>
  <updated>2012-08-05T18:13:51.0Z</updated>

  <link href="http://www.example.org/csirt/private/incidents/123456"
    rel="edit"/>

  <!-- The links to indicators related to this incident,
       and the history of this incident, and so on.... -->
  <link href="http://www.example.org/csirt/private/incidents/123456
    /relationships/indicators" rel="indicators"/>
  <link href="http://www.example.org/csirt/private/incidents/123456
    /relationships/history" rel="history"/>
  <link href="http://www.example.org/csirt/private/incidents/123456
    /relationships/campaign" rel="campaign"/>

  <!-- navigate up to the full collection.
       Might also be rel="collection" as per IANA registry -->
  <link href="http://www.example.org/csirt/private/incidents" rel="up"/>
  <rolie:format ns="urn:example:iodef"/>
  <content type="application/xml" src="example.org/123456/source">
  <!-- Content provided here as example, the content tag is only a
       link to this file. -->
    <iodef:IODEF-Document lang="en"
      xmlns:iodef="urn:ietf:params:xml:ns:iodef-1.0">
      <iodef:Incident purpose="traceback" restriction="need-to-know">
        <iodef:IncidentID name="http://www.example.org/csirt/private/
          incidents">123456</iodef:IncidentID>
        <!-- ...additional incident data.... -->
        </iodef:Incident>
    </iodef:IODEF-Document>

  </content>
</entry>

   As can be seen in the example response, the Atom <link> elements
   enable the client to navigate to the related indicator resources,
   and/or the history entries associated with this incident.





Banghart & Field        Expires September 6, 2018              [Page 14]


Internet-Draft                 ROLIE CSIRT                    March 2018


A.1.2.  Use Case: Collaborative Investigation

   This section provides a non-normative example of a collaborative
   investigation use case.

   In this use case, two member CSIRTs that belong to a closed sharing
   consortium are collaborating on an incident investigation.  The
   initiating CSIRT performs an HTTP GET to retrieve the service
   document of the peer CSIRT, and determines the collection name to be
   used for creating a new investigation request.  The initiating CSIRT
   then POSTs a new incident entry to the appropriate collection URL.
   The target CSIRT acknowledges the request by responding with an HTTP
   status code 201 Created.

   Example HTTP GET response for the service document:

HTTP/1.1 200 OK
Date: Fri, 24 Aug 2012 17:09:11 GMT
Content-Length: 934
Content-Type: application/atomsvc+xml;charset="utf-8"

<?xml version="1.0" encoding="UTF-8"?>
<service xmlns="http://www.w3.org/2007/app"
         xmlns:atom="http://www.w3.org/2005/Atom">
    <workspace xml:lang="en-US"
      xmlns:xml="http://www.w3.org/XML/1998/namespace">
      <atom:title type="text">RID Use Case Requests</atom:title>
      <collection
        href="http://www.example.org/csirt/RID/InvestigationRequests">
         <atom:title type="text">Investigation Requests</atom:title>
         <accept>application/atom+xml; type=entry</accept>
      </collection>
      <collection href="http://www.example.org/csirt/RID/TraceRequests">
         <atom:title type="text">Trace Requests</atom:title>
         <accept>application/atom+xml; type=entry</accept>
      </collection>
      <!-- ...and so on.... -->
    </workspace>
</service>

   As can be seen in the example response, the Atom <collection>
   elements enable the client to determine the appropriate collection
   URL to request an investigation or a trace.

   The client CSIRT then POSTs a new entry to the appropriate feed
   collection.  Note that the <content> element of the new entry may
   contain a RID message of type "InvestigationRequest" if desired,
   however this would NOT be required.  The entry content itself need



Banghart & Field        Expires September 6, 2018              [Page 15]


Internet-Draft                 ROLIE CSIRT                    March 2018


   only be an IODEF document, with the choice of the target collection
   resource URL indicating the callers intent.  A CSIRT would be free to
   use any URI template to accept investigationRequests.

   POST /csirt/RID/InvestigationRequests HTTP/1.1
   Host: www.example.org
   Content-Type: application/atom+xml;type=entry
   Content-Length: 852

   <?xml version="1.0" encoding="UTF-8"?>
   <entry xmlns="http://www.w3.org/2005/Atom"
     xmlns:rolie="urn:ietf:params:xml:ns:rolie-1.0">
     <title>New Investigation Request</title>
     <id>http://www.example2.org/csirt/private/incidents/123456</id>
     <!-- id and updated not guranteed to be preserved -->
     <!-- may want to profile that behavior in this document -->
     <updated>2012-08-12T11:08:22Z</updated>
     <author><name>Name of peer CSIRT</name></author>
     <rolie:format ns="urn:example:iodef"/>
     <content type="application/xml">
       <iodef:IODEF-Document lang="en"
         xmlns:iodef="urn:ietf:params:xml:ns:iodef-1.0">
         <iodef:Incident purpose="traceback" restriction="need-to-know">
         <iodef:IncidentID name="http://www.example2.org/csirt/
           private/incidents">123</iodef:IncidentID>
           <!-- ...additional incident data.... -->
         </iodef:Incident>
       </iodef:IODEF-Document>
     </content>
   </entry>

   The receiving CSIRT acknowledges the request with HTTP return code
   201 Created.


















Banghart & Field        Expires September 6, 2018              [Page 16]


Internet-Draft                 ROLIE CSIRT                    March 2018


   HTTP/1.1 201 Created
   Date: Fri, 24 Aug 2012 19:17:11 GMT
   Content-Length: 906
   Content-Type: application/atom+xml;type=entry
   Location: http://www.example.org/csirt/RID/InvestigationRequests/823
   ETag: "8a9h9he4qphqh"

   <?xml version="1.0" encoding="UTF-8"?>
   <entry xmlns="http://www.w3.org/2005/Atom"
     xmlns:rolie="urn:ietf:params:xml:ns:rolie-1.0">
     <title>New Investigation Request</title>
     <id>http://www.example.org/csirt/RID/InvestigationRequests/823</id>
     <!-- id and updated not guranteed to be preserved -->
     <!-- may want to profile that behavior in this document -->
     <updated>2012-08-12T11:08:30Z</updated>
     <published>2012-08-12T11:08:30Z</published>
     <author><name>Name of peer CSIRT</name></author>
     <rolie:format ns="urn:example:iodef"/>
     <content type="application/xml">
       <iodef:IODEF-Document lang="en"
         xmlns:iodef="urn:ietf:params:xml:ns:iodef-1.0">
         <iodef:Incident purpose="traceback" restriction="need-to-know">
         <iodef:IncidentID name="http://www.example.org/csirt/private
           /incidents">123</iodef:IncidentID>
           <!-- ...additional incident data.... -->
         </iodef:Incident>
       </iodef:IODEF-Document>
     </content>
   </entry>

   Consistent with HTTP/1.1 RFC, the location header indicates the URL
   of the newly created InvestigationRequest.  If for some reason the
   request were not authorized, the client would receive an HTTP status
   code 403 Unauthorized.  In this case the HTTP response body may
   contain additional details, if an as appropriate.

A.1.3.  Use Case: Cyber Data Repository

   This section provides a non-normative example of a cyber security
   data repository use case.

   In this use case a client accesses a persistent repository of cyber
   security data via a RESTful usage model.  Retrieving a feed
   collection is analogous to an SQL SELECT statement producing a result
   set.  Retrieving an individual Atom Entry is analogous to a SQL
   SELECT statement based upon a primary key producing a unique record.
   The cyber security data contained in the repository may include
   different data types, including indicators, incidents, benchmarks, or



Banghart & Field        Expires September 6, 2018              [Page 17]


Internet-Draft                 ROLIE CSIRT                    March 2018


   any other related resources.  In this use case, the repository is
   queried via HTTP GET, and the results that are returned to the client
   may optionally contain URL references to other cyber security
   resources that are known to be related.  These related resources may
   also be persisted locally, or they may exist at another (remote)
   cyber data respository.

   Example HTTP GET request to a persistent repository for any resources
   representing Distributed Denial of Service (DDOS) attacks:

   GET /csirt/repository/ddos
   Host: www.example.org
   Accept: application/atom+xml

   The corresponding HTTP response would be an XML document containing
   the DDOS feed.

   Example HTTP GET response for a DDOS feed:


HTTP/1.1 200 OK
Date: Fri, 24 Aug 2012 17:20:11 GMT
Content-Length: nnnn
Content-Type: application/atom+xml;type=feed;charset="utf-8"

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
    xmlns:rolie="urn:ietf:params:xml:ns:rolie-1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.w3.org/2005/Atom
                        file:/C:/schemas/atom.xsd
                        urn:ietf:params:xml:ns:iodef-1.0
                        file:/C:/schemas/iodef-1.0.xsd"
    xml:lang="en-US">

    <generator version="1.0" xml:lang="en-US">
      emc-csirt-iodef-feed-service</generator>
    <id>http://www.example.org/csirt/repository/ddos</id>
    <title type="text" xml:lang="en-US">
      Atom formatted representation of a feed of known ddos resources.
      </title>
    <updated xml:lang="en-US">2012-05-04T18:13:51.0Z</updated>
    <author>
        <email>csirt@example.org</email>
        <name>EMC CSIRT</name>
    </author>

    <!-- By convention there is usually a self link for the feed -->



Banghart & Field        Expires September 6, 2018              [Page 18]


Internet-Draft                 ROLIE CSIRT                    March 2018


    <link href="http://www.example.org/csirt/repository/ddos"
      rel="self"/>

    <entry>
        <id>http://www.example.org/csirt/repository/ddos/123456</id>
        <title>Sample DDOS Incident</title>
        <link href="http://www.example.org/csirt/repository/ddos/123456"
          rel="self"/>          <!-- by convention -->
        <link href="http://www.example.org/csirt/repository/ddos/123456"
          rel="alternate"/>     <!-- required by Atom spec -->
        <link href="http://www.example.org/csirt/repository/ddos/987654"
          rel="related"/>       <!-- link to a related DDOS resource
          in this repository -->
        <link href="http://www.cyber-agency.gov/repository/
          indicators/1a2b3c" rel="related"/>
          <!-- link to a related DDOS resource in another repository -->
        <published>2012-08-04T18:13:51.0Z</published>
        <updated>2012-08-05T18:13:51.0Z</updated>
        <!-- The category is based upon IODEF
                    purpose and restriction attributes -->
        <category term="traceback" scheme="purpose" label="trace back"/>
        <category term="need-to-know" scheme="restriction"
          label="need to know" />
        <category term="ddos" scheme="ttp"
          label="tactics, techniques, and procedures"/>
        <summary>A short description of this DDOS attack, extracted
        from the IODEF Incident class, <description> element. </summary>
        <rolie:format ns="urn:example:iodef"/>
        <content href="http://www.example.org/ddos/123456/data"/>
    </entry>

    <entry>
        <!-- ...another entry... -->
    </entry>

</feed>

   This feed document has two atom entries, one of which has been
   elided.  The completed entry illustrates an Atom <entry> element that
   provides a summary of essential details about one particular DDOS
   incident.  Based upon this summary information and the provided
   category information, a client may choose to do an HTTP GET operation
   to retrieve the full details of the DDOS incident.  This example
   shows how a persistent repository may provide links to additional
   resources, both local and remote.

   Note that the provider of a persistent repostory is not obligated to
   follow any particular URL template scheme.  The repository available



Banghart & Field        Expires September 6, 2018              [Page 19]


Internet-Draft                 ROLIE CSIRT                    March 2018


   at the hypothetical provider "www.example.com" uses a different URL
   pattern than the hypothetical repository available at "www.cyber-
   agency.gov".  When a client de-references a link to resource that is
   located in a remote repository the client may be challenged for
   authentication credentials acceptable to that provider.  If the two
   repository providers choose to support a federated identity scheme or
   some other form of single-sign-on technology, then the user
   experience can be improved for interactive clients (e.g., a human
   user at a browser).  However, this is not required and is an
   implementation choice that is out of scope for this specification.

Authors' Addresses

   Stephen A. Banghart
   National Institute of Standards and Technology
   100 Bureau Drive
   Gaithersburg, Maryland
   USA

   Phone: (301)975-4288
   Email: sab3@nist.gov


   John P. Field
   Pivotal Software, Inc.
   625 Avenue of the Americas
   New York, New York
   USA

   Phone: (646)792-5770
   Email: jfield@pivotal.io




















Banghart & Field        Expires September 6, 2018              [Page 20]


Html markup produced by rfcmarkup 1.127, available from https://tools.ietf.org/tools/rfcmarkup/