Sync CDOT dev branch with changes in USDOT develop

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: CI
+on: 
+  pull_request:
+  push:
+
+jobs:
+  jpo-security-svcs:
+   runs-on: ubuntu-latest
+   container:
+     image: maven:3.8-eclipse-temurin-21-alpine
+     options: --user root
+   steps:
+     - name: Checkout ${{ github.event.repository.name }}
+       uses: actions/checkout@v3    
+     - name: Set up Maven
+       uses: stCarolas/setup-maven@v4.5
+       with:
+        maven-version: 3.8.2          
+     - uses: actions/setup-java@v3
+       with:
+         java-version: '21'
+         distribution: 'temurin'               
+     - name: Build
+       run: |
+         cd $GITHUB_WORKSPACE
+         ls -ls && pwd
+         mvn -e -X clean org.jacoco:jacoco-maven-plugin:prepare-agent package
+         mvn -e -X clean org.jacoco:jacoco-maven-plugin:report package
+     - name: Archive code coverage results
+       uses: actions/upload-artifact@v3
+       with:
+         name: jpo-security-svcs
+         path: /__w/jpo-security-svcs/jpo-security-svcs/target 
+         if-no-files-found: error
+  tmca-tester:
+   runs-on: ubuntu-latest
+   steps:  
+     - name: Checkout ${{ github.event.repository.name }}
+       uses: actions/checkout@v3
+     - name: build tmca-tester
+       uses: actions/setup-node@v3
+       with:
+         node-version: '18.x'
+     - run: |
+         cd $GITHUB_WORKSPACE/tmca-tester
+         npm install --force
+         node ./tmca-tester.js  
+  sonar:
+    needs: [jpo-security-svcs, tmca-tester]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout ${{ github.event.repository.name }}
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0   
+      - name: Download code coverage results
+        uses: actions/download-artifact@v3
+        with:
+          name: jpo-security-svcs
+          path: home/runner/work/jpo-security-svcs/jpo-security-svcs/target     
+      - name: Find jacoco.xml
+        shell: bash
+        run: |
+          find "$GITHUB_WORKSPACE" -name "jacoco.xml"                
+      - name: Setup SonarScanner
+        uses: warchant/setup-sonar-scanner@v4
+        with:
+          version: 4.8.0.2856
+      - name: Generate sonar properties file
+        run: |
+          cat <<EOF > /tmp/sonar-scanner.properties
+          sonar.host.url=https://sonarcloud.io
+          sonar.coverage.jacoco.xmlReportPaths=$GITHUB_WORKSPACE/tmca-tester/target/site/jacoco/jacoco.xml
+          sonar.java.binaries=home/runner/work/jpo-security-svcs/jpo-security-svcs/target
+          sonar.projectBaseDir=$GITHUB_WORKSPACE
+          sonar.projectKey=usdot-jpo-ode_jpo-security-svcs
+          sonar.organization=usdot-jpo-ode-1
+          jpo-security-svcs.sonar.projectBaseDir  = home/runner/work/jpo-security-svcs/jpo-security-svcs
+          jpo-security-svcs.sonar.sources         = src
+          tmca-tester.sonar.projectBaseDir=$GITHUB_WORKSPACE /tmca-tester
+          tmca-tester.sonar.sources=.
+          EOF
+      - name: Run SonarScanner
+        uses: usdot-fhwa-stol/actions/sonar-scanner@main
+        with:
+          sonar-properties-path: /tmp/sonar-scanner.properties
+          sonar-token: ${{ secrets.SONAR_TOKEN }}
+          working-dir: $GITHUB_WORKSPACE                 

.github/workflows/docker.yml

@@ -0,0 +1,21 @@
+name: Docker build
+
+on:
+  push:
+    branches-ignore:
+      - "develop"
+      - "master"
+      - "release/*"
+  pull_request:
+
+jobs:
+  jpo-security-svcs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - run: ls -la && pwd 
+      - name: Build
+        uses: docker/build-push-action@v3

.github/workflows/dockerhub.yml

@@ -0,0 +1,27 @@
+name: "DockerHub Build and Push"
+
+on:
+  push:
+    branches:
+      - "develop"
+      - "master"
+      - "release/*"
+
+jobs:
+  dockerhub-jpo-ode:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: usdotjpoode/jpo-security-svcs:${{ github.ref_name }}

.gitignore

@@ -9,4 +9,6 @@
 **.jks
 **.pem
 .env
-**.crt
+**.crt
+.sonar/
+dependency-reduced-pom.xml

LICENSE-2.0.html

