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
Release files for cpgclientlib 0.10.59
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cpgclientlib-0.10.59.tar.gz | 3.3 kB | Details |
Release files / cpgclientlib-0.10.59.tar.gz
| Download URL | cpgclientlib-0.10.59.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
efb57b55cc5c1210a9816ef280a8f637b39ae757f884417372bcbef113c20932
|
|
BLAKE2b-256 checksum How to use checksums |
18e1af175a5dd02a7eb28dd1fcdf80c8b405ba99a704cdac9c70aade963169e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.12
|
