Skip to content

Commit dd204ec

Browse files
committed
more readble notes on compat + a note on reporting vulnerabilities
1 parent a3b6494 commit dd204ec

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,33 @@
55

66
Under the hood uses the [Bouncy Castle Crypto APIs](http://www.bouncycastle.org/).
77

8+
Each jruby-openssl gem release includes a certain version, usually the latest available,
9+
of the library (namely BC Provider and PKIX/CMS/EAC/PKCS/OCSP/TSP/OPENSSL jars).
10+
811
Please report bugs and incompatibilities (preferably with test-cases) to either
912
the JRuby [mailing list][1] or the [bug tracker][2].
1013

1114
## Compatibility
1215

13-
Since version **0.9.6** jruby-openssl aims to be compatible with all JRuby versions
14-
**>= 1.6.8** (including 1.7 and 9k), if it's not we consider that a bug, report.
1516

16-
We currently (for 0.9.x) require the Bouncy Castle Java APIs to be **>= 1.49**,
17-
for JRuby-OpenSSL **gem <= 0.9.6** you also need to make sure BC jars <= 1.50 !
17+
| JRuby-OpenSSL | JRuby compat | JVM compat | supported BC |
18+
| ------------- |:-------------:| ----------:| ------------:|
19+
| 0.9.6 | 1.6.8-9.0.2 | Java 6-8 | 1.47-1.50 |
20+
| 0.9.12 | 1.6.8-9.0.5 | Java 6-8 | 1.47-1.52 |
21+
| 0.9.13 | 1.6.8-9.1.2 | Java 6-8 | 1.49-1.52 |
22+
| 0.9.14 | 1.6.8-9.1.5 | Java 6-8 | 1.49-1.54 |
23+
| 0.9.17 | 1.6.8-9.1.5 | Java 6-8 | 1.50-1.54 |
24+
| 0.9.18 | 1.6.8-9.1.7 | Java 6-8 | 1.50-1.55 |
25+
26+
NOTE: backwards JRuby compatibility was not handled for versions <= **0.9.6**
27+
28+
## Security
29+
30+
JRuby-OpenSSL is an essential part of [JRuby](http://jruby.org), please report security
31+
vulnerabilities to `[email protected]` as detailed on JRuby's [security page](http://jruby.org/security).
32+
33+
Please note that most OpenSSL vulnerabilities do not effect JRuby since its not using
34+
any of OpenSSL's C code, only Ruby parts (*.rb) are the same as in MRI's OpenSSL library.
1835

1936
## Testing
2037

0 commit comments

Comments
 (0)