com.goldencode.p2j.util

Interface CommonSecurityPolicy

All Superinterfaces:

CommonHandle, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon

public interface CommonSecurityPolicy
extends CommonHandle, PseudoWidget

Exposes the following methods or attributes from the SECURITY-STATUS handle:

SECURITY-POLICY attribute or method	API
SYMMETRIC-SUPPORT	getSymmetricSupport()
SYMMETRIC-ENCRYPTION-ALGORITHM	getSymmetricEncryptionAlgorithm(), setSymmetricEncryptionAlgorithm(character)
SYMMETRIC-ENCRYPTION-KEY	getSymmetricEncryptionKey(), setSymmetricEncryptionKey(raw)
SYMMETRIC-ENCRYPTION-IV	getSymmetricEncryptionIV(), setSymmetricEncryptionIV(raw)
SYMMETRIC-ENCRYPTION-SALT	getEncryptionSalt(), setEncryptionSalt(raw)
PBE-KEY-ROUNDS	getPbeKeyRounds(), setPbeKeyRounds(integer)
PBE-HASH-ALGORITHM	getPbeHashAlgorithm(), setPbeHashAlgorithm(character)
GET-CLIENT	getClient()
SET-CLIENT	setClient(handle)}
REGISTER-DOMAIN	registerDomain(character, character), registerDomain(character, character, character), registerDomain(character, character, character, character),
LOAD-DOMAINS	loadDomains(character), loadDomains(integer),
LOCK-REGISTRATION	lockRegistration()}

This interface is used as a returned type by the handle.unwrapErrorStatus() API, which, depending on the handle's state, it either returns an ErrorManager.asHandle() instance or an dynamic proxy using handle.invalidAttrAccessProxy

Method Summary

Modifier and Type	Method and Description
handle	getClient() Implementation of SECURITY-POLICY:GET-CLIENT method.
raw	getEncryptionSalt() Implementation of ENCRYPTION-SALT attribute getter.
character	getPbeHashAlgorithm() Implementation of PBE-HASH-ALGORITHM attribute getter.
integer	getPbeKeyRounds() Implementation of PBE-KEY-ROUNDS attribute getter.
character	getSymmetricEncryptionAlgorithm() Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute getter.
raw	getSymmetricEncryptionIV() Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-IV attribute getter.
raw	getSymmetricEncryptionKey() Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-KEY attribute getter.
character	getSymmetricSupport() Implementation of SECURITY-POLICY:SYMMETRIC-SUPPORT attribute getter.
logical	loadDomains(character name) Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.
logical	loadDomains(int num) Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.
logical	loadDomains(integer num) Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.
logical	loadDomains(java.lang.String name) Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.
logical	lockRegistration() Implementation of SECURITY-POLICY:LOCK-REGISTRATION method.
logical	registerDomain(character domainName, character accessCode) Implementation of SECURITY-POLICY:REGISTER-DOMAIN method.
logical	registerDomain(character domainName, character accessCode, character domainDesc) Implementation of SECURITY-POLICY:REGISTER-DOMAIN method.
logical	registerDomain(character domainName, character accessCode, character domainDesc, character domainType) Implementation of SECURITY-POLICY:REGISTER-DOMAIN method.
logical	setClient(handle h) Implementation of SECURITY-POLICY:SET-CLIENT method.
void	setEncryptionSalt(raw salt) Implementation of SECURITY-POLICY:ENCRYPTION-SALT attribute setter.
void	setPbeHashAlgorithm(character aname) Implementation of SECURITY-POLICY:PBE-HASH-ALGORITHM attribute setter.
void	setPbeKeyRounds(integer rounds) Implementation of SECURITY-POLICY:PBE-KEY-ROUNDS attribute setter.
void	setSymmetricEncryptionAlgorithm(character aname) Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute setter.
void	setSymmetricEncryptionIV(raw iv) Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-IV attribute setter.
void	setSymmetricEncryptionKey(raw key) Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute setter.

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Method Detail

getSymmetricSupport

character getSymmetricSupport()

