opencontrol-linter 0.1

data/vendor/schemas/kwalify/opencontrol/v1.0.0.yaml

@@ -0,0 +1,67 @@
+type: map
+mapping:
+  name:
+    type: str
+    required: true
+  schema_version:
+    type: str
+    required: true
+  metadata:
+    type: map
+    mapping:
+      description:
+        type: str
+        required: true
+      maintainers:
+        required: true
+        type: seq
+        sequence:
+          - type: str
+  components:
+    type: seq
+    sequence:
+      - type: str
+  certifications:
+    type: seq
+    sequence:
+      - type: str
+  standards:
+    type: seq
+    sequence:
+      - type: str
+  dependencies:
+    type: map
+    mapping:
+      certifications:
+        type: seq
+        sequence:
+          - type: map
+            mapping:
+              url:
+                type: str
+              contextdir:
+                type: str
+              revision:
+                type: str
+      standards:
+        type: seq
+        sequence:
+          - type: map
+            mapping:
+              url:
+                type: str
+              contextdir:
+                type: str
+              revision:
+                type: str
+      systems:
+        type: seq
+        sequence:
+          - type: map
+            mapping:
+              url:
+                type: str
+              contextdir:
+                type: str
+              revision:
+                type: str

data/vendor/schemas/kwalify/requirements.txt

@@ -0,0 +1,3 @@
+pykwalify~=1.7.0
+pytest~=3.0.0
+PyYAML~=3.11

data/vendor/schemas/kwalify/standard/v1.0.0.yaml

@@ -0,0 +1,14 @@
+type: map
+mapping:
+  =:
+    type: map
+    mapping:
+      name:
+        type: str
+      family:
+        type: str
+      description:
+        type: str
+
+  name:
+    type: str

data/vendor/schemas/transformation-scripts/utils.py

@@ -0,0 +1,12 @@
+""" These are shared functions between v2_to_v1 and v1_to_v2 """
+
+def add_if_exists(new_data, old_data, field):
+    """ Adds the field to the new data if it exists in the old data """
+    if field in old_data:
+        new_data[field] = old_data.get(field)
+
+
+def transport_usable_data(new_data, old_data):
+    """ Adds the data structures that haven't changed to the new dictionary """
+    for field in old_data:
+        add_if_exists(new_data=new_data, old_data=old_data, field=field)

data/vendor/schemas/transformation-scripts/v1_example.yaml

@@ -0,0 +1,40 @@
+name: Amazon Elastic Compute Cloud # Name of the component
+documentation_complete: false # Manual check if the documentation is complete (for gap analysis)
+references:
+  - name: Reference  # Name of the reference ie. EC2 website
+    path: http://VerificationURL.com  # Url of the reference
+    type: URL # type of reference (will affect how it's rendered in the documentation)
+verifications:
+  EC2_Verification_1: # ID of verification
+    name: EC2 Verification 1  # Name of verification
+    path: http://VerificationURL.com #  URL of the verification
+    type: URL # type of reference (will affect how it's rendered in the documentation)
+  EC2_Verification_2:
+    name: EC2 Governor 2
+    path: artifact-ec2-1.png
+    type: Image
+satisfies:
+  NIST-800-53:
+    CM-2:
+      narrative: Justification in narrative form # Justification text
+      implementation_status: partial # Manual status of implementation (for gap analysis)
+      references:
+        - verification: EC2_Verification_1 # The specific verification ID that the reference links, no component or system is needed for internal references
+        - system: CloudFoundry  # System name of the verification (can link to other systems / components)
+          component: UAA  # System name of the verification (can link to other systems / components)
+          verification: UAA_Verification_1 # The specific verification ID that the reference links to
+  PCI-DSS-MAY-2015:
+    1.1:
+      narrative: Justification in narrative form # Justification text
+      implementation_status: partial # Manual status of implementation (for gap analysis)
+      references:
+        - verification: EC2_Verification_1 # The specific verification ID that the reference links, no component or system is needed for internal references
+        - system: CloudFoundry  # System name of the verification (can link to other systems / components)
+          component: UAA  # System name of the verification (can link to other systems / components)
+          verification: UAA_Verification_1 # The specific verification ID that the reference links to
+    1.1.1:
+      narrative: Justification in narrative form # Justification text
+      implementation_status: partial # Manual status of implementation (for gap analysis)
+    2.1:
+      narrative: Justification in narrative form # Justification text
+      implementation_status: partial # Manual status of implementation (for gap analysis)

data/vendor/schemas/transformation-scripts/v1_from_v2_example.yaml

