emasser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adf117509f0462e0242104ae66543567481509c3383f726a6c0a73b74ea38310
+  data.tar.gz: c08b8f35507724880fb7aadfea9cdb2f8df07a4cc26b79e4eb535f562f3066fc
+SHA512:
+  metadata.gz: 725f7442bc3178a14765bc4db1e5ee373e55edf53ea0f18a09128d32a194d52995aa73fb467a141426153a2f015d10829d52b1d33cd866826e0183cf6d172242
+  data.tar.gz: 226662bf3779c58d4bd6e7f730fd0c2e0bf0520251ba1d191a0ae75293ba76196caa5d1d6fb6b9050532b7f9d33bad5531d84eb46d1a9c85e94ddf3c46d44a0c

data/.dockerignore

@@ -0,0 +1,11 @@
+# git
+.git
+.gitignore
+CHANGELOG.md
+
+# ci
+.gitlab-ci.yml
+
+# code
+spec
+.env

data/.env-example

@@ -0,0 +1,10 @@
+export EMASSER_API_KEY_API_KEY=<API key>
+export EMASSER_API_KEY_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY_API_KEY belongs to>
+export EMASSER_HOST=<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 certficate in PEM format>
+export EMASSER_KEY_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>

data/.github/release-drafter.yml

@@ -0,0 +1,16 @@
+name-template: 'v$NEXT_PATCH_VERSION'
+tag-template: 'v$NEXT_PATCH_VERSION'
+categories:
+  - title: 'Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: 'Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+template: |
+  ## Changes
+  $CHANGES

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

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '42 7 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # 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@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/draft-release.yml

@@ -0,0 +1,16 @@
+name: Draft Release
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+
+jobs:
+  update_draft_release:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "main"
+      - uses: toolmantim/release-drafter@v5.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/generate_docs.yml

@@ -0,0 +1,33 @@
+name: generate-docs
+
+# Run on each push to main
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  test_job:
+    runs-on: ubuntu-latest
+    name: Generate Document with redoc
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # use the public name of the action
+      - name: redoc-cli test
+        uses: seeebiii/redoc-cli-github-action@v9
+        with:
+          args: 'bundle emass_client/eMASSRestOpenApi.yaml -o docs/redoc/index.html'
+
+      - name: check result
+        run: |
+          ls -al
+          test -f docs/redoc/index.html || (echo "Fail to generate docs/redoc/index.html from previous step." && exit 1)
+
+      - name: deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/redoc
+          destination_dir: docs/redoc
+          enable_jekyll: true

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

@@ -0,0 +1,33 @@
+name: Deploy to GitHub Pages
+on:
+  push:
+    branches: [ main ]
+  # pull_request:
+  #   branches: [ main ]
+    
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    name: Copy Markdown Files to gh_pages
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2
+
+      - name: Build Deploment Folder 🔧
+        run: |
+          sudo mkdir -p /publish
+          sudo mkdir -p /publish/docs
+          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 🚀
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: /publish
+          destination_dir: .
+          enable_jekyll: true

data/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Build and release gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release to gem hosts
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - run: git fetch origin +refs/tags/*:refs/tags/*
+      - name: Setup credentials and versioning
+        run: |
+          gem install git-lite-version-bump keycutter
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          printf -- ":github: Bearer ${GPR_API_KEY}\n" >> $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+          GPR_API_KEY: ${{secrets.GITHUB_TOKEN}}
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish to RubyGems
+        run: |
+          gem push --KEY rubygems --host https://rubygems.org *.gem
+      - name: Publish to GPR
+        run: |
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          OWNER: mitre

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+name: Run rubocop
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - run: git fetch origin +refs/tags/*:refs/tags/*
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install and run Rubocop
+        run: |
+          bundle install
+          bundle exec rubocop --cache false

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

@@ -0,0 +1,73 @@
+# name: Test emasser CLI
+
+# on:
+#   push:
+#     branches: [ main ]
+#   pull_request:
+#     branches: [ main ]
+
+# jobs:
+#   test:
+#     strategy:
+#       fail-fast: false
+#       matrix: 
+#        platform: [ ubuntu-latest, macos-latest, windows-latest ]
+#        ruby-version: ['2.6', '2.7']
+#     runs-on: ${{ matrix.platform }}
+#     steps:
+#       - name: Setup Ruby ${{matrix.ruby}}
+#         uses: ruby/setup-ruby@v1
+#         with:
+#           ruby-version: ${{ matrix.ruby-version }}
+#       - uses: actions/checkout@v2
+#       - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+#         if: matrix.platform == 'windows-latest'
+#         run: |
+#           echo "need to install libcurl.dll"
+#       - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+#         if: matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
+#         run: |
+#           bundle install
+#           bundle info swagger_client
+#           rspec spec --format documentation
+
+name: Test emasser CLI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix: 
+       platform: [ ubuntu-latest, macos-latest, windows-latest ]
+       ruby-version: ['2.6', '2.7']
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Setup Ruby ${{matrix.ruby}}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - uses: actions/checkout@v2
+      - uses: crazy-max/ghaction-chocolatey@v1
+        with:
+          args: install curl -y
+        if: matrix.platform == 'windows-latest'
+      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+        if: matrix.platform == 'windows-latest'
+        run: |
+          # bundle install
+          # bundle info swagger_client
+          # rspec spec --format documentation
+          echo "need to fix path to libcurl.dll"
+      - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
+        if: matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
+        run: |
+          bundle install
+          bundle info swagger_client
+          rspec spec --format documentation
+          

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/emasser_secrets
+/.vscode
+
+**/*.un~
+
+emassing/test/test_example.zip
+.DS_Store
+.byebug_history
+.env

