BeVigil CI Plugin

[ashikka]

Repository URL

https://github.com/Bevigil/BeVigil-CI-plugin

New Repository Name

bevigil-ci-plugin

Description

BeVigil-Plugin

Introduction

This is a plugin to scan Android and ioS applications in your jenkins pipelines using CloudSek BeVigil. BeVigil can analyze code at scale and easily search for API keys, regexes, etc to see the matches in different files of an application.

Getting started

The BeVigil-CI plugin is intended to be used as an additional step in build pipelines that already build android or ios apps. In this section, we will asume that you already have a pipeline running to build your application.

Installing the plugin

To use this plugin, you need to install it in your Jenkins installation. To do this, first login to your jenkins server, and click on "Manage Plugins" on the Manage Jenkins page:

Next, navigate to the available tab, and search for the "BeVigil VI" plugin. Click the checkbox next the plugin, and then click on "Install without Restart" to install the plugin.

Using the plugin in your jenkins build

1. Add a build step which uses the plugin on your Jenkins CI Build Pipeline:
   
   

   

2. Now, configure the following information about your app on the build step:
   
   

   

• API KEY: Your BeVigil API Key
• App Type: Select Android/ioS
• App Path: This is the path to your built app relative to the root of your jenkins workspace.
• Package Name: Enter the package name for your application
• Scan Timeout: This the time (in minutes) after which the scan will timeout on the plugin.
• Severity Threshold: This tells BeVigil to set a threshold for the vulnerabilities:
  • Low: This includes low, medium and high vulnerabilities
  • Medium: This includes medium and high vulnerabilities
  • High: This includes only high vulnerabilities

3. Save your build step, and start a new build. If all goes well, the plugin should print the report to stdout.

How the plugin works

Mobile applications are often full of security issues which when not identified can cost organizations a lot. This plugin helps to identify potential security vulnerabilities in the code. By running a scan during the build process, developers can catch and fix vulnerabilities early on, which can help to prevent security breaches and protect the integrity of the application. The plugin can be easily configured making it a valuable tool for any organization that values security.

The plugin recieves an AWS presigned URL where it uploaded the build file of the app after reading it. After uploading the file successfully, the file is scanned using BeVigil's API for vulnerabilites. Finally, we get the output for the scan.

Output

Issues

Report issues and enhancements in the Jenkins issue tracker.

Contributing

Refer to our contribution guidelines

LICENSE

Licensed under MIT, see LICENSE

GitHub users to have commit permission

@ashikka

Jenkins project users to have release permission

ashikka

Issue tracker

GitHub issues

[jenkins-cert-app]

Security audit, information and commands

The security team is auditing all the hosting requests, to ensure a better security by default. This message informs you that the security team was notified about the request and will soon participate in this issue to assist. The team is usually starting by a quick superficial audit and if it's not sufficient, they are planning a deeper audit.

Commands

Security team only:

• /audit-ok => the audit is complete, the hosting can continue :tada:.
• /audit-skip => the audit is not necessary, the hosting can continue :tada:.
• /audit-required => the superficial audit was not sufficient, a deeper look is necessary :mag:.
• /audit-findings => the audit reveals some issues that require corrections :pencil2:.

Anyone:

• /audit-review => the findings from the audits were corrected, this command will ping the security team to review the findings :eyes:. It's only applicable when the previous audit required changes.

Only one command can be requested per comment.

(automatically generated message)

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: Your baseline specified does not meet the minimum Jenkins version required, please update <jenkins.version>2.332.4</jenkins.version> to at least 2.361.4 in your pom.xml. Take a look at the baseline recommendations.
• :no_entry: Required: The parent pom version '4.51' should be at least '4.52' or higher.
• :no_entry: Required: The 'artifactId' from the pom.xml (bevigil-ci-plugin) is incorrect, it should be BeVigil-CI ('New Repository Name' field with "-plugin" removed)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[ashikka]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The 'artifactId' from the pom.xml (bevigil-ci) is incorrect, it should be BeVigil-CI ('New Repository Name' field with "-plugin" removed)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[ashikka]

@NotMyFault should I stick with the lowercase name even though the bot is asking me to change it to BeVigil-CI?

[Kevin-CB]

