What is CII Badging program?
CII (core infrastructure initiative) Badge may be achieved by the projects which follow the Best practices criteria for Free/Libre and Open Source Software (FLOSS).
CII has been created by the linux foundation in response to previous security issues in open-source projects (e.g. Heartbleed in openSSL).
The CII Badging is associated to the areas as follows:
Basics, Change Control, Reporting, Quality, Security & Analysis
Projects in ONAP should be CII certified to an appropriate level in order to confirm with expectation of carrier grade.
Levels
There are 3 levels of passing in the badging
- Passing
- Silver
- Gold
The levels may further be subdivided as follows:
Level 1: 70 % of the projects passing the level 1
with the non-passing projects reaching 80% passing level
Non-passing projects MUST pass specific cryptography criteria outlined by the Security Subcommittee*
Level 2: 70 % of the projects passing silver
with non-silver projects completed passing level and 80% towards silver level
Level 3: 70% of the projects passing gold
with non-gold projects achieving silver level and achieving 80% towards gold level
Level 4: 100 % passing gold.
Some of the important high level example criteria associated to the various levels are listed as follows for quick reference:
Level | Details/Criteria |
Passing | The project website MUST succinctly describe what the software does (what problem does it solve?). |
Silver | The project MUST document what the user can and cannot expect in terms of security from the software produced The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, and evidence that common security weaknesses have been |
Gold | The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than |
Requirement
For the Beijing release the requirement is Level 1 (at least 70% of the project are on passing level, and all non-passing projects at >80% towards passing).
Current Status
The dashboard gives a list of all onap projects that are undergoing the process and their % of completion
<TODO insert a link to the dashboard table here>
Procedure
First step is create a new project in bestpractices website
- Create a account in https://bestpractices.coreinfrastructure.org/ and login
- Click on the "Projects" icon on the top right
- This page will list all the projects certified by CII not just the onap projects. Click on Add/Add new project button to add a new project.
- Enter the details of your project in the new screen and click "Submit URL"
Now you will be prompted with a set of questions and most of them are straightforward. You can refer to one of the existing projects to get an idea of what has to be filled in.
Sample questions and answers
This section will cover all the questions in each level and what it means and what a possible answer can be. A description of the the question will be provided where needed.
Passing
| Question | Description |
|---|---|
| Question | Description | Sample Answer |
|---|---|---|
Basic project website content | ||
| The project website MUST succinctly describe what the software does | You can link to your readme file in onap.readthedocs | The description of the project can be found in |
| The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software | The following URLs describe the process to join the community, developing the software and provide feekback: https://wiki.onap.org/display/DW/Joining+the+Community https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA https://wiki.onap.org/display/DW/Developing+ONAP | |
| The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) | The process could be found in the following URL: https://wiki.onap.org/display/DW/Development+Procedures+and+Policies | |
| The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). | The Javascript code should meet the requirements except for the number of characters in a line of code specified by the styleguide | |
FLOSS license | ||
What license(s) is the project released under? | Apache-2.0 | |
| The software produced by the project MUST be released as FLOSS. | The Apache-2.0 license is approved by the Open Source Initiative (OSI). | |
| It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI) | The Apache-2.0 license is approved by the Open Source Initiative (OSI). | |
| The project MUST post the license(s) of its results in a standard location in their source repository. (URL require | License can be found in: | |
Documentation | ||
| The project MUST provide basic documentation for the software produced by the project. | The documentation describing the project can be found in | |
| The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. | The component sparky-fe needs to be used with sparky-be and AAI to view AAI component. | |
| The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. | Given only https: URLs. | |
| The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. | A mailing list is used for project related discussion. New users could also check, search the old discussion online at onap-discuss website. Joining the Community | |
| The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. | JIRA is used to track bugs. The whole website is in English. Tracking Issues with JIRA | |
| Change Control: Public version-controlled source repository | ||
| The project MUST have a version-controlled source repository that is publicly readable and has a URL. | The answer is optonal, you can just select the Met radio button | Sparky's version controlled repository can be found in |
| The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. | The answer is optonal, you can just select the Met radio button | Tracking is provided by using a combination of JIRA and git history. Every commit has an user and a Jira number attached to it. |
| To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. | Gerrit provides an temperate branch for reviewing and providing comments. Once approved, the code will be merged and the temperate branch will be removed. | |
| It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. | Git and Gerrit are used. | |
Unique version numbering | ||
| The project results MUST have a unique version identifier for each release intended to be used by users | Release version is with format ${major}.${minor}.${patch} and will be updated accordingly for each release. | |
| It is SUGGESTED that the Semantic Versioning (SemVer) format be used for releases | The answer is optonal, you can just select the Met radio button | |
Release notes | ||
| The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes] | Release note can be found in | |
| The release notes MUST identify every publicly known vulnerability with a CVE assignment or similar that is fixed in each new release, unless users typically cannot practically update the software themselves. If there are no release notes or there have been no publicly known vulnerabilities, choose "not applicable" (N/A). [release_notes_vulns] | The answer is optonal, you can just select the Met radio button | |
Bug-reporting process | ||
| The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process] | The description of the process could be found in the following URL: https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | |
| The project SHOULD use an issue tracker for tracking individual issues. [report_tracker] | Jira is used to track issues. https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | |
| The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. | *Optional | |
| The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive).[enhancement_responses] | *Optional | |
| The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive] | *Optional | |
Vulnerability report process | ||
| The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process] | Process on how to report a vulnerability can be found in | |
| If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private] | Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A). | Private vulnerability reports are not supported. ** |
| The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response] | For most the new projects there are no vulnerability reported so N/A would be a valid selection if that is the case for your project | There's no vulnerabilities reported so far. |
Working build system | ||
| If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build] | Jenkins is used to build the war file. https://jenkins.onap.org/view/aai/job/aai-sparky-fe-master-release-version-java-daily-no-sonar/ | |
| It is SUGGESTED that common tools be used for building the software. [build_common_tools] | Maven and npm are used to build the project | |
| The project SHOULD be buildable using only FLOSS tools | Maven is under Apache 2.0 liscense. And NPM is licensed under The Artistic License 2.0 | |
Automated test suite | ||
| The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). [test] | Sparky uses Karma, mock-require and mocha to run the unit tests | |
| A test suite SHOULD be invocable in a standard way for that language. [test_invocation] | Tests can be run, by running the command "npm test" | |
| It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. | Karma, mock-reuire and mocha combination has the ability to cove all the branches and input fields | |
| It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). | For each pull request, the project needs to be built successfully before the Merge option becomes activated. The test will be run automatically during the building process as well. Once build successfully and all tests has past, the Merge option will be activated. | |
New functionality testing | ||
| The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy] | The code coverage is evaluated by Sonar on daily bases. If the code coverage reduced, actions will be taken to add more test cases. All tests on for Clamp is trigger by Maven build and could be launched automatically by Jenkins. |
*Optional : You need not provide a details for these questions, specifying if your project meets the conditions are sufficient.
- The project website MUST succinctly describe what the software does
Resources
The following resources may be useful source of information about CII badging:
•CII Badging overview: https://bestpractices.coreinfrastructure.org/
•Basic Criteria: https://github.com/coreinfrastructure/best-practices-badge/blob/master/doc/criteria.md
•Higher Level Criteria: CII Badging overview : https://github.com/coreinfrastructure/best-practices-badge/blob/master/doc/other.md
•Example : https://bestpractices.coreinfrastructure.org/projects/1/0
•Further reading: https://wiki.onap.org/display/DW/ONAP+Beijing+Release+Developer+Forum%2C+Dec.+11-13%2C+2017%2C+Santa+Clara%2C+CA+US?preview=/16002054/20874916/ONAP-Security%20Sub-committee-pa2.pdf
•CLAMP project CII: https://bestpractices.coreinfrastructure.org/projects/1197
•http://tlhansen.us/onap/cii.php [temporary reference dashboard]