Skip to content

Commit

Permalink
docs: spring-content-encryption docs updates (#1183)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulcwarren authored Dec 13, 2022
1 parent 35c2734 commit 58e85e2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion spring-content-encryption/src/main/asciidoc/enc-index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Spring Content Filesystem - Reference Documentation
= Spring Content Encryption (beta) - Reference Documentation
Paul Warren, Peter Blum, Jeff Pak
:revnumber: {version}
:revdate: {localdate}
Expand Down
17 changes: 15 additions & 2 deletions spring-content-encryption/src/main/asciidoc/enc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,20 @@ content is stored it is first encrypted using the AES-CTR cipher and a randomly
content-encryption key is then encrypted using Hashicorp's vault and that key is then storied on the domain
object. Any user with authorization to decrypt the encryption key can retrieve the content.

Spring Content Encryption can be added to your application by updating your application's configuration, as follows:
Spring Content Encryption can be added to your application by adding the dependency:

====
[source, xml]
----
<dependency>
<groupId>com.github.paulcwarren</groupId>
<artifactId>spring-content-encryption</artifactId>
<version>${spring-content-version}</version>
</dependency>
----
====

and then updating your application's configuration, as follows:

.Spring Content Encryption using Java Config
====
Expand Down Expand Up @@ -42,7 +55,7 @@ public static class Config {
content encryption key) and the property to use to store the encryption key
====

Next, domain objects content properties are updated with a custom attribute to store the encrypted content-encryption key.
Domain objects content properties are then updated with a custom attribute to store the encrypted content-encryption key.

The above example assumes you have defined a "key" attribute on the content property, as the following example shows:

Expand Down

0 comments on commit 58e85e2

Please sign in to comment.