Skip to main content

Schema for the rl-profile configuration file

The Spectra Assure platform supports a special configuration file called rl-profile. With rl-profile configuration files, you can reuse, share, and audit configuration settings that impact analysis results (such as SAFE Levels, automatic approval, and policy overrides) across different Spectra Assure products.

This ensures consistency across products and automatically applies any predefined customizations, reducing the risk of configuration errors and discrepancies.

This page describes the full schema of the rl-profile configuration file.

How to read the schema?​

The schema contents are displayed as an expandable schema model and described in alphabetical order. Expandable items have an arrow indicator next to their name. Select the arrow to expand the item and view its contents.

The full rl-profile example file is displayed below the schema. You can copy the whole example by selecting "Copy" in the code block.

Desktop browsers: To make the schema easier to read, you can hide the navigation sidebar by selecting the << button at the bottom left of the page.

rl-profile schema​

required
object

The rl-profile section is the main container for all supported configuration options.

{
  • "rl-profile": {
    }
}

rl-profile example​

This example is for illustrative purposes only. It is used to visualize the configuration file structure.

rl-profile example
{
    "rl-profile": {
        "schema": 1,
        "name": "Profile",
        "info": "Profile exported from Spectra Assure Portal: Organization / Group",
        "timestamp": "2023-01-30T11:35:24+0000",
        "configuration": {
            "portal": {},
            "policy": {
                "min_catalogue": 5,
                "rl_scan_level": 5,
                "rl_auto_approval": false,
                "assessments": {
                    "secrets": {
                        "ignored": false
                    },
                    "licenses": {
                        "ignored": false
                    },
                    "vulnerabilities": {
                        "ignored": false,
                        "detections": {
                            "mandate": "fail",
                            "exploit": "warning",
                            "malware": "fail",
                            "critical": "warning"
                        }
                    },
                    "hardening": {
                        "ignored": false
                    },
                    "tampering": {
                        "ignored": false,
                        "ml_hunting": "warning"
                    },
                    "malware": {
                        "ignored": false,
                        "rl_analyst": "fail",
                        "rl_scanner": "fail",
                        "suspicious": "warning",
                        "dependency": {
                            "develop": "warning",
                            "release": "fail"
                        },
                        "detections": {
                            "adware": "fail",
                            "riskware": "warning",
                            "protestware": "pass",
                            "spam": "pass"
                        }
                    }
                },
                "governance": {
                    "community": {
                        "min_package_age": 90,
                        "min_version_age": 3,
                        "allow": [
                            {
                                "pattern": "pkg:gem/rack",
                                "audit": {
                                    "author": "person@company.com",
                                    "timestamp": "2023-01-30T11:35:24+0000",
                                    "reason": "Override reason"
                                }
                            },
                            {
                                "pattern": "pkg:pypi/flask@3.1.2?artifact=flask-3.1.2-py3-none-any.whl",
                                "audit": {
                                    "author": "person@company.com",
                                    "timestamp": "2023-01-30T11:35:24+0000",
                                    "reason": "Override reason"
                                }
                            }
                        ],
                        "block": [
                            {
                                "pattern": "pkg:npm/ua-parser-js@0.7.*",
                                "audit": {
                                    "author": "person@company.com",
                                    "timestamp": "2023-01-30T11:35:24+0000",
                                    "reason": "Blocking reason"
                                }
                            }
                        ]
                    }
                },
                "overrides": {
                    "SQ30108": {
                        "enabled": true,
                        "blocker": "pass",
                        "apply_to": [
                            "organization",
                            "group",
                            "any"
                        ],
                        "audit": {
                            "author": "person@company.com",
                            "timestamp": "2023-01-30T11:35:24+0000",
                            "reason": "Override reason"
                        }
                    }
                }
            }
        }
    }
}