emasser 3.12.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b90b832b57672567d46686a6c1e490a2f61ea08fae87709b2db7e5ee7f789bb
-  data.tar.gz: 312b2c6c4a56d40c1ac5fdefae3ee36f745af244a5f0e4839cf6b40796b53b14
+  metadata.gz: 0ea103b11885ac1177827b4c904231e195551c3e3aa3eff600f68b9f6f515209
+  data.tar.gz: 1fa842722e5c8df28d04cbf50d08fd4d7cc93a9cc4e4ca029d38802c252551fa
 SHA512:
-  metadata.gz: 50272e2670c607779a0365c352b7def9cbbb9b2dacab88811edbf0bd198a0b5e80e1c1111b5aebb13e5dd6e48cbf28a4a2304c86145841dbbd08325bdeafcaa2
-  data.tar.gz: 7853329f250ab9aa7af9420d6d706aaf8d6fa0caf3471c3da179370552a00ba33ca161e0ea1d5c406b9d8e0b815bfe0fcec3b42d99bd5fe9211b3567db08b461
+  metadata.gz: cbc31d64a2f79e938c68d39062bbc6ed713254e1e5801c187217bc03de5ab6ca5de307a6f4baf6a7bc3179b92dbb8d11ac35b78ef4bf78c9f194bc71bf802e69
+  data.tar.gz: aa638c03037d408dc81e183052401ca7d5dd7402d9185f3059a8a46352345e519f35827fbde7c6bde94af5512a04b22f7d24c36a70ee2e8a87e8330f2856eef4

data/.env-example

@@ -1,12 +1,18 @@
-export EMASSER_API_KEY=<API key>
-export EMASSER_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY belongs to>
-export EMASSER_HOST_URL=<FQDN of the eMASS server>
-export EMASSER_KEY_FILE_PATH=<path to your emass key in PEM format>
-export EMASSER_CERT_FILE_PATH=<path to your emass certificate in PEM format>
-export EMASSER_KEY_FILE_PASSWORD=<password for the key given in EMASSER_KEY_FILE_PATH>
-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>
+# -----------------------------------------------------------------------------
+# Required environment variables
+export EMASSER_API_KEY=<The eMASS API key (api-key)>
+export EMASSER_HOST_URL=<The Full Qualified Domain Name (FQDN) for the eMASS server>
+export EMASSER_KEY_FILE_PATH=<The eMASS key.pem private key file in PEM format (.pem)>
+export EMASSER_CERT_FILE_PATH=<The eMASS client.pem certificate file in PEM format (.pem)>
+export EMASSER_KEY_FILE_PASSWORD=<Secret phrase used to protect the encryption key>
+# Required by most eMASS instances for actionable requests (post,put,delete)
+export EMASSER_USER_UID=<The eMASS User Unique Identifier (user-uid)>
+# -----------------------------------------------------------------------------
+# Optional environment variables
+export EMASSER_CLIENT_SIDE_VALIDATION=<Client side validation - true or false (default true)>
+export EMASSER_VERIFY_SSL=<verify SSL - true or false (default true)>
+export EMASSER_VERIFY_SSL_HOST=<verify host SSL - true or false (default true)>
+export EMASSER_DEBUGGING=<set debugging - true or false (default false)>
+export EMASSER_CLI_DISPLAY_NULL=<display null value fields - true or false (default true)>
+export EMASSER_EPOCH_TO_DATETIME=<convert epoch to data/time value - true or false (default true)>
+export EMASSER_DOWNLOAD_DIR=`Directory where exported files are saved (default eMASSerDownloads)`

data/.github/workflows/anchore-syft.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow checks out code, builds an image, performs a container image
+# scan with Anchore's Syft tool, and uploads the results to the GitHub Dependency
+# submission API.
+
+# For more information on the Anchore sbom-action usage
+# and parameters, see https://github.com/anchore/sbom-action. For more
+# information about the Anchore SBOM tool, Syft, see
+# https://github.com/anchore/syft
+name: Anchore Syft SBOM scan
+
+on:
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: write
+
+jobs:
+  Anchore-Build-Scan:
+    permissions:
+      contents: write # required to upload to the Dependency submission API
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the code
+      uses: actions/checkout@v4
+    - name: Build the Docker image
+      run: docker build . --file Dockerfile --tag localbuild/testimage:latest
+    - name: Scan the image and upload dependency results
+      uses: anchore/sbom-action@bb716408e75840bbb01e839347cd213767269d4a
+      with:
+        image: "localbuild/testimage:latest"
+        artifact-name: image.spdx.json
+        dependency-snapshot: true

data/.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl

data/.github/workflows/push-to-docker-mail.yml

