Skip to content

Commit b732bf9

Browse files
CopilotIEvangelist
andauthored
Add .config/CredScanSuppressions.json for docs placeholder credentials (#680)
* Initial plan * Add .config/CredScanSuppressions.json with placeholder credential suppressions from docs Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/60f262d4-d7cc-4d67-824b-dc2782b7331a Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
1 parent 08630ef commit b732bf9

File tree

6 files changed

+55
-6
lines changed

6 files changed

+55
-6
lines changed

.config/CredScanSuppressions.json

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"tool": "Credential Scanner",
3+
"suppressions": [
4+
{
5+
"placeholder": "p@ssw0rd1",
6+
"_justification": "This is the canonical fake password used throughout documentation examples in database and service connection strings. New examples should also use this value."
7+
},
8+
{
9+
"placeholder": "p%40ssw0rd1",
10+
"_justification": "URL-encoded form of 'p@ssw0rd1', used throughout documentation examples in connection string URIs for SQL Server, PostgreSQL, Oracle, MongoDB, Redis, Valkey, Garnet, NATS, RabbitMQ, and ClickHouse."
11+
},
12+
{
13+
"placeholder": "secret",
14+
"_justification": "Placeholder password used in documentation examples illustrating Docker/Docker Compose usage (e.g., POSTGRES_PASSWORD=secret) where the value mirrors real-world Docker Compose examples. Not a real credential."
15+
},
16+
{
17+
"placeholder": "mykey",
18+
"_justification": "Placeholder key used in documentation examples for Azure Storage Data Lake and Azure Service Bus connection strings. Not a real credential."
19+
},
20+
{
21+
"placeholder": "myaccountkey",
22+
"_justification": "Placeholder account key used in documentation examples for Azure Storage Blobs and Azure Storage Queues connection strings. Not a real credential."
23+
},
24+
{
25+
"placeholder": "accesskey",
26+
"_justification": "Placeholder SharedAccessKey used in documentation examples for Azure Event Hubs connection strings. Not a real credential."
27+
},
28+
{
29+
"placeholder": "github_pat_YOUR_TOKEN_HERE",
30+
"_justification": "Placeholder GitHub personal access token used in documentation examples for GitHub Models integration user secrets. Not a real token."
31+
},
32+
{
33+
"placeholder": "YOUR_GITHUB_TOKEN_HERE",
34+
"_justification": "Placeholder GitHub personal access token used in documentation examples for GitHub Models integration user secrets. Not a real token."
35+
},
36+
{
37+
"placeholder": "sk-your-api-key",
38+
"_justification": "Placeholder OpenAI API key used in documentation examples showing how to configure the OpenAI integration. Not a real key."
39+
},
40+
{
41+
"placeholder": "123456!@#$%",
42+
"_justification": "Placeholder credential used in documentation examples for Meilisearch, SurrealDB, and Qdrant integration configuration. Not a real credential."
43+
},
44+
{
45+
"placeholder": "Non-default-P@ssw0rd",
46+
"_justification": "Placeholder password used in documentation examples for Oracle and Milvus integration configuration to illustrate that a non-default password is required. Not a real credential."
47+
}
48+
]
49+
}

src/frontend/src/content/docs/integrations/cloud/azure/azure-cache-redis/azure-cache-redis-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ The connection information is retrieved from the `ConnectionStrings` configurati
131131
```json
132132
{
133133
"ConnectionStrings": {
134-
"redis": "myredis.redis.cache.windows.net:6380,password=your_password,ssl=True"
134+
"redis": "myredis.redis.cache.windows.net:6380,password=p@ssw0rd1,ssl=True"
135135
}
136136
}
137137
```

src/frontend/src/content/docs/integrations/cloud/azure/azure-postgresql/azure-postgresql-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ The connection information is retrieved from the `ConnectionStrings` configurati
129129
```json title="JSON — appsettings.json"
130130
{
131131
"ConnectionStrings": {
132-
"database": "Host=myserver;Database=mydb;Username=myuser;Password=mypassword"
132+
"database": "Host=myserver;Database=mydb;Username=myuser;Password=p@ssw0rd1"
133133
}
134134
}
135135
```

src/frontend/src/content/docs/integrations/cloud/azure/azure-service-bus/azure-service-bus-client.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,11 +216,11 @@ The Aspire Azure Service Bus integration supports named configuration, which all
216216
"Messaging": {
217217
"ServiceBus": {
218218
"bus1": {
219-
"ConnectionString": "Endpoint=sb://namespace1.servicebus.windows.net/;SharedAccessKeyName=keyName;SharedAccessKey=key;",
219+
"ConnectionString": "Endpoint=sb://namespace1.servicebus.windows.net/;SharedAccessKeyName=keyName;SharedAccessKey=mykey;",
220220
"DisableTracing": false
221221
},
222222
"bus2": {
223-
"ConnectionString": "Endpoint=sb://namespace2.servicebus.windows.net/;SharedAccessKeyName=keyName;SharedAccessKey=key;",
223+
"ConnectionString": "Endpoint=sb://namespace2.servicebus.windows.net/;SharedAccessKeyName=keyName;SharedAccessKey=mykey;",
224224
"DisableTracing": true
225225
}
226226
}

src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database/azure-sql-database-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ The connection information is retrieved from the `ConnectionStrings` configurati
123123
```json
124124
{
125125
"ConnectionStrings": {
126-
"database": "Server=myserver;Database=mydb;User Id=myuser;Password=mypassword;Encrypt=True"
126+
"database": "Server=myserver;Database=mydb;User Id=myuser;Password=p@ssw0rd1;Encrypt=True"
127127
}
128128
}
129129
```

src/frontend/src/content/docs/integrations/frameworks/java.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ On Linux and macOS, you may need to add additional configuration to trust the As
105105

106106
```properties
107107
server.ssl.trust-store=/path/to/aspire/dev/certificate.p12
108-
server.ssl.trust-store-password=your-password
108+
server.ssl.trust-store-password=p@ssw0rd1
109109
```
110110

111111
For more information, see the [Spring Boot SSL documentation](https://docs.spring.io/spring-boot/reference/features/ssl.html).

0 commit comments

Comments
 (0)