emasser 1.0.3 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e0147d78cbeb98b610045c09b4ce03c5a941379e803bac7a3ecffdff566566
-  data.tar.gz: fa0c7a1c0b0864dc727eb358839c7825c219e5ace076c1df88ea7e03912ac9e7
+  metadata.gz: 04d5fabb5cd03ea2303313f9556bb0ab4758642acce449e545c06385db62e995
+  data.tar.gz: 8de5b75a59d1cf87539accfb26fef79fc6ab3633753726ab13a8db176d063286
 SHA512:
-  metadata.gz: ae4215cf7639312137b9418dd0af7c75164a0db000cefe91bbb17c61849d72058a1932d6a4b87234455506bc3353cdf385028aebb5e822e813a684b92a8f6536
-  data.tar.gz: 639dfe19211d633dfed0ba1d66c1180d5efaac0c999226ff1fb6d5444cbd4885fde4a71ffc982bcd858e1a104c3ed6089b4bf69589e27d7831585a88182d9871
+  metadata.gz: d76892c176a01f532bc1fc3025a400bc31a09217aac8622bb96c71aac92be66abbee84115c6a88dd1244890182a68bab75500d7b3138cdc4ba3a59088059313a
+  data.tar.gz: 76af52e24772b720e3a5fd6f45af2acd4356c6eb808c50b309b95a079ad854988797a576ff05dd1a9e029c53dce40c2f5fc1a31fe4b05eb7221a020ec75ccb43

data/.env-example

@@ -8,3 +8,5 @@ export EMASSER_CLIENT_SIDE_VALIDATION=<client side validation - true or false>
 export EMASSER_VERIFY_SSL=<verify SSL - true or false>
 export EMASSER_VERIFY_SSL_HOST=<verify host SSL - true or false>
 export EMASSER_DEBUGGING=<set debugging - true or false>
+export EMASSER_CLI_DISPLAY_NULL=<display null value fields - true or false>
+export EMASSER_EPOCH_TO_DATETIME=<convert epoch to data/time value - true or false>

data/.github/workflows/gh-pages.yml

@@ -2,8 +2,8 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches: [ main ]
-  # pull_request:
-  #   branches: [ main ]
+  pull_request:
+    branches: [ main ]
     
 jobs:
   build-deploy:
@@ -17,11 +17,10 @@ jobs:
         run: |
           sudo mkdir -p /publish
           sudo mkdir -p /publish/docs
+          sudo mkdir -p /publish/images
+          sudo cp -R ./images /publish
           sudo cp README.md /publish
           sudo cp _config.yml /publish/_config.yml       
-          sudo cp -R ./docs/redoc /publish/docs/redoc
-          sudo cp -R ./docs/swagger /publish/docs/swagger
-          sudo cp ./docs/developers.md /publish/docs/developers.md 
           sudo cp ./docs/features.md /publish/docs/features.md          
              
       - name: Deploy Markdown Files 🚀

data/.github/workflows/release.yml

@@ -28,15 +28,15 @@ jobs:
           GPR_API_KEY: ${{secrets.GITHUB_TOKEN}}
       - name: Build emasser
         run: gem build *.gemspec
-      - name: Build emass_client
-        run: gem build -C emass_client/ruby_client/ emass_client.gemspec
+      # - name: Build emass_client
+      #   run: gem build -C emass_client/ruby_client/ emass_client.gemspec
       - name: Publish to RubyGems
         run: |
           gem push --KEY rubygems --host https://rubygems.org *.gem
-          gem push --KEY rubygems --host https://rubygems.org emass_client/ruby_client/*.gem
-      # - name: Publish to GPR
-      #   run: |
-      #     gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      #     gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} emass_client/ruby_client/*.gem
-      #   env:
-      #     OWNER: mitre
+          # gem push --KEY rubygems --host https://rubygems.org emass_client/ruby_client/*.gem
+      - name: Publish to GPR
+        run: |
+          gem push --KEY github --host https://rubygems.pkg.github.com/mitre *.gem
+          # gem push --KEY github --host https://rubygems.pkg.github.com/mitre emass_client/ruby_client/*.gem
+        env:
+          OWNER: mitre

