Source code for swh.vulns.api.server

# Copyright (C) 2026  The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information

import logging
import os
from typing import Dict

from swh.core import config
from swh.core.api import RPCServerApp
from swh.core.api import encode_data_server as encode_data
from swh.core.api import error_handler
from swh.vulns.storage import get_vulnerabilities_storage
from swh.vulns.storage.interface import VulnerabilitiesStorageInterface

from .serializers import DECODERS, ENCODERS

vulnerabilities_storage = None



[docs]
def get_global_vulnerabilities_storage():
    global vulnerabilities_storage
    if not vulnerabilities_storage:
        vulnerabilities_storage = get_vulnerabilities_storage(**app.config["vulns"])
    return vulnerabilities_storage




[docs]
class VulnerabilitiesStorageServerApp(RPCServerApp):
    extra_type_decoders = DECODERS
    extra_type_encoders = ENCODERS



app = VulnerabilitiesStorageServerApp(
    __name__,
    backend_class=VulnerabilitiesStorageInterface,
    backend_factory=get_global_vulnerabilities_storage,
)



[docs]
@app.errorhandler(Exception)
def my_error_handler(exception):
    return error_handler(exception, encode_data)




[docs]
def has_no_empty_params(rule):
    return len(rule.defaults or ()) >= len(rule.arguments or ())




[docs]
@app.route("/")
def index():
    return """<html>
<head><title>Software Heritage OSV vulnerabilities storage RPC server</title></head>
<body>
<p>You have reached the
<a href="https://www.softwareheritage.org/">Software Heritage</a>
OSV vulnerabilities storage server.<br />
</body>
</html>"""




[docs]
def load_and_check_config(config_path: str, type_class: str = "postgresql") -> Dict:
    """Check the minimal configuration is set to run the api or raise an
       error explanation.

    Args:
        config_path: Configuration file path to load
        type_class: Configuration type, for 'postgresql' type (the default), more checks
              are done.

    Raises:
        Error if the setup is not as expected

    Returns:
        configuration as a dict

    """
    if not config_path:
        raise EnvironmentError("Configuration file must be defined")

    if not os.path.exists(config_path):
        raise FileNotFoundError(f"Configuration file {config_path} does not exist")

    cfg = config.read(config_path)

    vcfg = cfg.get("vulns")
    if not vcfg:
        raise KeyError("Missing 'vulns' configuration")

    if type_class == "postgresql":
        cls = vcfg.get("cls")
        if cls != "postgresql":
            raise ValueError(
                "The OSV vulnerabilities storage backend can only be started with "
                "a 'postgresql' configuration"
            )

        db = vcfg.get("db")
        if not db:
            raise KeyError("Invalid configuration; missing 'db' config entry")

    return cfg



api_cfg = None



[docs]
def make_app_from_configfile():
    """Run the WSGI app from the webserver, loading the configuration from
    a configuration file.

    SWH_CONFIG_FILENAME environment variable defines the
    configuration path to load.

    """
    global api_cfg
    if not api_cfg:
        config_path = os.environ.get("SWH_CONFIG_FILENAME")
        api_cfg = load_and_check_config(config_path)
        app.config.update(api_cfg)
    handler = logging.StreamHandler()
    app.logger.addHandler(handler)
    return app