SSLEngines
open class SSLEngines
| kotlin.Any | |
| ↳ | android.net.ssl.SSLEngines |
Static utility methods for accessing additional functionality of supported instances of SSLEngine. Engines from the platform TLS provider will be compatible with all methods in this class.
Summary
| Public methods | |
|---|---|
| open static ByteArray? |
exportKeyingMaterial(engine: SSLEngine, label: String, context: ByteArray?, length: Int)Exports a value derived from the TLS master secret as described in RFC 5705. |
| open static Boolean |
isSupportedEngine(engine: SSLEngine)Returns whether the given engine can be used with the methods in this class. |
| open static Unit |
setUseSessionTickets(engine: SSLEngine, useSessionTickets: Boolean)Enables or disables the use of session tickets. |
Public methods
exportKeyingMaterial
open static fun exportKeyingMaterial(
engine: SSLEngine,
label: String,
context: ByteArray?,
length: Int
): ByteArray?
Exports a value derived from the TLS master secret as described in RFC 5705. A number of protocols leverage Transport Layer Security (TLS) to perform key establishment but then use some of the keying material for their own purposes. This method allows an application to export keying material from a TLS connection. The exported material will be the same on the client and server if they pass in the same values for label and context. See RFC 5705 for further details.
| Parameters | |
|---|---|
engine |
SSLEngine: the engine to use for exporting keying material This value cannot be null. |
label |
String: the label to use in calculating the exported value. This must be an ASCII-only string. This value cannot be null. |
context |
ByteArray?: the application-specific context value to use in calculating the exported value. This may be null to use no application context, which is treated differently than an empty byte array. |
length |
Int: the number of bytes of keying material to return. |
| Return | |
|---|---|
ByteArray? |
a value of the specified length, or null if the handshake has not yet completed or the connection has been closed. |
| Exceptions | |
|---|---|
javax.net.ssl.SSLException |
if the value could not be exported. |
isSupportedEngine
open static fun isSupportedEngine(engine: SSLEngine): Boolean
Returns whether the given engine can be used with the methods in this class. In general, only engines from the platform TLS provider are supported.
| Parameters | |
|---|---|
engine |
SSLEngine: This value cannot be null. |
setUseSessionTickets
open static fun setUseSessionTickets(
engine: SSLEngine,
useSessionTickets: Boolean
): Unit
Enables or disables the use of session tickets.
This function must be called before the handshake is started or it will have no effect.
| Parameters | |
|---|---|
engine |
SSLEngine: the engine This value cannot be null. |
useSessionTickets |
Boolean: whether to enable or disable the use of session tickets |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the given engine is not a platform engine |