scanoss 0.15.6 → 0.16.0

package/CHANGELOG.md

@@ -2,92 +2,58 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [0.15.2](https://github.com/scanoss/scanoss.js/compare/v0.15.1...v0.15.2) (2024-08-29)
-
-### [0.15.1](https://github.com/scanoss/scanoss.js/compare/v0.15.0...v0.15.1) (2024-08-27)
-
-### [0.15.0](https://github.com/scanoss/scanoss.js/compare/v0.14.1...v0.15.0) (2024-07-28)
-
-### [0.14.1](https://github.com/scanoss/scanoss.js/compare/v0.14.0...v0.14.1) (2024-06-05)
-
-### [0.14.0](https://github.com/scanoss/scanoss.js/compare/v0.13.2...v0.14.0) (2024-05-23)
-
-### [0.13.2](https://github.com/scanoss/scanoss.js/compare/v0.13.1...v0.13.2) (2024-05-20)
-
-### [0.13.1](https://github.com/scanoss/scanoss.js/compare/v0.13.0...v0.13.1) (2024-05-15)
-
-### [0.13.0](https://github.com/scanoss/scanoss.js/compare/v0.12.2...v0.13.0) (2024-05-13)
-
-### [0.12.2](https://github.com/scanoss/scanoss.js/compare/v0.12.0...v0.12.2) (2024-05-10)
-
-### [0.12.0](https://github.com/scanoss/scanoss.js/compare/v0.11.5...v0.12.0) (2024-05-06)
-
-### [0.11.5](https://github.com/scanoss/scanoss.js/compare/v0.11.4...v0.11.5) (2024-04-19)
-
-### [0.11.4](https://github.com/scanoss/scanoss.js/compare/v0.11.3...v0.11.4) (2024-04-02)
-
-### [0.11.3](https://github.com/scanoss/scanoss.js/compare/v0.11.2...v0.11.3) (2024-01-09)
-
-### [0.11.2](https://github.com/scanoss/scanoss.js/compare/v0.11.1...v0.11.2) (2024-01-09)
-
-### [0.11.1](https://github.com/scanoss/scanoss.js/compare/v0.11.0...v0.11.1) (2024-01-09)
-
-### [0.11.0](https://github.com/scanoss/scanoss.js/compare/v0.10.5...v0.11.0) (2024-01-04)
-
-### [0.10.5](https://github.com/scanoss/scanoss.js/compare/v0.10.4...v0.10.5) (2023-12-29)
-
-### [0.10.4](https://github.com/scanoss/scanoss.js/compare/v0.10.3...v0.10.4) (2023-12-28)
-
-### [0.10.3](https://github.com/scanoss/scanoss.js/compare/v0.10.2...v0.10.3) (2023-12-22)
-
-### [0.10.2](https://github.com/scanoss/scanoss.js/compare/v0.10.1...v0.10.2) (2023-12-19)
-
-### [0.10.1](https://github.com/scanoss/scanoss.js/compare/v0.10.0...v0.10.1) (2023-11-22)
-
-### [0.10.0](https://github.com/scanoss/scanoss.js/compare/v0.9.2...v0.10.0) (2023-11-22)
-
-### [0.9.3](https://github.com/scanoss/scanoss.js/compare/v0.9.2...v0.9.3) (2023-10-20)
-
-### [0.9.2](https://github.com/scanoss/scanoss.js/compare/v0.9.1...v0.9.2) (2023-10-09)
-
-### [0.9.1](https://github.com/scanoss/scanoss.js/compare/v0.9.0...v0.9.1) (2023-05-18)
-
-### [0.9.0](https://github.com/scanoss/scanoss.js/compare/v0.8.7...v0.9.0) (2023-04-19)
-
-### [0.8.8](https://github.com/scanoss/scanoss.js/compare/v0.8.7...v0.8.8) (2023-04-16)
-
-### [0.8.7](https://github.com/scanoss/scanoss.js/compare/v0.8.6...v0.8.7) (2023-04-12)
-
-### [0.8.6](https://github.com/scanoss/scanoss.js/compare/v0.8.5...v0.8.6) (2023-03-28)
-
-### [0.8.5](https://github.com/scanoss/scanoss.js/compare/v0.8.0...v0.8.5) (2023-03-17)
-
-### [0.8.0](https://github.com/scanoss/scanoss.js/compare/v0.7.8...v0.8.0) (2023-02-20)
-
-### [0.7.8](https://github.com/scanoss/scanoss.js/compare/v0.4.0...v0.7.8) (2023-01-25)
-
-### [0.4.0](https://github.com/scanoss/scanoss.js/compare/v0.4.0-beta...v0.4.0) (2022-09-30)
-
-### [0.4.0-beta](https://github.com/scanoss/scanoss.js/compare/v0.4.0-alpha.0...v0.4.0-beta) (2022-08-31)
-
-### [0.4.0-alpha.0](https://github.com/scanoss/scanoss.js/compare/v0.3.0...v0.4.0-alpha.0) (2022-08-19)
-
-### [0.3.0](https://github.com/scanoss/scanoss.js/compare/v0.2.18...v0.3.0) (2022-07-02)
-
-### [0.2.18](https://github.com/scanoss/scanoss.js/compare/v0.2.16...v0.2.18) (2022-02-23)
-
-### [0.2.16](https://github.com/scanoss/scanoss.js/compare/v0.2.14...v0.2.16) (2022-02-14)
-
-### [0.2.14](https://github.com/scanoss/scanoss.js/compare/v0.2.10...v0.2.14) (2022-02-09)
-
-### [0.2.10](https://github.com/scanoss/scanoss.js/compare/v0.2.8...v0.2.10) (2022-01-11)
-
-### [0.2.8](https://github.com/scanoss/scanoss.js/compare/v0.2.6...v0.2.8) (2022-01-10)
-
-### [0.2.6](https://github.com/scanoss/scanoss.js/compare/v0.2.4...v0.2.6) (2022-01-06)
-
-### [0.2.4](https://github.com/scanoss/scanoss.js/compare/v0.2.2...v0.2.4) (2022-01-05)
-
-### 0.2.2 (2021-12-30)
+## [0.16.0] (2025-04-22)
+### Added
+- Added local cryptography library scanning
 
 ### 0.1.2 (2021-12-28)
+### 0.2.2 (2021-12-30)
+### [0.2.4](https://github.com/scanoss/scanoss.js/compare/v0.2.2...v0.2.4) (2022-01-05)
+### [0.2.6](https://github.com/scanoss/scanoss.js/compare/v0.2.4...v0.2.6) (2022-01-06)
+### [0.2.8](https://github.com/scanoss/scanoss.js/compare/v0.2.6...v0.2.8) (2022-01-10)
+### [0.2.10](https://github.com/scanoss/scanoss.js/compare/v0.2.8...v0.2.10) (2022-01-11)
+### [0.2.14](https://github.com/scanoss/scanoss.js/compare/v0.2.10...v0.2.14) (2022-02-09)
+### [0.2.16](https://github.com/scanoss/scanoss.js/compare/v0.2.14...v0.2.16) (2022-02-14)
+### [0.2.18](https://github.com/scanoss/scanoss.js/compare/v0.2.16...v0.2.18) (2022-02-23)
+### [0.3.0](https://github.com/scanoss/scanoss.js/compare/v0.2.18...v0.3.0) (2022-07-02)
+### [0.4.0-alpha.0](https://github.com/scanoss/scanoss.js/compare/v0.3.0...v0.4.0-alpha.0) (2022-08-19)
+### [0.4.0-beta](https://github.com/scanoss/scanoss.js/compare/v0.4.0-alpha.0...v0.4.0-beta) (2022-08-31)
+### [0.4.0](https://github.com/scanoss/scanoss.js/compare/v0.4.0-beta...v0.4.0) (2022-09-30)
+### [0.7.8](https://github.com/scanoss/scanoss.js/compare/v0.4.0...v0.7.8) (2023-01-25)
+### [0.8.0](https://github.com/scanoss/scanoss.js/compare/v0.7.8...v0.8.0) (2023-02-20)
+### [0.8.5](https://github.com/scanoss/scanoss.js/compare/v0.8.0...v0.8.5) (2023-03-17)
+### [0.8.6](https://github.com/scanoss/scanoss.js/compare/v0.8.5...v0.8.6) (2023-03-28)
+### [0.8.7](https://github.com/scanoss/scanoss.js/compare/v0.8.6...v0.8.7) (2023-04-12)
+### [0.8.8](https://github.com/scanoss/scanoss.js/compare/v0.8.7...v0.8.8) (2023-04-16)
+### [0.9.0](https://github.com/scanoss/scanoss.js/compare/v0.8.7...v0.9.0) (2023-04-19)
+### [0.9.1](https://github.com/scanoss/scanoss.js/compare/v0.9.0...v0.9.1) (2023-05-18)
+### [0.9.2](https://github.com/scanoss/scanoss.js/compare/v0.9.1...v0.9.2) (2023-10-09)
+### [0.9.3](https://github.com/scanoss/scanoss.js/compare/v0.9.2...v0.9.3) (2023-10-20)
+### [0.10.0](https://github.com/scanoss/scanoss.js/compare/v0.9.2...v0.10.0) (2023-11-22)
+### [0.10.1](https://github.com/scanoss/scanoss.js/compare/v0.10.0...v0.10.1) (2023-11-22)
+### [0.10.2](https://github.com/scanoss/scanoss.js/compare/v0.10.1...v0.10.2) (2023-12-19)
+### [0.10.3](https://github.com/scanoss/scanoss.js/compare/v0.10.2...v0.10.3) (2023-12-22)
+### [0.10.4](https://github.com/scanoss/scanoss.js/compare/v0.10.3...v0.10.4) (2023-12-28)
+### [0.10.5](https://github.com/scanoss/scanoss.js/compare/v0.10.4...v0.10.5) (2023-12-29)
+### [0.11.0](https://github.com/scanoss/scanoss.js/compare/v0.10.5...v0.11.0) (2024-01-04)
+### [0.11.1](https://github.com/scanoss/scanoss.js/compare/v0.11.0...v0.11.1) (2024-01-09)
+### [0.11.2](https://github.com/scanoss/scanoss.js/compare/v0.11.1...v0.11.2) (2024-01-09)
+### [0.11.3](https://github.com/scanoss/scanoss.js/compare/v0.11.2...v0.11.3) (2024-01-09)
+### [0.11.4](https://github.com/scanoss/scanoss.js/compare/v0.11.3...v0.11.4) (2024-04-02)
+### [0.11.5](https://github.com/scanoss/scanoss.js/compare/v0.11.4...v0.11.5) (2024-04-19)
+### [0.12.0](https://github.com/scanoss/scanoss.js/compare/v0.11.5...v0.12.0) (2024-05-06)
+### [0.12.2](https://github.com/scanoss/scanoss.js/compare/v0.12.0...v0.12.2) (2024-05-10)
+### [0.13.0](https://github.com/scanoss/scanoss.js/compare/v0.12.2...v0.13.0) (2024-05-13)
+### [0.13.1](https://github.com/scanoss/scanoss.js/compare/v0.13.0...v0.13.1) (2024-05-15)
+### [0.13.2](https://github.com/scanoss/scanoss.js/compare/v0.13.1...v0.13.2) (2024-05-20)
+### [0.14.0](https://github.com/scanoss/scanoss.js/compare/v0.13.2...v0.14.0) (2024-05-23)
+### [0.14.1](https://github.com/scanoss/scanoss.js/compare/v0.14.0...v0.14.1) (2024-06-05)
+### [0.15.0](https://github.com/scanoss/scanoss.js/compare/v0.14.1...v0.15.0) (2024-07-28)
+### [0.15.1](https://github.com/scanoss/scanoss.js/compare/v0.15.0...v0.15.1) (2024-08-27)
+### [0.15.2](https://github.com/scanoss/scanoss.js/compare/v0.15.1...v0.15.2) (2024-08-29)
+### [0.15.3](https://github.com/scanoss/scanoss.js/compare/v0.15.2...v0.15.3) (2024-11-24)
+### [0.15.4](https://github.com/scanoss/scanoss.js/compare/v0.15.3...v0.15.4) (2024-11-27)
+### [0.15.5](https://github.com/scanoss/scanoss.js/compare/v0.15.4...v0.15.5) (2024-12-30)
+### [0.15.6](https://github.com/scanoss/scanoss.js/compare/v0.15.5...v0.15.6) (2025-01-08)
+### [0.15.7](https://github.com/scanoss/scanoss.js/compare/v0.15.6...v0.15.7) (2025-03-05)
+### [0.16.0](https://github.com/scanoss/scanoss.js/compare/v0.15.7...v0.16.0) (2025-04-22)

package/LICENSE

@@ -1,23 +1,23 @@
-/\* SPDX-License-Identifier: MIT
+SPDX-License-Identifier: MIT
 
-- The MIT License (MIT)
-- Copyright © 2022 Scan Open Source Solutions SL - https://scanoss.com
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the “Software”), to
-- deal in the Software \* without restriction, including without limitation
-- the rights to use, copy, modify, merge, publish, distribute, sublicense,
-- and/or sell copies of the Software, and to permit persons to whom the
-- Software is furnished to do so, subject to the following conditions:
+The MIT License (MIT)
 
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
+Copyright © 2025 Scan Open Source Solutions SL - https://scanoss.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to
+deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
 
-- THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-- IN THE SOFTWARE.
-  \*/

package/README.md

@@ -38,18 +38,30 @@ Commands:
   scan [options] <source>  Scan a folder/file
   dep [options] <source>   Scan for dependencies
   wfp [options] <source>   Generates fingerprints for a folder/file
+  crypto [options] <source>  Scan local cryptography
   help [command]           display help for command
 ```
 
 ### Command `scan`
+* **Quick Analysis**: For a fast and free analysis of your project, simply run:
+  `scanoss-js scan -o results.json <source-folder>`
 
-* For a quick and free analysis of your project, simply input: `scanoss-js scan -o results.json <source-folder>`
+* **API Token Scanning**: Use your API token for enhanced scanning capabilities:
+  `scanoss-js scan -o results.json --key <your_token> --apiurl <your_apiurl> <source-folder>`
 
+* **Dependency Detection**: Include dependency detection in your scan:
+  `scanoss-js scan -o results.json --dependencies <source-folder>`
 
-* Using an API Token for Scanning: `scanoss-js scan -o results.json --key <your_token> --apiurl <your_apiurl> <source-folder>`
+* **Cryptography Detection**: Include cryptographic algorithm and library detection:
+  `scanoss-js scan results.json --cryptography --key <your_token>`
 
+  * You can also specify custom algorithm and library detection rules:
+    `scanoss-js scan results.json --cryptography --key <your_token> --algorithm-rules <path-to-algorithm-rules.json> --library-rules <path-to-library-rules.json>`
+    See examples of [algorithm rules](#example-algorithm-rules-file) and [library rules](#example-library-rules-file) files below.
+
+
+> **Note**: Component cryptography scanning is only performed when a token is provided. Without a token, only local cryptography scanning is performed. Custom rules for algorithms and libraries are applied to local cryptography detection in either case.
 
-* Include Dependency detection in scanning: `scanoss-js scan -o results.json --dependencies <source-folder>`
 
 ### Command `wfp`
 * Generate Hashes without analysis: `scanoss-js wfp -o fingerprints.wfp <source-folder>`
@@ -75,6 +87,66 @@ The manifest files acknowledged during the scanning process are:
     * Gradle: build.gradle
 
 
+### Command `crypto`
+* Focus exclusively on local cryptographic algorithm and library detection: 
+```bash
+scanoss-js crypto .
+```
+
+Us can also specify custom cryptography algorithm detection rules and library detection rules:
+``` bash
+scanoss-js crypto . --algorithm-rules <path-to-algorithm-rules.json> --library-rules <path-to-library-rules.json>
+```
+See examples of [algorithm rules](#example-algorithm-rules-file) and [library rules](#example-library-rules-file) files below.
+
+### Example Algorithm Rules File
+
+```json
+ [
+  {
+    "algorithm": "md5",
+    "strength": "128",
+    "keywords": [
+      "md5_file",
+      "md5crypt",
+      "md5_block_data_order",
+      "ossl_md5_sha1_",
+      "MD5_Init"
+    ]
+  },
+  {
+    "algorithm": "crc32",
+    "strength": "32",
+    "keywords": [
+      "..."
+    ]
+  }
+]
+```
+
+### Example Library Rules File
+```json
+[
+    {
+      "id": "library/webcrypto",
+      "name": "Web Cryptography API",
+      "description": "A JavaScript API for performing basic cryptographic operations in web applications.",
+      "keywords": [
+        "window.crypto.subtle",
+        "crypto.subtle.",
+        "crypto.getRandomValues",
+        "NodeWebCrypto",
+        "WebCryptoAPI"
+      ],
+      "url": "https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API",
+      "category": "library",
+      "purl": "pkg:generic/webcrypto",
+      "tags": [
+        "JavaScript"
+      ]
+    }
+]
+```
 
 
 ## SDK Usage

package/assets/ReportHTMLTemplate/index.html

@@ -676,8 +676,8 @@
                 <thead>
                   <tr>
                     <th>Component</th>
-                    <th>Version</th>
-                    <th>Cryptography</th>
+                    <th>Type</th>
+                    <th>Detected</th>
                   </tr>
                 </thead>
                 <tbody>
@@ -697,7 +697,8 @@
               <thead>
               <tr>
                 <th>File</th>
-                <th>Cryptography</th>
+                <th>Type</th>
+                <th>Detected</th>
               </tr>
               </thead>
               <tbody>
@@ -708,6 +709,7 @@
               <tr>
                 <td></td>
                 <td></td>
+                <td></td>
               </tr>
             </template>
           </div>
@@ -1178,9 +1180,9 @@
 
         for (const crypto of cryptography.components) {
           const clon = template.content.cloneNode(true);
-          clon.querySelector('td:nth-child(1)').innerHTML = crypto.purl;
-          clon.querySelector('td:nth-child(2)').innerHTML = crypto.version;
-          clon.querySelector('td:nth-child(3)').innerHTML = crypto.algorithms.map(e => `${e.algorithm} (${e.strength})`).join(' - ');
+          clon.querySelector('td:nth-child(1)').innerHTML = crypto.source;
+          clon.querySelector('td:nth-child(2)').innerHTML = crypto.type;
+          clon.querySelector('td:nth-child(3)').innerHTML = crypto.values.join(' - ');
           table.appendChild(clon);
         }
       }
@@ -1195,8 +1197,9 @@
 
         for (const crypto of cryptography.files) {
           const clon = template.content.cloneNode(true);
-          clon.querySelector('td:nth-child(1)').innerHTML = crypto.file;
-          clon.querySelector('td:nth-child(2)').innerHTML = crypto.algorithms.map(e => `${e.algorithm} (${e.strength})`).join(' - ');
+          clon.querySelector('td:nth-child(1)').innerHTML = crypto.source;
+          clon.querySelector('td:nth-child(2)').innerHTML = crypto.type;
+          clon.querySelector('td:nth-child(3)').innerHTML = crypto.values.join(' - ');
           table.appendChild(clon);
         }
       }