Skip to content

Commit 0f166b1

Browse files
Polish S3 encryption docs. (#1338)
1 parent e30abe3 commit 0f166b1

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/src/main/asciidoc/s3.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ try (OutputStream outputStream = s3Resource.getOutputStream()) {
129129

130130
=== S3 Client Side Encryption
131131

132-
AWS offers encryption library which is integrated inside of S3 Client called https://docs.aws.amazon.com/amazon-s3-encryption-client/latest/developerguide/what-is-s3-encryption-client.html [S3EncryptionClient].
132+
AWS offers encryption library which is integrated inside of S3 Client called https://docs.aws.amazon.com/amazon-s3-encryption-client/latest/developerguide/what-is-s3-encryption-client.html[S3EncryptionClient].
133133
With encryption client you are going to encrypt your files before sending them to S3 bucket.
134134

135135
To autoconfigure Encryption Client simply add the following dependency.
@@ -145,7 +145,7 @@ To autoconfigure Encryption Client simply add the following dependency.
145145

146146
We are supporting 3 types of encryption.
147147

148-
1. To configure encryption via KMS key specify 'spring.cloud.aws.s3.encryption.keyId' with KMS key arn and this key will be used to encrypt your files.
148+
1. To configure encryption via KMS key specify `spring.cloud.aws.s3.encryption.key-id` with KMS key arn and this key will be used to encrypt your files.
149149

150150
Also, following dependency is required.
151151
[source,xml]
@@ -158,10 +158,11 @@ Also, following dependency is required.
158158
----
159159

160160

161-
2. Asymmetric encryption is possible via RSA to enable it you will have to implement 'io.awspring.cloud.autoconfigure.s3.S3RsaProvider'
161+
2. Asymmetric encryption is possible via RSA to enable it you will have to implement `io.awspring.cloud.autoconfigure.s3.S3RsaProvider`
162162

163-
!Note you will have to manage storing private and public keys yourself otherwise you won't be able to decrypt the data later.
164-
Example of simple RSAProvider:
163+
NOTE: You will have to store private and public keys yourself otherwise you won't be able to decrypt the data later.
164+
165+
Example of simple `S3RsaProvider`:
165166

166167
[source,java,indent=0]
167168
----
@@ -185,8 +186,9 @@ public class MyRsaProvider implements S3RsaProvider {
185186

186187
3. Last option is if you want to use symmetric algorithm, this is possible via `io.awspring.cloud.autoconfigure.s3.S3AesProvider`
187188

188-
!Note you will have to manage storing storing private key!
189-
Example of simple AESProvider:
189+
NOTE: Ensure the private key is stored using secure storage mechanisms that prevent unauthorized access.
190+
191+
Example of simple `S3AesProvider`:
190192

191193
[source,java,indent=0]
192194
----

0 commit comments

Comments
 (0)