Skip to content

Commit 7a520d3

Browse files
docs/ Update README with demo keys, download formats and troubleshooting link
1 parent 4e15a00 commit 7a520d3

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,12 @@ open index.html
2525
xdg-open index.html
2626
```
2727

28-
### Loading your keys
28+
### Keys & Certificate
2929

30-
In the **Keys & Certificate** section:
31-
- Click **Load file** to pick your `private_key.pem` / `certificate.pem` from disk
32-
- Or paste the PEM content directly into the text area
30+
- Click **Generate demo keys** to create an RSA-2048 key pair and self-signed certificate in the browser — no tools required
31+
- Or click **Load file** to pick your own `private_key.pem` / `certificate.pem` from disk, or paste the PEM content directly
3332

34-
When both are loaded the tool computes a real signature and fills the `TPP-Signature-Certificate` header — the generated curl command will be ready to run without any manual substitution.
33+
When both are loaded the tool computes a real signature and fills the `TPP-Signature-Certificate` header — the generated output will be ready to run without any manual substitution.
3534

3635
> **Note:** Keys are never sent anywhere. All cryptographic operations run locally in the browser via the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).
3736
@@ -42,6 +41,19 @@ When both are loaded the tool computes a real signature and fills the `TPP-Signa
4241
| **Auto Run** | Steps play through with animated delays |
4342
| **Step by Step** | Pauses after each step — click **Run Step →** to advance |
4443

44+
### Download formats
45+
46+
After the flow completes, the request can be exported in several formats:
47+
48+
| Format | Description |
49+
|---|---|
50+
| **Copy** | Copies the curl command to clipboard |
51+
| **Download curl** | Pre-signed snapshot — valid for ~5 min |
52+
| **Download Bundle** | Bash script + key files — re-signs at runtime, always valid |
53+
| **Download C#** | Self-contained .NET 6+ console app — re-signs at runtime |
54+
| **Download Postman** | Postman collection — pre-signed snapshot |
55+
| **Download .http** | VS Code REST Client / IntelliJ HTTP Client — pre-signed snapshot |
56+
4557
## Compatibility
4658

4759
Requires a modern browser with Web Crypto API support (Chrome 60+, Firefox 57+, Safari 11+, Edge 79+).
@@ -63,6 +75,10 @@ Change the **Endpoint** and **Key ID** fields in the UI to target a different AS
6375
- `private_key.pem` and `certificate.pem` are listed in `.gitignore` — do not commit them.
6476
- The tool runs entirely client-side; no data leaves your machine.
6577

78+
## Troubleshooting
79+
80+
See [Troubleshooting.html](Troubleshooting.html) for a reference of common errors, their causes, and fixes.
81+
6682
## License
6783

6884
MIT

0 commit comments

Comments
 (0)