Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding CMEK info #327

Merged
merged 39 commits into from
Apr 18, 2024
Merged
Changes from 21 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
0c10132
Add a Python example alongside the cURL example in the Aura API docs.…
fiquick Feb 28, 2024
0b2eb41
Update authentication.adoc
fiquick Feb 28, 2024
264b5cd
Update authentication.adoc
fiquick Feb 28, 2024
104b861
update code indentation
fiquick Feb 29, 2024
c2f1ac7
Update modules/ROOT/pages/platform/api/authentication.adoc
fiquick Mar 4, 2024
1728bee
Update modules/ROOT/pages/platform/api/authentication.adoc
fiquick Mar 4, 2024
75779fb
remove timeout, add info about credentials
fiquick Mar 4, 2024
4133b46
adding CMEK info
fiquick Mar 10, 2024
e4fa188
adding CMEK info
fiquick Mar 11, 2024
7aa4ed4
Merge branch 'main' into CMEK
fiquick Mar 11, 2024
f95a597
Update security.adoc
fiquick Mar 11, 2024
ec0c3d8
Update security.adoc
fiquick Mar 11, 2024
4897a44
Update security.adoc
fiquick Mar 18, 2024
224fb28
Update security.adoc
fiquick Mar 18, 2024
fd74f3a
Update security.adoc
fiquick Mar 18, 2024
874992e
Update security.adoc
fiquick Mar 18, 2024
e9863c5
Update security.adoc
fiquick Mar 18, 2024
a1589c4
Update security.adoc
fiquick Mar 18, 2024
cb67098
Update security.adoc
fiquick Mar 18, 2024
d71993e
Update security.adoc
fiquick Mar 18, 2024
a46d1b6
Update modules/ROOT/pages/platform/security.adoc
fiquick Mar 19, 2024
7ba2945
Update security.adoc
fiquick Mar 19, 2024
d061c70
Update security.adoc
fiquick Mar 26, 2024
c2f100f
Update security.adoc
fiquick Mar 26, 2024
f966791
Editing CMEK content
fiquick Mar 27, 2024
65a9048
Adding info about ARN and Regionality
fiquick Apr 3, 2024
2f3d4b1
some updates to key policy and other word arrangements
fiquick Apr 3, 2024
8ca77e5
add info about deleting a key
fiquick Apr 4, 2024
1f8eef5
make "deleting a key" its own section
fiquick Apr 4, 2024
91b6556
edit wording "manual key rotation"
fiquick Apr 4, 2024
f1bd52f
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 9, 2024
e9fdbb1
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 9, 2024
d081b1f
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 9, 2024
7b486b3
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 9, 2024
9edadee
Add extra info for CMK
fiquick Apr 9, 2024
2f13b55
edit CMEK
fiquick Apr 9, 2024
0bd4de0
Append info in regards to "Importing an existing database" command
fiquick Apr 18, 2024
1e2f2c0
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 18, 2024
26970dc
Update modules/ROOT/pages/platform/security.adoc
fiquick Apr 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions modules/ROOT/pages/platform/security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -255,3 +255,79 @@ TLS v1.2:
* `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (RFC5289)`
* `TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (RFC7905)`
* `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (RFC5288)`

== Customer managed keys

label:AuraDB-Enterprise[]
label:AuraDS-Enterprise[]
label:beta[]

[CAUTION]
====

This feature has been released as a public GA for AuraDB Enterprise and AuraDS Enterprise for AWS managed keys.
GCP's Cloud Key Management is in public beta, and support for Azure's Key Vault is coming soon.
====

For more control over key operations than the standard Neo4j encryption, use customer-managed keys.
These keys are created and managed using a supported Cloud Key Management Service provider.
When using a customer managed key, all data at rest is encrypted with the key.

[WARNING]
====
Deleting a key makes all data encrypted under that key unrecoverable.
Neo4j cannot administer instances when keys are disabled, deleted or permissions revoked.
====

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

There is a limit of one key for AuraDB and one key for AuraDS per region.
Depending on the Cloud Key Management Service provider, there may be a delay between disabling a key,
and when the key can no longer be used to encrypt and decrypt data.

=== AWS key

* Create a single-region key in the AWS Console ensuring the region matches your Neo4j instance.
* Go to security settings in the Aura Console, create a customer managed key and copy the generated JSON code.
* Within the AWS Console, edit the key policy to include the JSON code.
Refer to the example key policy structure for guidance on formatting.

[source,json]

{
"Id": "key-consolepolicy-3",
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Enable IAM User Permissions",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::000000000000:root"
},
"Action": "kms:*",
"Resource": "*"
},
{
"Sid": "Allow access for Neo4j",
"Effect": "Allow",
"Principal": {
"AWS": "*"
},
"Action": [
"kms:Encrypt",
"kms:Decrypt",
"kms:ReEncrypt*",
"kms:GenerateDataKey*",
"kms:DescribeKey",
"kms:CreateGrant",
"kms:ListGrants",
"kms:RevokeGrant"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"kms:CallerAccount": "000000000000"
}
}
}
]
}

Loading