Skip to content

Commit f7be186

Browse files
committed
Align content to BP
1 parent 7efa280 commit f7be186

File tree

3 files changed

+39
-14
lines changed

3 files changed

+39
-14
lines changed

docs/authentication/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Authentication is a crucial security feature that verifies the identity of clien
1616

1717
MongoDB Atlas supports multiple authentication mechanisms:
1818

19-
- **SCRAM (Default)**: The default and recommended mechanism for MongoDB, providing secure authentication using salted challenge-response methods.
19+
- **SCRAM (Default)**: The default and simplest mechanism for MongoDB, providing secure authentication using salted challenge-response methods. (For production deployment we recommend using a more advanced authentication mechanism)
2020
- **X.509 Certificate Authentication**: Certificate-based authentication that uses SSL/TLS certificates for verifying client identity, typically used in environments that require high security.
2121
- **AWS IAM Authentication**:MongoDB Atlas supports AWS IAM authentication, allowing users to authenticate using their AWS Identity and Access Management roles, which is useful for integration with AWS services.
22-
- **Workforce Federation Authentication**: Allows users to integrate MongoDB Atlas with external identity providers (IdPs) like Okta or Azure AD for centralized access management and single sign-on (SSO).
23-
- **Workload Federation Authentication**: Enables authentication for applications and workloads by allowing them to assume predefined roles, simplifying access management for services running in hybrid or multi-cloud environments.
22+
- **Workforce Identity Federation Authentication**: Allows users to integrate MongoDB Atlas with external identity providers (IdPs) like Okta or Azure AD for centralized access management and single sign-on (SSO).
23+
- **Workload Identity Federation Authentication**: Enables authentication for applications and workloads by allowing them to assume predefined roles, simplifying access management for services running in hybrid or multi-cloud environments.
2424
- **LDAP Authentication**: Allows integration with corporate directory services, enabling centralized management of user access across the organization.
2525

2626
### SCRAM Authentication

docs/queryable-encryption/index.mdx

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,17 @@ import TabItem from '@theme/TabItem';
77

88
# Queryable Encryption
99

10-
Queryable Encryption allows you to run queries on encrypted data without decrypting it on the server side. This feature provides enhanced security by keeping sensitive data encrypted throughout its lifecycle while maintaining the ability to perform queries.
10+
## Introduction
11+
12+
Queryable Encryption is a groundbreaking technology that allows you to run specific queries on encrypted data without the need to decrypt it on the server. In MongoDB, this means sensitive data can remain encrypted throughout its lifecycle – at rest, in transit, and even during query processing. By enabling Queryable Encryption, you significantly reduce the attack surface by minimizing the exposure of plaintext data, even to authorized database administrators. This strengthens your security posture and helps meet stringent compliance requirements.
13+
14+
## Why is Queryable Encryption Important in MongoDB?
15+
16+
MongoDB, while offering various security features, can benefit significantly from Queryable Encryption for scenarios involving highly sensitive data. By implementing it, you ensure:
17+
- **Enhanced Data Protection**: Sensitive data remains encrypted even when it is being processed on the database side, minimizing the risk of exposure in case of a security breach or unauthorized access.
18+
- **Compliance with Regulations**: Helps meet stringent data privacy regulations like GDPR, HIPAA, and others that mandate strong encryption and control over sensitive information.
19+
- **Reduced Insider Threat**: Even database administrators or authorized personnel with access to the database infrastructure cannot see the plaintext data without the appropriate decryption keys managed outside of the database.
20+
- **Maintain Functionality**: Unlike traditional encryption where data needs to be decrypted for querying, Queryable Encryption allows you to perform specific types of queries directly on the encrypted data, preserving application functionality.
1121

1222
## Overview
1323

@@ -16,20 +26,20 @@ Queryable Encryption allows you to run queries on encrypted data without decrypt
1626

1727
In MongoDB Atlas, Queryable Encryption is available for:
1828
- M10 or larger clusters
19-
- MongoDB 6.0 or later
29+
- MongoDB 7.0 or later
2030
- Enterprise or Atlas deployments
2131

