Skip to content

Commit 0e55ccb

Browse files
docs: secret store advantages (#279)
* docs: secret store advantages * Update docs/preview/features/secret-store/index.md Co-authored-by: Tom Kerkhove <[email protected]> * Update docs/preview/features/secret-store/index.md Co-authored-by: Tom Kerkhove <[email protected]> * Update docs/preview/features/secret-store/index.md Co-authored-by: Tom Kerkhove <[email protected]> * Update docs/preview/features/secret-store/index.md Co-authored-by: Tom Kerkhove <[email protected]> * Update docs/preview/features/secret-store/index.md Co-authored-by: Tom Kerkhove <[email protected]> * pr-fix: update with design for security * pr-fix: update with 'plug and play' title * pr-fix: update with bullet points list * pr-sug: keep using v for title * pr-add: also add secret store advandates to current feature docs Co-authored-by: Tom Kerkhove <[email protected]>
1 parent 04008d9 commit 0e55ccb

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

docs/features/secret-store/index.md

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ Once register, you can fetch all secrets by using `ISecretProvider` which will g
1212

1313
> :bulb: See [this section](#using-secret-store-within-azure-functions) if you want to use the secret store functionality whitin Azure Functions.
1414
15+
## Why would I use it?
16+
Why would you use our Arcus secret store instead of just using the Azure SDK directly to access Azure Key Vault secrets?
17+
18+
The Arcus secret store has some advantages over using the Azure SDK or configuration directly:
19+
20+
**✔ Caching**
21+
* We provide caching so the secret providers will not be called upon every secret retrieval. This helps you avoiding hitting service limitations and we provide [asynchronous cache invalidation](https://background-jobs.arcus-azure.net/features/security/auto-invalidate-secrets).
22+
23+
**✔ Plug & play**
24+
* We support using multiple and combinations of secret providers so with a single secret retrieval can query multiple secret providers (also multiple Azure Key Vaults).
25+
26+
**✔ Design for security**
27+
* While using configuration for storing secrets can be good for development it is not a safe approach. With the secret store, we provide a single place to retrieve secrets instead of scattering the integration across the application.
28+
* Seperating configuration data and sensitive secrets is key in developing secure projects. Vulnerabilities gets introduced when secrets are seen as data and are included in logs, for example. Or when expired secrets doesn't get transient handling upon retrieval.
29+
30+
**✔ Extensibility**
31+
* Arcus secret store is highly extensible and can be extended with you own custom secret providers, in-memory secret providers for testing...
32+
1533
## Built-in secret providers
1634
Several built in secret providers available in the package.
1735

docs/preview/features/secret-store/index.md

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ Once register, you can fetch all secrets by using `ISecretProvider` which will g
1212

1313
> :bulb: See [this section](#using-secret-store-within-azure-functions) if you want to use the secret store functionality whitin Azure Functions.
1414
15+
## Why would I use it?
16+
Why would you use our Arcus secret store instead of just using the Azure SDK directly to access Azure Key Vault secrets?
17+
18+
The Arcus secret store has some advantages over using the Azure SDK or configuration directly:
19+
20+
**✔ Caching**
21+
* We provide caching so the secret providers will not be called upon every secret retrieval. This helps you avoiding hitting service limitations and we provide [asynchronous cache invalidation](https://background-jobs.arcus-azure.net/features/security/auto-invalidate-secrets).
22+
23+
**✔ Plug & play**
24+
* We support using multiple and combinations of secret providers so with a single secret retrieval can query multiple secret providers (also multiple Azure Key Vaults).
25+
26+
**✔ Design for security**
27+
* While using configuration for storing secrets can be good for development it is not a safe approach. With the secret store, we provide a single place to retrieve secrets instead of scattering the integration across the application.
28+
* Seperating configuration data and sensitive secrets is key in developing secure projects. Vulnerabilities gets introduced when secrets are seen as data and are included in logs, for example. Or when expired secrets doesn't get transient handling upon retrieval.
29+
30+
**✔ Extensibility**
31+
* Arcus secret store is highly extensible and can be extended with you own custom secret providers, in-memory secret providers for testing...
32+
1533
## Built-in secret providers
1634
Several built in secret providers available in the package.
1735

docs/v1.5.0/features/secret-store/index.md

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ Once register, you can fetch all secrets by using `ISecretProvider` which will g
1212

1313
> :bulb: See [this section](#using-secret-store-within-azure-functions) if you want to use the secret store functionality whitin Azure Functions.
1414
15+
## Why would I use it?
16+
Why would you use our Arcus secret store instead of just using the Azure SDK directly to access Azure Key Vault secrets?
17+
18+
The Arcus secret store has some advantages over using the Azure SDK or configuration directly:
19+
20+
**✔ Caching**
21+
* We provide caching so the secret providers will not be called upon every secret retrieval. This helps you avoiding hitting service limitations and we provide [asynchronous cache invalidation](https://background-jobs.arcus-azure.net/features/security/auto-invalidate-secrets).
22+
23+
**✔ Plug & play**
24+
* We support using multiple and combinations of secret providers so with a single secret retrieval can query multiple secret providers (also multiple Azure Key Vaults).
25+
26+
**✔ Design for security**
27+
* While using configuration for storing secrets can be good for development it is not a safe approach. With the secret store, we provide a single place to retrieve secrets instead of scattering the integration across the application.
28+
* Seperating configuration data and sensitive secrets is key in developing secure projects. Vulnerabilities gets introduced when secrets are seen as data and are included in logs, for example. Or when expired secrets doesn't get transient handling upon retrieval.
29+
30+
**✔ Extensibility**
31+
* Arcus secret store is highly extensible and can be extended with you own custom secret providers, in-memory secret providers for testing...
32+
1533
## Built-in secret providers
1634
Several built in secret providers available in the package.
1735

0 commit comments

Comments
 (0)