| Table of Contents |
|---|
...
You can view a history of the policy violations from different scans in the Plugin Policy Violation History reportReport.
A policy check summary report of the results is generated in HTML and JSON formats (located in the whitesource folder created in the directory from where the Agent was run) and can also be presented within the build server console via API.
...
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 provides the ability to integrate with issue tracking systems in order to automatically create issues in those systems when a policy match occurs. As a result, issues automatically open in the issue tracking system and are automatically filled with the relevant WhiteSource information required to mitigate the risks triggering the creation of the issue. When a policy is matched with a library (as a result of a scan or when applying policy changes to existing inventory), an issue creation is triggered in the WhiteSource application. The plugins periodically (once an hour) fetch this information and create the corresponding issues in Jira. 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: NOTES:
|
...
Organizational level policies are of a higher priority than Global organization level policies.
Product level policies are of a higher priority than organizational level policies.
Project level policies are of a higher priority than product level policies.
In the Policy Policies page, you can change the priorities of policies by using the following buttons:
...
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.
...
Use Case 2: Ticket Creation Workflow
WhiteSource policies can integrate with Ticket Management Systems (such as JIRA or Work Items), enabling the automatic creation of integrates with issue tracking systems to automatically create tickets for tracking issues externally to WhiteSource. When vulnerabilities are found in the user’s code that development needs to fix, a ticket is automatically created in the issue tracker with all related information. All relevant developers will automatically receive a task in JIRA to resolve in those systems when a policy match occurs. As a result, issues automatically open in the issue tracking system and are automatically filled with the relevant WhiteSource information required to mitigate the risks triggering the creation of the issue.
This use case provides an example of a ticket creation flow from the time a high-security vulnerability (as defined by the NVD) is discovered when scanning the user’s open source library code. This high security vulnerability needs to be fixed in the user’s code. An Issue policy is created in the WhiteSource application. The plugins periodically (once an hour) will fetch this information and create the corresponding issues issue in a Jira projects project where you the relevant developers will be able to see themit.
NOTE: Jira policies created in WhiteSource will only take effect once the plugin has been set up by your administrator. For more informationdetails, see Issue Tracker Integration Generic Platform and Plugins .
To create an issue in JIRA that can be managed externally to WhiteSource, do as follows:
In the Admin Console, create Policies page, click the Add Policy button.
Create the required policy and select the Issue action.
Select the Fail plugin policy check check box if you want to fail the scanned policies that have the Reject action type according to the Unified Agent configuration, before they are uploaded to the WhiteSource server.
Configure In the JIRA credentials in the Issue Settings:
Select, select the Tracker Type as Issue Tracker Plugin.
Select the Jira Project for the issue.
Select the Issue Type (e.g. Task or Bug).
Change the Assignee if required.
...
Click Add to revert to the Policies page showing the Issue policy created in WhiteSource.
In the Jira itself, the issue will describe the level and match type of the policy, including the organization, product and project which the library belongs to. Additional information will also be displayed that helps to identify why this library matched the policy (in this example, since the policy match type was High Severity Vulnerability, the vulnerability severity and link appears).
...
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.
...