• Using the Containers
  • Running the containers
  • Use gh-mrva container to send request via cli
  • Send request via gui, using vs code

Using the Containers

Running the containers

1. Start the containers

     cd ~/work-gh/mrva/mrva-docker/
     docker-compose down
     docker ps
     docker-compose -f docker-compose-demo.yml up -d

2. View all logs

   docker-compose logs
   

3. Follow all logs if started with -d

   docker-compose logs -f
   

4. Follow single container, server, logging via

     cd ~/work-gh/mrva/mrvacommander
     docker-compose up -d
     docker-compose logs -f server

5. Cleanup in case of obscure errors (network or other)

     docker-compose -f docker-compose-demo.yml down --volumes --remove-orphans
     docker network prune
     docker-compose -f docker-compose-demo.yml up --build

Use gh-mrva container to send request via cli

  docker exec -it mrva-docker-client-ghmrva-1 bash

  # Sanity check
  gh-mrva -h


  #    2. Set up the configuration
  mkdir -p ~/.config/gh-mrva
  cat > ~/.config/gh-mrva/config.yml <<eof
  # The following options are supported
  # codeql_path: Path to CodeQL distribution (checkout of codeql repo)
  # controller: NWO of the MRVA controller to use.  Not used here.
  # list_file: Path to the JSON file containing the target repos

  codeql_path: not-used/codeql-path
  controller: not-used/mirva-controller
  list_file: $HOME/work-gh/mrva/gh-mrva/gh-mrva-selection.json
  eof

  # Set up repository selection
  mkdir -p ~/work-gh/mrva/gh-mrva
  cat >   ~/work-gh/mrva/gh-mrva/gh-mrva-selection.json <<eof
  {
      "mirva-list": [
          "Mbed-TLS/mbedtlsctsj17ef85",
          "ampl/gslctsj4b270e",
          "baidu/sofa-pbrpcctsjba3501",
          "dlundquist/sniproxyctsj3d83e7",
          "emscripten-core/emscriptenctsj16e1d3",
          "hyprwm/Hyprlandctsjc2425f",
          "lz4/lz4ctsj2479c5",
          "medooze/media-server-nodectsj5e30b3",
          "murat-dogan/node-datachannelctsj4edeef",
          "pmneila/PyMCubesctsj582da6",
          "tsl0922/ttydctsj2e3faa"
      ]
  }
  eof

  # Create the query
  cat > ~/work-gh/mrva/gh-mrva/FlatBuffersFunc.ql <<eof
  /**
   ,* @name pickfun
   ,* @description pick function from FlatBuffers
   ,* @kind problem
   ,* @id cpp-flatbuffer-func
   ,* @problem.severity warning
   ,*/

  import cpp

  from Function f
  where
    f.getName() = "MakeBinaryRegion" or
    f.getName() = "microprotocols_add"
  select f, "definition of MakeBinaryRegion"
  eof


  # Submit the mrva job
  # Note: QLPack does not exist. Generating synthetic one for /root/work-gh/mrva/gh-mrva/FlatBuffersFunc.ql
  cd ~/work-gh/mrva/gh-mrva/
  gh-mrva submit --language cpp --session mirva-session-1160    \
            --list mirva-list                                     \
            --query ~/work-gh/mrva/gh-mrva/FlatBuffersFunc.ql


  # 4. Check the status
  gh-mrva status --session mirva-session-1160


  # 5. Download the sarif files and databases.  For the current
  # query / database combination there are zero result hence no downloads.
  cd ~/work-gh/mrva/gh-mrva/

  # Download the sarif files and CodeQL dbs
  gh-mrva download --session mirva-session-1160   \
          --download-dbs                          \
          --output-dir mirva-session-1160

  # Run a query with results
  # create the qlpack
  cat > ~/work-gh/mrva/gh-mrva/qlpack.yml <<eof
  library: false
  name: codeql-dataflow-ii-cpp
  version: 0.0.1
  dependencies:
    codeql/cpp-all: 0.5.3
  eof

  # create the query
  cat > ~/work-gh/mrva/gh-mrva/Fprintf.ql <<eof
  /**
   ,* @name findPrintf
   ,* @description find calls to plain fprintf
   ,* @kind problem
   ,* @id cpp-fprintf-call
   ,* @problem.severity warning
   ,*/

  import cpp

  from FunctionCall fc
  where
    fc.getTarget().getName() = "fprintf"
  select fc, "call of fprintf"
  eof

  # Submit the next mrva job
  cd ~/work-gh/mrva/gh-mrva/
  gh-mrva submit --language cpp --session mirva-session-1260  \
            --list mirva-list                                 \
            --query ~/work-gh/mrva/gh-mrva/Fprintf.ql


  # 4. Check the status
  gh-mrva status --session mirva-session-1260

  # 5. Download the sarif files and databases.  
  cd ~/work-gh/mrva/gh-mrva/
  gh-mrva download --session mirva-session-1260   \
          --download-dbs                          \
          --output-dir mirva-session-1260

Send request via gui, using vs code

The following sequence works when run from a local vs code with the custom codeql plugin.

1. ql tab > variant analysis repositories > {}, put this into databases.json

     {
         "version": 1,
         "databases": {
             "variantAnalysis": {
                 "repositoryLists": [
                     {
                         "name": "mirva-list",
                         "repositories": [
                             "lz4/lz4ctsj2479c5",
                             "pmneila/PyMCubesctsj582da6",
                             "murat-dogan/node-datachannelctsj4edeef",
                             "Mbed-TLS/mbedtlsctsj17ef85",
                             "tsl0922/ttydctsj2e3faa",
                             "medooze/media-server-nodectsj5e30b3",
                             "ampl/gslctsj4b270e",
                             "baidu/sofa-pbrpcctsjba3501",
                             "emscripten-core/emscriptenctsj16e1d3",
                             "dlundquist/sniproxyctsj3d83e7",
                             "hyprwm/Hyprlandctsjc2425f"
                         ]
                     }
                 ],
                 "owners": [],
                 "repositories": []
             }
         },
         "selected": {
             "kind": "variantAnalysisUserDefinedList",
             "listName": "mirva-list"
         }
     }

2. ql tab > variant analysis repositories > select mrva-list

3. select file qldemo/simple.ql and put Fprintf.ql parallel to it:

     /**
      ,* @name findPrintf
      ,* @description find calls to plain fprintf
      ,* @kind problem
      ,* @id cpp-fprintf-call
      ,* @problem.severity warning
      ,*/
   
     import cpp
   
     from FunctionCall fc
     where
       fc.getTarget().getName() = "fprintf"
     select fc, "call of fprintf"

4. Adjust the qlpack.yml to cpp, from python.
5. Submit the analysis job.