data/.mergify.yml

@@ -0,0 +1,25 @@
+queue_rules:
+  - name: default
+    conditions:
+      - "#approved-reviews-by>=1"
+      - base=main
+
+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: {}
+  - name: ask developers to resolve conflict
+    conditions:
+      - conflict
+    actions:
+        comment:
+          message: This pull request has a conflict. Could you fix it @{{author}}?

data/.rubocop.yml

@@ -0,0 +1,80 @@
+---
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+    - 'emass_client/ruby_client/**/*'
+    - Gemfile
+    - Rakefile
+    - 'test/**/*'
+    - '*.gemspec'
+
+#Cops in Metrics might need to be adjusted to past their defaults depending on how restrictive the requirements feel
+Style/Documentation:
+  Enabled: false
+Layout/ParameterAlignment:
+  Enabled: true
+Style/Encoding:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: true
+Layout/LineLength:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/NumericLiterals:
+  MinDigits: 10
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': ()
+    '%q': '{}'
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '{}'
+    '%W': ()
+    '%x': ()
+Layout/HashAlignment:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Style/Not:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/NegatedIf:
+  Enabled: false
+Style/UnlessElse:
+  Enabled: false
+Style/BlockDelimiters:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/SignalException:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-12-22 16:48:47 UTC using RuboCop version 1.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 21
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 190
+
+# Offense count: 17
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 78
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'lib/emasser/get.rb'
+    - 'lib/emasser/options_parser.rb'
+    - 'lib/emasser/post.rb'
+    - 'lib/emasser/put.rb'

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+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).
+
+## [Unreleased]
+- Harden the docker container (ex. non root user, etc).
+
+## [0.2.0] - 2020-12-14
+### Added
+- Scaffolding for the emasser project including such things as a Dockerfile, a .gitlab-ci.yml, some repository dependencies such as `standard` and `minitest`, and some gem dependencies such as `thor`.
+
+## [0.1.0] - 2020-12-10
+### Added
+- Put in MITRE's particular license modifications and notices.

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.5
+
+WORKDIR /emasser
+
+COPY . .
+
+RUN bundle install
+
+ENTRYPOINT ["bundle", "exec", "exe/emasser"]
+CMD ["-h"]

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in emasser.gemspec
+gemspec
+
+gem 'swagger_client', path: './emass_client/ruby_client/'

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    emasser (1.0.0)
+      activesupport
+      colorize
+      dotenv
+      rubyzip
+      swagger_client
+
+PATH
+  remote: emass_client/ruby_client
+  specs:
+    swagger_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      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.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.3-x64-mingw32)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.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.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    thor (1.1.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    yaml (0.2.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  bundler-audit (~> 0.7)
+  byebug
+  emasser!
+  rake (~> 13.0)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.7)
+  rubocop-minitest (~> 0.10)
+  rubocop-performance (~> 1.11)
+  rubocop-rake (~> 0.5)
+  swagger_client!
+  yaml (~> 0.2.0)
+
+BUNDLED WITH
+   2.2.29

data/LICENSE.md

@@ -0,0 +1,15 @@
+Licensed under the apache-2.0 license, except as noted below.  
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright/ digital rights 
+legend, this list of conditions and the following Notice.
+
+* Redistributions in binary form must reproduce the above copyright copyright/digital 
+rights legend, this list of conditions and the following Notice in the documentation 
+and/or other materials provided with the distribution.
+
+* Neither the name of The MITRE Corporation nor the names of its contributors may be 
+used to endorse or promote products derived from this software without specific prior 
+written permission.