A Python client library for Joern Server
A library to script code analyzers based on code property graphs (e.g., Joern/Ocular) via Python.
Requirements
- Python 3 and Pip(we do not support Python 2.7) see (https://packaging.python.org/tutorials/installing-packages/)
Installation
To download and install the latest version, issue the following command:
pip install cpgclientlib
Usage
Assuming that joernd is running locally, the following short scripts creates a code property graph and runs a query to retrieve all methods in JSON format.
#!/usr/bin/env python3
from cpgclient.CpgClient import CpgClient
server = '127.0.0.1'
port = 8080
client = CpgClient(server, port)
client.create_cpg('/path/to/cpg')
methods = client.query('cpg.method.toJson')
print(methods)
References
- Code Property Graph specification and tools https://github.com/ShiftLeftSecurity/codepropertygraph/
- The open source code analyze joern: https://joern.io
- ShiftLeft Ocular: https://ocular.shiftleft.io
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cpgclientlib-0.11.321.tar.gz
(3.3 kB
view details)
File details
Details for the file cpgclientlib-0.11.321.tar.gz.
File metadata
- Download URL: cpgclientlib-0.11.321.tar.gz
- Upload date:
- Size: 3.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/2.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c0ff49c797892b3c528a55c00034fc3eb05784277e60be834d859d7f0ca3d78
|
|
| MD5 |
c4afa57b8e07537c7da4b45ed3d76131
|
|
| BLAKE2b-256 |
075b54cb83bf2f7349a39d52594440498538c53b75974c6ffeefb0f2f78cffa7
|
