Skip to content

Commit 5c853c2

Browse files
authored
Change limitations section to FAQ. (#161)
Also fix broken security policy link. Signed-off-by: Billy Lynch <[email protected]> Signed-off-by: Billy Lynch <[email protected]>
1 parent 45f565f commit 5c853c2

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,38 @@ Validated Git signature: true
139139
Validated Rekor entry: true
140140
```
141141

142-
## Limitations
142+
## FAQ
143143

144-
- [GitHub Verified Badge](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
144+
### Is there any way to bypass the browser flow?
145145

146-
<img src="./images/unverified.png" width="400" />
146+
A browser window is needed to get an OAuth token, since gitsign aims to not
147+
store refresh tokens or other cryptographic material on disk, but there are some
148+
things you can do to make this process a bit easier!
147149

148-
GitHub doesn't recognize Gitsign signatures as verified at the moment:
150+
1. Set the `connectorID` config option - This preselects the identity provider
151+
to use. Assuming you're already signed in, in most cases you'll bounce
152+
directly to the auth success screen! (and you can clean up the browser tabs
153+
later)
154+
2. Use the [Credential Cache](cmd/gitsign-credential-cache/README.md). This uses
155+
an in-memory credential cache over a file socket that allows you to persist
156+
keys and certificates for their full lifetime (meaning you only need to auth
157+
once every 10 minutes).
149158

150-
1. The sigstore CA root is not a part of
151-
[GitHub's trust root](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#smime-commit-signature-verification).
152-
2. Because Gitsign's ephemeral keys are only valid for a short time, using
153-
standard x509 verification would consider the certificate invalid after
154-
expiration. Verification needs to include validation via Rekor to verify
155-
the cert was valid at the time it was used.
159+
### Why doesn't GitHub show commits as [verified](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)?
156160

157-
We hope to work with GitHub to get these types of signatures recognized as
158-
verified in the future!
161+
<img src="./images/unverified.png" width="400" />
162+
163+
GitHub doesn't recognize Gitsign signatures as verified at the moment:
164+
165+
1. The sigstore CA root is not a part of
166+
[GitHub's trust root](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#smime-commit-signature-verification).
167+
2. Because Gitsign's ephemeral keys are only valid for a short time, using
168+
standard x509 verification would consider the certificate invalid after
169+
expiration. Verification needs to include validation via Rekor to verify the
170+
cert was valid at the time it was used.
171+
172+
We hope to work with GitHub to get these types of signatures recognized as
173+
verified in the future!
159174

160175
## Debugging
161176

@@ -243,8 +258,8 @@ Gitsign stores data in 2 places:
243258

244259
## Security
245260

246-
Should you discover any security issues, please refer to sigstores
247-
[security process](https://github.com/sigstore/community/blob/main/SECURITY.md)
261+
Should you discover any security issues, please refer to the
262+
[security process](https://github.com/sigstore/gitsign/security/policy)
248263

249264
## Advanced
250265

0 commit comments

Comments
 (0)