Skip to content

Commit d381aae

Browse files
authored
Call out OpenSSL 1.1.x as legacy-only in README (#54)
The README listed four SSL backends with no steering. A user picking one had no signal about which still received upstream fixes. OpenSSL 1.1.x reached end-of-life in September 2023 and gets no public security fixes; the other three (OpenSSL 3.0.x, OpenSSL 4.0.x, and LibreSSL) are actively maintained. Call this out in the prose, mark the 1.1.x subsection heading as legacy, and put it after the actively maintained backends. Drive-by: fix a pre-existing "You'll might" typo in Dependencies. Closes #52
1 parent eacf68d commit d381aae

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,9 @@ Production ready.
1717

1818
## Supported SSL versions
1919

20-
OpenSSL 1.1.x, OpenSSL 3.0.x, OpenSSL 4.0.x, and LibreSSL are supported. Select the library version at compile-time using Pony's compile time definition functionality.
20+
OpenSSL 3.0.x, OpenSSL 4.0.x, LibreSSL, and OpenSSL 1.1.x are supported. Select the library version at compile-time using Pony's compile time definition functionality.
2121

22-
### Using OpenSSL 1.1.x
23-
24-
```bash
25-
corral run -- ponyc -Dopenssl_1.1.x
26-
```
22+
Not every supported backend is still actively maintained upstream. OpenSSL 1.1.x reached end-of-life in September 2023 and no longer receives public security fixes. It remains available here for legacy use only. OpenSSL 3.0.x, OpenSSL 4.0.x, and LibreSSL are actively maintained.
2723

2824
### Using OpenSSL 3.0.x
2925

@@ -43,9 +39,15 @@ corral run -- ponyc -Dopenssl_4.0.x
4339
corral run -- ponyc -Dlibressl
4440
```
4541

42+
### Using OpenSSL 1.1.x (legacy)
43+
44+
```bash
45+
corral run -- ponyc -Dopenssl_1.1.x
46+
```
47+
4648
## Dependencies
4749

48-
`ssl` requires either LibreSSL or OpenSSL in order to operate. You'll might need to install it within your environment of choice.
50+
`ssl` requires either LibreSSL or OpenSSL in order to operate. You might need to install it within your environment of choice.
4951

5052
### Installing on APT based Linux distributions
5153

0 commit comments

Comments
 (0)