data/Dockerfile

@@ -18,21 +18,23 @@ RUN gem install bundler -v '2.3.5'
 RUN apt update && apt install -y build-essential
 COPY . .
 RUN bundle install
-WORKDIR /emasser/emass_client/ruby_client
-RUN gem build emass_client.gemspec
+# WORKDIR /emasser/emass_client/ruby_client
+# RUN gem build emass_client.gemspec
 WORKDIR /emasser
 RUN gem build emasser.gemspec
 RUN mkdir gems
-RUN mv emass_client/ruby_client/emass_client*.gem gems/emass_client.gem
+# RUN mv emass_client/ruby_client/emass_client*.gem gems/emass_client.gem
 RUN mv emasser*.gem gems/emasser.gem
 
+
 FROM ruby:2-alpine
 
 # Use the line below when testing creating the container locally
 # RUN sed -i 's/https/http/g' /etc/apk/repositories
 COPY --from=build /emasser/gems /emass-gems
 
-RUN apk add build-base libcurl && gem install /emass-gems/emass_client.gem && gem install /emass-gems/emasser.gem
+# RUN apk add build-base libcurl && gem install /emass-gems/emass_client.gem && gem install /emass-gems/emasser.gem
+RUN apk add build-base libcurl && gem install /emass-gems/emasser.gem
 
 VOLUME [ "/data" ]
 WORKDIR /data

data/Gemfile

@@ -5,4 +5,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in emasser.gemspec
 gemspec
 
-gem 'emass_client', path: './emass_client/ruby_client/'
+#gem 'emass_client', path: './emass_client/ruby_client/'

data/Gemfile.lock

@@ -1,80 +1,74 @@
 PATH
   remote: .
   specs:
-    emasser (1.0.3)
+    emasser (1.0.6)
       activesupport (~> 6.1.4)
       colorize (~> 0.8.1)
       dotenv (~> 2.7.6)
-      emass_client (~> 1.0)
+      emass_client (~> 1.0, != 1.0.3)
       rubyzip (~> 2.3.2)
       thor (~> 1.1.0)
 
-PATH
-  remote: emass_client/ruby_client
-  specs:
-    emass_client (1.0.3)
-      json (~> 2.1, >= 2.1.0)
-      typhoeus (~> 1.0, >= 1.0.1)
-
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.4)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    bundler-audit (0.9.0.1)
+    bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     byebug (11.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     dotenv (2.7.6)
+    emass_client (1.0.6)
+      typhoeus (~> 1.0, >= 1.0.1)
     ethon (0.15.0)
       ffi (>= 1.15.0)
     ffi (1.15.5-x64-mingw32)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.1)
     minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.24.1)
+    rubocop (1.30.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.17.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.20.0)
       rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.13.1)
