-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update java-project-ci.yml * Migrate to techstack project based on parent pom * Add description of implementation sub-projects * add infrastructure layer example * link to techstack * structure of feature module * Update check-project-technical-quality.yml * Add maven profile execution parameter for activation of maven dependencies check * Update java-project-ci.yml * debug os condition evaluation for publishing * Sub-projects structure * standard structure examples of: - one infrastructure client as redis adapter library (infrastructure layer) - on RTS computation unit as vert.x module (domain layer) * add licences and notices per jar project * Luttece client retained as Redis connector * create structure of UI module sub-projects * UI layer: actions-scheduling (features, backend, frontend modules) refactoring of pom.xml message shown during the build * create acsc features project structure * model of dependencies distribution between sub-project of ACSC sub-modules * ASCS frontend module project structure * test of frontend start ok * documentation * Transfert of web backend implementation to messaging gw project * transfert of frontend impl to dedicated shared projects * update of UI layer documentation * update program development status * remove not need properties * documentation enhancement about sub-projects location * Update mpp-ui-systems-stack.png * add basic classes regarding backend and frontend projects * Generic concept based on names components types by implementation architecture * add basic generic and common classes reusable by any features implementation * deactivate structured sub-projects but that are without any implementation * add license * renaming of common project as "framework" * Feature 153, 133, 157 - Add framework support library including annotation for specification documentations link - set links to first architecture requirements implemented into the sub-projects - update the documentation explaining the annotations usage * Update coding-conventions.md
- Loading branch information
1 parent
8e0760b
commit 89de355
Showing
129 changed files
with
4,534 additions
and
321 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
-724 Bytes
(100%)
docs/governance/managed-programs/CYBNITY_open_source_project_plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
## PURPOSE | ||
Presentation of several coding conventions followed by the developers implementing the CYBNITY projects. | ||
|
||
# SOURCE CODES DOCUMENTATION | ||
## REQUIREMENTS LINKING | ||
Specific annotations are available to link the specification documentations (e.g functional, architecture, security requirement...) managed in other repository than GitHub with the source codes developed as realization of them. | ||
|
||
- Why it's important: to quickly navigate and control the quality of alignment between the specifications managed in any other tools (e.g Notion tool for Product Requirements Definition, Security control measures and policies, architecture concepts) with the implementation software codes. | ||
|
||
- How: the __support framework library__ (dependency defined in parent `pom.xml` of any implementation project) provide specific reusable annotations for add link to requirement managed in an external documentation reference (link based on requirement identifier). The annotation is usable on several source code element types (e.g Method, Parameter, Package...). | ||
|
||
For example, to add a reference to an architecture requirement (e.g identified as REQ_ARC_10) into a CYBNITY source code package (e.g into a `package-info.java` file): | ||
|
||
```java | ||
@CYBNITYRequirement(reqType = RequirementCategory.Maintainability, reqId = "10") | ||
package org.cybnity.infrastructure.technical.message_bus.adapter.impl; | ||
|
||
import org.cybnity.framework.support.annotation.CYBNITYRequirement; | ||
import org.cybnity.framework.support.annotation.RequirementCategory; | ||
``` | ||
|
||
## VULNERABILITIES LINKING | ||
Specific annotation is also available to add any references to known vulnerabilities (e.g generated by reused external technologies which not was fixed; or regarding a specific security mitigation developed into a CYBNITY component) fixed into a CYBNITY source code and/or configuration file. | ||
|
||
- Why it's important: some time some vulnerability are not quickly fixed by the technology partners or other open source projects, and CYBNITY program's developers can develop a fix code more quickly (e.g a temporary mitigation solution reducing the threat impact on the CYBNITY software including a dependency to the external problem) during the time for the partner to solve the problem into their software version. | ||
|
||
- How: the __support framework library__ (dependency defined in parent `pom.xml` of any implementation project) provide specific reusable annotations for add link to vulnerability declaring by external stakeholder (e.g other software editor) and/or public documentation (e.g Mitre website). The annotation is usable on several source code element types (e.g Type, Method, Local variable, Type parameter...). | ||
|
||
For example, to add a reference link to a Mitre published vulnerability (e.g identified as CVE-2022-33915) on a java method fixing the problem during mitigation period into a CYBNITY source code file: | ||
|
||
```java | ||
import org.cybnity.framework.support.annotation.VulnerabilityOrigin; | ||
import org.cybnity.framework.support.annotation.ThreatOriginCategory; | ||
|
||
class X { | ||
@VulnerabilityOrigin(originType = ThreatOriginCategory.CVE, originId = "2022-33915") | ||
public methodWhereVulnerabilityGenerateImpact(...) { | ||
|
||
} | ||
} | ||
``` | ||
|
||
# | ||
[Back To Parent](../) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.