ci: Protex only scan main

docs: add contributing guidelines

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## PR Checklist
+<!-- Please check if your PR fulfills the following requirements: -->
+
+- [ ] Unit Tests have been added for new changes
+- [ ] API tests have been updated if applicable
+- [ ] All commented code has been removed
+- [ ] If you've added a dependency, you've ensured license is compatible with Apache 2.0 and clearly outlined the added dependency.
+
+
+## What are you changing?
+<!-- Please provide a short description of the updates that are in the PR -->
+
+
+## Anything the reviewer should know when reviewing this PR?
+
+### If the there are associated PRs in other repositories, please link them here (i.e. open-amt-cloud-toolkit/repo#365 )

.github/workflows/build_all.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Create Build Dir
         run: mkdir build
       - name: Clone
-        run: git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+        run: git clone https://github.com/microsoft/vcpkg.git && cd vcpkg && git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
       - name: Build VCPKG
         run: cd vcpkg && bootstrap-vcpkg.bat
         shell: cmd
@@ -71,7 +71,7 @@ jobs:
       - name: Create Build Dir
         run: mkdir build
       - name: Clone
-        run: git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+        run: git clone https://github.com/microsoft/vcpkg.git && cd vcpkg && git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
       - name: Build VCPKG
         run: cd vcpkg && ./bootstrap-vcpkg.sh
         shell: bash

.github/workflows/changelog.yml

@@ -2,7 +2,7 @@ name: Changelog Generator
 
 on:  
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
   workflow_dispatch:
 jobs:
   build:

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ name: Build RPC (Native)
 
 on:
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
    
 env:
   BUILD_TYPE: Release
@@ -21,7 +21,7 @@ jobs:
     - name: Create Build Dir
       run: mkdir build
     - name: Clone
-      run: git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+      run: git clone https://github.com/microsoft/vcpkg.git  && cd vcpkg && git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
     - name: Build VCPKG
       run: cd vcpkg && bootstrap-vcpkg.bat
       shell: cmd
@@ -54,7 +54,7 @@ jobs:
     - name: Create Build Dir
       run: mkdir build
     - name: Clone
-      run: git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+      run: git clone https://github.com/microsoft/vcpkg.git && cd vcpkg && git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
     - name: Build VCPKG
       run: cd vcpkg && ./bootstrap-vcpkg.sh
       shell: bash

.github/workflows/docker-ci.yml

@@ -7,7 +7,7 @@ name: Docker Image CI
 
 on:
   push:
-      branches: [ master ]
+      branches: [ main ]
 jobs:
   build:
     runs-on: ubuntu-latest

Build.md

@@ -25,8 +25,9 @@ sudo apt install git cmake build-essential curl zip unzip tar pkg-config
 Open a Terminal window.
 
 ```
-git clone -b 2020.11-1 https://github.com/microsoft/vcpkg.git
+git clone https://github.com/microsoft/vcpkg.git
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 ./bootstrap-vcpkg.sh
 ./vcpkg install cpprestsdk[websockets]
 ```
@@ -68,8 +69,9 @@ Steps below are for Windows 10 and Visual Studio 2019 Professional.
 Open an x64 Native Tools Command Prompt for Visual Studio 2019.
 
 ```
-git clone -b 2020.11-1 https://github.com/microsoft/vcpkg.git
+git clone https://github.com/microsoft/vcpkg.git
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 bootstrap-vcpkg.bat
 vcpkg install cpprestsdk[websockets]:x64-windows-static
 ```

CHANGELOG.md

@@ -1,3 +1,30 @@
+<a name="v2.0.0"></a>
+## v2.0.0
+
+### Build
+- bump version to v1.3.0
+- bump version to v2.0.0
+
+### Ci
+- update scanning
+
+### Docs
+- **readme:** wording
+- **readme:** update readme
+- **security:** added SECURITY.md file
+
+### Feat
+- update to OpenSSL 1.1.1l
+- update workflows and Docker build.
+- Update to latest vcpkg
+- Update docs and scripts for Windows and Ubuntu.
+- format json status messages
+- add AMT wireless adapter info to amtinfo LAN settings.
+
+### Fix
+- klockwork reported success / failure check fix
+- **spelling:** lan inteface -> lan interface in amtinfo
+
 <a name="v1.2.2"></a>
 ## [v1.2.2] - 2021-06-22
 ### Ci

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required (VERSION 3.1)
 
-project (rpc VERSION 1.2.1)
+project (rpc VERSION 2.0.0)
 
 set (CMAKE_CXX_STANDARD 11)
 

CONTRIBUTING.MD

