aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRasmus Dahlberg <rgdd@glasklarteknik.se>2025-03-02 12:12:43 +0100
committerRasmus Dahlberg <rgdd@glasklarteknik.se>2025-03-02 12:25:31 +0100
commit43105d27d470757a19184beeb18e1347a9f236bb (patch)
treedc3bafbcd469dff430c8a945610ec16a23900b7e
parent48bb0066e511f2fc9288391d8c5159d8a604e879 (diff)
Document log list in README
This was only documented in the lengthier design doc before, and the option of doing "remove_logs" and "static_logs" had not been documented. Part of #21, thanks vexelnet!
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 42fc1b8..1e19f08 100644
--- a/README.md
+++ b/README.md
@@ -101,6 +101,19 @@ configuration of each trusted system. The monitor will refuse to mark a
certificate as legitimate unless the trusted system that requested it had
permission to do so. This adds a layer of separation between trusted systems.
+The list of logs is configured and kept up-to-date by downloading [Google's
+list][] in signed format. To remove a log, specify the `"remove_logs"` list.
+Each entry should be a log key on the same format as in the signed list.
+
+ "remove_logs": [
+ "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8m/SiQ8/xfiHHqtls9m7FyOMBg4JVZY9CgiixXGz0akvKD6DEL8S0ERmFe9U4ZiA0M4kbT5nmuk3I85Sk4bagA=="
+ ]
+
+To add or override a log (mostly useful for debug), specify the `"static_logs"`
+list. Each log entry should be on the same format as in the signed list.
+
+[Google's list]: https://github.com/google/certificate-transparency-community-site/blob/master/docs/google/known-logs.md
+
### Start the monitor
Start the monitor: