org.bouncycastle.crypto.tls.TlsClient Maven / Gradle / Ivy
Show all versions of bcprov-debug-jdk15to18 Show documentation
package org.bouncycastle.crypto.tls;
import java.io.IOException;
import java.util.Hashtable;
import java.util.Vector;
/**
* Interface describing a TLS client endpoint.
*
* @deprecated Migrate to the (D)TLS API in org.bouncycastle.tls (bctls jar).
*/
public interface TlsClient
extends TlsPeer
{
void init(TlsClientContext context);
/**
* Return the session this client wants to resume, if any. Note that the peer's certificate
* chain for the session (if any) may need to be periodically revalidated.
*
* @return A {@link TlsSession} representing the resumable session to be used for this
* connection, or null to use a new session.
* @see SessionParameters#getPeerCertificate()
*/
TlsSession getSessionToResume();
/**
* Return the {@link ProtocolVersion} to use for the TLSPlaintext.version
field prior to
* receiving the server version. NOTE: This method is not called for DTLS.
*
*
* See RFC 5246 E.1.: "TLS clients that wish to negotiate with older servers MAY send any value
* {03,XX} as the record layer version number. Typical values would be {03,00}, the lowest
* version number supported by the client, and the value of ClientHello.client_version. No
* single value will guarantee interoperability with all old servers, but this is a complex
* topic beyond the scope of this document."
*
*
* @return The {@link ProtocolVersion} to use.
*/
ProtocolVersion getClientHelloRecordLayerVersion();
ProtocolVersion getClientVersion();
boolean isFallback();
int[] getCipherSuites();
short[] getCompressionMethods();
// Hashtable is (Integer -> byte[])
Hashtable getClientExtensions()
throws IOException;
void notifyServerVersion(ProtocolVersion selectedVersion)
throws IOException;
/**
* Notifies the client of the session_id sent in the ServerHello.
*
* @param sessionID
* @see TlsContext#getResumableSession()
*/
void notifySessionID(byte[] sessionID);
void notifySelectedCipherSuite(int selectedCipherSuite);
void notifySelectedCompressionMethod(short selectedCompressionMethod);
// Hashtable is (Integer -> byte[])
void processServerExtensions(Hashtable serverExtensions)
throws IOException;
// Vector is (SupplementalDataEntry)
void processServerSupplementalData(Vector serverSupplementalData)
throws IOException;
TlsKeyExchange getKeyExchange()
throws IOException;
TlsAuthentication getAuthentication()
throws IOException;
// Vector is (SupplementalDataEntry)
Vector getClientSupplementalData()
throws IOException;
/**
* RFC 5077 3.3. NewSessionTicket Handshake Message
*
* This method will be called (only) when a NewSessionTicket handshake message is received. The
* ticket is opaque to the client and clients MUST NOT examine the ticket under the assumption
* that it complies with e.g. RFC 5077 4. Recommended Ticket Construction.
*
* @param newSessionTicket The ticket.
* @throws IOException
*/
void notifyNewSessionTicket(NewSessionTicket newSessionTicket)
throws IOException;
}