Feature/go build (#1)

* Temp commit Signed-off-by: Prabhu Subramanian <prabhu@appthreat.com>
AppThreat · Apr 6, 2023 · 69efbf8 · 69efbf8
1 parent 54f4cf2
commit 69efbf8
Show file tree

Hide file tree

Showing 6 changed files with 627 additions and 434 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -27,7 +27,7 @@ COPY . /usr/local/src/
 
 RUN echo -e "[nodejs]\nname=nodejs\nstream=18\nprofiles=\nstate=enabled\n" > /etc/dnf/modules.d/nodejs.module \
     && microdnf install -y gcc git-core php php-cli python3 python3-devel pcre2 which tar zip unzip sudo \
-        java-17-openjdk-headless ncurses jq krb5-libs libicu openssl-libs compat-openssl11 zlib \
+        java-17-openjdk-headless java-1.8.0-openjdk-headless ncurses jq krb5-libs libicu openssl-libs compat-openssl11 zlib \
         dotnet-sdk-7.0 dotnet-targeting-pack-7.0 dotnet-templates-7.0 dotnet-hostfxr-7.0 nodejs \
     && curl -LO https://github.com/joernio/joern/releases/latest/download/joern-install.sh \
     && chmod +x ./joern-install.sh \

diff --git a/README.md b/README.md
@@ -65,6 +65,15 @@ Container based invocation
 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw --cpus=4 --memory=16g -t ghcr.io/appthreat/cpggen cpggen -i <src directory> -o <CPG directory or file name>
 ```
 
+### Artifacts produced
+
+Upon successful completion, cpggen would produce the following artifacts in the directory specified under `out_dir`
+
+- {name}-{lang}-cpg.bin.zip - Code Property Graph for the given language type
+- {name}-{lang}-cpg.bom.xml - SBoM in CycloneDX XML format
+- {name}-{lang}-cpg.bom.json - SBoM in CycloneDX json format
+- {name}-{lang}-cpg.manifest.json - A json file listing the generated artifacts and the invocation commands
+
 ## Server mode
 
 cpggen can run in server mode.
@@ -105,15 +114,27 @@ curl "http://127.0.0.1:7072/cpg?url=https://github.com/HooliCorp/vulnerable-aws-
 
 ## Environment variables
 
-| Name                    | Purpose                                                      |
-| ----------------------- | ------------------------------------------------------------ |
-| JOERN_HOME              | Joern installation directory                                 |
-| CPGGEN_HOST             | cpggen server host. Default 127.0.0.1                        |
-| CPGGEN_PORT             | cpggen server port. Default 7072                             |
-| CPGGEN_CONTAINER_CPU    | CPU units to use in container execution mode. Default 2      |
-| CPGGEN_CONTAINER_MEMORY | Memory units to use in container execution mode. Default 32g |
-| CPGGEN_MEMORY           | Heap memory to use for frontends. Default 32G                |
-| AT_DEBUG_MODE           | Set to debug to enable debug logging                         |
+| Name                    | Purpose                                                           |
+| ----------------------- | ----------------------------------------------------------------- |
+| JOERN_HOME              | Joern installation directory                                      |
+| CPGGEN_HOST             | cpggen server host. Default 127.0.0.1                             |
+| CPGGEN_PORT             | cpggen server port. Default 7072                                  |
+| CPGGEN_CONTAINER_CPU    | CPU units to use in container execution mode. Default computed    |
+| CPGGEN_CONTAINER_MEMORY | Memory units to use in container execution mode. Default computed |
+| CPGGEN_MEMORY           | Heap memory to use for frontends. Default computed                |
+| AT_DEBUG_MODE           | Set to debug to enable debug logging                              |
+
+## GitHub actions
+
+Use the marketplace [action](https://github.com/marketplace/actions/cpggen) to generate CPGs using GitHub actions. Optionally, the upload the generated CPGs as build artifacts use the below step.
+
+```
+- name: Upload cpg
+  uses: actions/upload-artifact@v1.0.0
+  with:
+    name: cpg
+    path: cpg_out
+```
 
 ## License