@@ -0,0 +1,101 @@
+## <a name="commit"></a> Commit Message Guidelines
+
+We have precise rules over how our git commit messages should be formatted. This leads to more readable messages that are easy to follow when looking through the project history.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** with **type** is mandatory.  The **scope** of the header is optional as far as the automated PR checks are concerned, but be advised that PR reviewers **may request** you provide an applicable scope.
+
+Any line of the commit message should no be longer 72 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
+
+The footer should contain a reference to an Azure Boards ticket (e.g. AB#[number]).
+
+Example 1:
+```
+feat(telemetry): Add new MQTT events
+
+Events are now emitted over various /mps topics on MQTT for success/failures 
+as they occur throughout the service.
+
+Resolves: AB#2222
+```
+
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the CI/CD pipeline or build system or external dependencies (example scopes: travis, jenkins, makefile)
+* **ci**: Changes provided by DevOps for CI purposes.
+* **revert**: Reverts a previous commit.
+
+### Scope
+
+Should be one of the following:
+Modules:
+* **common**: A change or addition to the common module
+* **tracker**: A change or addition to the tracker module
+* **server**: A change or addition to the server module
+* **msgs**: A change or addition to msgs module
+* **eval**: Any change to benchmark tools
+* **deps**: A change to any dependency or 3rd-party library
+* **all**: A change that affects all modules
+* *no scope*:  If no scope is provided, it is assumed the PR does not apply to the above scopes
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+Here is detailed guideline on how to write the body of the commit message ([Reference](https://chris.beams.io/posts/git-commit/)):
+```
+More detailed explanatory text, if necessary. Wrap it to about 72
+characters or so. In some contexts, the first line is treated as the
+subject of the commit and the rest of the text as the body. The
+blank line separating the summary from the body is critical (unless
+you omit the body entirely); various tools like `log`, `shortlog`
+and `rebase` can get confused if you run the two together.
+
+Explain the problem that this commit is solving. Focus on why you
+are making this change as opposed to how (the code explains that).
+Are there side effects or other unintuitive consequences of this
+change? Here's the place to explain them.
+
+Further paragraphs come after blank lines.
+
+ - Bullet points are okay, too
+
+ - Typically a hyphen or asterisk is used for the bullet, preceded
+   by a single space, with blank lines in between, but conventions
+   vary here
+```
+
+### Footer
+
+The footer should contain a reference to JIRA ticket (e.g. SL6-0000) that this commit **Closes** or **Resolves**.
+The footer should contain any information about **Breaking Changes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+
+
+### Pull Requests practices
+
+* PR author is responsible to merge its own PR after review has been done and CI has passed.
+* When merging, make sure git linear history is preserved. PR author should select a merge option (`Rebase and merge` or `Squash and merge`) based on which option will fit the best to the git linear history.
+* PR topic should follow the same guidelines as the header of the [Git Commit Message](#commit-message-format)

CentOS7.md

@@ -50,8 +50,9 @@ export PATH=/home/user/Downloads/git:$PATH
 Using a Terminal window with the PATH and devtoolset enabled per the Dependencies.
 
 ```
-git clone -b 2020.11-1 https://github.com/microsoft/vcpkg.git
+git clone https://github.com/microsoft/vcpkg.git
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 ./bootstrap-vcpkg.sh
 ./vcpkg install cpprestsdk[websockets]
 ```

CentOS8.md

@@ -28,8 +28,9 @@ sudo yum install cmake
 Using a Terminal window with the PATH and devtoolset enabled per the Dependencies.
 
 ```
-git clone -b 2020.11-1 https://github.com/microsoft/vcpkg.git
+git clone https://github.com/microsoft/vcpkg.git
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 ./bootstrap-vcpkg.sh
 ./vcpkg install cpprestsdk[websockets]
 ```

Dockerfile

@@ -15,7 +15,7 @@ RUN \
 RUN git clone https://github.com/open-amt-cloud-toolkit/rpc.git
 WORKDIR /rpc
 RUN mkdir -p build
-RUN git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+RUN git clone https://github.com/microsoft/vcpkg.git && cd vcpkg && git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 RUN cd vcpkg && ./bootstrap-vcpkg.sh
 RUN ./vcpkg/vcpkg install cpprestsdk[websockets]
 

Jenkinsfile

@@ -24,6 +24,11 @@ pipeline {
                 PROJECT_NAME               = 'OpenAMT - RPC'
                 SCANNERS                   = 'protex'
             }
+            when {
+                anyOf {
+                    branch 'main';
+                }
+            }
             steps {
                 rbheStaticCodeScan()
             }
@@ -151,4 +156,4 @@ pipeline {
             }
         }
     }
-}
+}

README.md

