SecurityAdmin MBean

Management interface for Security functions.


Operation Summary
voidupdateAuthDataCfg(java.util.HashMap newCfg)
           Updates the auth data entries in runtime
voidpurgeUserFromAuthCache(java.lang.String realm, java.lang.String userid)
           Remove a user from the auth cache
voidclearAuthCache()
           Remove all users from the auth cache
voidgenerateKeys(java.lang.String password)
           Generates the LTPA keys
java.util.PropertiesgenKeys(java.lang.String password)
           Generates the LTPA keys without updating the Runtime
voidexportKeys(java.lang.String fileName, java.util.Properties props)
           Export the LTPAKeys from runtime to a file
voidimportKeys(java.lang.String fileName, [B passwd)
           Imports the LTPAKeys into the runtime from a file
voidimportLTPAKeys(java.util.Properties ssoProps, [B passwd)
           Imports the LTPAKeys into the runtime
voidcheckImportLTPAKeys(java.util.Properties ssoProps, [B passwd)
           Checks of the keys can be decrypted with the password
java.util.PropertiesexportLTPAKeys()
           Exports the LTPA keys from the runtime
com.ibm.websphere.security.ResultgetUsers(java.lang.String pattern, java.lang.Integer limit, java.util.Properties props)
           getUsers from the UserRegistry
com.ibm.websphere.security.ResultgetGroups(java.lang.String pattern, java.lang.Integer limit, java.util.Properties props)
           getGroups from the UserRegistry
java.lang.BooleancheckPassword(java.lang.String userId, java.lang.String password, java.util.Properties props)
           authenticates the user
java.lang.IntegercheckTokenLibFile(java.lang.String tokenType, java.lang.String tokenLib, java.lang.String tokenSlot, java.lang.String tokenPasswordEncoded, java.lang.String serverAlias, java.lang.String clientAlias)
           Validates SSL cryptographic config
java.lang.IntegercheckKeyFile(java.lang.String fileType, java.lang.String fileName, java.lang.String filePasswordEncoded, java.lang.String serverAlias, java.lang.String clientAlias)
           Validates SSL key file config
java.lang.IntegercheckTrustFile(java.lang.String fileType, java.lang.String fileName, java.lang.String filePasswordEncoded)
           Validates SSL trust file config
java.lang.StringgetRealm(java.util.Properties props)
           gets the Realm
java.lang.BooleancheckRunAsUser(java.util.List usrList, java.util.List grpList, java.lang.String userName, java.util.Properties props)
           Checks if the user can be added to the runAsRole
java.lang.StringgetAccessIds(boolean isUser, java.lang.String name, java.util.Properties props)
           Gets the accessIds for users and groups from the active registry
voidupdateJAASCfg(java.lang.String newCfg)
           Dynamic refreshing the WCCM JAAS configuration
java.lang.StringgetJAASCfg()
           Get the WCCM JAAS configuration

Operation Detail

updateAuthDataCfg

public void updateAuthDataCfg(java.util.HashMap newCfg)
Updates the auth data entries in runtime
Parameters:
newCfg - The auth data config.

purgeUserFromAuthCache

public void purgeUserFromAuthCache(java.lang.String realm, java.lang.String userid)
Remove a user from the auth cache
Parameters:
realm - The security realm.
userid - The userid.

clearAuthCache

public void clearAuthCache()
Remove all users from the auth cache

generateKeys

public void generateKeys(java.lang.String password)
Generates the LTPA keys
Parameters:
password - The password to encrypt and decrypt the Keys

genKeys

public java.util.Properties genKeys(java.lang.String password)
Generates the LTPA keys without updating the Runtime
Parameters:
password - The password to encrypt and decrypt the Keys

exportKeys

public void exportKeys(java.lang.String fileName, java.util.Properties props)
Export the LTPAKeys from runtime to a file
Parameters:
fileName - A File to which LTPA keys to be exported
props - optional LTPA server properties

importKeys

public void importKeys(java.lang.String fileName, [B passwd)
Imports the LTPAKeys into the runtime from a file
Parameters:
fileName - A File containing the LTPA keys to import
passwd - password to encrypt and decrypt the LTPA keys

importLTPAKeys

public void importLTPAKeys(java.util.Properties ssoProps, [B passwd)
Imports the LTPAKeys into the runtime
Parameters:
ssoProps - A properties object containing the LTPA keys to import
passwd - password to encrypt and decrypt the LTPA keys

checkImportLTPAKeys

public void checkImportLTPAKeys(java.util.Properties ssoProps, [B passwd)
Checks of the keys can be decrypted with the password
Parameters:
ssoProps - A properties object containing the LTPA keys to import
passwd - password to encrypt and decrypt the LTPA keys

exportLTPAKeys

public java.util.Properties exportLTPAKeys()
Exports the LTPA keys from the runtime

getUsers

public com.ibm.websphere.security.Result getUsers(java.lang.String pattern, java.lang.Integer limit, java.util.Properties props)
getUsers from the UserRegistry
Parameters:
pattern - The pattern to search for users in the UserRegistry
limit - The maximum number of users that can be returned
props - The properties object

getGroups

public com.ibm.websphere.security.Result getGroups(java.lang.String pattern, java.lang.Integer limit, java.util.Properties props)
getGroups from the UserRegistry
Parameters:
pattern - The pattern to search for groups in the UserRegistry
limit - The maximum number of groups that can be returned
props - The properties object

checkPassword

public java.lang.Boolean checkPassword(java.lang.String userId, java.lang.String password, java.util.Properties props)
authenticates the user
Parameters:
userId - The userId to authenticate
password - The password of the user
props - The properties object

checkTokenLibFile

public java.lang.Integer checkTokenLibFile(java.lang.String tokenType, java.lang.String tokenLib, java.lang.String tokenSlot, java.lang.String tokenPasswordEncoded, java.lang.String serverAlias, java.lang.String clientAlias)
Validates SSL cryptographic config
Parameters:
tokenType - Token type, i.e., PKCS#11
tokenLib - The token library file name
tokenSlot - The tokenslot number
tokenPasswordEncoded - The token password in the encoded form
serverAlias - The value from com.ibm.ssl.keyStoreServerAlias
clientAlias - The value from com.ibm.ssl.keyStoreClientAlias

checkKeyFile

public java.lang.Integer checkKeyFile(java.lang.String fileType, java.lang.String fileName, java.lang.String filePasswordEncoded, java.lang.String serverAlias, java.lang.String clientAlias)
Validates SSL key file config
Parameters:
fileType - The file type, i.e., JKS
fileName - The absolute path of the key file
filePasswordEncoded - The key file password in the encoded form
serverAlias - The value from com.ibm.ssl.keyStoreServerAlias
clientAlias - The value from com.ibm.ssl.keyStoreClientAlias

checkTrustFile

public java.lang.Integer checkTrustFile(java.lang.String fileType, java.lang.String fileName, java.lang.String filePasswordEncoded)
Validates SSL trust file config
Parameters:
fileType - The file type, i.e., JKS
fileName - The absolute path of the trust file
filePasswordEncoded - The trust file password in the encoded form

getRealm

public java.lang.String getRealm(java.util.Properties props)
gets the Realm
Parameters:
props - The properties object

checkRunAsUser

public java.lang.Boolean checkRunAsUser(java.util.List usrList, java.util.List grpList, java.lang.String userName, java.util.Properties props)
Checks if the user can be added to the runAsRole
Parameters:
usrList - The list of userNames
grpList - The list of groupNames
userName - The user name entered for runAsRole
props - The properties object

getAccessIds

public java.lang.String getAccessIds(boolean isUser, java.lang.String name, java.util.Properties props)
Gets the accessIds for users and groups from the active registry
Parameters:
isUser - true if it a user, false if it is a group
name - The name of the user or group
props - The properties object

updateJAASCfg

public void updateJAASCfg(java.lang.String newCfg)
Dynamic refreshing the WCCM JAAS configuration
Parameters:
newCfg - New WCCM JAAS configuration

getJAASCfg

public java.lang.String getJAASCfg()
Get the WCCM JAAS configuration

Copyright IBM Corp. 1996-2003