JAR-Scanner

Be compliant with the licenses of your 3rd Party JARs.
Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • OS Compatibility
• Getting Started
• JAR-Scanner Configuration
• Run Scan
• Sample JAR-Scanner Report
• JAR-Scanner v1.0 Demo
• Contribution
• License
• Contact

About The Project

JAR-Scanner v1.0 is a python CLI based tool performing the analysis of all the JARs which are bundled as part of the product release. The main objective of this tool is to find the 3rd party JARs in the project and check if the license has been procured or not. It is done by comparing all the jars with the existing License document which contains the list JARs with already procured licenses. The tool will also project the JARs which are no longer used in the project.

Built With

OS Compatibility

• Windows
• Linux (x64)

Getting Started

To get this project in your system, follow the below steps:

1. Clone the repo

git clone https://github.com/nishantarora94/jar-scanner.git

2. You are good to go.

JAR-Scanner Configuration

Bucket – Folder for all the WAR, EAR, ZIP files extracted by the tool.
Requisite – Folder for CSV files containing list of proprietary JARs and 3rd party pre-approved JARs.
License.csv – The list of 3rd party JARs which are part of the product release and for which license has been procured.
suppression_jars.csv – The list of proprietary JARs which are suppressed during the scan.
Report – Folder for output report.
venv – To keep dependencies separate and creating python virtual environment.

Run Scan

Run the below command to initiate the command:

python jar-scanner.py

Sample JAR-Scanner Report

What are the tabs in the report all about?

3rd Party Jars: All the 3rd party JARs which are currently part of the scanned project.
New Jars: All the JARs which have been newly added to the project and are not part of the suppression_jars CSVor License CSV list.
Upgraded Jars: All the 3rd party JARs which are part of the License CSV document but the JAR version has been upgraded.
Unutilized Jars: All the 3rd party jars which are part of the License CSV document but are not being utilized in the scanned project currently.

JAR-Scanner v1.0 Demo

Contribution

Your contribution can make a huge difference. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/<Branch_Name>)
3. Commit your Changes (git commit -m 'ADD COMMIT MESSAGE)
4. Push to the Branch (git push origin feature/<Branch_Name>)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Nishant Arora - LinkedIn - [email protected]

Project Link: https://github.com/nishantarora94/jar-scanner