Skip to content

Commit 00e7d52

Browse files
authored
Replace secrets encryption with redaction (#102)
1 parent 5f42304 commit 00e7d52

File tree

6 files changed

+30
-31
lines changed

6 files changed

+30
-31
lines changed

Diff for: docs/about/changelog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Related: [Upgrade CodeGate](../how-to/install.mdx#upgrade-codegate)
3131
- **PII redaction:** - 10 Feb, 2025\
3232
Starting with v0.1.18, CodeGate now redacts personally identifiable
3333
information (PII) found in LLM prompts and context. See the
34-
[feature page](../features/secrets-encryption.md) to learn more.
34+
[feature page](../features/secrets-redaction.md) to learn more.
3535

3636
- **Model muxing** - 7 Feb, 2025\
3737
With CodeGate v0.1.17 you can use the new `/v1/mux` endpoint to configure

Diff for: docs/features/secrets-encryption.md renamed to docs/features/secrets-redaction.md

+17-22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Secrets encryption and PII redaction
2+
title: Secrets and PII redaction
33
description: Keep your secrets a secret
44
---
55

@@ -22,13 +22,12 @@ and PII found in your prompts.
2222

2323
CodeGate automatically scans all prompts for secrets and PII. This happens
2424
transparently without requiring a specific prompt. Without interrupting your
25-
development flow, CodeGate protects your data by encrypting secrets and
25+
development flow, CodeGate protects your data by redacting secrets and
2626
anonymizing PII. These changes are made before the prompt is sent to the LLM and
2727
are restored when the result is returned to your machine.
2828

2929
When a secret or PII is detected, CodeGate adds a message to the LLM's output
30-
and an alert is recorded in the [dashboard](../how-to/dashboard.md) (PII alerts
31-
in the dashboard are coming soon).
30+
and an alert is recorded in the [dashboard](../how-to/dashboard.md).
3231

3332
:::info
3433

@@ -55,36 +54,32 @@ sequenceDiagram
5554
deactivate CodeGate
5655
```
5756

58-
### Secrets encryption
57+
CodeGate redacts secrets and anonymizes PII by replacing each string with a
58+
unique identifier on the fly, before sending the prompt to the LLM. This way,
59+
CodeGate protects your sensitive data without blocking your development flow.
60+
When the LLM returns a response, CodeGate matches up the identifier and replaces
61+
it with the original value.
5962

60-
CodeGate uses pattern matching to detect secrets such as:
63+
### Secrets filtering
64+
65+
CodeGate uses pattern matching to detect secrets like:
6166

6267
- API keys and tokens
63-
- Private keys and certificates
68+
- Cloud provider credentials
6469
- Database credentials
70+
- Private keys and certificates
6571
- SSH keys
66-
- Cloud provider credentials
67-
- ...and more - see the
68-
[signatures file](https://github.com/stacklok/codegate/blob/main/signatures.yaml)
69-
in the project repo
7072

71-
CodeGate transparently encrypts secrets before sending the prompt to the LLM.
72-
This is performed on the fly using AES256-GCM encryption with a temporary
73-
per-session key. When the LLM returns a response, CodeGate decrypts the secret
74-
before delivering it to your coding assistant, then securely erases the
75-
temporary key from memory.
73+
For the full list of detected patterns, see the
74+
[signatures file](https://github.com/stacklok/codegate/blob/main/signatures.yaml)
75+
in the project repo.
7676

7777
### PII redaction
7878

79-
CodeGate scans for common types of PII like:
79+
CodeGate scans for common types of PII including:
8080

8181
- Email addresses
8282
- Phone numbers
8383
- Government identification numbers
8484
- Credit card numbers
8585
- Bank accounts and crypto wallet IDs
86-
87-
CodeGate anonymizes PII by replacing each string with a unique identifier before
88-
sending the prompt to the LLM. This way, CodeGate protects your sensitive data
89-
without blocking your development flow. When the LLM returns a response,
90-
CodeGate matches up the identifier and replaces it with the original value.

Diff for: docs/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ sequenceDiagram
3636
CodeGate includes several key features for privacy, security, and coding
3737
efficiency, including:
3838

39-
- [Secrets encryption and PII redaction](./features/secrets-encryption.md) to
40-
protect your sensitive credentials and anonymize personally identifiable
41-
information
39+
- [Secrets PII redaction](./features/secrets-redaction.md) to protect your
40+
sensitive credentials and anonymize personally identifiable information
4241
- [Dependency risk awareness](./features/dependency-risk.md) to update the LLM's
4342
knowledge of malicious or deprecated open source packages
4443
- [Model muxing](./features/muxing.mdx) to quickly select the best LLM
@@ -104,7 +103,7 @@ Review the [installation instructions](./how-to/install.mdx).
104103

105104
Learn more about CodeGate's features:
106105

107-
- [Secrets and PII redaction](./features/secrets-encryption.md)
106+
- [Secrets and PII redaction](./features/secrets-redaction.md)
108107
- [Dependency risk awareness](./features/dependency-risk.md)
109108
- [Security reviews](./features/security-reviews.md)
110109
- [Workspaces](./features/workspaces.mdx)

Diff for: docs/quickstart-continue.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ For example, using `conf.ini`:
184184
@conf.ini Explain this file
185185
```
186186

187-
CodeGate intercepts the request and transparently encrypts the sensitive data
187+
CodeGate intercepts the request and transparently redacts the sensitive data
188188
before it leaves your machine.
189189

190190
<ThemedImage
@@ -200,7 +200,7 @@ before it leaves your machine.
200200
width={'600px'}
201201
/>
202202

203-
Learn more in [Secrets encryption](./features/secrets-encryption.md).
203+
Learn more in [Secrets and PII redaction](./features/secrets-redaction.md).
204204

205205
### Assess dependency risk
206206

Diff for: docs/quickstart-copilot.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Enter this prompt into the chat:
161161
Explain the current file
162162
```
163163

164-
CodeGate intercepts the request and transparently encrypts the sensitive data
164+
CodeGate intercepts the request and transparently redacts the sensitive data
165165
before it leaves your machine.
166166

167167
<ThemedImage
@@ -177,7 +177,7 @@ before it leaves your machine.
177177
width={'600px'}
178178
/>
179179

180-
Learn more in [Secrets encryption](./features/secrets-encryption.md).
180+
Learn more in [Secrets and PII redaction](./features/secrets-redaction.md).
181181

182182
### Assess dependency risk
183183

Diff for: vercel.json

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
"source": "/how-to/(use-with-):path(aider|cline|continue|copilot)",
55
"destination": "/integrations/:path",
66
"permanent": true
7+
},
8+
{
9+
"source": "/features/secrets-encryption",
10+
"destination": "/features/secrets-redaction",
11+
"permanent": true
712
}
813
]
914
}

0 commit comments

Comments
 (0)