Implementation of SECURITY-POLICY:SYMMETRIC-SUPPORT attribute getter. Returns a comma-separated list of supported cryptographic algorithm names to use in encrypting and decrypting data. Each algorithm name is a concatenation of three character expressions that identify an algorithm, mode, and key size.

Returns:

A comma-separated list of supported cryptographic algorithm names.

getSymmetricEncryptionAlgorithm

character getSymmetricEncryptionAlgorithm()

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute getter. Returns a character string that specifies the name of the default cryptographic algorithm to use with the ENCRYPT and DECRYPT functions. The default value is "AES_CBC_128"

Returns:

The name of the default cryptographic algorithm.

setSymmetricEncryptionAlgorithm

void setSymmetricEncryptionAlgorithm(character aname)

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute setter. Sets the name of the default cryptographic algorithm to use with the ENCRYPT and DECRYPT functions.

Parameters:

aname - The name of the default cryptographic algorithm.

getSymmetricEncryptionKey

raw getSymmetricEncryptionKey()

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-KEY attribute getter. This is write-only attribute, so the getter always return error

Returns:

error (4052).

setSymmetricEncryptionKey

void setSymmetricEncryptionKey(raw key)

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-ALGORITHM attribute setter. Sets the default encryption key (a binary value) to use with the ENCRYPT and DECRYPT functions. The default value is the Unknown value (?).

Parameters:

key - The default encryption key.

getSymmetricEncryptionIV

raw getSymmetricEncryptionIV()

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-IV attribute getter. Returns the default initialization vector value to use with the encryption key in the ENCRYPT and DECRYPT functions. The default value is the Unknown value (?), which indicates that no initialization vector value is used.

Returns:

The default initialization vector value.

setSymmetricEncryptionIV

void setSymmetricEncryptionIV(raw iv)

Implementation of SECURITY-POLICY:SYMMETRIC-ENCRYPTION-IV attribute setter. Sets the default initialization vector value to use with the encryption key in the ENCRYPT and DECRYPT functions. The default value is the Unknown value (?), which indicates that no initialization vector value is used.

Parameters:

iv - The default initialization vector value.

getEncryptionSalt

raw getEncryptionSalt()

Implementation of ENCRYPTION-SALT attribute getter. Returns the default salt value (a random series of bytes) to use with the GENERATE-PBE-KEY function. The default value is the Unknown value (?), which indicates that no salt value is used to generate the password-based encryption key.

Returns:

The default salt value.

setEncryptionSalt

void setEncryptionSalt(raw salt)

Implementation of SECURITY-POLICY:ENCRYPTION-SALT attribute setter. Sets the default salt value (a random series of bytes) to use with the GENERATE-PBE-KEY function. The default value is the Unknown value (?), which indicates that no salt value is used to generate the password-based encryption key.

Parameters:

salt - The default salt value.

getPbeKeyRounds

integer getPbeKeyRounds()

Implementation of PBE-KEY-ROUNDS attribute getter. Returns the number of hash algorithm iterations to perform in the GENERATE-PBE-KEY function to generate a password-based encryption key. The value must be a positive integer. The default value is 1000.

Returns:

The number of hash algorithm iterations.

setPbeKeyRounds

void setPbeKeyRounds(integer rounds)

Implementation of SECURITY-POLICY:PBE-KEY-ROUNDS attribute setter. Sets the number of hash algorithm iterations to perform in the GENERATE-PBE-KEY function to generate a password-based encryption key. The value must be a positive integer. The default value is 1000.

Parameters:

rounds - The number of hash algorithm iterations.

getPbeHashAlgorithm

character getPbeHashAlgorithm()

Implementation of PBE-HASH-ALGORITHM attribute getter. Returns the number of hash algorithm iterations to perform in the GENERATE-PBE-KEY function to generate a password-based encryption key. The value must be a positive integer. The default value is 1000.

Returns:

The number of hash algorithm iterations.

setPbeHashAlgorithm

void setPbeHashAlgorithm(character aname)

Implementation of SECURITY-POLICY:PBE-HASH-ALGORITHM attribute setter. Sets the number of hash algorithm iterations to perform in the GENERATE-PBE-KEY function to generate a password-based encryption key. The value must be a positive integer. The default value is 1000.

Parameters:

aname - The number of hash algorithm iterations.

getClient

handle getClient()

Implementation of SECURITY-POLICY:GET-CLIENT method. Returns the handle to a copy of the sealed client-principal object that represents the user identity for the ABL session. If no identity has been established for the session using the SECURITY-POLICY:SET-CLIENT( ) method, this method returns the Unknown value (?).

Returns:

The handle to a copy of the sealed client-principal object.

setClient

logical setClient(handle h)

Implementation of SECURITY-POLICY:SET-CLIENT method. Sets the identity, using an unsealed or a sealed client-principal object, for the current ABL session, and for all connected and unlocked OpenEdge database connections.

Parameters:

h - The handle to an unsealed or a sealed client-principal object.

Returns:

true if operation succeeded or false otherwise

registerDomain

logical registerDomain(character domainName,
                       character accessCode)

Implementation of SECURITY-POLICY:REGISTER-DOMAIN method. Registers a security domain in the ABL session domain registry. The AVM uses this registry to authenticate or validate (through a single sign-on (SSO) operation) the session identity represented by a client-principal object, as well as the connection identity for any OpenEdge database configured to use the session (application) registry.

Parameters:

domainName - A character expression that specifies the name of this security domain.

accessCode - A character expression that specifies the secret value to use when authenticating or validating a client-principal object that represents a user identity in this domain.

Returns:

true if operation succeeded or false otherwise

registerDomain

logical registerDomain(character domainName,
                       character accessCode,
                       character domainDesc)

Implementation of SECURITY-POLICY:REGISTER-DOMAIN method. Registers a security domain in the ABL session domain registry. The AVM uses this registry to authenticate or validate (through a single sign-on (SSO) operation) the session identity represented by a client-principal object, as well as the connection identity for any OpenEdge database configured to use the session (application) registry.

Parameters:

domainName - A character expression that specifies the name of this security domain.

accessCode - A character expression that specifies the secret value to use when authenticating or validating a client-principal object that represents a user identity in this domain.

domainDesc - An optional character expression that specifies a description for this domain.

Returns:

true if operation succeeded or false otherwise

registerDomain

logical registerDomain(character domainName,
                       character accessCode,
                       character domainDesc,
                       character domainType)

Implementation of SECURITY-POLICY:REGISTER-DOMAIN method. Registers a security domain in the ABL session domain registry. The AVM uses this registry to authenticate or validate (through a single sign-on (SSO) operation) the session identity represented by a client-principal object, as well as the connection identity for any OpenEdge database configured to use the session (application) registry.

Parameters:

domainName - A character expression that specifies the name of this security domain.

accessCode - A character expression that specifies the secret value to use when authenticating or validating a client-principal object that represents a user identity in this domain.

domainDesc - An optional character expression that specifies a description for this domain.

domainType - An optional character expression that specifies an application-defined authentication system for user authentication and single-sign-on (SSO) operations.

Returns:

true if operation succeeded or false otherwise

loadDomains

logical loadDomains(character name)

Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.

Parameters:

name - The logical name or alias of a connected database from which to load registered domains

Returns:

true if operation succeeded or false otherwise

loadDomains

logical loadDomains(java.lang.String name)

Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.

Parameters:

name - The logical name or alias of a connected database from which to load registered domains.

Returns:

true if operation succeeded or false otherwise.

loadDomains

logical loadDomains(integer num)

Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.

Parameters:

num - The sequence number of a connected database from which to load registered domains.

Returns:

true if operation succeeded or false otherwise.

loadDomains

logical loadDomains(int num)

Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry.

Parameters:

num - The sequence number of a connected database from which to load registered domains.

Returns:

true if operation succeeded or false otherwise.

lockRegistration

logical lockRegistration()

Implementation of SECURITY-POLICY:LOCK-REGISTRATION method. Prevents the registration of additional domains in the ABL session domain registry for the remainder of an ABL session. You must call this method to use the domains you have registered in the session domain registry using the REGISTER-DOMAIN( ) method.

Returns:

true if operation succeeded or false otherwise