@@ -0,0 +1,41 @@
+documentation_complete: false
+name: Amazon Elastic Compute Cloud
+references:
+- name: Reference
+  path: http://VerificationURL.com
+  type: URL
+satisfies:
+  NIST-800-53:
+    CM-2:
+      implementation_status: partial
+      narrative: Justification in narrative form
+      references:
+      - verification: EC2_Verification_1
+      - component: UAA
+        system: CloudFoundry
+        verification: UAA_Verification_1
+  PCI-DSS-MAY-2015:
+    1.1:
+      implementation_status: partial
+      narrative: Justification in narrative form
+      references:
+      - verification: EC2_Verification_1
+      - component: UAA
+        system: CloudFoundry
+        verification: UAA_Verification_1
+    2.1:
+      implementation_status: partial
+      narrative: Justification in narrative form
+    1.1.1:
+      implementation_status: partial
+      narrative: Justification in narrative form
+schema_version: 2.0
+verifications:
+  EC2_Verification_1:
+    name: EC2 Verification 1
+    path: http://VerificationURL.com
+    type: URL
+  EC2_Verification_2:
+    name: EC2 Governor 2
+    path: artifact-ec2-1.png
+    type: Image

data/vendor/schemas/transformation-scripts/v1_to_v2.py

@@ -0,0 +1,75 @@
+""" Python script to convert Open Controls schema version v1.0 to v2.0 """
+
+import yaml
+import glob
+
+from utils import add_if_exists, transport_usable_data
+
+
+def flatten_verifications(old_verifications):
+    """ Convert verifications from v1 to v2 """
+    new_verifications = []
+    for key in old_verifications:
+        verification = old_verifications[key]
+        verification['key'] = key
+        new_verifications.append(verification)
+    return new_verifications
+
+
+def transform_references(old_references):
+    """ Covert old reference format to new reference format """
+    new_references = []
+    for ref in old_references:
+        new_ref = {}
+        new_ref['verification_key'] = ref['verification']
+        component_key = ref.get('component')
+        system_key = ref.get('system')
+        if component_key:
+            new_ref['component_key'] = component_key
+        if system_key:
+            new_ref['system_key'] = system_key
+        new_references.append(new_ref)
+    return new_references
+
+
+def convert_satisfies(old_satisfies):
+    """ Convert satisfies objects from v1 to v2 """
+    new_satisfies = []
+    for standard_key in old_satisfies:
+        for control_key in old_satisfies[standard_key]:
+            new_control_dict = {
+                'standard_key': standard_key,
+                'control_key': control_key
+            }
+            old_control_dict = old_satisfies[standard_key][control_key]
+            add_if_exists(
+                new_data=new_control_dict,
+                old_data=old_control_dict,
+                field='narrative'
+            )
+            add_if_exists(
+                new_data=new_control_dict,
+                old_data=old_control_dict,
+                field='implementation_status'
+            )
+            print(old_control_dict)
+            new_control_dict['covered_by'] = transform_references(
+                old_control_dict.get('references', {})
+            )
+            new_satisfies.append(new_control_dict)
+    return new_satisfies
+
+
+def convert(old_data):
+    """ Convert the data from the v2 to v1 """
+    new_data = {}
+    transport_usable_data(new_data=new_data, old_data=old_data)
+    verifications = flatten_verifications(old_data.get('verifications', {}))
+    if verifications:
+        new_data['verifications'] = verifications
+    satisfies = convert_satisfies(old_data.get('satisfies', {}))
+    if satisfies:
+        new_data['satisfies'] = satisfies
+    # Tag new schema version
+    new_data['schema_version'] = 2.0
+    return new_data

data/vendor/schemas/transformation-scripts/v2_example.yaml

@@ -0,0 +1,45 @@
+documentation_complete: false
+name: Amazon Elastic Compute Cloud
+references:
+- name: Reference
+  path: http://VerificationURL.com
+  type: URL
+satisfies:
+- control_key: 1.1.1
+  covered_by: []
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+- control_key: 1.1
+  covered_by:
+  - verification_key: EC2_Verification_1
+  - component_key: UAA
+    system_key: CloudFoundry
+    verification_key: UAA_Verification_1
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+- control_key: 2.1
+  covered_by: []
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+- control_key: CM-2
+  covered_by:
+  - verification_key: EC2_Verification_1
+  - component_key: UAA
+    system_key: CloudFoundry
+    verification_key: UAA_Verification_1
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: NIST-800-53
+verifications:
+- key: EC2_Verification_2
+  name: EC2 Governor 2
+  path: artifact-ec2-1.png
+  type: Image
+- key: EC2_Verification_1
+  name: EC2 Verification 1
+  path: http://VerificationURL.com
+  type: URL
+schema_version: 2.0

data/vendor/schemas/transformation-scripts/v2_from_v1_example.yaml

@@ -0,0 +1,45 @@
+documentation_complete: false
+name: Amazon Elastic Compute Cloud
+references:
+- name: Reference
+  path: http://VerificationURL.com
+  type: URL
+satisfies:
+- control_key: CM-2
+  covered_by:
+  - verification_key: EC2_Verification_1
+  - component_key: UAA
+    system_key: CloudFoundry
+    verification_key: UAA_Verification_1
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: NIST-800-53
+- control_key: 1.1.1
+  covered_by: []
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+- control_key: 1.1
+  covered_by:
+  - verification_key: EC2_Verification_1
+  - component_key: UAA
+    system_key: CloudFoundry
+    verification_key: UAA_Verification_1
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+- control_key: 2.1
+  covered_by: []
+  implementation_status: partial
+  narrative: Justification in narrative form
+  standard_key: PCI-DSS-MAY-2015
+schema_version: 2.0
+verifications:
+- key: EC2_Verification_1
+  name: EC2 Verification 1
+  path: http://VerificationURL.com
+  type: URL
+- key: EC2_Verification_2
+  name: EC2 Governor 2
+  path: artifact-ec2-1.png
+  type: Image