@@ -0,0 +1,228 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  <meta charset="utf-8">
+  <title>Apache License, Version 2.0</title>
+</head>
+<body>
+<div class="container">
+  <style type="text/css">
+  /* The following code is added by mdx_elementid.py
+     It was originally lifted from http://subversion.apache.org/style/site.css */
+  /*
+   * Hide class="elementid-permalink", except when an enclosing heading
+   * has the :hover property.
+   */
+  .headerlink, .elementid-permalink {
+    visibility: hidden;
+  }
+  h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }
+  </style>
+  <p>Apache License<br>
+  Version 2.0, January 2004<br>
+  <a href=
+  "http://www.apache.org/licenses/">http://www.apache.org/licenses/</a></p>
+  <p>TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND
+  DISTRIBUTION</p>
+  <p><strong><a name="definitions" id="definitions">1.
+  Definitions</a></strong>.</p>
+  <p>"License" shall mean the terms and conditions for use,
+  reproduction, and distribution as defined by Sections 1 through 9
+  of this document.</p>
+  <p>"Licensor" shall mean the copyright owner or entity authorized
+  by the copyright owner that is granting the License.</p>
+  <p>"Legal Entity" shall mean the union of the acting entity and
+  all other entities that control, are controlled by, or are under
+  common control with that entity. For the purposes of this
+  definition, "control" means (i) the power, direct or indirect, to
+  cause the direction or management of such entity, whether by
+  contract or otherwise, or (ii) ownership of fifty percent (50%)
+  or more of the outstanding shares, or (iii) beneficial ownership
+  of such entity.</p>
+  <p>"You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.</p>
+  <p>"Source" form shall mean the preferred form for making
+  modifications, including but not limited to software source code,
+  documentation source, and configuration files.</p>
+  <p>"Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but not
+  limited to compiled object code, generated documentation, and
+  conversions to other media types.</p>
+  <p>"Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work (an
+  example is provided in the Appendix below).</p>
+  <p>"Derivative Works" shall mean any work, whether in Source or
+  Object form, that is based on (or derived from) the Work and for
+  which the editorial revisions, annotations, elaborations, or
+  other modifications represent, as a whole, an original work of
+  authorship. For the purposes of this License, Derivative Works
+  shall not include works that remain separable from, or merely
+  link (or bind by name) to the interfaces of, the Work and
+  Derivative Works thereof.</p>
+  <p>"Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or
+  additions to that Work or Derivative Works thereof, that is
+  intentionally submitted to Licensor for inclusion in the Work by
+  the copyright owner or by an individual or Legal Entity
+  authorized to submit on behalf of the copyright owner. For the
+  purposes of this definition, "submitted" means any form of
+  electronic, verbal, or written communication sent to the Licensor
+  or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control
+  systems, and issue tracking systems that are managed by, or on
+  behalf of, the Licensor for the purpose of discussing and
+  improving the Work, but excluding communication that is
+  conspicuously marked or otherwise designated in writing by the
+  copyright owner as "Not a Contribution."</p>
+  <p>"Contributor" shall mean Licensor and any individual or Legal
+  Entity on behalf of whom a Contribution has been received by
+  Licensor and subsequently incorporated within the Work.</p>
+  <p><strong><a name="copyright" id="copyright">2. Grant of
+  Copyright License</a></strong>. Subject to the terms and
+  conditions of this License, each Contributor hereby grants to You
+  a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+  irrevocable copyright license to reproduce, prepare Derivative
+  Works of, publicly display, publicly perform, sublicense, and
+  distribute the Work and such Derivative Works in Source or Object
+  form.</p>
+  <p><strong><a name="patent" id="patent">3. Grant of Patent
+  License</a></strong>. Subject to the terms and conditions of this
+  License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have
+  made, use, offer to sell, sell, import, and otherwise transfer
+  the Work, where such license applies only to those patent claims
+  licensable by such Contributor that are necessarily infringed by
+  their Contribution(s) alone or by combination of their
+  Contribution(s) with the Work to which such Contribution(s) was
+  submitted. If You institute patent litigation against any entity
+  (including a cross-claim or counterclaim in a lawsuit) alleging
+  that the Work or a Contribution incorporated within the Work
+  constitutes direct or contributory patent infringement, then any
+  patent licenses granted to You under this License for that Work
+  shall terminate as of the date such litigation is filed.</p>
+  <p><strong><a name="redistribution" id="redistribution">4.
+  Redistribution</a></strong>. You may reproduce and distribute
+  copies of the Work or Derivative Works thereof in any medium,
+  with or without modifications, and in Source or Object form,
+  provided that You meet the following conditions:</p>
+  <ol style="list-style: lower-latin;">
+    <li>You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and</li>
+    <li>You must cause any modified files to carry prominent
+    notices stating that You changed the files; and</li>
+    <li>You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work, excluding
+    those notices that do not pertain to any part of the Derivative
+    Works; and</li>
+    <li>If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute
+    must include a readable copy of the attribution notices
+    contained within such NOTICE file, excluding those notices that
+    do not pertain to any part of the Derivative Works, in at least
+    one of the following places: within a NOTICE text file
+    distributed as part of the Derivative Works; within the Source
+    form or documentation, if provided along with the Derivative
+    Works; or, within a display generated by the Derivative Works,
+    if and wherever such third-party notices normally appear. The
+    contents of the NOTICE file are for informational purposes only
+    and do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed as
+    modifying the License.<br>
+    <br>
+    You may add Your own copyright statement to Your modifications
+    and may provide additional or different license terms and
+    conditions for use, reproduction, or distribution of Your
+    modifications, or for any such Derivative Works as a whole,
+    provided Your use, reproduction, and distribution of the Work
+    otherwise complies with the conditions stated in this
+    License.</li>
+  </ol>
+  <p><strong><a name="contributions" id="contributions">5.
+  Submission of Contributions</a></strong>. Unless You explicitly
+  state otherwise, any Contribution intentionally submitted for
+  inclusion in the Work by You to the Licensor shall be under the
+  terms and conditions of this License, without any additional
+  terms or conditions. Notwithstanding the above, nothing herein
+  shall supersede or modify the terms of any separate license
+  agreement you may have executed with Licensor regarding such
+  Contributions.</p>
+  <p><strong><a name="trademarks" id="trademarks">6.
+  Trademarks</a></strong>. This License does not grant permission
+  to use the trade names, trademarks, service marks, or product
+  names of the Licensor, except as required for reasonable and
+  customary use in describing the origin of the Work and
+  reproducing the content of the NOTICE file.</p>
+  <p><strong><a name="no-warranty" id="no-warranty">7. Disclaimer
+  of Warranty</a></strong>. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or
+  conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
+  FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
+  determining the appropriateness of using or redistributing the
+  Work and assume any risks associated with Your exercise of
+  permissions under this License.</p>
+  <p><strong><a name="no-liability" id="no-liability">8. Limitation
+  of Liability</a></strong>. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect,
+  special, incidental, or consequential damages of any character
+  arising as a result of this License or out of the use or
+  inability to use the Work (including but not limited to damages
+  for loss of goodwill, work stoppage, computer failure or
+  malfunction, or any and all other commercial damages or losses),
+  even if such Contributor has been advised of the possibility of
+  such damages.</p>
+  <p><strong><a name="additional" id="additional">9. Accepting
+  Warranty or Additional Liability</a></strong>. While
+  redistributing the Work or Derivative Works thereof, You may
+  choose to offer, and charge a fee for, acceptance of support,
+  warranty, indemnity, or other liability obligations and/or rights
+  consistent with this License. However, in accepting such
+  obligations, You may act only on Your own behalf and on Your sole
+  responsibility, not on behalf of any other Contributor, and only
+  if You agree to indemnify, defend, and hold each Contributor
+  harmless for any liability incurred by, or claims asserted
+  against, such Contributor by reason of your accepting any such
+  warranty or additional liability.</p>
+  <p>END OF TERMS AND CONDITIONS</p>
+  <h1 id="apply">APPENDIX: How to apply the Apache License to your
+  work<a class="headerlink" href="#apply" title=
+  "Permanent link">¶</a></h1>
+  <p>To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!) The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a file
+  or class name and description of purpose be included on the same
+  "printed page" as the copyright notice for easier identification
+  within third-party archives.</p>
+  <div class="codehilite">
+    <pre>Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+    </pre>
+  </div>
+</div>
+
+</body>
+</html>

