You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/attestors/secretscan.md
+36-36Lines changed: 36 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,42 @@ The attestor uses [Gitleaks](https://github.com/zricethezav/gitleaks) to scan fo
19
19
20
20
When secrets are found, they are recorded in a structured format with the actual secret replaced by a DigestSet containing cryptographic hashes of the secret using all configured hash algorithms from the attestation context.
21
21
22
+
## SecretScan Attestor Examples
23
+
24
+
This section contains examples demonstrating the capabilities of the SecretScan attestor. You can find the demo script [here](https://github.com/in-toto/go-witness/blob/main/attestation/secretscan/examples/demo-encoded-secrets.sh)
25
+
26
+
### Demo Scripts
27
+
28
+
### `demo-encoded-secrets.sh`
29
+
30
+
This script demonstrates the multi-layer encoding detection capabilities of the secretscan attestor. It:
31
+
32
+
1. Creates test files with secrets in various encodings:
33
+
- Plain text
34
+
- Base64-encoded
35
+
- Double base64-encoded
36
+
- URL-encoded
37
+
- Hex-encoded
38
+
- Mixed encoding (base64 + URL)
39
+
40
+
2. Runs the witness CLI with the secretscan attestor on each file
41
+
42
+
3. Extracts and displays the findings from each attestation
43
+
44
+
### Running the Demo
45
+
46
+
```sh
47
+
# Make sure the script is executable
48
+
chmod +x demo-encoded-secrets.sh
49
+
50
+
# Run the demo
51
+
./demo-encoded-secrets.sh
52
+
```
53
+
54
+
## Additional Resources
55
+
56
+
For more information about the secretscan attestor, see the [main README](https://github.com/in-toto/go-witness/blob/main/attestation/secretscan/README.md) in the parent directory.
57
+
22
58
## Schema
23
59
```json
24
60
{
@@ -92,39 +128,3 @@ When secrets are found, they are recorded in a structured format with the actual
92
128
}
93
129
}
94
130
```
95
-
96
-
# SecretScan Attestor Examples
97
-
98
-
This section contains examples demonstrating the capabilities of the SecretScan attestor. You can find the demo script [here](https://github.com/in-toto/go-witness/blob/main/attestation/secretscan/examples/demo-encoded-secrets.sh)
99
-
100
-
### Demo Scripts
101
-
102
-
### `demo-encoded-secrets.sh`
103
-
104
-
This script demonstrates the multi-layer encoding detection capabilities of the secretscan attestor. It:
105
-
106
-
1. Creates test files with secrets in various encodings:
107
-
- Plain text
108
-
- Base64-encoded
109
-
- Double base64-encoded
110
-
- URL-encoded
111
-
- Hex-encoded
112
-
- Mixed encoding (base64 + URL)
113
-
114
-
2. Runs the witness CLI with the secretscan attestor on each file
115
-
116
-
3. Extracts and displays the findings from each attestation
117
-
118
-
### Running the Demo
119
-
120
-
```sh
121
-
# Make sure the script is executable
122
-
chmod +x demo-encoded-secrets.sh
123
-
124
-
# Run the demo
125
-
./demo-encoded-secrets.sh
126
-
```
127
-
128
-
## Additional Resources
129
-
130
-
For more information about the secretscan attestor, see the [main README](https://github.com/in-toto/go-witness/blob/main/attestation/secretscan/README.md) in the parent directory.
0 commit comments