Skip to content

Commit d55d38e

Browse files
Copilotbmhughes
authored andcommitted
Fix markdownlint issues in SCRAM-SHA-256 documentation
Co-authored-by: bmhughes <[email protected]>
1 parent 42b40e4 commit d55d38e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

documentation/scram-sha-256.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ SCRAM-SHA-256 (Salted Challenge Response Authentication Mechanism) is a password
55
## Overview
66

77
SCRAM-SHA-256 authentication offers several advantages:
8+
89
- **Stronger security**: Uses SHA-256 instead of MD5
910
- **Salt protection**: Prevents rainbow table attacks
1011
- **Iteration count**: Makes brute force attacks more difficult
@@ -13,12 +14,14 @@ SCRAM-SHA-256 authentication offers several advantages:
1314
## Password Format
1415

1516
SCRAM-SHA-256 passwords have this specific format:
16-
```
17+
18+
```text
1719
SCRAM-SHA-256$<iteration_count>:<salt>$<StoredKey>:<ServerKey>
1820
```
1921

2022
Example:
21-
```
23+
24+
```text
2225
SCRAM-SHA-256$4096:27klCUc487uwvJVGKI5YNA==$6K2Y+S3YBlpfRNrLROoO2ulWmnrQoRlGI1GqpNRq0T0=:y4esBVjK/hMtxDB5aWN4ynS1SnQcT1TFTqV0J/snls4=
2326
```
2427

@@ -41,6 +44,7 @@ end
4144
The cookbook automatically handles escaping of special characters (`$`) in SCRAM-SHA-256 passwords. You don't need to manually escape these characters - the cookbook will handle this transparently.
4245

4346
**Before (manual escaping required):**
47+
4448
```ruby
4549
postgresql_role 'user1' do
4650
# Manual escaping was required
@@ -50,6 +54,7 @@ end
5054
```
5155

5256
**Now (automatic escaping):**
57+
5358
```ruby
5459
postgresql_role 'user1' do
5560
# No manual escaping needed
@@ -195,4 +200,4 @@ WHERE rolname = 'your_username';
195200

196201
- [PostgreSQL SCRAM-SHA-256 Documentation](https://www.postgresql.org/docs/current/auth-password.html)
197202
- [RFC 7677: SCRAM-SHA-256 and SCRAM-SHA-256-PLUS](https://tools.ietf.org/html/rfc7677)
198-
- [PostgreSQL Security Best Practices](https://www.postgresql.org/docs/current/auth-methods.html)
203+
- [PostgreSQL Security Best Practices](https://www.postgresql.org/docs/current/auth-methods.html)

0 commit comments

Comments
 (0)