Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   *  Licensed to the Apache Software Foundation (ASF) under one or more
   *  contributor license agreements.  See the NOTICE file distributed with
   *  this work for additional information regarding copyright ownership.
   *  The ASF licenses this file to You under the Apache License, Version 2.0
   *  (the "License"); you may not use this file except in compliance with
   *  the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
  *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
 
 package org.apache.tomcat.jni;

SSL Context

Author(s):
Mladen Turk
Version:
$Revision: 515 $, $Date: 2008-03-17 22:02:23 +0100 (Mon, 17 Mar 2008) $
 
 
 public final class SSLContext {


    
Initialize new SSL context

Parameters:
pool The pool to use.
protocol The SSL protocol to use. It can be one of:
 SSL_PROTOCOL_SSLV2
 SSL_PROTOCOL_SSLV3
 SSL_PROTOCOL_SSLV2 | SSL_PROTOCOL_SSLV3
 SSL_PROTOCOL_TLSV1
 SSL_PROTOCOL_ALL
 
mode SSL mode to use
 SSL_MODE_CLIENT
 SSL_MODE_SERVER
 SSL_MODE_COMBINED
 
 
     public static native long make(long poolint protocolint mode)
         throws Exception;

    
Free the resources used by the Context

Parameters:
ctx Server or Client context to free.
Returns:
APR Status code.
 
     public static native int free(long ctx);

    
Set Session context id. Usually host:port combination.

Parameters:
ctx Context to use.
id String that uniquely identifies this context.
 
     public static native void setContextId(long ctxString id);

    
Asssociate BIOCallback for input or output data capture.
First word in the output string will contain error level in the form:
 [ERROR]  -- Critical error messages
 [WARN]   -- Varning messages
 [INFO]   -- Informational messages
 [DEBUG]  -- Debugging messaged
 
Callback can use that word to determine application logging level by intercepting write call. If the bio is set to 0 no error messages will be displayed. Default is to use the stderr output stream.

Parameters:
ctx Server or Client context to use.
bio BIO handle to use, created with SSL.newBIO
dir BIO direction (1 for input 0 for output).
 
     public static native void setBIO(long ctxlong bioint dir);

    
Set OpenSSL Option.

Parameters:
ctx Server or Client context to use.
options See SSL.SSL_OP_* for option flags.
 
     public static native void setOptions(long ctxint options);

    
Sets the "quiet shutdown" flag for ctx to be mode. SSL objects created from ctx inherit the mode valid at the time and may be 0 or 1.
Normally when a SSL connection is finished, the parties must send out "close notify" alert messages using L<SSL_shutdown(3)|SSL_shutdown(3)> for a clean shutdown.
When setting the "quiet shutdown" flag to 1, SSL.shutdown will set the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN. (SSL_shutdown then behaves like called with SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.) The session is thus considered to be shutdown, but no "close notify" alert is sent to the peer. This behaviour violates the TLS standard. The default is normal shutdown behaviour as described by the TLS standard.

Parameters:
ctx Server or Client context to use.
mode True to set the quiet shutdown.
    public static native void setQuietShutdown(long ctxboolean mode);

    
Cipher Suite available for negotiation in SSL handshake.
This complex directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase. Notice that this directive can be used both in per-server and per-directory context. In per-server context it applies to the standard SSL handshake when a connection is established. In per-directory context it forces a SSL renegotation with the reconfigured Cipher Suite after the HTTP request was read but before the HTTP response is sent.

Parameters:
ctx Server or Client context to use.
ciphers An SSL cipher specification.
    public static native boolean setCipherSuite(long ctxString ciphers)
        throws Exception;

    
Set File of concatenated PEM-encoded CA CRLs or directory of PEM-encoded CA Certificates for Client Auth
This directive sets the all-in-one file where you can assemble the Certificate Revocation Lists (CRL) of Certification Authorities (CA) whose clients you deal with. These are used for Client Authentication. Such a file is simply the concatenation of the various PEM-encoded CRL files, in order of preference.
The files in this directory have to be PEM-encoded and are accessed through hash filenames. So usually you can't just place the Certificate files there: you also have to create symbolic links named hash-value.N. And you should always make sure this directory contains the appropriate symbolic links. Use the Makefile which comes with mod_ssl to accomplish this task.

Parameters:
ctx Server or Client context to use.
file File of concatenated PEM-encoded CA CRLs for Client Auth.
path Directory of PEM-encoded CA Certificates for Client Auth.
    public static native boolean setCARevocation(long ctxString file,
                                                 String path)
        throws Exception;

    
Set File of PEM-encoded Server CA Certificates
This directive sets the optional all-in-one file where you can assemble the certificates of Certification Authorities (CA) which form the certificate chain of the server certificate. This starts with the issuing CA certificate of of the server certificate and can range up to the root CA certificate. Such a file is simply the concatenation of the various PEM-encoded CA Certificate files, usually in certificate chain order.
But be careful: Providing the certificate chain works only if you are using a single (either RSA or DSA) based server certificate. If you are using a coupled RSA+DSA certificate pair, this will work only if actually both certificates use the same certificate chain. Else the browsers will be confused in this situation.

Parameters:
ctx Server or Client context to use.
file File of PEM-encoded Server CA Certificates.
skipfirst Skip first certificate if chain file is inside certificate file.
    public static native boolean setCertificateChainFile(long ctxString file,
                                                         boolean skipfirst);

    
Set Certificate
Point setCertificateFile at a PEM encoded certificate. If the certificate is encrypted, then you will be prompted for a pass phrase. Note that a kill -HUP will prompt again. A test certificate can be generated with `make certificate' under built time. Keep in mind that if you've both a RSA and a DSA certificate you can configure both in parallel (to also allow the use of DSA ciphers, etc.)
If the key is not combined with the certificate, use key param to point at the key file. Keep in mind that if you've both a RSA and a DSA private key you can configure both in parallel (to also allow the use of DSA ciphers, etc.)

Parameters:
ctx Server or Client context to use.
cert Certificate file.
key Private Key file to use if not in cert.
password Certificate password. If null and certificate is encrypted, password prompt will be dispayed.
idx Certificate index SSL_AIDX_RSA or SSL_AIDX_DSA.
    public static native boolean setCertificate(long ctxString cert,
                                                String keyString password,
                                                int idx)
        throws Exception;

    
Set File and Directory of concatenated PEM-encoded CA Certificates for Client Auth
This directive sets the all-in-one file where you can assemble the Certificates of Certification Authorities (CA) whose clients you deal with. These are used for Client Authentication. Such a file is simply the concatenation of the various PEM-encoded Certificate files, in order of preference. This can be used alternatively and/or additionally to path.
The files in this directory have to be PEM-encoded and are accessed through hash filenames. So usually you can't just place the Certificate files there: you also have to create symbolic links named hash-value.N. And you should always make sure this directory contains the appropriate symbolic links. Use the Makefile which comes with mod_ssl to accomplish this task.

Parameters:
ctx Server or Client context to use.
file File of concatenated PEM-encoded CA Certificates for Client Auth.
path Directory of PEM-encoded CA Certificates for Client Auth.
    public static native boolean setCACertificate(long ctxString file,
                                                  String path)
        throws Exception;

    
Set SSL connection shutdown type
The following levels are available for level:
 SSL_SHUTDOWN_TYPE_STANDARD
 SSL_SHUTDOWN_TYPE_UNCLEAN
 SSL_SHUTDOWN_TYPE_ACCURATE
 

Parameters:
ctx Server or Client context to use.
type Shutdown type to use.
    public static native void setShutdowType(long ctxint type);

    
Set Type of Client Certificate verification and Maximum depth of CA Certificates in Client Certificate verification.
This directive sets the Certificate verification level for the Client Authentication. Notice that this directive can be used both in per-server and per-directory context. In per-server context it applies to the client authentication process used in the standard SSL handshake when a connection is established. In per-directory context it forces a SSL renegotation with the reconfigured client verification level after the HTTP request was read but before the HTTP response is sent.
The following levels are available for level:
 SSL_CVERIFY_NONE           - No client Certificate is required at all
 SSL_CVERIFY_OPTIONAL       - The client may present a valid Certificate
 SSL_CVERIFY_REQUIRE        - The client has to present a valid Certificate
 SSL_CVERIFY_OPTIONAL_NO_CA - The client may present a valid Certificate
                              but it need not to be (successfully) verifiable
 

The depth actually is the maximum number of intermediate certificate issuers, i.e. the number of CA certificates which are max allowed to be followed while verifying the client certificate. A depth of 0 means that self-signed client certificates are accepted only, the default depth of 1 means the client certificate can be self-signed or has to be signed by a CA which is directly known to the server (i.e. the CA's certificate is under setCACertificatePath), etc.

Parameters:
ctx Server or Client context to use.
level Type of Client Certificate verification.
depth Maximum depth of CA Certificates in Client Certificate verification.
    public static native void setVerify(long ctxint levelint depth);
New to GrepCode? Check out our FAQ X