Merge pull request #24 from oracle-devrel/adm

adm checks

Author: RahulMR42

oci-build-examples/README.md

@@ -18,8 +18,10 @@ All about OCI devops build samples ..
 <details>
   <summary>Security & Quality - click to expand</summary>
 
-* [Integrate sonarqube with OCI devops build runner.](./oci_buildrunner_with_sonarqube/)
 * [Container image scanning  before deploy.](./oci_imagescan_before_deploy/)
+* [Integrate sonarqube with OCI devops build runner.](./oci_buildrunner_with_sonarqube/)
+* [Scanning code for vulnerabilities for Maven packages](./oci-devops-vulnerability-audit-management)
+
 
 </details>
 

oci-build-examples/oci-devops-vulnerability-audit-management/.gitignore

@@ -0,0 +1,2 @@
+.idea
+**.DS_Store

oci-build-examples/oci-devops-vulnerability-audit-management/Dockerfile

@@ -0,0 +1,25 @@
+# Maven build container 
+
+FROM maven:3.8.5-openjdk-11 AS maven_build
+
+COPY pom.xml /tmp/
+
+COPY src /tmp/src/
+
+WORKDIR /tmp/
+
+RUN --mount=type=cache,target=/root/.m2 mvn package
+
+#pull base image
+
+FROM openjdk
+
+#expose port 8080
+EXPOSE 8080
+
+#default command
+CMD java -jar /data/hello-world-0.1.0.jar
+
+#copy hello world to docker image from builder image
+
+COPY --from=maven_build /tmp/target/hello-world-0.1.0.jar /data/hello-world-0.1.0.jar

oci-build-examples/oci-devops-vulnerability-audit-management/README.md

