org.apache.tomcat.util.net

Interface SSLSupport

public interface SSLSupport

Nested Class Summary

class
SSLSupport.CipherData
Simple data class that represents the cipher being used, along with the corresponding effective key size.

Field Summary

static String
CERTIFICATE_KEY
The Request attribute key for the client certificate chain.
static String
CIPHER_SUITE_KEY
The Request attribute key for the cipher suite.
static String
KEY_SIZE_KEY
The Request attribute key for the key size.
static String
SESSION_ID_KEY
The Request attribute key for the session id.
static SSLSupport.CipherData[]
ciphers
A mapping table to determine the number of effective bits in the key when using a cipher suite containing the specified cipher name.

Method Summary

String
getCipherSuite()
The cipher suite being used on this connection.
Integer
getKeySize()
Get the keysize.
Object[]
getPeerCertificateChain()
The client certificate chain (if any).
Object[]
getPeerCertificateChain(boolean force)
The client certificate chain (if any).
String
getSessionId()
The current session Id.

Field Details

CERTIFICATE_KEY

public static final String CERTIFICATE_KEY
The Request attribute key for the client certificate chain.


CIPHER_SUITE_KEY

public static final String CIPHER_SUITE_KEY
The Request attribute key for the cipher suite.


KEY_SIZE_KEY

public static final String KEY_SIZE_KEY
The Request attribute key for the key size.


SESSION_ID_KEY

public static final String SESSION_ID_KEY
The Request attribute key for the session id. This one is a Tomcat extension to the Servlet spec.


ciphers

public static final SSLSupport.CipherData[] ciphers
A mapping table to determine the number of effective bits in the key when using a cipher suite containing the specified cipher name. The underlying data came from the TLS Specification (RFC 2246), Appendix C.

Method Details

getCipherSuite

public String getCipherSuite()
            throws IOException
The cipher suite being used on this connection.


getKeySize

public Integer getKeySize()
            throws IOException
Get the keysize. What we're supposed to put here is ill-defined by the Servlet spec (S 4.7 again). There are at least 4 potential values that might go here: (a) The size of the encryption key (b) The size of the MAC key (c) The size of the key-exchange key (d) The size of the signature key used by the server Unfortunately, all of these values are nonsensical.


getPeerCertificateChain

public Object[] getPeerCertificateChain()
            throws IOException
The client certificate chain (if any).


getPeerCertificateChain

public Object[] getPeerCertificateChain(boolean force)
            throws IOException
The client certificate chain (if any).

Parameters:
force - If true, then re-negotiate the connection if necessary.


getSessionId

public String getSessionId()
            throws IOException
The current session Id.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.