Skip to content

Commit 9fa26b6

Browse files
authored
EQL docs edits
Edit for consistence and typos
1 parent 1145e91 commit 9fa26b6

File tree

1 file changed

+16
-23
lines changed

1 file changed

+16
-23
lines changed

docs/concepts/WHY.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
# Postgres data security with CipherStash
22

3-
This article gives a high-level overview of CipherStash's encryption in use solution, including the CipherStash Proxy and the Encrypt Query Language (EQL).
3+
This page gives a high-level overview of CipherStash's encryption in use solution, including CipherStash Proxy and the Encrypt Query Language (EQL). It's designed for developers and engineers who need to implement robust data security in PostgreSQL without sacrificing performance or usability.
44

5-
It is designed for developers and engineers who need to implement robust data security in PostgreSQL without sacrificing performance or usability.
6-
7-
## Table of Contents
5+
## On this page
86

97
1. [Encryption in use](#encryption-in-use)
108
- [What is encryption in use?](#what-is-encryption-in-use)
119
- [Why use encryption in use?](#why-use-encryption-in-use)
1210
2. [CipherStash Proxy](#cipherstash-proxy)
13-
- [Proxy overview](#proxy-overview)
1411
- [How it works](#how-it-works)
1512
3. [Encrypt Query Language (EQL)](#encrypt-query-language-eql)
1613
4. [Best practices](#best-practices)
@@ -20,7 +17,8 @@ It is designed for developers and engineers who need to implement robust data se
2017

2118
## Encryption in use
2219

23-
EQL enables encryption in use, without significant changes to your application code.
20+
CipherStash's encryption in use solution, comprising CipherStash Proxy and EQL, provides a practical way to enhance data security in Postgres databases.
21+
EQL enables encryption in use without significant changes to your application code.
2422
A variety of searchable encryption techniques are available, including:
2523

2624
- **Matching** - Equality or partial matches
@@ -44,8 +42,6 @@ Encryption in use mitigates this risk by ensuring that:
4442

4543
## CipherStash Proxy
4644

47-
### Proxy overview
48-
4945
CipherStash Proxy is a transparent proxy that sits between your application and your PostgreSQL database.
5046
It intercepts SQL queries and handles the encryption and decryption of data on-the-fly.
5147
This enables encryption in use without significant changes to your application code.
@@ -63,19 +59,19 @@ This enables encryption in use without significant changes to your application c
6359
Encrypt Query Language (EQL) is a set of PostgreSQL functions and data types provided by CipherStash to work with encrypted data and indexes.
6460
EQL allows you to perform queries on encrypted data without decrypting it, supporting operations like equality checks, range queries, and unique constraints.
6561

66-
To get started, view the [Getting Started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
62+
To get started, read the [Getting started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
6763

68-
## Best Practices
64+
## Best practices
6965

70-
- **Leverage CipherStash Proxy**: Use CipherStash Proxy to handle encryption/decryption transparently.
71-
- **Utilize EQL functions**: Always use EQL functions when interacting with encrypted data.
72-
- **Define constraints**: Apply database constraints to maintain data integrity.
73-
- **Secure key management**: Ensure encryption keys are securely managed and stored.
74-
- **Monitor performance**: Keep an eye on query performance and optimize as needed.
66+
- **Use CipherStash Proxy** to handle encryption/decryption transparently.
67+
- **Use EQL functions** when interacting with encrypted data.
68+
- **Define database constraints**to maintain data integrity.
69+
- **Secure key management** of encryption keys.
70+
- **Monitor query performance** and optimize as needed.
7571

76-
## Advanced Topics
72+
## Advanced topics
7773

78-
### Integrating without CipehrStash Proxy
74+
### Integrating without CipherStash Proxy
7975

8076
> The SDK approach is currently in development, but if you're interested in contributing, please start a discussion [here](https://github.com/cipherstash/encrypt-query-language/discussions).
8177
@@ -88,11 +84,8 @@ For advanced users who prefer to handle encryption within their application:
8884

8985
**Note**: This approach increases complexity and is recommended only if CipherStash Proxy does not meet specific requirements.
9086

91-
## Conclusion
92-
93-
CipherStash's encryption in use solution, comprising CipherStash Proxy and EQL, provides a practical way to enhance data security in Postgres databases.
94-
By keeping data encrypted even during processing, you minimize the risk of data breaches and comply with stringent security standards without significant changes to your application logic.
87+
## Getting started
9588

96-
To get started, see the [Getting Started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
89+
To get started using CipherStash's encryption is use solution, see the [Getting Started](https://github.com/cipherstash/encrypt-query-language/blob/main/GETTINGSTARTED.md) guide.
9790

98-
**Contact Support:** For further assistance, raise an issue [here](https://github.com/cipherstash/encrypt-query-language/issues).
91+
For further help, raise an issue [here](https://github.com/cipherstash/encrypt-query-language/issues).

0 commit comments

Comments
 (0)