| Table of Contents |
|---|
...
The following match types are available:
Match Type | Description |
|---|---|
License Group NOTE: In the API, use "LICENSE". | The library license is matched against specific licenses in a selected group or a specific license group, and the policy is enforced per the rules. |
GLOB Pattern on Resource Name NOTE: In the API, use "RESOURCE_NAME_REGEX". | The library name is matched against a given GLOB Pattern. |
GLOB Pattern on GAV Custom Attributes NOTE: In the API, use "GAV REGEX". | The library's GAV (Group Artifact Version) strings are matched against the provided GLOB pattern. You can define only 1 or 2 of the 3 parameters (Group Id, Artifact Id and Version). For example, Apache (Group Id) and Commons (Artifact Id). |
Security Vulnerability Severity NOTE: In the API, use "VULNERABILITY_SEVERITY". | The library is matched against the security vulnerability severity. There are three levels of severity (as defined by the NVD): High, Medium and Low. The policy will perform the action on libraries that have a least one security vulnerability, per severity, with the selected severity. For example, a component with 1 High severity vulnerability and 2 Low severity vulnerabilities will be considered as High and the relevant policy will be enforced on it. If Prioritize is enabled, you have the option to apply this match only to libraries with Effective Vulnerability (i.e. at least one reported vulnerability was detected as a "red shield") by selecting the Only Libraries with Effective Vulnerabilities check box. |
Security Vulnerability Score (CVSS 3) NOTE: In the API, use "VULNERABILITY_SCORE". | The library is matched against the security vulnerability CVSS 3 score. The score can be any number between 0-10. NOTE: As of version 20.1.3, bug rating and version activity match types were removed. Existing organizations will no longer be able to add these match types when creating a new policy. They will remain, however, for organizations that already have this policy so they will still be editable. |
Library Age NOTE: In the API, use "LIBRARY_STALENESS". | The library is matched against the library age, which can be defined in months (1-240 months). The policy will perform the action on libraries that were released during the specified number of months. |
Primary Attribute Value NOTE: In the API, use "PRIMARY_ATTRIBUTE_VALUE". | If a component is marked with this attribute value, the library is matched against its attribute value. |
Library Request History NOTE: In the API, use "LIBRARY_REQUEST_HISTORY". | The policy performs the action on libraries according to previous actions which were performed on them. |
Exists in Product’s Inventory NOTE: In the API, use "PRODUCT". | The policy performs the action on libraries that were previously approved and available in the selected product inventory. |
Vulnerability Effectiveness (prioritize shields) NOTE: In the API, use "EFFECTIVENESS". | The policy performs the action on libraries that have at least one security vulnerability with the selected shield type: red, yellow, green, or grey. Selecting None for Vulnerability Effectiveness indicates a policy for libraries that do not have shields. NOTE: For customers with Vulnerability-Based Alerting enabled, grey shields are not displayed. |
Applying Actions to a Library
The Action is the operation the policy runs on a matched library.
NOTE: A library or request can be matched to only one type and execute only one action.
You can apply one of the following actions on a matched library:
Action | Description |
|---|---|
Approve | Automatically approves the library. The request will be automatically closed. |
Reject | Automatically rejects the library:
|
Reassign | Workflow - reassigns the request to a designated user or group in the system which is not the default approver. NOTE: For a Reassign action to take effect, the Open tasks for new libraries check box (Integrate tab > Advanced Settings) must be selected. |
Conditions | Workflow - automatically assigns conditions and open tasks on libraries. NOTE: For a Conditions action to take effect, the Open tasks for new libraries check box (Integrate tab > Advanced Settings) must be selected. A request is opened for the default approver and sub-tasks are opened as “conditions” for the different assignees according to the policy definition. Conditions will be automatically sent to assignees when libraries are matched. Conditions can be assigned to a single user/group or to different members of a group/organization. The Conditions are added to the Tasks panel and the Request Details page where assignees can view the original library request and update the status of the conditions after handling their assigned conditions. By clicking one of the following check boxes, you can choose to set conditions to trigger the automatic approval or rejection of the original request based on the resolution of the relevant assignees:
The assignee can mark the condition as Satisfied or Rejected. The assignee can also suggest to the approver another user to review the condition, by clicking Propose Reassignment. Only the approver is allowed to change assignees. The Default Approver can perform the following actions on conditions: Edit, Reassign, Override and Approve, or Override and Reject. |
Issue | Workflow: Issue tracker integration. WhiteSource policies can integrate with Ticket Management Systems (such as, JIRA or Work Items), enabling the automatic creation of tickets for tracking issues. When scanning the open source code, if vulnerabilities are found that need fixing, a ticket is automatically created in the issue tracker with all relevant information, addressed to the specific developers that need to fix the issue. After resolving the issue, the Security officer must check that the risk was mitigated. NOTE: For an Issue action to take effect, the Open tasks for new libraries check box (Integrate tab > Advanced Settings) must be selected. When creating an ‘Issue’ policy you can select the Jira Project to open the issue for the Issue Type (such as, bug), Priority and Assignee. The JIRA describes the level and match type of the policy, including the organization, product and project to which the library belongs. Additional information is also displayed that can help to identify why this library matched the policy (for example, if the policy match type is high severity vulnerability, the vulnerability severity and link will appear). When working with JIRA, if the issue type in the project requires mandatory fields, those fields are displayed and must be filled in. NOTES:
|
Scope and Prioritization of Policies
...
In the Policy page, you can change the priorities of policies by using the following buttons:
Raise Priority | Select the required policy and click to raise its priority. |
Lower Priority | Select the required policy and click to lower its priority. |
Auto Prioritize | Click to prioritize policies based on their action, in the following order: |
In cases of more than one organization, for example, when each organization has a different independent division or represents a different product line, you can define different policies for each organization.
...
NOTE: A Product Admin has higher permissions than an ORG Admin, as project and product policies are the first policies that WhiteSource will look at for a match.
Managing Policies
Organizational policies are managed via the Policies menu item from the main menu.
In the Policies page, you can view, add, edit, change the priority of, enable/disable, and remove policies.
Product-level policies are available for products that want to set their own policies which override the organizational ones. Product policies are managed from the product page, under the Policies button.
...
Creating a New Policy
To create a new WhiteSource policy, do as follows:
In the Policies page, click the Add Policy button. The Add Policy page is displayed.
Match your policy to a library. From the Match drop-down list, select the library type to which you want to match the policy.
Specify the action to be performed on the matched library. In the Action section, click the action you want to apply to the library.
Click the Add button to revert to the Policies page showing the newly-created policy.
If required, you can reorder the policy according to priority by selecting it and clicking the Raise Priority/Lower Priority buttons.
...
Reject libraries with vulnerabilities.
Any vulnerability can be exploited, so we cannot recommend a “minimum level.” You will need to decide for yourself how to set this, but you can always start with High Severity vulnerabilities and create policies down the line for less severe vulnerabilities.
Consult with a legal expert and reject any licenses that are too restrictive.
Again, while we cannot provide legal advice, Risk Scores are available for a subset of licenses - determined by legal experts that specialize in open source compliance, so that is a good place to start!
Enable tasks to ensure that any new libraries which are introduced are subject to manual review, if they are not resolved by the existing policies. And then…
Create a group(s) of users as necessary that should review the tasks and assign the these users to the relevant Products (via Product>
>Product Default Approvers) . These groups should be restricted to personnel with the authority to make decisions, such as security experts, managers or team leaders. The more you delegate to reviewers, the more visibility you will have, resulting in fewer neglected tasks. Groups are more easily administered and as such, they are more highly recommended than individual user assignments.Consult with a legal expert and approve any licenses that are deemed permissible. This will help to resolve any tasks for new libraries.
Ensure that the order of your policies correctly reflect the Priority you require. The higher the policy on the list, the higher the priority. A library will be subject to the first policy it matches.
Establish organization-level policies and only use product and project-level policies where there are exceptions, to limit complexity.
“Issue” policies at the product or project-level that create JIRA or Work Item tickets can be assigned to the relevant team in your organization. This allows you to seamlessly integrate remediation tasks into your development process.
Unified Agent
The Unified Agent is a Java command-line tool that scans directories' open source components for vulnerable libraries and source files, as well as license compliance, and uploads the results to the WhiteSource web application.
...