+    rubocop-performance (1.14.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
@@ -88,7 +82,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     yaml (0.2.0)
-    zeitwerk (2.5.3)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   x64-mingw32
@@ -97,7 +91,6 @@ DEPENDENCIES
   bundler (~> 2.3)
   bundler-audit (~> 0.7)
   byebug (~> 11.1.3)
-  emass_client!
   emasser!
   rake (~> 13.0)
   rspec (~> 3.10.0)

data/README.md

@@ -1,56 +1,36 @@
 # emasser
-![GitHub Release Date](https://img.shields.io/github/release-date/mitre/emasser?label=Release%20Date)
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/mitre/emasser?label=Release%20Version)
-[![Gem Version](https://badge.fury.io/rb/emasser.svg)](https://badge.fury.io/rb/emasser)
-
+![GitHub Release Date](https://img.shields.io/github/release-date/mitre/emasser?label=Release%20Date&logo=github&color=blue)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/mitre/emasser?label=Release%20Version&logo=github) ![Gem](https://img.shields.io/gem/v/emasser?label=gem%20version&logo=ruby&logoColor=red) ![Docker Version](https://img.shields.io/docker/v/mitre/emasser?label=docker%20version&logo=docker&sort=semver)
 
 ![emasser Testing](https://github.com/mitre/emasser/actions/workflows/test-cli.yml/badge.svg)
 ![CodeQL Vulnerabilities and Errors](https://github.com/mitre/emasser/actions/workflows/codeql-analysis.yml/badge.svg)
-![Docs Generation](https://github.com/mitre/emasser/actions/workflows/generate_docs.yml/badge.svg)
+[![GitHub Pages](https://github.com/mitre/emasser/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/mitre/emasser/actions/workflows/gh-pages.yml)
 ![Code Linter](https://github.com/mitre/emasser/actions/workflows/rubocop.yml/badge.svg)
-## About
-
-`emasser` is a command line interface (CLI) that aims to automate routine business use-cases and provide utility surrounding the Enterprise Mission Assurance Support Service (eMASS) by leveraging its representational state transfer (REST) application programming interface (API) v3.2.
-
-## Documentation
-emasser provides users with the following documentation:
-
-[**eMASS API Documentation**](https://mitre.github.io/emasser/docs/redoc/) | [**eMASS Swagger UI**](https://mitre.github.io/emasser/docs/swagger/)
-
-## Current Features
-
-The following eMASS API HTTP methods are implemented:
-* `GET` view eMASS resources
-* `POST` add eMASS resources
-* `PUT` update eMASS resources
-* `DELETE` remove eMASS resources
-
-
-[**emasser CLI Features**](docs/features.md) | [**emasser Developers Instructions**](docs/developers.md)
 
-## In Development
+## About
 
-This project is actively looking for user stories, features to build, and interactions with eMASS. See Roadmap for more information.
+`emasser` is a Command Line Interface (CLI) that aims to automate routine business use-cases and provide utility surrounding the Enterprise Mission Assurance Support Service (eMASS) by leveraging its Representational State Transfer (REST) Application Programming Interface (API). 
 
-* Support raw JSON upload
+***NOTE***: The `emasser` CLI utilizes the [emass_client](https://github.com/mitre/emass_client) RubyGem executable package to access the eMASS API endpoints.
 
-## Roadmap
+---
+## Documentation
+For detail content information about the `eMASS` API references the [**eMASS API Specification**](https://mitre.github.io/emass_client/docs/redoc/) page.
 
-Emasser is currently in MVP development and we are targeting all the features listed in Current and In Development for version 1.0.X. The Road Map are things that the team and community have talked about as possible great additions but feedback on which should come first, second, and third are what we would love feedback on from you.
+For detail features provided by the `emasser` CLI references the [**emasser CLI Features**](docs/features.md) page.
 
-* Update a system's record with met/not met NIST 800-53 Security and Privacy controls and/or common control indicators (CCI) based on scan results expressed in [Heimdall Data Format (HDF)](https://saf.mitre.org/#/normalize).
-* Resolve a particular plan of action and milestone (POA&M) based on scan results or git-ops workflow.
-* PKCS11 support to run in an attended mode.
+The `emasser` CLI [**Architecture**](#emasser-cli-architecture) depicts the `emasser` structure, and provides an explanation of how it behaves. 
 
-## Installation
+---
+## Installation Options
 
-`emasser` is a Ruby CLI that is distributed via git only. You must request the source from saf@groups.mitre.org
+`emasser` is a Ruby CLI distributed via GitHub (this repository), [RubyGems](https://rubygems.org/gems/emass_client/versions/), or [Docker](https://hub.docker.com/r/mitre/emasser/tags).
 
-Installation Dependencies:
+### Installation Dependencies
   * git
-  * Ruby version 2.7 or greater.
+  * Ruby version 2.7 or greater
 
-Runtime Dependencies:
+### Runtime Dependencies
   * Ruby version 2.7 or greater.
   * `rubyzip (latest version)`
   * `emass_client (latest version)`
@@ -63,52 +43,74 @@ Runtime Dependencies:
     - Install [cURL for windows](https://community.chocolatey.org/packages/curl) and add the installation directory to the PATH.
 
 
-To install (via github):
-```bash
-git clone <path to emasser git> emasser
-cd emasser
-```
-- Build the emasser gem
-```bash
-  gem build *.gemspec
-  gem install *.gem
-```
-- Build the emass_client gem
-```bash
-  cd emass_client/ruby_client
-  gem build *.gemspec
-  gem install *.gem
-```
+## Install via GitHub
+- [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the repository
+  ```bash
+  git clone <path to emasser repository> emasser
+  cd emasser
+  ```
+- Build the emasser gem*
+  ```bash
+    gem build *.gemspec
+    gem install *.gem
+  ```
 
-To install (via published RubyGems):
-```bash
-gem install emasser
-```
+***Note:** To run in development mode there isn't a need to build the gem, simply clone from the emasser repository and use:
 
-**Note:** To run in development mode there isn't a need to build the gem, simply clone from the emasser repository and use:
 ```
+bundle install
+
 bundle exec exe/emasser [command]
 ```
 
+## Install via published RubyGems
+- Install the `emasser` gem from the [RubyGems](https://rubygems.org/gems/emass_client/versions/) registry
+    ```bash
+    gem install emasser
+    ```
+- Update the `emasser` gem to the latest version
+  ```bash
+  gem update emasser
+  ```
+
+- To run (execute a command) create a `.env*` file in the directory where you want to invoke the `emmaser` and use: 
+  
+  ```
+  emasser [command]
+  ```
+***Note:** See [Setting Environment Variables Configuration](https://github.com/mitre/emasser/wiki/Editing-Environment-Variables-Configuration) for detailed information on required and optional variables.
+
 ## Using Docker
-### Run the emasser Docker Container
-- To run the emasser container use:
+Ensure that docker engine is running and start the emasser Docker Container.
+### Install
+- On Linux or Mac:
   ```
   docker run --rm -v $PWD/path-to-secrets:/data mitre/emasser:latest
   ```
-- To run the emasser container in a `Windows terminal (cmd)` use:
+- On Windows:
+    ```
+    docker run --rm -v %cd%/path-to-secrets:/data mitre/emasser:latest
     ```
-  docker run --rm -v %cd%/path-to-secrets:/data mitre/emasser:latest
+- Update via Docker
+  ```bash
+    docker pull mitre/emasser:latest
   ```
-**Notes:**
+
+**Docker Notes:**
 - Docker Options
   - `--rm` Automatically remove the container when it exits
   - `-v` Bind mount a volume
 - path-to-secrets
-  - Path to the `.env` file and the appropriate eMASS certificates (key. pem and client.pem). See [Editing Environment Variables Configuration](https://github.com/mitre/emasser/wiki/Editing-Environment-Variables-Configuration)
+  - Is the path to the `.env` file and the appropriate eMASS certificates (key.pem and client.pem).
+  - For example, if the `.env` is located in the same directory where the `docker run` is executed, running the command in a Windows platform would look like this:
+  
+      ```
+      docker run --rm -v %cd%/.:/data mitre/emasser:latest
+      ```
+  -  See [Editing Environment Variables Configuration](https://github.com/mitre/emasser/wiki/Editing-Environment-Variables-Configuration)
 
 ### Run emasser API client commands
-- To list all GET, POST, PUT, or DELETE commands use:
+- To list all available GET, POST, PUT, or DELETE commands use:
   ```
   docker run --rm -v $PWD/path-to-secrets:/data mitre/emasser:latest get help
   ```
@@ -121,34 +123,41 @@ bundle exec exe/emasser [command]
   ```
   docker run --rm -v $PWD/path-to-secrets:/data mitre/emasser:latest delete help
   ```
+  Example commands are for Linux or Mac, replace the `$PWD` with `%cd%` for Windows
 
 ### Delete (remove) the Docker Container
 ```
   docker rmi -f mitre/emasser
 ```
+---
+## Roadmap
 
-## Use
+The `emasser` implements all endpoints provided by the `eMASS` API, there is, all of the functions available from the `eMASS GUI` that are exposed by the API. If additional functions are useful (accessible via the CLI), please submit a request to [eMass Tier III Support](mailto:disa.meade.id.mbx.emass-tier-iii-support@mail.mil) for possible inclusion into the API.
 
-**Requirement 1 & 2: Authentication and Authorization:**
-`emasser` requires authentication to eMASS as well as authorization to use the eMASS API. This authentication and authorization is **not** a function of `emasser` and needs to be handled directly with discussions with [eMASS](https://www.dcsa.mil/is/emass/). `emasser` will accept credentials that are created based on those discussions.
+The Road Map seeks to add any useful features that facilitates organization that utilizes  `eMASS` instances and have a need to automate their cybersecurity management process. 
 
-**Approve API Client for Actionable Requests**
-Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions.
+For additional capability create an [issue](https://github.com/mitre/emasser/issues), and email it to the [SAF Team](mailto:saf@groups.mitre.org) citing the issue link so we can help.
 
-To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
-* [eMASS Tier III support - Website](https://www.dcsa.mil/is/emass/)
-* [Send email to eMASS Tier III support](disa.meade.id.mbx.emass-tier-iii-support@mail.mil)
-* [eMASS New User Registration (CAC required)](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf)
+Some proposed capabilities (looking for a sponsor) are:
+* Update a system's record with met/not met NIST 800-53 Security and Privacy controls and/or common control indicators (CCI) based on scan results expressed in [Heimdall Data Format (HDF)](https://saf.mitre.org/#/normalize).
+* Resolve a particular plan of action and milestone (POA&M) based on scan results or git-ops workflow.
+* PKCS11 support to run in an attended mode.
 
 
 ## Design
 
-**Interactions with eMASS API:**
-`emasser` leverages a MITRE dependency, `emass_client`, which provides a REST API client based on a MITRE-created [OpenAPI](https://www.openapis.org/) version 3 specification for the official eMASS version 3.2 API documentation. This design enables REST API clients to be generated in [any supported programming language](https://swagger.io/tools/swagger-codegen/). This design decision enables `emass_client` to generate a Ruby client for `emasser` and a TypeScript client that is included with [Heimdall Enterprise Server](https://github.com/mitre/heimdall2).
+### Interactions with eMASS API
+The `emasser` CLI leverages the [emass_client](https://github.com/mitre/emass_client), which provides a REST API client developed by MITRE based on the [OpenAPI V3](https://www.openapis.org/) standards for the official [eMASS API specification](https://mitre.github.io/emass_client/docs/redoc). This design enables REST API clients to be generated in [any supported programming language](https://openapi-generator.tech/docs/generators/). The design enables the `emass_client` to be generated independently of the emasser CLI. Currently, a Ruby and a Typescript eMASS client API are provided. The TypeScript client is used with the [Security Automation Framework CLI (SAF) CLI](https://github.com/mitre/saf).
+
+### Business Logic
+Because interactions with the API are handled by a dependency, the bulk of `emasser` business logic is for accepting user input/output, reading data from eMASS or from input, transforming data, and routing data to the appropriate eMASS API endpoint. This business logic is organized into Ruby Classes and Modules based on the command or subcommand requested by the user.
 
-**Business Logic:**
-Because interactions with the API are handled by a dependency, the bulk of `emasser` is business logic for accepting user input/output, reading data from eMASS or from input, transforming data, and routing data to the appropriate eMASS API endpoint. This business logic is organized into Ruby Classes and Modules based on the command or subcommand requested by the user.
+## Emasser CLI Architecture
+The `emasser` CLI makes use of the `emass_client` ruby gem to communicate with an `eMASS` instance via the `eMASS API` as depicted in the diagram below:
 
+<div align="center">
+  <img src="images/emasser_architecture.jpg" alt="emasser CLI Architecture" title="emasser CLI Architecture">
+</div>
 
 ### NOTICE