Unified Language User Guides
iCR User Guide 5.0
iCR User Guide 5.0
  • Table of contents
    • Introduction
    • Overview
    • Authorizing Access to Your Source Code
      • Authenticating GitHub Cloud Access Using OAuth
      • Authenticating GitHub Cloud Access Using PAT
      • Authenticating GitHub Enterprise Access Using OAuth
      • Authenticating GitHub Enterprise Access Using PAT
      • Authenticating GitLab Cloud Access Using OAuth
      • Authenticating GitLab Cloud Access Using PAT
      • Authenticating GitLab Enterprise Access Using OAuth
      • Authenticating GitLab Enterprise Access Using PAT
      • Authenticating Bitbucket Cloud Access using OAuth
    • Using the Navigator
      • Connecting to the Navigator
      • Setting your User Password
      • Updating your User Information
      • The Navigator top banner
      • The Analysis Engine status
      • Selecting Your Source Code
        • Using a cloud-based VCS
        • Selecting your branch
        • Using a private VCS
        • Using a local project
        • Limiting the files to be analyzed
      • Integrating with your bug tracking system
        • Integrating with Jira - Define Your Project
        • Integrating with Jira - Authorizing Access for iCR
        • Integrating with Jira - Connecting with iCR
    • Using the Analysis Engine
      • Initiating an analysis
      • Monitoring the analysis
      • Interrupting the analysis
    • Reviewing your results
      • Reviewer summary and filters
        • Filter by Severity
        • Filter by Category
        • Filter by CWE
        • Filter by OWASP
        • Filter by Directory
      • Reviewing a fix
      • Accepting a fix
        • Accepting a fix when integrated with your bug system
      • Rejecting a fix
        • Rejecting a fix when integrated with your bug system
      • Undoing a fix
        • Undoing a fix when integrated with your bug system
      • Rejected fix history
      • Providing feedback
      • Applying the fixes
      • Cases needing manual attention
      • Comparing Analyses
      • Capturing results for printing or sharing
      • Ending a reviewer session
    • When you are complete
    • Integrating iCR Into Your CI/CD Workflows
      • Jenkins Workflow
        • Installing the plugin
        • Configuring the plugin
          • Creating a Personal Access Token
          • Copying Your Repository's URL
        • Viewing the Results
      • GitHub Actions Workflow
        • GitHub Actions Overview
        • Preparing the GitHub Workflow
          • Environment Variables
          • User Supplied Secrets
          • Setting the User Defined Secrets Values
        • Executing the Workflow
      • GitLab CI/CD Workflow
        • GitLab CI/CD OverView
        • Configuring the GitLab Script variables
          • Environment Variables
          • User Supplied Variables
          • Creating a Personal Access Token
          • Setting the User Defined Variable Values
        • Executing the Workflow
      • Multiple Workflows
    • Appendix – Language Specific Fixer Lists
    • Appendix - Sample Bug Listing
    • Appendix - Getting a BitBucket App Password for JENKINS
Powered by GitBook
On this page
  1. Table of contents
  2. Using the Navigator
  3. Selecting Your Source Code

Using a private VCS

PreviousSelecting your branchNextUsing a local project

Last updated 4 months ago

As introduced in Authenticating GitHub Access with a Private VCS Repository, you may be using a locally deployed version of your VCS. Continuing to use GitHub as the example, here is how you set up to review repositories managed by GitHub Enterprise. If you are using GitLab Enterprise as your local VCS, refer to Authenticating GitLab Access with a Private VCS Repository for details on how to configure it for use with the Navigator.

This will bring up the popup showing all of the private repositories that you may have configured and offer you the choice of configuring access either via OAuth or using your private PAT. If this is the first time that you have selected GitHub Enterprise as the VCS, there will be no servers displayed. In this first example, we will create a new server which we will authenticate using OAuth.

Clicking on Add New OAuth Info brings up the OAuth configuration window where you set up the entries needed to locate the server and authenticate it with your OAuth credentials.

Set the name to anything you like. In this example we’ll call it “Private GitHub”.

Then, insert the URL to your private GitHub Enterprise Server. For our example, we have created a URL named github.openrefactory.com. Note that you must add the https:// prefix to the URL to reach your server properly.

Finally, from the OAuth setup described in Authenticating GitHub Access using OAuth, you created a new Client ID and Secret key. Copy those from that window and paste them here.

If you have chosen to authenticate using your private PAT, the above process is a little different. In this case, selecting GitHub Enterprise will again bring up the popup showing all of the private repositories. However, this time, we will choose Add New PAT info. This brings up the popup asking for the PAT information.

Clicking on Add New PAT Info brings up the PAT configuration window where you set up the entries needed to locate the server and authenticate it with your PAT token.

As in the OAuth example, we’ll set the name to “Private GitHub”. Insert the URL to your private GitHub Enterprise Server. We'll use the same URL we used for the OAuth example: github.openrefactory.com.

Finally, as described in Authenticating GitHub Access using PAT, enter the PAT you created from that step.

Once the credentials are set, you may use that private repository by re-selecting GitHub Enterprise from the Select Repository pull-down menu. You will now see the one we just added: Private GitHub.

You will also notice that there are 3 new icons offered to allow you to:

Get Repositories Fetch the list of repositories for the selected Enterprise server

Edit Info Change the GitHub OAuth or PAT credentials

Remove Remove this private VCS from iCR

Click on Get Repositories to see all of your GitHub Enterprise repositories.

From here, everything works the same as outlined in for the cloud-based VCS.

Selecting your branch