Chief Information Officer
IC Technical Specifications
CDR: Search
Overview
This IC/DoD enterprise encoding specification defines requirements and provides guidelines for the realization of the Content Discovery and Retrieval (CDR) Search component as both a RESTful, OpenSearch [OS] web service and using the SOAP binding, hereafter termed a Search Service. This component provides a common interface and behavioral model for IC and DoD content collections, enabling content consumers to discover relevant content resources from disparate collections across the IC/DoD Enterprise. The content of this specification describes the Search Service’s behavior, interface and other aspects in detail, providing enough information for Search Service providers and consumers to create and use CDR-conformant Search services.
The Search service exposes a single Search operation that is responsible for three activities that underpin Content Discovery capabilities: search, result presentation, and results paging. A Search service’s results are resource metadata rather than actual content resources. In the context of Search, resource metadata generally refers to a subset of a resource’s available metadata, not the entire underlying record. Results normally contain information needed for a consumer to retrieve or otherwise use the referenced resource.
Technical Specification Downloads
Latest Approved Public Release:
- IC/DoD REST Interface Encoding Specification for CDR Search (V3 - Standalone Package (Release Date: 03 Oct 2012))
- IC/DoD SOAP Interface Encoding Specification for CDR Search (V3 - Standalone Package (Release Date: 03 Oct 2012))
Value Proposition
This specification supports Intelligence Community Directive 501(ICD 501), Discovery, Dissemination or Retrieval of Information within the Intelligence Community, which establishes policies for (1) discovery, and (2) dissemination or retrieval of intelligence and intelligence-related information collected, or analysis produced by the Intelligence Community.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package. This specification is maintained by the IC Chief Information Officer via the Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
This specification is designed to fulfill a number of requirements in support of the transformational efforts of the Intelligence Community and Department of Defense Enterprise(IC/DoD). Features of this specification are to:
- Searching through content and metadata in multiple formats as specified by the consumer, such as image files and textual documents.
- Searching through information content that is static, dynamic, structured and unstructured.
- Enable searching through and appropriately processing of information content and metadata at different classification levels, and with different handling caveats; information which could be located on different security domains.
- Searching through natural language content (probably in many different languages) or highly formatted content such as geospatial or temporal content. (Data sources can be active [current, dynamically changing] or historic [static], each containing different data types).
Chief Information Officer
IC Technical Specifications
CDR: Query Management
Overview
This IC/DoD enterprise encoding specification defines requirements and provides guidelines for the realization of the Content Discovery and Retrieval (CDR) Query Management component as a web service using both a RESTful, OpenSearch [OS] and SOAP style binding, hereafter termed the Query Management (QM) Service, as a web service using the SOAP style binding. The Query Management (QM) Component, as defined by the “IC/DoD Content Discovery and Retrieval (CDR) Specification Framework” , is a CDR Component that manages Saved Searches and may initiate search requests based on Saved Searches. It describes the external service interfaces and the internal activities that provide service behaviors so that service providers and consumers can create and use CDR-compliant Query Management Services.
This specification supports Intelligence Community Directive 501(ICD 501), Discovery, Dissemination or Retrieval of Information within the Intelligence Community, which establishes policies for (1) discovery, and (2) dissemination or retrieval of intelligence and intelligence-related information collected, or analysis produced by the Intelligence Community.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package. This specification is maintained by the IC Chief Information Officer via the Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
Technical Specification Downloads
Latest Approved Public Release:
Value Proposition
This specification is designed to fulfill a number of requirements in support of the transformational efforts of the Intelligence Community and Department of Defense Enterprise(IC/DoD). The six functions listed below provide QM service consumers with a coordinated set of capabilities that support managing and using both searches and search related information. This specification mandates the generic interfaces that a QM consumer would utilize to manage and use a Saved Search:
- Create –The Create function is used to insert a new Saved Search into the QM Collection.
- Read – The Read function is used to retrieve a Saved Search from the QM Collection.
- Update – The Update function is used to change a Saved Search in the QM Collection.
- Delete – The Delete function is used to logically remove a Saved Search from the QM Collection.
- Execute – The Execute function enables a QM consumer to execute (run) a Saved Search at the location specified by the Target Search Capability. To process an execute request, the Query Management Service retrieves the Target Search Capability (the location of the Search Service) and the Search Request from the Saved Search. This information is then used to initiate the Search. This capability SHOULD leverage the CDR Search approach to effect the execution of a Saved Search.
- Search – The Search function enables a prospective consumer to interrogate the QM Collection on the basis of anything to be found in the Saved Search Bundle or the Saved Search Description to determine if a suitable search has already been created. Generic search terms can be used to provide functionality that provides a ‘list’ of the contents of the QM Collection. This capability SHOULD leverage the CDR Search discovery approach.
Chief Information Officer
IC Technical Specifications
CDR: Deliver
Overview
This IC/DoD enterprise encoding specification defines requirements and provides guidelines for the realization of the Content Discovery and Retrieval (CDR) Deliver Component as a web service using both the SOAP messaging protocol and REST style binding, hereafter termed a Deliver service. This component provides a common interface and behavioral model for IC and DoD content collections, enabling content consumers to deliver relevant content resources from disparate collections across the IC/DoD Enterprise. The content of this specification describes a Deliver service’s interface and other aspects in detail, providing enough information for Deliver service providers and implementers to create CDR-compliant Deliver services.
The REST Deliver Service, as defined by the Intelligence Community/Department of Defense (IC/DoD) CDR Specification Framework, serves as a “push” mechanism to send information resources. The Deliver Service relies on mechanisms that are already well established in the internet infrastructure:
- HTTP Handling Method (Post):
- HTML: http://en.wikipedia.org/wiki/HTML and
- HTTP/HTTPS: http://www.w3.org/Protocols/
- HTTP Status Codes (maintained by Internet Assigned Numbers Authority – IANA): Hypertext Transfer Protocol (HTTP) Status Code Registry – http://www.iana.org/assignments/http-status-code
- MIME Types (maintained by IANA): MIME types http://www.ietf.org/rfc/rfc2045.txt
The SOAP Deliver Service exposes a Deliver function. While the function is often used in concert with delivering the results of a Content Discovery search, it may be used in general to process any compliant Deliver instructions. The Deliver function can be used in a few different patterns:
- Deliver content provided by the entity invoking the service to a default or specified recipient(s)
- Deliver content obtained as the result of a previous query to default or specified recipient(s)
- Deliver based upon additionally specified criteria (e.g. time, event)
The Deliver Service facilitates the transfer of a content resource to a specified destination. In its simplest form, the Deliver Service will take a consumer-supplied payload and send it to another consumer as specified by the delivery destination and properties. The Deliver Service may include additional (interim) processing, including but not limited to compression, encryption, or conversion.
This specification supports Intelligence Community Directive 501(ICD 501), Discovery, Dissemination or Retrieval of Information within the Intelligence Community, which establishes policies for (1) discovery, and (2) dissemination or retrieval of intelligence and intelligence-related information collected, or analysis produced by the Intelligence Community.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package. This specification is maintained by the IC Chief Information Officer via the Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
Technical Specification Downloads
Latest Approved Public Release:
Value Proposition
This specification is designed to fulfill a number of requirements in support of the transformational efforts of the Intelligence Community and Department of Defense Enterprise(IC/DoD). Features of this specification are to:
- Enable a content resource to be delivered to a specified location which may or may not be the requesting component.
- Provide additional processing of the content to make it suitable for delivery to its destination and delivery path to be used.
- On behalf of the consumer, retrieve the requested content and then deliver to the specified location.
Chief Information Officer
IC Technical Specifications
WSS XML Signature & XML Encryption
Overview
This IC information guidance document provides guidance to solutions architects, integrators, and developers on how to minimize the risks and vulnerabilities with the use of XML Signature and XML Encryption.
This high level guidance is intended to provide an understanding of risks associated with the vulnerabilities of using XML Signature and XML Encryption. This document does not provide low-level details needed for implementation, but points to lower-level specifications and standards for the necessary details and should be sufficient to act as a consistent basis upon which solutions architects, integrators, and developers can design and implement specific security solutions.
This standard supports Executive Order (EO) 13526, Classified National Security Information which "prescribes a uniform system for classifying, safeguarding, and declassifying national security information," across national security disciplines, networks, services, and data.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package.
This specification is maintained by the IC Chief Information Officer via the Data Services Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Technical Specification Downloads
Latest Approved Public Release:
Mission Requirements
This informational guidance document applies to solutions using World Wide Web Consortium (W3C) XML Signature and XML Encryption for XML message in transit through HTTP-based web service (SOAP and REST). The W3C XML Security Working Group develops updates to the core XML Security specifications, which include the W3C recommendations for XML Encryption, XML Signature and XML Signature Properties. The group publishes working group notes that provide best practice guides, use cases, requirements, and test cases for the specifications.
Chief Information Officer
IC Technical Specifications
CDR: Atom Results Set
Overview
The Content Discovery & Retrieval (CDR) framework enables the use of results sets in service responses. As various service specifications leverage the Atom 1.0 feed syndications format, guidelines must be created to ensure consistent usage across CDR Search REST and SOAP specifications. In addition to the general guidelines for the use of Atom as described at http://www.atomenabled.org and in Atom 1.0 specification itself, this document extends the base specification to support information requirements in the CDR Search component. The guidance provided in this document focuses largely on the use of Atom 1.0 feed syndication format itself and the general format of commonly used extensions.
This specification supports Intelligence Community Directive 501 (ICD 501), Discovery, Dissemination or Retrieval of Information within the Intelligence Community, which establishes policies for (1) discovery, and (2) dissemination or retrieval of intelligence and intelligence-related information collected, or analysis produced by the Intelligence Community.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package. This specification is maintained by the IC Chief Information Officer via the Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
Technical Specification Downloads
Latest Approved Public Release:
- Atom Data Encoding Specification for Content Discovery and Retrieval Result Sets (V2 - Standalone Package (Release Date: 10 Apr 2013))
- Atom Data Encoding Specification for Content Discovery and Retrieval Result Sets (V2 - Light Package (Release Date: 10 Apr 2013))
Value Proposition
This specification is designed to fulfill a number of requirements in support of the transformational efforts of the Intelligence Community and Department of Defense Enterprise(IC/DoD). Features of this specification are to:
- To provide guidance on leveraging Atom 1.0 as a result set for both the CDR REST and SOAP Search specifications
- Support the implementation of both the IC/DoD Content Discovery & Retrieval SOAP [CDR-SS] and REST [CDR-RS] Interface Specifications for CDR Search.