CII Badging Program
- Arul Nambi
- Leah Mitelberg
- Tony Hansen
What is the 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.
How to add multiple editors to a project report
- You need the numeric ID for the new editor you're adding to your project report.
- If the new editor doesn't already have a login on the CII site, they need to create one by going to https://bestpractices.coreinfrastructure.org and clicking on Sign Up.
- If you don't know the new editor's CII login ID, have them log in and click on Account -> Profile. At the bottom is a link called “JSON”. Click that and a JSON structure will be shown. We need the “id” value, which is numeric. For example, mine is 1597.
- An existing owner or editor of a project then needs to bring up the project page that they want to add another editor to. At the top is a menu item “Edit”. Click that, and search for “(Advanced) What other users have additional rights to edit this badge entry?”. In the field right below that, type in “+” and the numeric ID retrieved above. Click on one of the green “Save” buttons below.
- That new person is immediately added as an editor on the project.
- As an editor, you can quickly get a list of the projects that you have rights to by clicking on “Account -> Profile”.
Do I Report For the Entire Project or Separately For Every Single Repo? Can I Group Repos Together?
This is your choice. You can do a single report for your entire project, or you can file a separate report for each repository, or even group multiple repositories together.
- If your repositories use different languages or different testing procedures, you probably would find it easier to do it per-repository.
- You may also group multiple repositories together, if that would help. For example, you might group all of the repositories together that use Java, or all of the repos together that use Erlang.
- The key to grouping repositories together is to list all of the repo URLs in the response to the question "What is the URL for the version control repository?" question.
It's your choice as to what makes it easiest for you to manage your project.
If you do file one report for the entire project, or group multiple repos together then you need to answer each Met/Not Met question based on the lowest-common denominator answer: if ANY of the repos don’t meet the requirement, you cannot select Met. You can use the text response for each question to keep track of your reasons for picking any particular answer.
CII Badging Levels
There are 3 CII Badging levels which are as follows:
|
|
|
When a new project starts the badging process they will begin at 0% completeness and as they progress the % will increase.
To see a list of all ONAP projects and their level of completions refer to link https://bestpractices.coreinfrastructure.org/projects?q=onap
ONAP CII Compliance Levels
For ONAP, 4 levels(ONAP Compliance) of compliance have been defined:
For each ONAP compliance level, all the projects in ONAP should comply to certain standards when it comes to CII badging.
ONAP Level 1: 70 % of the code in gerrit must have an 100% completion in the CII badging towards passing level
with the non-passing projects reaching 80% completion in the CII badging towards passing level
Non-passing projects MUST pass specific cryptography criteria outlined by the Security Subcommittee*
ONAP Level 2: 70 % of the projects in gerrit must have an 100% completion in the CII badging for silver level
with non-silver projects completed passing level and 80% completion towards silver level
ONAP Level 3: 70% of the projects in gerrit must have an 100% completion in the CII badging for gold level
with non-gold projects achieving silver level and achieving 80% completion towards gold level
ONAP Level 4: 100 % passing gold.
ONAP CII Badging Dashboard: http://tlhansen.us/onap/cii.html
Some of the important high level example criteria associated to the various levels are listed as follows for quick reference:
Level | Example 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 |
Badge Specific Adherence requirements
Each of the Badging level is associated with compliance requirements which in turn may vary from being e.g. absolute to being as varied as recommendatory in nature.
The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" in the Badging guideline documents are are to be interpreted as below. (The terms are similar to what is described in RFC2119/RFC8174).
- The term MUST is an absolute requirement, and MUST NOT is an absolute prohibition.
- The term SHOULD indicates a criterion that is normally required, but there may exist valid reasons in particular circumstances to ignore it. However, the full implications must be understood and carefully weighed before choosing a different course.
- The term SUGGESTED is used instead of SHOULD when the criterion must be considered, but valid reasons to not do so are even more common than for SHOULD.
- Often a criterion is stated as something that SHOULD be done, or is SUGGESTED, because it may be difficult to implement or the costs to do so may be high.
- The term MAY provides one way something can be done, e.g., to make it clear that the described implementation is acceptable.
- To obtain a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR the rationale for not implementing the criterion must be documented, and all SUGGESTED criteria have to be considered (rated as met or unmet). In some cases a URL may be required as part of the criterion's justification.
R2 Beijing Requirements
For the Beijing release, the compliance requirement is ONAP Level 1 (at least 70% of the project are on passing level, and all non-passing projects at >80% towards passing).
R2 Beijing Current Status Dashboard
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 to Fill Out the BestPractices.CoreInfrastructure.Org Form
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. The following set of Sample Questions and Answers should help you fill it out. You may also wish to refer to one of the existing projects to get an idea of what has to be filled in. You can use this link and click on any project name to see the answers used for that project.
You should go through the questions for each of the levels. Some of the questions at Silver level change a "SHOULD" into a "MUST" from the Passing level, so if you have met some suggestion at Passing level, verify that is marked as Met at Silver level as well.
Sample Passing Level Questions and Answers |
This section will cover all the questions in each level and what it means and what a possible answer should be. A description of the question will be provided where needed.
| Question | Description | Sample Answer | |
|---|---|---|---|
Basics: Identification | |||
This is a short name. It SHOULD include "ONAP" as part of it. | ONAP CLAMP (Closed Loop Automation Management Platform) | ||
Include a paragraph describing your project. You MUST include "ONAP" as part of it the description in order for our queries to work. | ONAP CLAMP is a platform for designing and managing control loops. It is used to design a closed loop, configure it with specific parameters for a particular ... etc ... | ||
Use the wiki URL for your project. Only use the HTTPS version. | https://wiki.onap.org/display/DW/CLAMP+Project | ||
| What is the URL for the version control repository (it may be the same as the project URL)? | This will be the Gerrit URL for your project. It MUST start with either <https://gerrit.onap.org/r/#/admin/projects> or <https://git.onap.org>. You may list multiple URLs here if your report is covering multiple repositories. Separate them with whitespace. | https://gerrit.onap.org/r/#/admin/projects/clamp | |
What programming language(s) are used to implement the project? | C++, Java, JavaScript, Python, etc. | ||
| The textual answer is optional; you may leave it blank. | |||
| Question | Description | Sample Answer | |
Basics: Basic project website content | |||
| The project website MUST succinctly describe what the software does [description_good] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Include the link to your readme file on onap.readthedocs.io | 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 [interact] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The following URLs describe the process to join the community, developing the software and provide feekback: https://lf-onap.atlassian.net/wiki/display/DW/Joining+the+Community https://lf-onap.atlassian.net/wiki/display/DW/Tracking+Issues+with+JIRA https://lf-onap.atlassian.net/wiki/display/DW/Developing+ONAP | |
| The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The process could be found in the following URL: https://lf-onap.atlassian.net/wiki/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). [contribution_requirements] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The Javascript code should meet the requirements except for the number of characters in a line of code specified by the styleguide | |
| Question | Description | Sample Answer | |
Basics: FLOSS license | |||
What license(s) is the project released under? [license] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | Apache-2.0 | |
| The software produced by the project MUST be released as FLOSS. [floss_license] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | 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) [floss_license_osi] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | 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 required) [license_location] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | License can be found in: | |
| Question | Description | Sample Answer | |
Basics: Documentation | |||
| The project MUST provide basic documentation for the software produced by the project. [documentation_basics] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Include a pointer to your project's readthedocs.io area. | 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. [documentation_interface] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Full Documentation for ONAP can be found at: https://docs.onap.org/en/latest/ | |
| Question | Description | Sample Answer | |
Basics: Other | |||
| The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The project sites are all HTTPS: | |
| 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. [discussion] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | 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 ONAP Technical Community | |
| The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | JIRA is used to track bugs. The whole website is in English. Tracking Issues with JIRA | |
| Question | Description | Sample Answer | |
| Change Control: Public version-controlled source repository | |||
| The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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. [repo_track] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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. [repo_interim] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Gerrit provides an temporary 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. [repo_distributed] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Git and Gerrit are used. | |
| Question | Description | Sample Answer | |
Change Control: Unique version numbering | |||
| The project results MUST have a unique version identifier for each release intended to be used by users [version_unique] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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 [version_semver] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Release version is with format ${major}.${minor}.${patch} and will be updated accordingly for each release. | |
| It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Each release is tagged within the Gerrit repository. | |
| Question | Description | Sample Answer | |
Change Control: 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Release notes 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] | If your project has had a vulnerability reported (e.g. identified in Nexus-IQ), verify that it is noted in the release notes with a CVE, CVSS, CWE, or CAPEC identifier, then select the Met radio button. (If not, select the Unmet radio button.) If there have been no vulnerabilities yet reported, select N/A. | Release notes with identified vulnerabilities can be found in No vulnerabilities have yet been identified. | |
| Question | Description | Sample Answer | |
Reporting: 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The description of the process can be found in the following URL: https://lf-onap.atlassian.net/wiki/display/DW/Tracking+Issues+with+JIRA | |
| The project SHOULD use an issue tracker for tracking individual issues. [report_tracker] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Jira is used to track issues. https://lf-onap.atlassian.net/wiki/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. [report_responses] | *ONAP project common response* ONAP requires that the PTLs review bug reports, so you can just select the Met radio button. Use text similar to the sample answer. | The reported issues are being handled as soon as possible. | |
| The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive).[enhancement_responses] | *ONAP project common response* ONAP requires that the PTLs review enhancement requests, so you can just select the Met radio button. Use text similar to the sample answer. | The reported issues are being handled as soon as possible. | |
| The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The ONAP Jira Ticketing System: https://jira.onap.org/secure/Dashboard.jspa Additionally a concise list of open defects, epics, stories, and tasks can be found at: https://lf-onap.atlassian.net/wiki/display/DW/Issue+Reports | |
| Question | Description | Sample Answer | |
Change Control: Vulnerability report process | |||
| The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The 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] | *ONAP project common response* According to updated version of ONAP Vulnerability Management process vulnerabilities should be reported by creating OJSI tickets. Taken into account their default limited visibility and HTTPS only access to Jira, we consider them to be private reports. All details how to report the issue has been described in the process itself. Choose "Met". | The process on how to report a vulnerability can be found in By default all vulnerability reports are private unless modified by the reporter. | |
| 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 new projects there are no vulnerability reported, so N/A would be a valid selection if that is the case for your project. For older projects that were in a previous ONAP release, the JIRA tickets should be reviewed for vulnerability response times. | There's no vulnerabilities reported so far. | |
| Question | Description | Sample Answer | |
Quality: 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Maven and npm are used to build the project | |
| The project SHOULD be buildable using only FLOSS tools [build_floss_tools] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Maven is under Apache 2.0 liscense. And NPM is licensed under The Artistic License 2.0 | |
| Question | Description | Sample Answer | |
Quality: 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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. [test_most] | ONAP has differing requirements for each release; depending on your coverage, select the appropriate radio button. Use text similar to the sample answer. | The combination of Karma, mock-require and mocha has the ability to cover 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). [test_continuous_integration] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | 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. | |
| Question | Description | Sample Answer | |
Quality: New functionality testingQuality: Warning flags | The remaining questions in the Quality section must be individually answered according to your project. | ||
| . . . | |||
| Question | Description | Sample Answer | |
Security: Secured delivery against man-in-the-middle (MITM) attacks | |||
| The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm] | *ONAP project common response* ONAP uses HTTPS for access to all ONAP artifacts, such as built items and source. In addition, some artifacts are signed by the Linux Foundation. | HTTPS is used to download all ONAP artifacts, and some are signed by the Linux Foundation. | |
| A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned] | *ONAP project common response* Since all HTTP access is over HTTPS, if ONAP were to to publish checksums, they could only be retrieved using HTTPS. | TBD Does ONAP publish any checksums? If so, the answer is Met. If not, the answer is N/A. | |
Security: Secure development knowledgeSecurity: Use basic good cryptographic practicesSecurity: Publicly known vulnerabilities fixedSecurity: Other security issues | These questions in the Security section must be individually answered according to your project. | ||
| Question | Description | Sample Answer | |
Analysis: Static code analysisAnalysis: Dynamic code analysis | The questions in the Analysis section must be individually answered according to your project. |
Sample Silver Level Questions and Answers |
| Question | Description | Sample Answer | |
Basics: IdentificationBasics: Prerequisites | The questions in these Basics sections will be filled in automatically. | ||
| Question | Description | Sample Answer | |
Basics: Basic project website content | |||
| The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements] | *ONAP project common response* ONAP has Developer Best Practices, so click on Met and add a reference. | https://lf-onap.atlassian.net/wiki/display/DW/Developer+Best+Practices | |
| Question | Description | Sample Answer | |
Basics: Project oversight | |||
| The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco] | *ONAP project common response* This question can be answered the same ONAP-wide. | ONAP requires both a Developer Certificate of Origin (DCO), and a Contributor License Agreement (CLA). https://lf-onap.atlassian.net/wiki/display/DW/Contribution+Agreements | |
| The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance] | *ONAP project common response* This question can be answered the same ONAP-wide. | The project governance is described at https://lf-onap.atlassian.net/wiki/display/DW/Community+Offices+and+Governance Further information can be found at https://lf-onap.atlassian.net/wiki/display/DW/ONAP+Technical+Community+Document | |
| The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct] | *ONAP project common response* This question can be answered the same ONAP-wide. ONAP adheres to the Linux Foundation Code of Conduct, so you can just select the Met radio button. | ONAP adheres to the Linux Foundation Code of Conduct, found at https://lfprojects.org/policies/code-of-conduct/ | |
| The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities] | *ONAP project common response* This question can be answered the same ONAP-wide. | The key roles in the project and their responsibilities are described at https://lf-onap.atlassian.net/wiki/display/DW/Community+Offices+and+Governance Current members are listed at https://lf-onap.atlassian.net/wiki/pages/viewpage.action?pageId=16232285 | |
| The project MUST be able to continue with minimal interruption if any one person is incapacitated or killed. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation that an individual is incapacitated or killed. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity] | ONAP uses the Linux Foundation structure to support all projects, including all keys and passwords. Nothing, including all legal rights, is invested in any single person. | For AAI-UI we have 4 committers and multiple contributes who are listed in |