Github collector for OpenHound
About
OpenHound is a standardized framework for building and running OpenGraph collectors and converters. It is built in Python and powered by the Data Load Tool (DLT) library, giving you a consistent workflow to collect, process, and convert data from any source into BloodHound-compatible graphs.
The openhound-github extension collects resources from Github organizations and transforms these into useable nodes and edges for BloodHound.
GitHub App JWT issuer
Enterprise GitHub App credentials accept either client_id or app_id as the
JWT issuer. When both are configured, client_id is preferred. At least one
identifier must be supplied together with key_path and enterprise_name.
GitHub Enterprise Server endpoints
GitHub.com is the default deployment and does not require endpoint configuration.
To collect from GitHub Enterprise Server, set both API endpoints in config.toml:
[sources.github]
rest_api_url = "https://ghe.example/api/v3"
graphql_url = "https://ghe.example/api/graphql"
Both values must be provided together when overriding the GitHub.com defaults.
Endpoint URLs must use HTTPS and share the same origin. GitHub App
credentials.api_uri may override only the path on that same origin.
Enterprise SCIM and hybrid correlations
A token with enterprise SCIM access is used to collect both /scim/v2/enterprises/{enterprise}/Users and /scim/v2/enterprises/{enterprise}/Groups. The collector emits normalized SCIM_Organization, SCIM_User, and SCIM_Group nodes plus SCIM_Contains, SCIM_MemberOf, and SCIM_Provisioned relationships. Install the BloodHound SCIM extension alongside this extension to register the shared SCIM kinds.
SOURCES__GITHUB__EMIT_LEGACY_SCIM_CORRELATIONS=true temporarily reproduces GitHound-style Okta-to-SCIM correlation relationships. It defaults to false because a dedicated hybrid correlator should own IdP-to-SCIM matching; GitHub remains authoritative for GitHub's SCIM resources and target-system provisioning relationships.
Enterprise roles, including the built-in members role, are emitted through GH_HasRole and granular enterprise capability relationships. Only capability relationships with a confirmed privilege path are traversable; descriptive permissions such as GH_WriteEnterpriseSso remain non-traversable.
Optional privileged collection
The collector runs successfully with the documented read-only permission set. Some higher-fidelity relationships require optional non-read-only permissions because GitHub exposes the supporting read APIs behind privileged permission names:
- Organization
Members: writeenables external group mapping collection for IdP-synced teams, which allows the converter to emitSCIM_Provisionededges fromSCIM_GrouptoGH_Team. This is useful when the organization uses team synchronization with an external identity provider; if no GitHub teams are linked to external groups, this permission does not add graph data. - Classic PAT scope
manage_runners:enterpriseenables enterprise self-hosted runner group and runner collection. This is useful when the enterprise has enterprise-scoped runner groups or runners, especially runner groups shared into organizations; if all runners are organization- or repository-scoped, this scope does not add graph data. - Repository
Administration: readenables deploy key collection. GitHub exposes repository deploy keys through an administration-scoped read endpoint, and the collector emitsGH_DeployKeynodes only when that endpoint is accessible.
If these optional permissions are not granted, OpenHound skips the affected resources and continues collecting the rest of the GitHub environment.
Getting Started
Follow the OpenHound GitHub collector docs to get started:
Metadata
Release files for openhound-github 0.16.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openhound_github-0.16.0.tar.gz | 3.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openhound_github-0.16.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.9 MB
Release files / openhound_github-0.16.0.tar.gz
| Download URL | openhound_github-0.16.0.tar.gz |
|---|---|
| Size | 3.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
62eb141145bd3d7154d993f9ece9a69e67bf832761a4f099e3e94e3db4326b18
|
|
BLAKE2b-256 checksum How to use checksums |
67d83ca79d72a2d35c16e2fb44bf3ccda2ed76cf9a6ce89c61546690ca2493b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / openhound_github-0.16.0-py3-none-any.whl
| Download URL | openhound_github-0.16.0-py3-none-any.whl |
|---|---|
| Size | 163.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e44626334566d7bb655a49e254fc77bacab8e6f9de99f7c4d011d4e312119117
|
|
BLAKE2b-256 checksum How to use checksums |
7d13ea9db40a4aa74f06e4e02d8376a378f3b7e179f23fbc87452a93b0fb86d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