data/vendor/schemas/transformation-scripts/v2_to_v1.py

@@ -0,0 +1,74 @@
+""" Python script to convert Open Controls schema version v2.0 to v1.0 """
+
+import yaml
+
+from utils import add_if_exists, transport_usable_data
+
+
+def unflatten_verifications(old_verifications):
+    """ Convert verifications from v2 to v1 """
+    new_verifications = {}
+    for verification in old_verifications:
+        key = verification['key']
+        del verification['key']
+        new_verifications[key] = verification
+    return new_verifications
+
+
+def transform_covered_by(covered_by):
+    """ Transform covered_by to references as in version 1.0 """
+    new_references = []
+    for ref in covered_by:
+        new_ref = {}
+        new_ref['verification'] = ref['verification_key']
+        component_key = ref.get('component_key')
+        system_key = ref.get('system_key')
+        if component_key:
+            new_ref['component'] = component_key
+        if system_key:
+            new_ref['system'] = system_key
+        new_references.append(new_ref)
+    return new_references
+
+
+def unflatten_satisfies(old_satisfies):
+    """ Convert satisfies from v2 to v1 """
+    new_satisfies = {}
+    for element in old_satisfies:
+        new_element = {}
+        # Handle exsiting data
+        add_if_exists(
+            new_data=new_element,
+            old_data=element,
+            field='narrative'
+        )
+        add_if_exists(
+            new_data=new_element,
+            old_data=element,
+            field='implementation_status'
+        )
+        # Handle covered_by
+        references = transform_covered_by(element.get('covered_by', {}))
+        control_key = element['control_key']
+        standard_key = element['standard_key']
+        if references:
+            new_element['references'] = references
+        # Unflatten
+        if standard_key not in new_satisfies:
+            new_satisfies[standard_key] = {}
+        if control_key not in new_satisfies[standard_key]:
+            new_satisfies[standard_key][control_key] = new_element
+    return new_satisfies
+
+
+def convert(old_data):
+    """ Convert the data from the v2 to v1 """
+    new_data = {}
+    transport_usable_data(new_data=new_data, old_data=old_data)
+    verifications = unflatten_verifications(old_data.get('verifications', {}))
+    if verifications:
+        new_data['verifications'] = verifications
+    satisfies = unflatten_satisfies(old_data.get('satisfies', {}))
+    if satisfies:
+        new_data['satisfies'] = satisfies
+    return new_data

metadata

@@ -0,0 +1,320 @@
+--- !ruby/object:Gem::Specification
+name: opencontrol-linter
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Adrian Kierman
+- James Connor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: powerpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rationalist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.29.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: |2
+      Automatic Open Control schema checking tool.
+      Aims to provide quick tests that ensure open control controls work together reliably.
+email: 
+executables:
+- opencontrol-linter
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- exe/opencontrol-linter
+- lib/opencontrol.rb
+- lib/opencontrol/cli.rb
+- lib/opencontrol/messages.rb
+- lib/opencontrol/version.rb
+- vendor/README.md
+- vendor/schemas/CONTRIBUTING.md
+- vendor/schemas/README.md
+- vendor/schemas/examples/component_v3.0.0.yaml
+- vendor/schemas/examples/component_v3.1.0.yaml
+- vendor/schemas/examples/opencontrol_v1.0.0.yaml
+- vendor/schemas/kwalify/README.md
+- vendor/schemas/kwalify/certification/v1.0.0.yaml
+- vendor/schemas/kwalify/component/test_data_validity.py
+- vendor/schemas/kwalify/component/v1.0.0.yaml
+- vendor/schemas/kwalify/component/v2.0.0.yaml
+- vendor/schemas/kwalify/component/v3.0.0.yaml
+- vendor/schemas/kwalify/component/v3.1.0.yaml
+- vendor/schemas/kwalify/opencontrol/v1.0.0.yaml
+- vendor/schemas/kwalify/requirements.txt
+- vendor/schemas/kwalify/standard/v1.0.0.yaml
+- vendor/schemas/transformation-scripts/utils.py
+- vendor/schemas/transformation-scripts/v1_example.yaml
+- vendor/schemas/transformation-scripts/v1_from_v2_example.yaml
+- vendor/schemas/transformation-scripts/v1_to_v2.py
+- vendor/schemas/transformation-scripts/v2_example.yaml
+- vendor/schemas/transformation-scripts/v2_from_v1_example.yaml
+- vendor/schemas/transformation-scripts/v2_to_v1.py
+homepage: https://github.com/adriankierman/opencontrol
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/adriankierman/opencontrol/
+  changelog_uri: https://github.com/adriankierman/opencontrol/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/adriankierman/opencontrol
+  documentation_uri: https://github.com/adriankierman/opencontrol
+  bug_tracker_uri: https://github.com/adriankierman/opencontrol/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Automatic open control linting tool.
+test_files: []