Create Custom FlexNet Code Insight Fingerprints

[#1]

Summary

Palamida's Source Code Fingerprint matching ordinarily checks file contents for terms that are likely indicators of third-party content. This articles provides steps for creating custom fingerprints.

Synopsis

FlexNet Code Insight's Source Code Fingerprint matching ordinarily checks file contents for terms that are likely indicators of third-party content. Creating custom fingerprints allows one to generate a list of terms suited to the kinds of components one is interested in identifying. FlexNet Code Insight's standard source code fingerprints will continue to be checked for matches alongside your custom fingerprints.

Behavior

FlexNet Code Insight centrally manages custom data, such as custom source code fingerprints and digests. This means that custom fingerprints and digests will be picked up by all workspaces. If you need to isolate custom data to a particular workspace, contact Flexera Software Support.

Configuration

Custom fingerprint generation is controlled by an XML configuration file. The template for this file is located in:

scriptRunner/scripts/customFingerprints_template.xml

Discussion

The basic instructions for generating custom fingerprints are as follows:

1. Go to scriptRunner/scripts directory and make a copy of the customFingerprints_template.xml file. You can either edit this file or make a copy of it. For example purposes, we?ll assume we are editing the customFingerprints_template.xml file in these instructions.

2. Edit customFingerprints_template.xml file located in scriptRunner/scripts directory as follows and save when finished:

   Set the output directory to point to the corporate workspaces directory:

   outputDir="Palamida/workspaces/CorporateWS">

   Set the product name for which you are generating SCF:

   <product name="component_foo">

   Set the release name for every distinct release for which you are generating SCF:

   <release name="component_foo_1.0.zip">
   <release name="component_foo_1.2.zip">

   Provide a directory where the source code for the fingerprints is located. Note: you need to give the path to the directory and not the file path. Custom SCFs will be generated for all the files under this directory.

   <fileset dir="/Palamida/custom/foo_directory">

3. Make sure the Palamida Server is running.

4. Invoke scriptRunner to generate your custom fingerprints:

   cd $PALAMIDA_HOME/scriptRunner/bin
   ./scriptRunner.sh -n customFingerprints.groovy ?d customFingerprints_template.xml

Additional Information

The following options can provide you more detailed match information.

• -d: This option applied to the fingerprint compiler causes a digest record to be created for every file that is processed. If you do not specify the ?-d? option, you will not get digest matches on exact copies of the files processed by the fingerprint compiler.
• -a: This option generates fingerprints for files within archives. Otherwise, the fingerprint compiler will not go inside archive files.
• -v: This option gives you more detailed information in the scriptRunner/log/scriptRunner.log