@@ -27,7 +27,7 @@ We leverage GitHub Actions as a means to build RPC automatically leveraging Gith
 
 3. Click the **Run Workflow** dropdown. 
 
-4. Select the **Branch: master**, or a preferred version, from the **Use workflow from** dropdown. 
+4. Select the **Branch: main**, or a preferred version, from the **Use workflow from** dropdown. 
 
 5. By default, the Build Type should be **release**.  
 

info.cpp

@@ -273,7 +273,7 @@ bool info_get_lan_interface_settings()
     bool hasWired = cmd_get_lan_interface_settings(tmp);
     if (hasWired)
     {
-        out_text("LAN Inteface", "wired");
+        out_text("LAN Interface", "wired");
         out_text("DHCP Enabled", (tmp.dhcp_enabled) ? "true" : "false");
         out_text("DHCP Mode", (tmp.dhcp_mode == 1) ? "active" : "passive");
         out_text("Link Status", (tmp.link_status) ? "up" : "down");
@@ -291,7 +291,7 @@ bool info_get_lan_interface_settings()
     bool hasWireless = cmd_get_lan_interface_settings(tmp, false);
     if (hasWireless)
     {
-        out_text("LAN Inteface", "wireless");
+        out_text("LAN Interface", "wireless");
         out_text("DHCP Enabled", (tmp.dhcp_enabled) ? "true" : "false");
         out_text("DHCP Mode", (tmp.dhcp_mode == 1) ? "active" : "passive");
         out_text("Link Status", (tmp.link_status) ? "up" : "down");
@@ -368,4 +368,4 @@ bool info_get_verify(const std::string info)
     }
 
     return false;
-}
+}

main.cpp

@@ -7,6 +7,7 @@
 #include <thread>
 #include <cpprest/ws_client.h>
 #include <cpprest/json.h>
+#include <algorithm>
 #include "port.h"
 #include "lms.h"
 #include "commands.h"
@@ -271,7 +272,22 @@ int main(int argc, char* argv[])
                 g_timeout_val = 0;
 
                 // exit
-                std::cout << std::endl << msgMessage << std::endl;
+                try {
+                    std::cout << std::endl;
+                    utility::string_t tmp = utility::conversions::convertstring(msgMessage);
+                    web::json::value parsed = web::json::value::parse(tmp);
+                    for (const auto& obj : parsed.as_object()) {
+                        std::string key = utility::conversions::to_utf8string(obj.first);
+                        std::string value = utility::conversions::to_utf8string(obj.second.serialize());
+                        value.erase(std::remove(value.begin(), value.end(), '"'), value.end());
+                        std::cout << key << ": " << value << std::endl;
+                    }
+                }
+                catch (...)
+                {
+                    std::cout << std::endl << msgMessage << std::endl;
+                }
+
                 return;
             }
             else if (msgStatus.compare("failed")==0)
@@ -280,7 +296,22 @@ int main(int argc, char* argv[])
                 g_timeout_val = 0;
 
                 // exit
-                std::cout << std::endl << msgMessage << std::endl;
+                try {
+                    std::cout << std::endl;
+                    utility::string_t tmp = utility::conversions::convertstring(msgMessage);
+                    web::json::value parsed = web::json::value::parse(tmp);
+                    for (const auto& obj : parsed.as_object()) {
+                        std::string key = utility::conversions::to_utf8string(obj.first);
+                        std::string value = utility::conversions::to_utf8string(obj.second.serialize());
+                        value.erase(std::remove(value.begin(), value.end(), '"'), value.end());
+                        std::cout << key << ": " << value << std::endl;
+                    }
+                }
+                catch (...)
+                {
+                    std::cout << std::endl << msgMessage << std::endl;
+                }
+
                 return;
             }
 

scripts/jenkins-pre-build.cmd

@@ -15,8 +15,9 @@ set VCPKG_DIR=C:\opt\vcpkg-source
 cd %VCPKG_DIR%
 
 REM build vcpkg
-git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git
+git clone https://github.com/microsoft/vcpkg.git
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 cmd /c bootstrap-vcpkg.bat
 
 REM install CPPRestSDK

scripts/jenkins-pre-build.sh

@@ -12,8 +12,9 @@ apt install git cmake build-essential curl zip unzip tar pkg-config -y
 
 #cd "$BASE_DIR"/rpc
 ## build vcpkg
-git -C vcpkg pull || git clone --branch 2020.11-1 https://github.com/microsoft/vcpkg.git vcpkg
+git -C vcpkg pull || git clone https://github.com/microsoft/vcpkg.git vcpkg
 cd vcpkg
+git checkout 772d435ba18bf2f342458e0187ab7b48b84fe3f0
 ./bootstrap-vcpkg.sh
 
 ## install CPPRestSDK