@@ -1,10 +1,9 @@
-name: Push emasser CLI to Docker Hub on every merge to master and tag as latest
+name: Push eMASSer CLI to Docker Hub on every merge to master and tag as latest
 
 on:
   push:
     branches: [ main ]
 
-
 jobs:
   docker:
     runs-on: ubuntu-latest

data/.github/workflows/push-to-docker.yml

@@ -1,4 +1,4 @@
-name: Push emasser to Docker Hub on every release
+name: Push eMASSer to Docker Hub on every release
 
 on:
   release:
@@ -23,7 +23,7 @@ jobs:
           string: "${{ github.event.release.tag_name }}"
           replace-with: ''
           flags: 'g'
-      - name: Checkout the emasser Repository
+      - name: Checkout the eMASSer Repository
         uses: actions/checkout@v4
       - name: Build and push
         id: docker_build

data/.github/workflows/rubocop.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.4
       - name: Install and run Rubocop
         run: |
           bundle install

data/.github/workflows/test-cli.yml

@@ -12,10 +12,10 @@ jobs:
       fail-fast: false
       matrix:
        platform: [ ubuntu-latest, macos-latest, windows-latest ]
-       ruby-version: ['2.6', '2.7']
+       ruby-version: ['3.4']
     runs-on: ${{ matrix.platform }}
     steps:
-      - name: Setup Ruby ${{matrix.ruby}}
+      - name: Setup Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
@@ -24,14 +24,14 @@ jobs:
         with:
           args: install curl -y
         if: matrix.platform == 'windows-latest'
-      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby-version }}
         if: matrix.platform == 'windows-latest'
         run: |
           # bundle install
           # bundle info emass_client
           # rspec spec --format documentation
           echo "need to fix path to libcurl.dll"
-      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby-version }}
         if: matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
         run: |
           bundle install

data/.mergify.yml

@@ -1,25 +1,25 @@
 queue_rules:
   - name: default
-    conditions:
+    queue_conditions:
+      - label=ready-to-merge
+    merge_conditions:
       - "#approved-reviews-by>=1"
       - base=main
+    merge_method: squash
 
 pull_request_rules:
-  - name: automatic merge for master when reviewed and CI passes
-    conditions:
-      - label=ready-to-merge
-    actions:
-      queue:
-        name: default
-        method: squash
   - name: delete head branch after merge
     conditions:
       - merged
     actions:
-      delete_head_branch: {}
+          delete_head_branch: {}
   - name: ask developers to resolve conflict
     conditions:
       - conflict
     actions:
-        comment:
-          message: This pull request has a conflict. Could you fix it @{{author}}?
+      comment:
+        message: This pull request has a conflict. Could you fix it @{{author}}?
+  - name: automatic merge for master when reviewed and CI passes
+    conditions: []
+    actions:
+      queue:

data/.rubocop.yml

@@ -1,7 +1,7 @@
 ---
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-minitest
   - rubocop-performance
   - rubocop-rake

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.20.0] Feb 28, 2025
+### Changes
+- Implemented eMASS API V3.22 specifications (to include previous updates)
+- Updated documentation to include new capabilities (endpoints)
+- Updated docker container to use Ruby v3 and appropriate dependencies
+
 ## [3.12.0] Oct 11, 2023
 ### Changes
 - Implemented eMASS API V3.12 specifications (to include previous updates)

data/Dockerfile

@@ -1,5 +1,5 @@
 # Buld from ruby 2.7.5 image
-FROM ruby:2.7.5 as build
+FROM ruby:3.2.5 as build
 
 LABEL name="emasser" \
       vendor="MITRE" \
@@ -13,8 +13,8 @@ LABEL name="emasser" \
 # Set the base directory that will be used from now on
 WORKDIR /emasser
 
-# Install dependency
-RUN gem install bundler -v '2.3.5'
+# Install dependency (old bundler was 2.3.5)
+RUN gem install bundler -v '2.6.5'
 RUN apt update && apt install -y build-essential
 COPY . .
 RUN bundle install
@@ -27,7 +27,9 @@ RUN mkdir gems
 RUN mv emasser*.gem gems/emasser.gem
 
 
-FROM ruby:2-alpine
+# FROM ruby:2-alpine
+# Updated to ruby:3-alpine
+FROM ruby:3-alpine
 
 # Use the line below when testing creating the container locally
 # RUN sed -i 's/https/http/g' /etc/apk/repositories

data/Gemfile.lock

@@ -1,108 +1,152 @@
 PATH
   remote: .
   specs:
-    emasser (3.12.0)
+    emasser (3.22.0)
       activesupport (>= 6.1.4, < 7.1.0)
