KeyStore

This type is a class for model objects.

This object represents a KeyStore used to store certificates and keys. The KeyStore is referenced by the SSLConfig (for certificates) and the KeySet objects (for keys). The KeyStore object can be scoped to a management scope based on where the physical KeyStore lives or a user selection of the scope. This is necessary so that the wrong association is not made between an SSLConfig and a management scope where the SSLConfig KeyStore reference would not be possible given the associated management scope.

Package: ssl

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

Reference attributes having this type:
  Certificate.keyStore
  KeySet.keyStore
  RSAToken.adminCertificateTrustStore
  SecureSocketLayer.keyStore
  SecureSocketLayer.trustStore

Collection attributes having this type:
  AuditCommon.keyStores
  SecurityCommon.keyStores


Attributes Summary
name : EString The name of the KeyStore instance. This is a user-defined name.
password : Password The password for the KeyStore, Token, etc.
provider : EString This is the provider of the Keystore implementation.
location : EString This is the URL or filename of the KeyStore. This can be a DLL for cryptographic devices or a filename or file URL for file-based KeyStores. It can be a safkeyring URL for RACF keyrings.
type : EString This is the provider for the KeyStore. Valid values include JKS, JCEKS, PKCS12, PKCS11Impl (Hardware Crypto), CMS, CMS Crypto), JCERACFKS, JCE4758KS (RACF Crypto). Default is JCEKS (secure file-based KeyStore).
fileBased : EBoolean True or false. Default is true.
hostList : EString Comma separated ordered list of host name.
readOnly : EBoolean Read Only KeyStore, True or false. Default is true
initializeAtStartup : EBoolean True or false. Default is false.
customProviderClass : EString Custom provider class.
createStashFileForCMS : EBoolean Create a stash file for CMS type. The stash file option is only valid with the CMS type.
slot : EInt The slot for the keyStore.
useForAcceleration : EBoolean Use for Acceleration
description : EString KeyStore's description.
usage : EString This is determined usage of the keyStore, one of the following can be used: 1,. SSL 2. RoleProp 3. KeySets 4.Audit 5.Custom If it's not specify, then SSL is the default.
managementScope : ManagementScope @ * No description is available *
additionalKeyStoreAttrs : DescriptiveProperty * * No description is available *


Attribute Details

name  -  The name of the KeyStore instance. This is a user-defined name.
    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

password  -  The password for the KeyStore, Token, etc.
    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

provider  -  This is the provider of the Keystore implementation.
    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

location  -  This is the URL or filename of the KeyStore. This can be a DLL for cryptographic devices or a filename or file URL for file-based KeyStores. It can be a safkeyring URL for RACF keyrings.
    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

type  -  This is the provider for the KeyStore. Valid values include JKS, JCEKS, PKCS12, PKCS11Impl (Hardware Crypto), CMS, CMS Crypto), JCERACFKS, JCE4758KS (RACF Crypto). Default is JCEKS (secure file-based KeyStore).
    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

fileBased  -  True or false. Default is true.
    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

hostList  -  Comma separated ordered list of host name.
    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

readOnly  -  Read Only KeyStore, True or false. Default is true
    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

initializeAtStartup  -  True or false. Default is false.
    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

customProviderClass  -  Custom provider class.
    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

createStashFileForCMS  -  Create a stash file for CMS type. The stash file option is only valid with the CMS type.
    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

slot  -  The slot for the keyStore.
    Data Type: EInt
    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

useForAcceleration  -  Use for Acceleration
    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

description  -  KeyStore's description.
    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

usage  -  This is determined usage of the keyStore, one of the following can be used: 1,. SSL 2. RoleProp 3. KeySets 4.Audit 5.Custom If it's not specify, then SSL is the default.
    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

managementScope  -  * No description is available *
    Reference Type: ManagementScope @
    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

additionalKeyStoreAttrs  -  * No description is available *
    Reference Type: DescriptiveProperty *
    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


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