Skip to content

[GCP Docs] Document how to add new logs to a witness #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mhutchinson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[GCP Docs] Document how to add new logs to a witness #528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions cmd/omniwitness_gcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,56 @@ export SECRET="projects/..." # This is the secret manager secret name.
go run ./cmd/omniwitness_gcp/ --signer_private_key_secret_name=${SECRET} --spanner=${SPANNER}
```

## Operations

### Adding a new log

To add a new log configuration to a running witness, you can insert a row directly into the Spanner `logs` table. Since the persistence layer requires a deterministic `logID` derived from the log's origin, you can use the following standalone Go program to generate the exact `INSERT` statement to execute in Spanner Studio.

Either save and run this snippet locally, or use https://go.dev/play/ to generate the SQL.

```go
package main

import (
"fmt"

"github.com/transparency-dev/formats/log"
)

func main() {
// Edit these parameters for the log you wish to add:
origin := "vindex.gopherwatch.org"
vkey := "vindex.gopherwatch.org+af4f4f3a+AYlEp21ErzmKZa+aqhjC8BQteyEtsVwmLzblkzHxn8et"
contact := "admin@gopherwatch.org"
qpd := 86400.0
disabled := false

fmt.Println(generateInsert(origin, vkey, contact, qpd, disabled))
}

func generateInsert(origin, vkey, contact string, qpd float64, disabled bool) string {
id := log.ID(origin)

contactVal := "NULL"
if contact != "" {
contactVal = fmt.Sprintf("'%s'", contact)
}

qpdVal := "NULL"
if qpd > 0 {
qpdVal = fmt.Sprintf("%f", qpd)
}

return fmt.Sprintf(`INSERT INTO logs (logID, origin, vkey, contact, qpd, disabled)
VALUES (
'%s',
'%s',
'%s',
%s,
%s,
%t
);`, id, origin, vkey, contactVal, qpdVal, disabled)
}
```

Loading