REGISTER-DOMAIN( ) method

REGISTER-DOMAIN( ) method

Registers an authentication domain in the application’s trusted authentication domain registry. The AVM uses this registry to validate Client-principal objects during the session. After you have registered all authentication domains for a session, you must restrict the registration of additional domains by calling the LOCK-REGISTRATION( ) method.

Caution: Use caution when registering authentication domains in the application’s trusted authentication domain registry using the REGISTER-DOMAIN( ) and LOCK-REGISTRATION( ) methods. You can introduce the risk for a security breach by allowing the registration of rogue domains between registering your domains and locking the registry. Consider using the LOAD-DOMAINS( ) method, which loads authentication domain registry information directly from an OpenEdge database and then automatically locks the registry.

Return type: LOGICAL

Applies to: SECURITY-POLICY system handle
Syntax
REGISTER-DOMAIN( domain-name, domain-key [, domain-description  
  [, domain-type ] ] ) 
domain-name

A character expression that specifies the name of this authentication domain.

domain-key

A character expression that specifies the key to use when validating a Client-principal object created in this domain. The AVM converts this key to UTF-8 before using it, which ensures a consistent value regardless of code page settings.

domain-description

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

domain-type

An optional character expression that specifies an application-defined domain type.

You must call the LOCK-REGISTRATION( ) method before you can use the trusted authentication domain registry to validate Client-principal objects for the application.

If you do not register at least one authentication domain in the trusted authentication domain registry before calling this method, this method returns TRUE. However, any attempt to seal a Client-principal object will generate a run-time error.

If successful, this method returns TRUE. Otherwise, it returns FALSE.

The following code fragment illustrates how to use the REGISTER-DOMAIN( ) method:
DEFINE VARIABLE name AS CHARACTER NO-UNDO. 
DEFINE VARIABLE key  AS CHARACTER NO-UNDO. 
FOR EACH trusted-registrar: 
  name = trusted-registrar.name. 
  key = trusted-registrar.key. 
  SECURITY-POLICY:REGISTER-DOMAIN(name, key). 
END. 
SECURITY-POLICY:LOCK-REGISTRATION. 
See also: LOAD-DOMAINS( ) method, LOCK-REGISTRATION( ) method

Syntax
REGISTER-DOMAIN( `domain-name`, `domain-key` [, `domain-description` [, `domain-type` ] ] )

DEFINE VARIABLE name AS CHARACTER NO-UNDO. DEFINE VARIABLE key AS CHARACTER NO-UNDO. FOR EACH trusted-registrar: name = trusted-registrar.name. key = trusted-registrar.key. SECURITY-POLICY:REGISTER-DOMAIN(name, key). END. SECURITY-POLICY:LOCK-REGISTRATION.

OpenEdge Release 10.2B