andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify who is responsible closing the InputStream once SslContext w… (#10983)

Browse Source 
Motivation:

It was not 100% clear who is responsible calling close() on the InputStream.

Modifications:

Clarify javadocs.

Result:

Related to https://github.com/netty/netty/issues/10974

Co-authored-by: Chris Vest <christianvest_hansen@apple.com>
This commit is contained in:
Norman Maurer 2021-02-01 11:50:26 +01:00 committed by GitHub
parent 3353bc1152
commit a9a3e2cef1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
handler/src/main/java/io/netty/handler/ssl/SslContextBuilder.java
View File

@ -65,8 +65,13 @@ public final class SslContextBuilder {
/** /**
* Creates a builder for new server-side {@link SslContext}. * Creates a builder for new server-side {@link SslContext}.
* *
* @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format * @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format. The caller is
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format * responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format. The caller is
* responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
*
* @see #keyManager(InputStream, InputStream) * @see #keyManager(InputStream, InputStream)
*/ */
public static SslContextBuilder forServer(InputStream keyCertChainInputStream, InputStream keyInputStream) { public static SslContextBuilder forServer(InputStream keyCertChainInputStream, InputStream keyInputStream) {
@ -112,8 +117,12 @@ public final class SslContextBuilder {
/** /**
* Creates a builder for new server-side {@link SslContext}. * Creates a builder for new server-side {@link SslContext}.
* *
* @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format * @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format. The caller is
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format * responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format. The caller is
* responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyPassword the password of the {@code keyFile}, or {@code null} if it's not * @param keyPassword the password of the {@code keyFile}, or {@code null} if it's not
* password-protected * password-protected
* @see #keyManager(InputStream, InputStream, String) * @see #keyManager(InputStream, InputStream, String)
@ -238,6 +247,8 @@ public final class SslContextBuilder {
/** /**
* Trusted certificates for verifying the remote endpoint's certificate. The input stream should * Trusted certificates for verifying the remote endpoint's certificate. The input stream should
* contain an X.509 certificate collection in PEM format. {@code null} uses the system default. * contain an X.509 certificate collection in PEM format. {@code null} uses the system default.
*
* The caller is responsible for calling {@link InputStream#close()} after {@link #build()} has been called.
*/ */
public SslContextBuilder trustManager(InputStream trustCertCollectionInputStream) { public SslContextBuilder trustManager(InputStream trustCertCollectionInputStream) {
try { try {
@ -300,8 +311,12 @@ public final class SslContextBuilder {
* Identifying certificate for this host. {@code keyCertChainInputStream} and {@code keyInputStream} may * Identifying certificate for this host. {@code keyCertChainInputStream} and {@code keyInputStream} may
* be {@code null} for client contexts, which disables mutual authentication. * be {@code null} for client contexts, which disables mutual authentication.
* *
* @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format * @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format. The caller is
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format * responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format. The caller is
* responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
*/ */
public SslContextBuilder keyManager(InputStream keyCertChainInputStream, InputStream keyInputStream) { public SslContextBuilder keyManager(InputStream keyCertChainInputStream, InputStream keyInputStream) {
return keyManager(keyCertChainInputStream, keyInputStream, null); return keyManager(keyCertChainInputStream, keyInputStream, null);
@ -358,8 +373,12 @@ public final class SslContextBuilder {
* Identifying certificate for this host. {@code keyCertChainInputStream} and {@code keyInputStream} may * Identifying certificate for this host. {@code keyCertChainInputStream} and {@code keyInputStream} may
* be {@code null} for client contexts, which disables mutual authentication. * be {@code null} for client contexts, which disables mutual authentication.
* *
* @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format * @param keyCertChainInputStream an input stream for an X.509 certificate chain in PEM format. The caller is
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format * responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyInputStream an input stream for a PKCS#8 private key in PEM format. The caller is
* responsible for calling {@link InputStream#close()} after {@link #build()}
* has been called.
* @param keyPassword the password of the {@code keyInputStream}, or {@code null} if it's not * @param keyPassword the password of the {@code keyInputStream}, or {@code null} if it's not
* password-protected * password-protected
*/ */