SecureSocketLayer

SecureSocketLayer

This type is a class for model objects.

Configuration settings for using Secure Socket Layer (SSL).
Package: ssl

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  DataReplication.ssl
  SSLConfig.setting

Attributes Summary

keyFileName : EString The fully-qualified path to the key file which contains public keys (and perhaps private keys).

keyFilePassword : Password The password for accessing the key file.

keyFileFormat : KeyFileFormatKind The format of the key file.

clientKeyAlias : EString Choose an alias in key file to authenticate the client side of a secure socket connection. (Reserved by IBM for Future Use)

serverKeyAlias : EString Choose an alias in key file to authenticate the server side of a secure socket connection. (Reserved by IBM for Future Use)

trustFileName : EString The fully qualified path to a trust file containing the public keys.

trustFilePassword : Password A password for accessing the trust file.

trustFileFormat : KeyFileFormatKind The format of the trust file.

clientAuthentication : EBoolean Specifies that the server and client should prove their identities through an exchange of keys.

securityLevel : SSLSecurityLevel One of a preconfigured set of cipher suites with the indicated level of encryption strength.

enableCryptoHardwareSupport : EBoolean Indicate whether cryptographic token standard interface support is enabled.

enabledCiphers : EString This is a space separated list of ciphers which will be used for this SSL configuration when creating SSLContext objects.

jsseProvider : EString IBMJSSE2, IBMJSSE, IBMJSSEFIPS or "custom". Default is "IBMJSSE2".

clientAuthenticationSupported : EBoolean required, supported, disabled. Default is "disabled". Having this enabled can cause problems with the identity specification for some protocols.

sslProtocol : EString SSL_TLS, "TLS", "TSLv1", "SSLv3", "SSL". Default is "SSL_TLS".

cryptoHardware : CryptoHardwareToken @ Specifies information about the cryptographic tokens related to SSL support.

properties : Property * SecureSocketLayer attributes are represented as name-value pair at runtime. A property defined with the identical name overrides the attribute value. For example, the com.ibm.ssl.enabledCipherSuites can be defined to override the pre-configured cipher suites.

keyStore : KeyStore @ * No description is available *

trustStore : KeyStore @ * No description is available *

trustManager : TrustManager * * No description is available *

keyManager : KeyManager @ * No description is available *

Attribute Details

keyFileName  -  The fully-qualified path to the key file which contains public keys (and perhaps private keys).
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keyFilePassword  -  The password for accessing the key file.
    Data Type: Password
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keyFileFormat  -  The format of the key file.
    Data Type: KeyFileFormatKind
    Default value:  unspecified
    Allowed values:
        0 - JKS
        1 - PKCS12
        2 - JCEK
        3 - JCERACFKS
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

clientKeyAlias  -  Choose an alias in key file to authenticate the client side of a secure socket connection. (Reserved by IBM for Future Use)
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

serverKeyAlias  -  Choose an alias in key file to authenticate the server side of a secure socket connection. (Reserved by IBM for Future Use)
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustFileName  -  The fully qualified path to a trust file containing the public keys.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustFilePassword  -  A password for accessing the trust file.
    Data Type: Password
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustFileFormat  -  The format of the trust file.
    Data Type: KeyFileFormatKind
    Default value:  unspecified
    Allowed values:
        0 - JKS
        1 - PKCS12
        2 - JCEK
        3 - JCERACFKS
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

clientAuthentication  -  Specifies that the server and client should prove their identities through an exchange of keys.
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

securityLevel  -  One of a preconfigured set of cipher suites with the indicated level of encryption strength.
    Data Type: SSLSecurityLevel
    Default value:  unspecified
    Allowed values:
        0 - HIGH
        1 - MEDIUM
        2 - LOW
        3 - CUSTOM
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableCryptoHardwareSupport  -  Indicate whether cryptographic token standard interface support is enabled.
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enabledCiphers  -  This is a space separated list of ciphers which will be used for this SSL configuration when creating SSLContext objects.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

jsseProvider  -  IBMJSSE2, IBMJSSE, IBMJSSEFIPS or "custom". Default is "IBMJSSE2".
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

clientAuthenticationSupported  -  required, supported, disabled. Default is "disabled". Having this enabled can cause problems with the identity specification for some protocols.
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

sslProtocol  -  SSL_TLS, "TLS", "TSLv1", "SSLv3", "SSL". Default is "SSL_TLS".
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

cryptoHardware  -  Specifies information about the cryptographic tokens related to SSL support.
    Reference Type: CryptoHardwareToken @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

properties  -  SecureSocketLayer attributes are represented as name-value pair at runtime. A property defined with the identical name overrides the attribute value. For example, the com.ibm.ssl.enabledCipherSuites can be defined to override the pre-configured cipher suites.
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keyStore  -  * No description is available *
    Reference Type: KeyStore @
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustStore  -  * No description is available *
    Reference Type: KeyStore @
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

trustManager  -  * No description is available *
    Reference Type: TrustManager *
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keyManager  -  * No description is available *
    Reference Type: KeyManager @
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
keyFileName : EString	The fully-qualified path to the key file which contains public keys (and perhaps private keys).
keyFilePassword : Password	The password for accessing the key file.
keyFileFormat : KeyFileFormatKind	The format of the key file.
clientKeyAlias : EString	Choose an alias in key file to authenticate the client side of a secure socket connection. (Reserved by IBM for Future Use)
serverKeyAlias : EString	Choose an alias in key file to authenticate the server side of a secure socket connection. (Reserved by IBM for Future Use)
trustFileName : EString	The fully qualified path to a trust file containing the public keys.
trustFilePassword : Password	A password for accessing the trust file.
trustFileFormat : KeyFileFormatKind	The format of the trust file.
clientAuthentication : EBoolean	Specifies that the server and client should prove their identities through an exchange of keys.
securityLevel : SSLSecurityLevel	One of a preconfigured set of cipher suites with the indicated level of encryption strength.
enableCryptoHardwareSupport : EBoolean	Indicate whether cryptographic token standard interface support is enabled.
enabledCiphers : EString	This is a space separated list of ciphers which will be used for this SSL configuration when creating SSLContext objects.
jsseProvider : EString	IBMJSSE2, IBMJSSE, IBMJSSEFIPS or "custom". Default is "IBMJSSE2".
clientAuthenticationSupported : EBoolean	required, supported, disabled. Default is "disabled". Having this enabled can cause problems with the identity specification for some protocols.
sslProtocol : EString	SSL_TLS, "TLS", "TSLv1", "SSLv3", "SSL". Default is "SSL_TLS".
cryptoHardware : CryptoHardwareToken @	Specifies information about the cryptographic tokens related to SSL support.
properties : Property *	SecureSocketLayer attributes are represented as name-value pair at runtime. A property defined with the identical name overrides the attribute value. For example, the com.ibm.ssl.enabledCipherSuites can be defined to override the pre-configured cipher suites.
keyStore : KeyStore @	* No description is available *
trustStore : KeyStore @	* No description is available *
trustManager : TrustManager *	* No description is available *
keyManager : KeyManager @	* No description is available *