-      colorize (~> 0.8.1)
-      dotenv (~> 2.7.6)
-      emass_client (~> 3.12)
+      colorize (~> 1.1.0)
+      dotenv (~> 3.1.2)
+      emass_client (~> 3.20)
       rubyzip (~> 2.3.2)
-      thor (~> 1.1.0)
+      thor (~> 1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.0.8.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    bundler-audit (0.9.1)
+    backport (1.2.0)
+    benchmark (0.4.0)
+    bundler-audit (0.9.2)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     byebug (11.1.3)
-    colorize (0.8.1)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
-    dotenv (2.7.6)
-    emass_client (3.12.0)
+    colorize (1.1.0)
+    concurrent-ruby (1.3.5)
+    diff-lcs (1.6.0)
+    dotenv (3.1.7)
+    emass_client (3.22.0)
       typhoeus (~> 1.0, >= 1.0.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.16.3)
-    ffi (1.16.3-x64-mingw32)
-    i18n (1.14.1)
+    ffi (1.17.1-x64-mingw-ucrt)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    minitest (5.20.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    jaro_winkler (1.6.0)
+    json (2.10.1)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    minitest (5.25.4)
+    nokogiri (1.18.3-x64-mingw-ucrt)
+      racc (~> 1.4)
+    observer (0.1.2)
+    ostruct (0.6.1)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    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.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rake (13.2.1)
+    rbs (3.8.1)
+      logger
+    regexp_parser (2.10.0)
+    reverse_markdown (3.0.0)
+      nokogiri
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.52.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.73.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-minitest (0.31.0)
-      rubocop (>= 1.39, < 2.0)
-    rubocop-performance (1.18.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.37.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
     ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
-    thor (1.1.0)
-    typhoeus (1.4.0)
+    solargraph (0.51.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      jaro_winkler (~> 1.6)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      logger (~> 1.6)
+      observer (~> 0.1)
+      ostruct (~> 0.6)
+      parser (~> 3.0)
+      rbs (~> 3.0)
+      reverse_markdown (>= 2.0, < 4)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.3.2)
+    tilt (2.6.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    yaml (0.2.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yaml (0.3.0)
+    yard (0.9.37)
 
 PLATFORMS
-  x64-mingw32
-  x86_64-linux
+  x64-mingw-ucrt
 
 DEPENDENCIES
-  bundler (~> 2.3)
-  bundler-audit (~> 0.7)
+  bundler (~> 2.5)
+  bundler-audit (~> 0.9)
   byebug (~> 11.1.3)
   emasser!
-  rake (~> 13.0)
-  rspec (~> 3.10.0)
+  rake (~> 13.2.1)
+  rspec (~> 3.13.0)
   rubocop (~> 1.7)
-  rubocop-minitest (~> 0.10)
-  rubocop-performance (~> 1.11)
-  rubocop-rake (~> 0.5)
-  yaml (~> 0.2.0)
+  rubocop-minitest (~> 0.35)
+  rubocop-performance (~> 1.21)
+  rubocop-rake (~> 0.6)
+  solargraph (~> 0.50)
+  yaml (~> 0.3.0)
 
 BUNDLED WITH
-   2.3.22
+   2.6.5

data/README.md

@@ -2,10 +2,10 @@
 ![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)
+[![emasser Testing](https://github.com/mitre/emasser/actions/workflows/test-cli.yml/badge.svg)](https://github.com/mitre/emasser/actions/workflows/test-cli.yml)
+[![CodeQL Vulnerabilities and Errors](https://github.com/mitre/emasser/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/mitre/emasser/actions/workflows/codeql-analysis.yml)
 [![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)
+[![Code Linter](https://github.com/mitre/emasser/actions/workflows/rubocop.yml/badge.svg)](https://github.com/mitre/emasser/actions/workflows/rubocop.yml)
 
 ## About
 
@@ -28,10 +28,10 @@ The `eMASSer` CLI [**Architecture**](#emasser-cli-architecture) depicts the stru
 
 ### Installation Dependencies
   * git
-  * Ruby version 2.7 or greater
+  * Ruby version 3.22 or greater
 
 ### Runtime Major Dependencies
-  * Ruby version 2.7 or greater
+  * Ruby version 3.22 or greater
   * `rubyzip (latest version)`
   * `emass_client (latest version)`
   * On Windows the `cURL` binary is required (libcurl.dll). To install cURL:
@@ -157,12 +157,12 @@ Because interactions with the API are handled by a dependency, the bulk of `eMAS
 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">
+  <img src="images/emasser_architecture.png" alt="emasser CLI Architecture" title="emasser CLI Architecture">
 </div>
 
 ### NOTICE
 
-© 2020 The MITRE Corporation.
+© 2025 The MITRE Corporation.
 
 Approved for Public Release; Distribution Unlimited. Case Number 18-3678.