README
¶
Justification Verification
JVS is not an official Google product.
This repository contains components related to a justification verification service
Use Case
Audit logs are special logs that record when and who called which
application and accessed what data. And why the access was necessary (aka.
the justification of the data access). JVS is a solution to produce verified
justifications and in combination with
abcxyz/lumberjack the justifications
could be audit logged.
Components
JVS consists of the following components:
- JVS APIs
- Justification API: verify justifications and mint short-lived justification tokens.
- Cert Rotator API: rotate signing keys.
- Public Key API: JWKs.
- CLI Tool
- UI
See manuals for JVS APIs usage, JVS CLI Tool Usage, and JVS UI usage
TODO(#115): add a simple diagram to describe the user experience flow of enabling JVS in Lumberjack.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
v0
Package v0 contains versioned JVS contracts, e.g.
|
Package v0 contains versioned JVS contracts, e.g. |
|
Package assets defines the templates and embedded filesystems.
|
Package assets defines the templates and embedded filesystems. |
|
client-lib
|
|
|
go/client
Package client provides a client library for JVS
|
Package client provides a client library for JVS |
|
go
Module
|
|
|
cmd
|
|
|
internal
|
|
|
project
Package project defines global project helpers.
|
Package project defines global project helpers. |
|
pkg
|
|
|
cli
Package cli implements the commands for the JVS CLI.
|
Package cli implements the commands for the JVS CLI. |
|
config
Package config provides configuration-related files and methods.
|
Package config provides configuration-related files and methods. |
|
formatter
Package formatter exposes printers and formatters for justifications and justification tokens.
|
Package formatter exposes printers and formatters for justifications and justification tokens. |
|
idtoken
Package idtoken provides functions to generate id tokens for end users.
|
Package idtoken provides functions to generate id tokens for end users. |
|
testutil
Package testutil provides utilities that are intended to enable easier and more concise writing of unit test code.
|
Package testutil provides utilities that are intended to enable easier and more concise writing of unit test code. |
Click to show internal directories.
Click to hide internal directories.