@@ -0,0 +1,180 @@
+A sample illustration of Code Vulnerabilities for Maven packages
+------
+
+The Application Dependency Management (ADM) service provides you with an integrated vulnerability knowledge base that you can use from the Oracle Cloud Infrastructure (OCI) DevOps build pipelines to detect vulnerabilities in the packages used for the build.
+
+
+Objective
+---
+
+- Create an OCI build pipeline with a sample java - maven-based application.
+- Instantiate a vulnerability scan and demonstrate success and failure conditions.
+
+* Specific instruction to clone only this example.
+
+   ```
+   $ git init oci-devops-vulnerability-audit-management
+   $ cd oci-devops-vulnerability-audit-management
+   $ git remote add origin <url to this git repo>
+   $ git config core.sparsecheckout true
+   $ echo "oci-build-examples/oci-devops-vulnerability-audit-management/*">>.git/info/sparse-checkout
+   $ git pull --depth=1 origin main
+
+   ```
+
+Procedure to use the illustration
+-------
+- Create an OCI notification topic - https://docs.oracle.com/en-us/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createTopic
+- Create a DevOps project - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_project.htm#create_a_project.
+- Associate with the notification topic.
+
+![](images/oci_devops_project.png)
+
+- Enable the logging for the DevOps project.
+
+![](images/oci_devops_logs.png)
+
+
+- Create an OCI Dynamic group and add the below rules. - https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm
+
+```markdown
+ALL {resource.type = 'devopsbuildpipeline', resource.compartment.id = 'COMPARMENT OCID'}
+
+ALL {resource.type = 'devopsrepository', resource.compartment.id = 'COMPARMENT OCID'}
+```
+
+- Create an OCI policy and add the below policies - https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policies.htm
+
+```markdown
+Allow dynamic-group "NAME OF THE DynamicGroup" to manage repos in compartment "COMPARTMENT NAME"
+Allow dynamic-group  "NAME OF THE DynamicGroup" to use ons-topics in compartment "COMPARTMENT NAME"
+```
+
+- Follow the below steps and create  a knowledge base - https://docs.oracle.com/en-us/iaas/Content/application-dependency-management/concepts/getting-started.htm
+
+- In the `Oracle Cloud Console`, open the navigation menu, and click `Developer Services`. Under `Application Dependency Management`, click `Knowledge Bases`.
+- Click Create Knowledge Base. You are prompted to enter information to describe the new knowledge base.
+- Enter the following information:
+  - Name: Give the knowledge base a name. For example, "Sample Knowledge Base".
+  - Create in Compartment: Select the compartment from the compartment drop-down list.
+  - (Optional) Provide a list of one or more unique tag key-value pairs to describe the knowledge base.
+
+![](images/oci_kb.png)
+- Make a note of the `Knowledge base OCID`.
+
+![](images/oci_kb_ocid.png)
+
+- Switch back to `OCI DevOps Project ` and create an OCI Code repo - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_repo.htm#create_repo
+
+![](images/oci_repo.png)
+
+- Push the content to OCI Code repo - https://docs.oracle.com/en-us/iaas/Content/devops/using/clone_repo.htm
+
+- You may use other support version control repos as well (like Github.com,Bitbucket.com, Bitbucket Cloud etc). You may also need to adjust the policies according to connection and setup external connections accordingly - https://docs.oracle.com/en-us/iaas/Content/devops/using/create_connection.htm
+
+- Create a new build pipeline. -  https://docs.oracle.com/en-us/iaas/Content/devops/using/create_buildpipeline.htm
+
+![](images/oci_new_buildpipeline.png)
+
+- Under the build pipeline, add below `Parameters`
+
+```markdown
+VA_COMPARTMENT_OCID - Add the Compartment OCID as the default value.
+KB_OCID - Add the OCID of the knowledge base as the default value
+```
+
+![](images/oci_build_param.png)
+
+- Under the `Build pipeline` tab click `+` and add a `Managed Build` stage.
+
+![](images/oci_build_managedbuild_stage.png)
+
+- Add necessary details.
+
+![](images/oci_build_stage_1.png)
+
+- Click `Select` under `primary code repository` and associate with the code repo created.
+- You can give any name as `source name`
+
+![](images/oci_buildstage_primary_repo.png)
+
+- Keep all other values by default.
+- Before we do the test, let us see what is with in the managed build, the instructions are defined under the [build_spec.yaml](build_spec.yaml) file.
+
+  - `VulnerabilityAudit` is the step where we are assessing the application dependencies against the knowledge base and based on the  `maxPermissibleCvssV2Score` and `maxPermissibleCvssV3Score` values marking its success or failure.
+
+```markdown
+- type: VulnerabilityAudit
+    name: "Vulnerability Audit Step"
+    configuration:
+      buildType: maven
+      pomFilePath: ${OCI_PRIMARY_SOURCE_DIR}/pom.xml
+      maxPermissibleCvssV2Score: 6.0
+      maxPermissibleCvssV3Score: 7.0
+    knowledgeBaseId: ${KB_OCID}
+    vulnerabilityAuditCompartmentId: ${VA_COMPARTMENT_OCID}
+    vulnerabilityAuditName: build_sample_${OCI_PRIMARY_SOURCE_SOURCE_BRANCH_NAME}
+```
+- Only if it's successful it will do the further steps as a docker image build.
+
+Let's test
+------------
+
+- Switch to `Build pipeline` and click on `Start manual run`
+- Wait for all the build steps to end, at this run, it will be successful.
+
+![](images/oci_buildrun_ok.png)
+
+- The execution is successful as we set the CvvsV2Score as 6 and CvssV3Score as 7 . To validate the dependency vulnerability scanning repo, switch to the `knowledge base` >`Vulnerability Audits` tab.
+
+![](images/oci_kb_audit_1.png)
+
+- Click and view the details against the `audit run`.
+
+![](images/oci_kb_audit_2.png)
+
+- Change the file [build_spec.yaml](build_spec.yaml) and update `maxPermissibleCvssV2Score` as `2.0` and `maxPermissibleCvssV3Score` as `3.0` .
+
+```markdown
+
+- type: VulnerabilityAudit
+    name: "Vulnerability Audit Step"
+    configuration:
+      buildType: maven
+      pomFilePath: ${OCI_PRIMARY_SOURCE_DIR}/pom.xml
+      maxPermissibleCvssV2Score: 2.0
+      maxPermissibleCvssV3Score: 3.0
+    knowledgeBaseId: ${KB_OCID}
+    vulnerabilityAuditCompartmentId: ${VA_COMPARTMENT_OCID}
+    vulnerabilityAuditName: build_sample_${OCI_PRIMARY_SOURCE_SOURCE_BRANCH_NAME}
+```
+- Push the changed file back to `OCI Code repo` and re-run the `Build pipeline` using the `Start manual run` option.
+
+- The build run will fail at the steps `Vulnerability Audit Step`.
+
+![](images/oci_buildrun_failed.png)
+
+- To validate the dependency vulnerability scanning repo, switch to the `knowledge base` >`Vulnerability Audits` tab.
+
+![](images/oci_kb_failed.png)
+
+![](images/oci_kb_failed_details.png)
+
+Read more
+---
+
+- OCI Devops service - https://docs.oracle.com/en-us/iaas/Content/devops/using/home.htm 
+
+Contributors
+===========
+
+- Author: Rahul M R.
+- Collaborators: Doug Clarke.
+- Last release: June 2022
+
+### Back to examples.
+----
+
+- 🍿 [Back to OCI Devops Build sample](./../README.md)
+- 🏝️ [Back to OCI Devops sample](./../../README.md)
+

oci-build-examples/oci-devops-vulnerability-audit-management/build_spec.yaml

@@ -0,0 +1,39 @@
+version: 0.1
+component: build
+timeoutInSeconds: 1000
+shell: bash
+env:
+  # these are local variables to the build config
+  variables:
+
+  # exportedVariables are made available to use as parameters in sucessor Build Pipeline stages
+  # For this Build to run, the Build Pipeline needs to have a BUILDRUN_HASH parameter set
+  exportedVariables:
+    # To export variables/
+
+steps:
+  - type: VulnerabilityAudit
+    name: "Vulnerability Audit Step"
+    configuration:
+      buildType: maven
+      pomFilePath: ${OCI_PRIMARY_SOURCE_DIR}/pom.xml
+      maxPermissibleCvssV2Score: 6.0
+      maxPermissibleCvssV3Score: 7.0
+    knowledgeBaseId: ${KB_OCID}
+    vulnerabilityAuditCompartmentId: ${VA_COMPARTMENT_OCID}
+    vulnerabilityAuditName: build_sample_${OCI_PRIMARY_SOURCE_SOURCE_BRANCH_NAME}
+  - type: Command
+    name: "Docker build"
+    command: |
+      docker  build -t "hello-world-java" .
+      echo "DONE"
+    onFailure:
+      - type: Command
+        command: |
+          echo "Handling Failure"
+          build_result=FAILURE
+          echo "Failure successfully handled"
+# outputArtifacts:
+#  - name: Build_output_image
+#    type: DOCKER_IMAGE
+#    location: "hello-world-java"