You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ This page describes how you can join the community in this goal.
8
8
9
9
If you are new to the community? We recommend you do the following before diving into the code:
10
10
11
-
* Read the [Code of Conduct](https://github.com/PQCA/sonar-cryptography/blob/main/CODE_OF_CONDUCT.md)
12
-
* Familiarize yourself with the community (via [GitHub](https://github.com/PQCA/sonar-cryptography/discussions) etc.)
11
+
* Read the [Code of Conduct](https://github.com/cbomkit/sonar-cryptography/blob/main/CODE_OF_CONDUCT.md)
12
+
* Familiarize yourself with the community (via [GitHub](https://github.com/cbomkit/sonar-cryptography/discussions) etc.)
13
13
14
14
## Choose an issue to work on
15
15
The Sonar Cryptography Plugin uses the following labels to help non-maintainers find issues best suited to their interest and experience level:
16
16
17
-
*[good first issue](https://github.com/PQCA/sonar-cryptography/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - these issues are typically the simplest available to work on, ideal for newcomers. They should already be fully scoped, with a clear approach outlined in the descriptions.
18
-
*[help wanted](https://github.com/PQCA/sonar-cryptography/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - these issues are generally more complex than good first issues. They typically cover work that core maintainers don't currently have capacity to implement and may require more investigation/discussion. These are a great option for experienced contributors looking for something a bit more challenging.
17
+
*[good first issue](https://github.com/cbomkit/sonar-cryptography/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - these issues are typically the simplest available to work on, ideal for newcomers. They should already be fully scoped, with a clear approach outlined in the descriptions.
18
+
*[help wanted](https://github.com/cbomkit/sonar-cryptography/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - these issues are generally more complex than good first issues. They typically cover work that core maintainers don't currently have capacity to implement and may require more investigation/discussion. These are a great option for experienced contributors looking for something a bit more challenging.
The plugin provides new inventory rules (PQCA Cryptography Repository) regarding the use of cryptography for
50
+
The plugin provides new inventory rules (Cbomkit Cryptography Repository) regarding the use of cryptography for
51
51
the supported languages.
52
52
If you enable these rules, a source code scan creates a cryptographic inventory by creating a
53
53
[CBOM](https://cyclonedx.org/capabilities/cbom/) with all cryptographic assets and writing
@@ -72,7 +72,7 @@ to start your first scan.
72
72
73
73
### Visualizing your CBOM
74
74
75
-
Once you have scanned your source code with the plugin, and obtained a `cbom.json` file, you can use [PQCA's CBOM Viewer](https://github.com/PQCA/cbomkit) service to know more about it.
75
+
Once you have scanned your source code with the plugin, and obtained a `cbom.json` file, you can use [Cbomkit's CBOM Viewer](https://github.com/cbomkit/cbomkit) service to know more about it.
76
76
It provides you with general insights about the cryptography used in your source code and its compliance with post-quantum safety.
77
77
It also allows you to explore precisely each cryptography asset and its detailed specification, and displays where it appears in your code.
78
78
@@ -85,8 +85,8 @@ If you encounter difficulties or unexpected results while installing the plugin
85
85
If you'd like to contribute to Sonar Cryptography Plugin, please take a look at our
86
86
[contribution guidelines](CONTRIBUTING.md). By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT.md).
87
87
88
-
We use [GitHub issues](https://github.com/PQCA/sonar-cryptography/issues) for tracking requests and bugs. For questions
89
-
start a discussion using [GitHub Discussions](https://github.com/PQCA/sonar-cryptography/discussions).
88
+
We use [GitHub issues](https://github.com/cbomkit/sonar-cryptography/issues) for tracking requests and bugs. For questions
89
+
start a discussion using [GitHub Discussions](https://github.com/cbomkit/sonar-cryptography/discussions).
Copy file name to clipboardExpand all lines: docs/DETECTION_RULE_STRUCTURE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ This will then be useful when we translate the detected findings: we use the bun
109
109
And finally, we can finish the specification of the detection rules by adding top level dependent detection rules with `withDependingDetectionRules(List<IDetectionRule<T>> detectionRules)` (or not, using `withoutDependingDetectionRules()` instead).
110
110
These are similar to the parameter dependent rules, but instead of applying these rules on a parameter, they are applied to the object itself, i.e. to the object with which the rule matched in the first place[^2].
111
111
112
-
[^2]: Currently, findings of top level dependent detection rules are added below *each* (top level and parameter) detections of the rules in the tree of detected values, *except* for parameter detections using `asChildOfParameterWithId`. More information [here](https://github.com/PQCA/sonar-cryptography/pull/142).
112
+
[^2]: Currently, findings of top level dependent detection rules are added below *each* (top level and parameter) detections of the rules in the tree of detected values, *except* for parameter detections using `asChildOfParameterWithId`. More information [here](https://github.com/cbomkit/sonar-cryptography/pull/142).
113
113
114
114
> [!TIP]
115
115
> You will find all the classes implementing the action factories, value factories and contexts (that you may use in the functions described above) in the [`model`](../engine/src/main/java/com/ibm/engine/model/) directory of the engine.
Copy file name to clipboardExpand all lines: docs/TROUBLESHOOTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ To do so, start by opening this repo and `git checkout` to the latest release br
19
19
Open the [`docker-compose.yaml`](../docker-compose.yaml) file and check the `image` argument to make sure that it uses a version of SonarQube supported by our plugin.
20
20
21
21
You then need to have a `.jar` plugin in the `.SonarQube/plugins/` directory. There are two options for this:
22
-
- Easiest way: download the `.jar` file from the [latest releases](https://github.com/PQCA/sonar-cryptography/releases) GitHub page and move it to this directory. In our case, it is named `sonar-cryptography-plugin-1.2.0.jar`.
22
+
- Easiest way: download the `.jar` file from the [latest releases](https://github.com/cbomkit/sonar-cryptography/releases) GitHub page and move it to this directory. In our case, it is named `sonar-cryptography-plugin-1.2.0.jar`.
23
23
- Alternatively, you can build the plugin from source, as explained in the [Build](../CONTRIBUTING.md#build) paragraph of [`CONTRIBUTING.md`](../CONTRIBUTING.md).
24
24
25
25
Now, you can run our plugin with SonarQube by following the [Run the Plugin with SonarQube](../CONTRIBUTING.md#run-the-plugin-with-sonarqube) paragraph of [`CONTRIBUTING.md`](../CONTRIBUTING.md).
@@ -149,4 +149,4 @@ If the analysis runs as expected, you should see the results in two ways:
149
149
150
150
---
151
151
152
-
If you did not succeed while following all the steps in this guide, please check previous GitHub [issues](https://github.com/PQCA/sonar-cryptography/issues?q=is%3Aissue) to check if someone else ever had your problem, otherwise feel free to reach us by creating a new GitHub issue.
152
+
If you did not succeed while following all the steps in this guide, please check previous GitHub [issues](https://github.com/cbomkit/sonar-cryptography/issues?q=is%3Aissue) to check if someone else ever had your problem, otherwise feel free to reach us by creating a new GitHub issue.
0 commit comments