Quick look at the code, we'll perform a more complete security audit, tracked internally as JENSEC-1921.

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A human volunteer will check over things that I am not able to check for (code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[NotMyFault]

@ashikka I fixed it for you. Repository names should be all lowercase.

[NotMyFault]

Hey @ashikka,

I took a quick glance over your repository setup and noticed the following:

• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/pom.xml#L51 the bom version should match your baseline, use bom-2.361.x
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/pom.xml#L58-L82 seems to be redundant, there are no imports of these plugins. I'd recommend removing all dependencies you don't need.
• ~~https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/pom.xml#L83-L99 instead of shading jackson components, you can depend on the corresponding Jenkins plugin: https://plugins.jenkins.io/jackson2-api/#dependencies provides the API and reduces your file size~~
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/pom.xml#L114-L133 is obsolete, you don't need to configure that.
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/main/SECURITY.md should be deleted. The Jenkins project uses an organization wide disclosure policy, applied automatically to all repositories.
• https://github.com/Bevigil/Bevigil-CI-Plugin#issues you link the Jenkins issue tracker in your README, but reference GitHub issues as tracker in this hosting request. If you plan to use GH as tracker, I'd recommend on changing the readme entry.
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/.github/workflows/release-drafter.yml#L7 can be removed. Your default branch is named main
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/.github/workflows/release-drafter.yml#L15 to keep dependabot noise down, you can pin this entry to @v5
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/main/.github/CODEOWNERS is not correct. This should be

• @jenkinsci/bevigil-ci-plugin-developers

• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/.github/release-drafter.yml#L2 see the point above for the correct name. This tag template is incorrect.
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/src/main/resources/index.jelly#L3 please fill this out. This is displayed at the update center.
• I can spot various SpotBugs violations. If you're building the plugin locally, check via mvn clean verify to see the exact locations and obtain more details if you address them.
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/416c938429af1cfa70c8ef24c3e36515a22f857c/src/main/resources/io/jenkins/plugins/bevigilciplugin/BeVigilCIBuilder/config.jelly#L6-L11 for simple dropdowns, I recommend looking into the second sample on https://weekly.ci.jenkins.io/design-library/Select/
• https://github.com/Bevigil/Bevigil-CI-Plugin/tree/main/src/main/resources/io/jenkins/plugins/bevigilciplugin I recommend deleting all _languagecode files, if they don't actually translate Messages.properties

[yaroslavafenkin]

Hey @ashikka,

• ~~https://github.com/Bevigil/Bevigil-CI-Plugin/blob/237c569936c4bffe2e685a8707ad2b059013f336/src/main/java/io/jenkins/plugins/bevigilciplugin/BeVigilCIBuilder.java#L27 would result in API key stored as plain text on disk. We recommend you use Secret type instead. Reference docs: https://www.jenkins.io/doc/developer/security/secrets/#storing-secrets-on-disk~~
• ~~https://github.com/Bevigil/Bevigil-CI-Plugin/blob/237c569936c4bffe2e685a8707ad2b059013f336/src/main/resources/io/jenkins/plugins/bevigilciplugin/BeVigilCIBuilder/config.jelly#L3-L5 would result in API key being displayed unmasked in Jenkins UI. We recommend you use <f:password /> instead. Reference docs: https://www.jenkins.io/doc/developer/security/secrets/#secrets-and-configuration-forms~~
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/237c569936c4bffe2e685a8707ad2b059013f336/src/main/java/io/jenkins/plugins/bevigilciplugin/BeVigilCIBuilder.java#L76-L79 allows escaping workspace context by providing relative path in appPath. You should probably check whether File's canonical path is not outside the workspace.
• https://github.com/Bevigil/Bevigil-CI-Plugin/blob/237c569936c4bffe2e685a8707ad2b059013f336/src/main/java/io/jenkins/plugins/bevigilciplugin/BeVigilCIBuilder.java#L127. We recommend you to not shut down whole JVM if your build step fails 🙂.

We'll let you correct those and let us know when you're done for another round of review.

[ashikka]

Hello @yaroslavafenkin @NotMyFault, thank you for your review. I have corrected all the points you have mentioned and you can proceed with another round of review.

[ashikka]

Hi @yaroslavafenkin @NotMyFault , just following up. Did you get a chance to check out the changes?

[NotMyFault]

I've struck through my points, thanks.

[yaroslavafenkin]

Hi @ashikka,

Third point is not fully addressed. Checking for absolute path is not enough as it does not grant protection against symlinks. Refer to https://docs.oracle.com/javase/7/docs/api/java/io/File.html#getCanonicalPath(). Other corrections seem to be fine, crossed those points out.

[yaroslavafenkin]

/audit-findings

[ashikka]

Hello @yaroslavafenkin,

I have made the correction. Please check.

[yaroslavafenkin]

Re-checked, seems fine now.

[yaroslavafenkin]

/audit-ok

[timja]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A human volunteer will check over things that I am not able to check for (code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[timja]

/hosting host

[jenkins-infra-bot]

Hosting request complete, the code has been forked into the jenkinsci project on GitHub as https://github.com/jenkinsci/bevigil-ci-plugin

GitHub issues has been selected for issue tracking and was enabled for the forked repo.

A pull request has been created against the repository permissions updater to setup release permissions. Additional users can be added by modifying the created file.

Please delete your original repository (if there are no other forks), under 'Danger Zone', so that the jenkinsci organization repository is the definitive source for the code. If there are other forks, please contact GitHub support to make the jenkinsci repo the root of the fork network (mention that Jenkins approval was given in support request 569994). Also, please make sure you properly follow the documentation on documenting your plugin so that your plugin is correctly documented.

You will also need to do the following in order to push changes and release your plugin:

• Accept the invitation to the Jenkins CI Org on Github
• Add additional users for upload permissions, if needed
• Releasing your plugin

In order for your plugin to be built by the Jenkins CI Infrastructure and check pull requests, please add a Jenkinsfile to the root of your repository with the following content: buildPlugin(useContainerAgent: true, jdkVersions: [8, 11])

Welcome aboard!