Skip to content

Latest commit

 

History

History
176 lines (80 loc) · 4.38 KB

README.md

File metadata and controls

176 lines (80 loc) · 4.38 KB
Raw

sca-codeinsight-workflow-v6

This python based script allows users to synchronize Code Insight v7 manual review tasks with Code Insight v6 requests for advanced workflow requirements.

The process starts with creating an inventory item in v7 and marking it as disclosed. A Manual Review Task is required as well which can be automatically created by enabling the "Manual Review Option" settings within the Projects Review and Remediation Settings Tab. This task can also be manually created for each component if desired.

As the request goes through the workflow approval process, each time the script is executed the current status is updated with in the associated task.

Once the request has reached its completion the inventory item in v7 is approved/rejected and the task is closed.

This script can be manually executed or run via a cron job at selected intervals.

Basic Script Flow

Initial Synchronization

  • Cycles through each project

  • Project status != “Project Completed”

  • Cycle through each inventory item

  • Disclosed == “True”

  • Active Manual Review Task

  • Create v6 project is required

  • v7 project name + v7 project ID

Review Task w/out workflow association

  • Create draft request

  • Update inventory item workflow url with newly created request details

Review Task w/ workflow association

  • Update v7 task with latest workflow

  • Current review level

  • Task owner to currently assigned reviewer

  • If request has reached workflow termination

  • Close task

  • Inventory item approved/rejected

Prerequisites

Within Code Insight v6 (workflow system)

  • Template project exists in v6
    • Project Form
    • Project Review Hierarchy Defined
  • User account with admin rights
    • Owns template project and can assign ownership
    • Authorization token required for conifguration
  • Common usernames between v6 and v7 for standard users
    • Inventory creator in v7 is requester in v6

Within Code Insight v7 (Disclosure/Scanning system)

  • Project has been created in v7
  • Correct Policy Selected in v7
  • Automatic task creation option for un-reviewed items enabled
    • Manual task creation is required if this option is not set
  • Common usernames between v6 and v7 for standard users
    • Inventory creator in v7 is requester in v6
  • Authorization Token
    • User
      • Project owner rights
    • Admin
      • For user based API access

For the python script itself pip install -r requirements.txt installs the required dependencies to execute the script. This script has been tested specifically on Python version 3.8.1 but it should on versions 3.5 or greater.

Script Configuration

In config.py please update all of the variables defined there to reflect the values for the v6 and v7 instances that are being synchronized.

For Code Insight v6 (Workflow System)

v6_FNCI_HOST = "localhost"  # IP Address of Workflow System

v6_FNCI_PORT = "8880"  # Port for Workflow System

v6_BASEURL = "http(s)://" + v6_FNCI_HOST + ":" + v6_FNCI_PORT + "/palamida/api/"

v6_REQUESTURL = "http(s)://" + v6_FNCI_HOST + ":" + v6_FNCI_PORT + "/palamida/RequestDetails.htm?rid="

# Token for Workflow Admin User - This user must own the template project!

v6_AUTHTOKEN = "*****"

v6_teamName = "Engineering"

v6_projectTemplatename = "Workflow Template"  # Must be owned by user with Auth Token above

For Code Insight v7 (Disclosure/Scanning System)

FNCI_HOST = "localhost"  # IP Address of Scanning System

FNCI_PORT = "8888"  # Port for Scanning System

BASEURL = "http(s)://" + FNCI_HOST + ":" + FNCI_PORT + "/codeinsight/api/"

# Token for Workflow Admin User ( must be added to project to update task)

ADMIN_AUTHTOKEN = "*****"

AUTHTOKEN = "*****"

In v7 the ADMIN_AUTHTOKEN is required for a few of the API calls that need admin rights. If the standard project owner does not have admin rights enter the token for an admin user

Finally specify the v7 version of Code Insight to allow for future additions to the script based on functionality being added as time goes on.

# To allow for changes in script that are release specific

FNCI_VERSION = "2020R1"

License

MIT