001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package javax.microedition.io;
028:
029: import java.lang.String;
030: import java.io.IOException;
031: import javax.microedition.pki.Certificate;
032: import javax.microedition.pki.CertificateException;
033:
034: /**
035: * This interface defines methods
036: * to access information about a secure network connection.
037: * Protocols that implement secure connections may use this interface
038: * to report the security parameters of the connection.
039: * <p>
040: * It provides the certificate, protocol, version, and cipher suite,
041: * etc. in use.
042: *
043: * @see CertificateException
044: * @see SecureConnection
045: * @see HttpsConnection
046: */
047: public interface SecurityInfo {
048:
049: /**
050: * Returns the <CODE>Certificate</CODE> used to establish the
051: * secure connection with the server.
052: *
053: * @return the <CODE>Certificate</CODE> used to establish the
054: * secure connection with the server.
055: */
056: public Certificate getServerCertificate();
057:
058: /**
059: * Returns the protocol version.
060: * If appropriate, it should contain the major and minor versions
061: * for the protocol separated with a "." (Unicode U+002E).
062: * <pre>
063: * For SSL V3 it MUST return "3.0"
064: * For TLS 1.0 it MUST return "3.1"
065: * For WTLS (WAP-199) it MUST return "1"
066: * For WAP TLS Profile and Tunneling Specification it MUST return "3.1"
067: *</pre>
068: * @return a String containing the version of the protocol;
069: * the return value MUST NOT be <CODE>null</CODE>.
070: */
071: public String getProtocolVersion();
072:
073: /**
074: * Returns the secure protocol name.
075: *
076: * @return a <code>String</code> containing the secure protocol identifier;
077: * if TLS (RFC 2246) or WAP TLS Profile and Tunneling (WAP-219-TLS)
078: * is used for the connection the return value is "TLS";
079: * if SSL V3 (The SSL Protocol Version 3.0) is used for the connection;
080: * the return value is "SSL");
081: * if WTLS (WAP 199) is used for the connection the return value is "WTLS".
082: */
083: public String getProtocolName();
084:
085: /**
086: * Returns the name of the cipher suite in use for the connection.
087: * The name returned is from the CipherSuite column of the CipherSuite
088: * definitions table in Appendix C of RFC 2246. If the cipher suite is
089: * not in Appendix C, the name returned is non-null and its contents
090: * are not specified. For non-TLS implementations the cipher suite name
091: * should be selected according to the actual key exchange, cipher,
092: * and hash
093: * combination used to establish the connection, so that regardless of
094: * whether the secure connection uses SSL V3
095: * or TLS 1.0 or WTLS or WAP TLS Profile and Tunneling,
096: * equivalent cipher suites have the same name.
097: *
098: * @return a <code>String</code> containing the name of the cipher suite
099: * in use.
100: */
101: public String getCipherSuite();
102: }
|