2232
To enable Queryable Encryption:
23-
1. Create an encryption key in your preferred Key Management System (AWS KMS, Azure Key Vault, GCP KMS)
33+
1. Create an encryption key in your preferred Key Management System (local, AWS KMS, Azure Key Vault, GCP KMS)
2434
2. Configure your Atlas cluster to use the KMS provider
2535
3. Use the MongoDB driver with Queryable Encryption support
2636

2737
</TabItem>
2838
<TabItem value="onprem" label="On-Premises">
2939

3040
For self-hosted MongoDB deployments:
31-
- Requires Enterprise Edition
32-
- MongoDB 6.0 or later
41+
- Requires Enterprise Edition for Client Side Level Encryption (community versions support Queryable Encryption only)
42+
- MongoDB 7.0 or later
3343
- A supported Key Management System
3444

3545
Configuration steps:
@@ -40,6 +50,12 @@ Configuration steps:
4050
</TabItem>
4151
</Tabs>
4252

53+
## Key Concepts in Queryable Encryption:
54+
55+
- **Key Management System (KMS)**: A secure system for managing encryption keys. MongoDB Queryable Encryption relies on either local keys/on-premises vaults like Hasicorp, or external KMS providers like AWS KMS, Azure Key Vault, Google Cloud KMS to store and manage the cryptographic keys.
56+
- **Encryption on Field Level Basis**: Encryption and decryption operations are performed on the client-side application before data is sent to or retrieved from the MongoDB server. This ensures that the server only handles encrypted data.
57+
- **Encryption Schema**: Defines which fields in your documents need to be encrypted and specifies the type of encryption to be used for each field, influencing the types of queries that can be performed on that field.
58+
4359
## Implementation
4460

4561

@@ -159,29 +175,33 @@ Queryable Encryption supports various query types depending on the encryption al
159175

160176
1. **Equality Queries**
161177
- Exact matches on encrypted fields
162-
- Supported by all encryption algorithms
178+
- Supported with deterministic encryption
179+
- Example: `{"encryptedField": "exactValue"}`
180+
163181

164182
2. **Range Queries**
165183
- Comparison operators ($gt, $gte, $lt, $lte)
184+
- Available for range-queryable encrypted fields
185+
- Example: `{"encryptedField": {"$gt": "value"}}`
166186
- Requires RangePreview algorithm
167187

168-
3. **Prefix Queries**
169-
- String prefix matching
170-
- Requires specialized string encryption
171188

172189
## Best Practices
173190

174191
1. **Key Management**
192+
- Securely Manage KMS Credentials: Protect your KMS access keys and credentials diligently. Use best practices for secret management.
175193
- Regularly rotate encryption keys
176194
- Securely store and backup keys
177195
- Use separate keys for different environments
178196

179197
2. **Performance Considerations**
198+
- Understand Performance Implications: Queryable Encryption involves additional resources for indexing and storage on the server side. Test and optimize your application accordingly. Tune the relevant parameters and document design for best performance.
180199
- Index encrypted fields when needed
181200
- Monitor query performance on encrypted fields
182201
- Use appropriate encryption algorithms
183202

184203
3. **Security Guidelines**
204+
- Principle of Least Privilege: Grant only the necessary permissions to access encryption keys.
185205
- Follow the principle of least privilege
186206
- Encrypt only necessary fields
187207
- Regularly audit encryption configurations
@@ -193,3 +213,4 @@ For hands-on practice with Queryable Encryption concepts, check out our [practic
193213
## Next Steps
194214

195215
After implementing Queryable Encryption, you can reach the final closing phase of Additional Security Considerations and Summary.
216+

docs/rbac/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,21 @@ A role consists of:
2222

2323
### Built-in Roles in Atlas
2424

25-
1. **Organization Roles**
25+
1. **Organization Roles (examples)**
2626
- `Organization Owner`
2727
- `Organization Member`
2828
- `Organization Read Only`
2929

30-
2. **Project Roles**
30+
For all roles see this [Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#std-label-user-roles).
31+
32+
2. **Project Roles (examples)**
3133
- `Project Owner`
3234
- `Project Data Access Admin`
3335
- `Project Data Access Read/Write`
3436
- `Project Read Only`
3537

38+
For more project level roles see this [Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#project-roles).
39+
3640
### Managing Roles in Atlas
3741

3842
```shell

0 commit comments

Comments
 (0)