Package org.microproxy

Record Class ProxyFailure.TlsFailed

java.lang.Object

java.lang.Record

org.microproxy.ProxyFailure.TlsFailed

Record Components:

hostAndPort - the destination host and port, or null when unavailable

cause - the failure that triggered this event

All Implemented Interfaces:

ProxyFailure

Enclosing interface:

ProxyFailure

public static record ProxyFailure.TlsFailed(String hostAndPort, IOException cause)
extends Record
implements ProxyFailure

The TLS handshake with the server (when intercepting) or with a TLS chained proxy failed or did not finish within HttpProxyServerBootstrap.withTlsHandshakeTimeout(java.time.Duration) (or the request's HttpFilters.proxyToServerTlsHandshakeTimeout()), e.g. because its certificate is not trusted. Default 502.

cause is the handshake's own exception, as the JDK threw it, with its whole cause chain: an SSLHandshakeException whose causes say, for example, that the certificate was revoked (a CertPathValidatorException with reason CertPathValidatorException.BasicReason.REVOKED); a SocketTimeoutException for a handshake that overran its deadline. reason() and alert() read the chain for the common cases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProxyFailure.TlsFailed.Reason	Why a TLS handshake failed, read from the exception's cause chain: the certificate checks first, then an alert from the peer, a timeout, or anything else.

Nested classes/interfaces inherited from interface org.microproxy.ProxyFailure

ProxyFailure.BadRequest, ProxyFailure.BadServerResponse, ProxyFailure.ConnectFailed, ProxyFailure.NoConnectionAvailable, ProxyFailure.NoRoute, ProxyFailure.RequestTooLarge, ProxyFailure.ServerTimeout, ProxyFailure.TlsFailed, ProxyFailure.UnresolvedHost

Constructor Summary

Constructors

Constructor	Description
TlsFailed(String hostAndPort, IOException cause)	Creates an instance of a TlsFailed record class.

Method Summary

Modifier and Type	Method	Description
String	alert()	Returns the description of the TLS alert the peer ended the handshake with, as RFC 8446 section 6 names it ("unrecognized_name", "handshake_failure", ...), or null when the peer sent none.
IOException	cause()	Returns the value of the cause record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	hostAndPort()	Returns the value of the hostAndPort record component.
ProxyFailure.TlsFailed.Reason	reason()	Returns why the handshake failed, as far as cause()'s chain tells.
HttpResponseStatus	status()	Returns the status of the proxy's default answer.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TlsFailed

public TlsFailed(String hostAndPort,
 IOException cause)

Creates an instance of a TlsFailed record class.

Parameters:

hostAndPort - the value for the hostAndPort record component

cause - the value for the cause record component

Method Details

status

public HttpResponseStatus status()

Description copied from interface: ProxyFailure

Returns the status of the proxy's default answer.

Specified by:

status in interface ProxyFailure

Returns:

the status of the proxy's default answer

reason

public ProxyFailure.TlsFailed.Reason reason()

Returns why the handshake failed, as far as cause()'s chain tells.

Returns:

why the handshake failed, as far as cause()'s chain tells

See Also:

• ProxyFailure.TlsFailed.Reason.of(Throwable)

alert

public String alert()

Returns the description of the TLS alert the peer ended the handshake with, as RFC 8446 section 6 names it ("unrecognized_name", "handshake_failure", ...), or null when the peer sent none.

Returns:

the description of the TLS alert the peer ended the handshake with, as RFC 8446 section 6 names it ("unrecognized_name", "handshake_failure", ...), or null when the peer sent none

See Also:

• ProxyFailure.TlsFailed.Reason.alertOf(Throwable)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

hostAndPort

public String hostAndPort()

Returns the value of the hostAndPort record component.

Returns:

the value of the hostAndPort record component

cause

public IOException cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component