README.md

@@ -9,6 +9,8 @@ This module exposes a RESTful API for performing cryptographic functions. The fo
 Note that the cryptographic functions may be carried out against an on-prem instance, or against a remote instance. A local instance is a simplified case and does not require mutual TLS authentication. For the remote signing use case, MTLS will be used to secure the communications. This requires some additional work on the part of configuration, and uses private and public keys to secure the communications between this instance and the remote signing instance.
 ## Mutual TLS Authentication
 For enhanced security, MTLS is used to communicate with a remote signing system. This requires properly configured certificates from the remote system to property perform - work with your remote signing authority to obtain necessary certificates. 
+## Release Notes
+The current version and release history of the Jpo-security-svcs: [Jpo-security-svcs Release Notes](<docs/Release_notes.md>)
 
 ### Certificate Conversion
 Certificates can be in several different formats, including the widely used PEM format. Because this is a Java application, the signing certificates must be in the Java Keystore format to be used. The following commands using [OpenSSL](https://www.openssl.org/) and the Java keytool will convert a PEM file to a Java Keystore file.
@@ -91,4 +93,4 @@ In `./src/main/resources/application.properties` you'll find the following prope
 | sec.cryptoServiceEndpointSignPath | The REST endpoint path of the external service. | /tmc/signtim |SEC_CRYPTO_SERVICE_ENDPOINT_SIGN_PATH|
 | sec.useCertficates | Whether to use certificates or not. | true | SEC_USE_CERTIFICATES |
 | sec.keyStorePath | The path to the keystore file. | /home/cert.jks | SEC_KEY_STORE_PATH |
-| sec.keyStorePassword | The password for the keystore file. | password | SEC_KEY_STORE_PASSWORD |
+| sec.keyStorePassword | The password for the keystore file. | password | SEC_KEY_STORE_PASSWORD |