Ice Reference Documentation
<<< Previous | Slice Documentation | Next >>>

# `IceSSL`

## Overview

    module IceSSL

IceSSL is a dynamic SSL transport plug-in for the Ice core. It provides authentication, encryption, and message integrity, using the industry-standard SSL protocol.

### Interface Index

CertificateVerifier

  The `CertificateVerifier` is the base interface for all classes that define additional application-specific certificate verification rules.

Plugin

  The interface for the SSL plug-in.

### Exception Index

`CertificateException`

  A root exception class for all exceptions related to public key certificates.

`CertificateKeyMatchException`

  When loading a public and private key pair into a `Context`, the load succeeded, but the private key and public key (certificate) did not match.

`CertificateLoadException`

  Indicates that a problem occurred while loading a certificate into a `Context` from either a memory buffer or from a file.

`CertificateParseException`

  Indicates that IceSSL was unable to parse the provided public key certificate into a form usable by the underlying SSL implementation.

`CertificateSignatureException`

  Indicates that the signature verification of a newly signed temporary RSA certificate has failed.

`CertificateSigningException`

  Indicates that a problem occurred while signing certificates during temporary RSA certificate generation.

`CertificateVerificationException`

  Indicates a problem occurred during the certificate verification phase of the SSL handshake.

`CertificateVerifierTypeException`

  This exception indicates that the provided CertificateVerifier was not derived from the proper base class, and thus, does not provide the appropriate interface.

`ConfigParseException`

  This exception indicates that a problem occurred while parsing the SSL configuration file, or while attempting to locate the configuration file.

`ConfigurationLoadingException`

  This exception indicates that an attempt was made to load the configuration for a `Context`, but the property specifying the indicated `Context`'s SSL configuration file was not set.

`ContextException`

  A problem was encountered while setting up the `Context`.

`ContextInitializationException`

  Indicates that a problem occurred while initializing the context structure of the underlying SSL implementation.

`ContextNotConfiguredException`

  This exception is raised when an attempt is made to make use of a `Context` that has not been configured yet.

`PrivateKeyException`

  A root exception class for all exceptions related to private keys.

`PrivateKeyLoadException`

  Indicates that a problem occurred while loading a private key into a `Context` from either a memory buffer or from a file.

`PrivateKeyParseException`

  Indicates that IceSSL was unable to parse the provided private key into a form usable by the underlying SSL implementation.

`ProtocolException`

  Indicates that a problem occurred that violates the SSL protocol, causing the connection to be shutdown.

`ShutdownException`

  This exception generally indicates that a problem occurred that caused the shutdown of an SSL connection.

`SslException`

  This exception represents the base of all security related exceptions in Ice.

`TrustedCertificateAddException`

  An attempt to add a certificate to the `Context`'s trusted certifificate store has failed.

`UnsupportedContextException`

  An attempt was made to call a method that references a ContextType that is not supported for that operation.

### Enum Index

ContextType

  A `Plugin` may serve as a Client, Server or both (ClientServer).

<<< Previous | Home | Next >>>
`IcePack::ServiceDescriptor` | Up | `IceSSL::CertificateException`