A client library for CPG servers
Project description
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
Project details
Release history Release notifications | RSS feed
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.9.255.tar.gz
(3.3 kB
view details)
File details
Details for the file cpgclientlib-0.9.255.tar.gz
.
File metadata
- Download URL: cpgclientlib-0.9.255.tar.gz
- Upload date:
- Size: 3.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48555194b728a82cd8d219446d27164d83a87bd8ef58f28ddb7e964db86de25e |
|
MD5 | d5469b308363352f177a05742e0af5f2 |
|
BLAKE2b-256 | 7b402e96561650bc9f959beabe9b2e999e9e985d5373805a6ec95ea42212fcbe |