How jbcongdon/platform works
Project type and purpose
• This is a backend platform monorepo (“OpenTDF”) that provides a modular set of gRPC‐based microservices, a native Go SDK, CLI tools, shared libraries, protobuf definitions and example clients. Its purpose is to enforce attribute‐based access control (ABAC) on encrypted data via a set of services (authorization, entity‐resolution, policy, key‐access (KAS), logging) and an OIDC IdP (Keycloak) for authentication.
File structure
• Top‐level modules:
• service/ – the main OpenTDF service and sub‐services (authorization, entityresolution, kas, logger, health)
• sdk/ – the native Go SDK and generated service SDKs
• lib/ – shared libraries (crypto, flattening, fixtures)
• protocol/ – protobuf definitions and generated Go stubs (gRPC + HTTP‐gateway)
• examples/ – sample CLI programs demonstrating encrypt/decrypt, metrics, authorization
• docker-compose.yaml, Dockerfile, .github/ – orchestration and CI/CD configuration
• Notice the microservice pattern: each domain (policy, authorization, entityresolution, kas) has its own proto, its own Go implementation and its own test suite.
• Configuration YAMLs (opentdf-*.yaml) define service endpoints, database connections, Keycloak OIDC settings.
• buf.yaml + buf.gen.* manage protobuf code generation (gRPC + OpenAPI).
README for additional insights
• Core entrypoint: the “service” binary (service/cmd/start.go)
• Dependencies: Go, Docker Compose, Buf, Keycloak
• Quickstart shows: Key Generation → Docker Compose up (Postgres, Keycloak, service, KAS) → Provision Keycloak → Run service → Use SDK/CLI to encrypt/decrypt.
• The README calls out ABAC (PDP/PEP), OIDC, and policy schemas (ERD) as central concepts.