Skip to content

Commit 4451cba

Browse files
Doc cleanup (#640)
The docs were out of date in a number of places, and information about dev setup was duplicated. Changes: * config/DEVELOPMENT - Deleted, information was already in ca-kms-support * config/README - Out of date, Scaffolding should be used * docs/ctlog - Moved detail on test secret setup from DEVELOPMENT * docs/developer - Deleted, didn't add anything * docs/hsm-support - Removed duplicate info about setting up GCP CA Service, made the focus of the doc about HSM * docs/security-model - Removed extraneous info about timestamping and transparency logs, Fulcio isn't the right place. Left a little bit of detail still. This doc needs some revision and will likely be superseded by a threat model doc. * docs/setup - Small additions from DEVELOPMENT added Misc: * Add back gcloud into docker-compose * Remove SPIFFE provider from test config Signed-off-by: Hayden Blauzvern <[email protected]>
1 parent e022fcd commit 4451cba

File tree

9 files changed

+73
-372
lines changed

9 files changed

+73
-372
lines changed

config/DEVELOPMENT.md

Lines changed: 0 additions & 213 deletions
This file was deleted.

config/README.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

config/config.jsn

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@
1616
"IssuerClaim": "$.federated_claims.connector_id",
1717
"Type": "email"
1818
},
19-
"https://oidc.dlorenc.dev": {
20-
"IssuerURL": "https://oidc.dlorenc.dev",
21-
"ClientID": "sigstore",
22-
"Type": "spiffe"
23-
},
2419
"https://token.actions.githubusercontent.com": {
2520
"IssuerURL": "https://token.actions.githubusercontent.com",
2621
"ClientID": "sigstore",

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ services:
3636
- "5554:5554"
3737
- "2112:2112"
3838
volumes:
39+
- ~/.config/gcloud:/root/.config/gcloud/:z # for GCP authentication
3940
- ./config/config.jsn:/etc/fulcio-config/config.json:z
4041
healthcheck:
4142
test: ["CMD", "curl", "-f", "http://localhost:5555/ping"]

docs/ctlog.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,15 @@ We will create new log shards each year. The log's name will be the year. Curren
101101
at `https://ctfe.sigstore.dev/test`. After sharding the log, the log will be accessible at
102102
`https://ctfe.sigstore.dev/2022`. We can use the same signing key for each year's shard, so that we don't
103103
need to distribute a new key each year in the TUF metadata.
104+
105+
## Test secrets
106+
107+
There are test secrets in `ctfe` for **DEVELOPMENT ONLY**.
108+
They were generated with:
109+
110+
```shell
111+
openssl ec -in <(openssl ecparam -genkey -name prime256v1) -out privkey.pem -des
112+
openssl ec -in privkey.pem -pubout -out pubkey.pem
113+
```
114+
115+
The password is `foobar` and is stored in the `ct_server.cfg` file.

docs/developer.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)