Skip to content

Commit

Permalink
Update README.md to reflect repo name change
Browse files Browse the repository at this point in the history
  • Loading branch information
anweiss authored and Andrew Weiss committed Apr 14, 2017
1 parent b99eb45 commit 441e22b
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Docker Datacenter Compliance Controls [![CircleCI](https://circleci.com/gh/docker/ddc-opencontrol/tree/master.svg?style=svg&circle-token=daeaf5acd7ac08000ea727cbf8ec9baa8ded8da4)](https://circleci.com/gh/docker/ddc-opencontrol/tree/master) [![codecov](https://codecov.io/gh/docker/ddc-opencontrol/branch/master/graph/badge.svg?token=WiRPQcno3c)](https://codecov.io/gh/docker/ddc-opencontrol)
# Docker Datacenter Compliance Controls [![CircleCI](https://circleci.com/gh/docker/compliance/tree/master.svg?style=svg&circle-token=daeaf5acd7ac08000ea727cbf8ec9baa8ded8da4)](https://circleci.com/gh/docker/compliance/tree/master) [![codecov](https://codecov.io/gh/docker/compliance/branch/master/graph/badge.svg?token=WiRPQcno3c)](https://codecov.io/gh/docker/compliance)

**<em>Updates to this content reflecting Docker Enterprise Edition and FedRAMP High are currently being developed in the [fedramp-high](https://github.com/docker/ddc-opencontrol/tree/fedramp-high) branch</em>**
**<em>Updates to this content reflecting Docker Enterprise Edition and FedRAMP High are currently being developed in the [fedramp-high](https://github.com/docker/compliance/tree/fedramp-high) branch</em>**

Contained within this repository is compliance information for Docker Datacenter as it pertains to NIST-800-53 Rev 4 security controls and the FedRAMP Moderate baseline. This data adheres to the [OpenControl](http://open-control.org/) schema for building compliance documentation and can be used as part of your own ATO review process. The documentation generated from this content can be used to ATO Docker Datacenter in both on-premises/private cloud infrastructure and in public cloud providers.

Expand All @@ -19,10 +19,10 @@ The control guidance for Docker Datacenter is separated in to the following comp

|Component Name|Folder|Version|
|--------------|------|-------|
|Commercially Supported (CS) Docker Engine|[`CSEngine/`](https://github.com/docker/ddc-opencontrol/tree/master/CSEngine)|1.12.3-cs4|
|Docker Trusted Registry (DTR)|[`DTR/`](https://github.com/docker/ddc-opencontrol/tree/master/DTR)|2.1.1|
|Universal Control Plane (UCP)|[`UCP/`](https://github.com/docker/ddc-opencontrol/tree/master/UCP)|2.0.1|
|Universal Control Plane Authentication and Authorization Service|[`UCPAuthNAuthZService/`](https://github.com/docker/ddc-opencontrol/tree/master/UCPAuthNAuthZService)|2.0.1|
|Commercially Supported (CS) Docker Engine|[`CSEngine/`](https://github.com/docker/compliance/tree/master/CSEngine)|1.12.3-cs4|
|Docker Trusted Registry (DTR)|[`DTR/`](https://github.com/docker/compliance/tree/master/DTR)|2.1.1|
|Universal Control Plane (UCP)|[`UCP/`](https://github.com/docker/compliance/tree/master/UCP)|2.0.1|
|Universal Control Plane Authentication and Authorization Service|[`UCPAuthNAuthZService/`](https://github.com/docker/compliance/tree/master/UCPAuthNAuthZService)|2.0.1|

> Both the UCP and DTR components leverage the UCP Authentication and Authorization Service component for authentication and authorization across an entire Docker Datacenter cluster.
Expand All @@ -32,22 +32,22 @@ In order to generate the documentation appropriate to your system, refer to the

## Developing

Refer to the [Contributing Guide](https://github.com/docker/ddc-opencontrol/blob/master/CONTRIBUTING.md) for instructions on contributing to this project.
Refer to the [Contributing Guide](https://github.com/docker/compliance/blob/master/CONTRIBUTING.md) for instructions on contributing to this project.

### Component Validation

The OpenControl schema is defined by the [Kwalify](http://www.kuwata-lab.com/kwalify/) schema validator and YAML parser. Each Docker Datacenter component definition is tested against this schema using the [PyKwalify](https://github.com/Grokzen/pykwalify) Python port of the Kwalify specification. This repository contains a Dockerfile for running the component tests within a container.

```sh
docker build -t docker/ddc-opencontrol .
docker run docker/ddc-opencontrol
docker build -t docker/compliance-opencontrol .
docker run docker/compliance-opencontrol
```

### Natural Language Processing [Experimental]

Thorough documentation of the relevant security controls for each of the DDC components is a critical aspect of this project. It's imperative that not only is each control satisfied, but that the contents of the actual narratives match that which is defined by NIST 800-53. As such, this project includes experimental support for key phrase text analysis backed by [Microsoft Cognitive Services](https://www.microsoft.com/cognitive-services).

The [`nlp/`](https://github.com/docker/ddc-opencontrol/tree/master/nlp) directory contains a command-line service written in Go that parses each component control's narratives and submits them to the [Text Analytics API](https://www.microsoft.com/cognitive-services/en-us/text-analytics-api) for detection of key phrases (e.g. "access control", "authentication", etc). The key phrases are then checked against the key phrases that represent each of the NIST 800-53 definitions to ensure that the content indeed matches. The match process is currently quite basic. A successful match occurs when a component's narrative includes one or more of the key phrases that are also in the list of key phrases representative of the NIST definition itself. You can think of this as a form of automated proofreading.
The [`nlp/`](https://github.com/docker/compliance/tree/master/nlp) directory contains a command-line service written in Go that parses each component control's narratives and submits them to the [Text Analytics API](https://www.microsoft.com/cognitive-services/en-us/text-analytics-api) for detection of key phrases (e.g. "access control", "authentication", etc). The key phrases are then checked against the key phrases that represent each of the NIST 800-53 definitions to ensure that the content indeed matches. The match process is currently quite basic. A successful match occurs when a component's narrative includes one or more of the key phrases that are also in the list of key phrases representative of the NIST definition itself. You can think of this as a form of automated proofreading.

Ultimately, this functionality is best served as a compliance-masonry [plugin](https://github.com/opencontrol/compliance-masonry/tree/master/exampleplugin) developed in a separate repository instead of a standalone tool. Contributions welcome!

Expand Down

0 comments on commit 441e22b

Please sign in to comment.