jspωiki
Fanout Configuration File Statements

Table of Contents

Platform Configuration File Statmentes#

The Platform Configuration File which can be determined configures the platform. This file name is the same on all platforms (asamplat.conf) and default Fanout Configuration File Location.

Below are the allowed statements and syntax and some sample values that maybe contained within the file.

ACF2.DISABLE Statement#

z/OS only.

The ACF2.DISABLE statement specifies the handling for ACF2* users who have the Login Disabled attribute set in their corresponding eDirectory™ User objects.

Syntax:#

ACF2.DISABLE Action
Action must be either
  • suspend or
  • cancel.
Specifying either one causes the corresponding CA ACF2 logonid attribute to be set. If no ACF2.DISABLE statement is present, the default Action is suspend.

Example:#

ACF2.DISABLE cancel

ACF2.EXPIREWARN Statement#

z/OS only.

The ACF2.EXPIREWARN statement specifies the number of days before a User object password in eDirectory expires that Platform Services begins to warn the ACF2 user.

Syntax:#

ACF2.EXPIREWARN Days
Days specifies the number of days that warning messages appear before password expiration.

If no ACF2.EXPIREWARN statement is present, the default is 5 days.

Example:#

ACF2.EXPIREWARN 14

ADMINPASSWORD Statement#

The ADMINPASSWORD statement specifies the password of the administrative user specified by the ADMINUSER statement. If there is no ADMINPASSWORD statement, you are prompted to enter the password when obtaining a platform security certificate.

Syntax:#

ADMINPASSWORD Pswd
Pswd specifies the password of the administrative user.

Example:#

ADMINPASSWORD 18emf25dhf

ADMINUSER Statement#

The ADMINUSER statement specifies the fully distinguished name of an eDirectory user with Read and Create object rights to the ASAM System container. If there is no ADMINUSER statement, you are prompted to enter a user object name when obtaining a platform security certificate.

Syntax:#

ADMINUSER Fdn
Fdn specifies the fully distinguished name of an eDirectory user with Read and Create object rights to the ASAM System container.

Example:#

ADMINUSER .Admin.DigitalAirlines

AM.GROUP.INCLUDE Statement / AM.GROUP.EXCLUDE Statement#

AM.GROUP.INCLUDE and AM.GROUP.EXCLUDE provide a list of specific groups or group masks to be included or excluded from Identity Provisioning. This can be useful for installation verification and early implementation and for special groups that should be managed locally. Multiple AM.GROUP.INCLUDE and AM.GROUP.EXCLUDE statements can be coded, and they can be mixed together. There is no limit to the number of groups that can be included or excluded.

Syntax:#

AM.GROUP.INCLUDE GroupMask[ GroupMask, GroupMask ...]

AM.GROUP.EXCLUDE GroupMask[ GroupMask, GroupMask ...]
GroupMask can be a single complete group name, or it can include masking characters to represent more than one group. If more than one GroupMask matches a given group, the most specific GroupMask is used. GroupMask is case-insensitive. For more information, see Mask Characters and Examples.

Unless AM.GROUP.EXCLUDE * is coded, AM.GROUP.INCLUDE * is always assumed. Certain special groups are always excluded unless the IGNORESTANDARDEXCLUDES statement is specified. For details, see IGNORESTANDARDEXCLUDES Statement.

NOTE: Do not code both an AM.GROUP.INCLUDE statement and an AM.GROUP.EXCLUDE statement.

For more information, see Section 10.4, Using Include and Exclude Configuration Statements.

Example:#

AM.GROUP.EXCLUDE sales, mkt*

AM.USER.INCLUDE Statement / AM.USER.EXCLUDE Statement#

AM.USER.INCLUDE and AM.USER.EXCLUDE provide a list of specific user IDs or user ID masks to be included or excluded from Identity Provisioning. This can be useful for installation verification and early implementation and for special user IDs that should be managed locally. Multiple AM.USER.INCLUDE and AM.USER.EXCLUDE statements can be coded, and they can be mixed together. There is no limit to the number of users that can be included or excluded.

Syntax:#

AM.USER.INCLUDE UserMask[ UserMask, UserMask ...]

AM.USER.EXCLUDE UserMask[ UserMask, UserMask ...]
UserMask can be a single complete user ID, or it can include masking characters to represent more than one user ID. If more than one UserMask matches a given user ID, the most specific UserMask is used. UserMask is case-insensitive. For more information, see Mask Characters and Examples.

Unless AM.USER.EXCLUDE * is coded, AM.USER.INCLUDE * is always assumed. Certain special users are always excluded unless the INGORESTANDARDEXCLUDES statement is specified. For details, see IGNORESTANDARDEXCLUDES Statement.

NOTE: Do not code both an AM.USER.INCLUDE * statement and an AM.USER.EXCLUDE * statement.

Identity Manager Fan-Out Driver Linux/UNIX platforms always manage root locally.

For more information, see Section 10.4, Using Include and Exclude Configuration Statements.

Example:#

AM.USER.EXCLUDE act*, billing%, sys*, sales48

AS.USER.INCLUDE Statement / AS.USER.EXCLUDE Statement#

AS.USER.INCLUDE and AS.USER.EXCLUDE provide a list of specific user IDs or user ID masks to be included or excluded from Authentication Services. This can be useful for installation verification and early implementation and for special user IDs that should be authenticated locally. Multiple AS.USER.INCLUDE and AS.USER.EXCLUDE statements can be coded, and they can be mixed together. There is no limit to the number of users that can be included or excluded, although a large list can cause a performance impact because it must be searched for every user login. These statements apply to system authentications only and are not used by the AS Client API routines (although there is an API call to test whether a user ID is excluded).

Syntax:#

AS.USER.INCLUDE UserMask[ UserMask, UserMask ...]

AS.USER.EXCLUDE UserMask[ UserMask, UserMask ...]
UserMask can be a single complete user ID, or it can include masking characters to represent more than one user ID. If more than one UserMask matches a given user ID, the most specific UserMask is used. UserMask is case-insensitive. For more information, see Mask Characters and Examples.

Unless AS.USER.EXCLUDE * is coded, AS.USER.INCLUDE * is always assumed. Certain special users are always excluded unless the INGORESTANDARDEXCLUDES statement is specified. For details, see IGNORESTANDARDEXCLUDES Statement.

Do not code both an AS.USER.INCLUDE * statement and an AS.USER.EXCLUDE * statement.

For more information, see Section 10.4, Using Include and Exclude Configuration Statements.

Example:#

AS.USER.EXCLUDE act*, billing%, sys*, sales48

AS.USER.NONNDS Statement#

z/OS only.

The AS.USER.NONNDS statement specifies how Platform Services handles users that are defined in the local security system but not in eDirectory. This allows an installation to avoid confusion between the Platform Services security system exit and standard TSO full-screen logon if a user is not defined in eDirectory.

Syntax:#

AS.USER.NONNDS Action
Action specifies the action to take for a user that is defined in the local security system but not in eDirectory. Possible values follow.

Possible Values for Specified Action#

ValueDescription
DISABLEDThe user ID is handled as though it were revoked in the local security system.
UNDEFINEDThe user ID is handled as though it were not defined to the local security system.
AUTHLOCALThe user ID is authenticated locally, as though the Core Driver was not available. It is not allowed to change its password.
EXCLUDEDThe user ID is authenticated as though it were excluded. The user can change its password in the local security system.
In each case, a message is written to the ASCLIENT log describing how the user's authentication request was modified.

If no AS.USER.NONNDS statement is provided, the default Action is undefined.

Example:#

AS.USER.NONNDS authlocal

ASAMDIR Statement#

The ASAMDIR statement specifies the file path where the Identity Manager Fan-Out Driver is installed. Fan-Out Driver components use ASAMDIR to find files needed for execution.

Syntax:#

ASAMDIR FilePath
FilePath specifies the location in file system where the component is installed. If there is no ASAMDIR statement, FilePath defaults as follows:
  • z/OS: /usr/local/ASAM in HFS
  • OS/400: /usr/local/ASAM
  • Linux and UNIX: /usr/local/ASAM
  • Windows: c:\novell\asam

Example:#


ASAMDIR c:\novell\asam

AUTHENTICATION Statement#

The AUTHENTICATION statement specifies the network address and port of one Core Driver used for Authentication Services. In order to use Authentication Services, you must have at least one AUTHENTICATION statement in your configuration file.

A maximum of 100 AUTHENTICATION statements can be coded.

Syntax:#

AUTHENTICATION Address [PORT PortNumber] [PREF PrefGroup]
Address specifies the DNS name or IP address of a Core Driver used for Authentication Services.

PortNumber specifies the TCP port number that is to be used to communicate with this Core Driver. PORT is optional. PortNumber defaults to 3451.

IMPORTANT:If you specify a port number other than the default, you must also use the Web interface to specify the same port number for the Core Driver configuration object.

PrefGroup specifies the Preference Group Number that determines the way a Core Driver is selected. It is optional, and the default is for all Core Drivers listed to be in Preference Group 1. Core Drivers within a Preference Group are selected equally for load balancing. Core Drivers with the lowest Preference Group Number are always tried first, followed by the Core Drivers with the next Preference Group Number, and so on, until a Core Driver can be contacted. Preference Group Number must be coded as a positive integer.

Examples:#

AUTHENTICATION cdriver1.digitalairlines.com
AUTHENTICATION cdriver2.digitalairlines.com
AUTHENTICATION cdriver5.digitalairlines.com PORT 5009 PREF 2

CODEPAGE Statement#

Linux/UNIX only. The CODEPAGE statement specifies a code page to be used by the Platform Receiver. Data received and sent by the Platform Receiver is encoded in UTF-8.

Syntax:#

CODEPAGE	 CodepageID
CodepageID specifies the code page to be used by the Platform Receiver for converting values from and to UTF-8. For information about the available choices for CodepageID, see the man page for iconv on your system.

If no CODEPAGE statement is present, UTF-8 values are used without conversion.

Example:#

CODEPAGE iso88591

DEBUGLOGFILE Statement#

The DEBUGLOGFILE statement specifies a destination file for debugging data written when the -d command line parameter is present for a component.

The DEBUGLOGFILE statement is not available for z/OS.

Syntax:#

DEBUGLOGFILE FilePath
FilePath specifies the location in file system where the debugging output is to be written.

Example:#

DEBUGLOGFILE /usr/local/ASAM/debug.txt

DEBUGTOSTDOUT Statement#

The DEBUGTOSTDOUT statement specifies that debugging data is to be written to the standard output channel stdout when the -d command line parameter is present for a component.

The DEBUGTOSTDOUT statement is not available for z/OS.

Syntax:#

DEBUGTOSTDOUT

Example:#

DEBUGTOSTDOUT

DIRECTTOAUTHENTICATION Statement#

The DIRECTTOAUTHENTICATION statement causes Authentication Services to connect directly to a Core Driver for Authentication Services without using the Platform Services Process. Use the DIRECTTOAUTHENTICATION statement on platforms where the volume of traffic with Core Drivers is so low that running the Platform Services Process is not justified.

Platforms using the DIRECTTOAUTHENTICATION statement do not perform Core Driver load balancing, although failover support is available if you specify multiple AUTHENTICATION statements.

The DIRECTTOAUTHENTICATION statement is not available for z/OS.

Syntax:#

DIRECTTOAUTHENTICATION

Example:#

DIRECTTOAUTHENTICATION

ENTROPY Statement#

Linux/UNIX only.

The ENTROPY statement specifies the file where components obtain entropy for SSL.

Syntax:#

ENTROPY	 FilePath
FilePath specifies the file that contains entropy.

If no ENTROPY statement is coded, the default is to use the /dev/random device for entropy. If there is no /dev/random device, the default entropy file is /etc/entropy.

NOTE: If your platform has a /dev/random device, you do not need to code an ENTROPY statement.

Example:#

ENTROPY /etc/entropy

HONORMVSDISABLE Statement#

z/OS only.

The HONORMVSDISABLE statement controls whether or not the local z/OS platform’s security system user disabled status is honored if the user is enabled for login in eDirectory.

Users whose Login Disabled attribute is set in eDirectory cannot log on through Authentication Services regardless of the setting in the local security system.

Syntax:#

HONORMVSDISABLE Action
Action must be:
  • YES - If Action is YES, a user that is enabled in eDirectory but disabled in the local security system is not allowed to log on.
  • NO - If Action is no, a user that is enabled in eDirectory but disabled in the local security system is allowed to log on, and the flag in the local security system is set to enable logons.

For RACF, the Revoke attribute is used to determine the local disabled status.

For CA ACF2, the logonid attribute specified by the ACF2.DISABLE statement is used to determine the local disabled status.

For CA Top Secret, the PSUSPEND flag is used to determine the local disabled status. The ASUSPEND flag is not programmatically accessible. Users with the ASUSPEND flag set are always prevented by CA Top Secret from logging on.

If no HONORMVSDISABLE statement is present, the default Action is NO.

Example:#

HONORMVSDISABLE YES

IGNORESTANDARDEXCLUDES Statement#

The IGNORESTANDARDEXCLUDES statement specifies that the standard list of users and groups excluded from Identity Provisioning and Authentication Services processing is not used. If this statement is not present, the standard list of excludes is used. For the standard list of excluded users and groups, see Section 8.10, Standard Exclude List.

Syntax:#

IGNORESTANDARDEXCLUDES

Example:#

IGNORESTANDARDEXCLUDES

KEY Statement#

z/OS only.

The KEY statement specifies a 56-bit DES encryption key for communications between a platform that uses DES encryption, and Core Drivers.

Syntax:#

KEY KeyValue
KeyValue specifies the value of the key. KeyValue must be entered as sixteen hexadecimal digits (0-9, A-F, a-f). The Web interface is used to enter this value in the corresponding Platform object. You must specify the same key value in both places. For details about using the Web interface to set the attributes of a Platform object, see Section 6.5.6, Configuring Platforms.

Example:#

KEY 0f4b9692d8bca5f6

LOCALE Statement#

The LOCALE statement identifies the language to be used by the component.

Syntax:#

LOCALE Id
Id specifies the two-character ISO 639 language identifier.

Example:#

LOCAL en

PASSWORDPROMPT Statement#

Linux/UNIX only.

The PASSWORDPROMPT statement specifies the prompt issued by the PAM module to request the user's password for authentication.

Syntax:#

PASSWORDPROMPT Text
If there is no PASSWORDPROMPT statement, Text defaults to
"NDS Password: "

Example:#

PASSWORDPROMPT "Password: "

PASSWORDPROMPTCURRENT Statement#

Linux/UNIX only.

The PASSWORDPROMPTCURRENT statement specifies the prompt issued by the PAM module to request the user's current password for password changes.

Syntax:#

PASSWORDPROMPTCURRENT Text
If there is no PASSWORDPROMPTCURRENT statement, Text defaults to
"Current NDS Password: "

Example:#

PASSWORDPROMPTCURRENT "Enter Current Password: "

PASSWORDPROMPTCHANGE Statement#

Linux/UNIX only.

The PASSWORDPROMPTCHANGE statement specifies the prompt issued by the PAM module to request the user's new password for password changes.

Syntax:#

PASSWORDPROMPTCHANGE Text
If there is no PASSWORDPROMPTCHANGE statement, Text defaults to
"New NDS Password: "

Example:#

PASSWORDPROMPTCHANGE "New Password: "

PASSWORDPROMPTCHANGEAGAIN Statement#

Linux/UNIX only.

The PASSWORDPROMPTCHANGEAGAIN statement specifies the prompt issued by the PAM module to verify the user's new password for password changes.

Syntax:#

PASSWORDPROMPTCHANGEAGAIN Text
If there is no PASSWORDPROMPTCHANGEAGAIN statement, Text defaults to
"Re-enter New NDS Password: "

Example:#

PASSWORDPROMPTCHANGEAGAIN "Verify New Password: "

PLATFORMNAME Statement#

The PLATFORMNAME statement specifies the common name of the Platform object. If there is no PLATFORMNAME statement, you are prompted to enter the name when obtaining a platform security certificate.

Syntax:#

PLATFORMNAME Cn
Cn specifies the common name of the Platform configuration object that was specified in the Web interface when platform was defined.

Example:#

PLATFORMNAME WestCentral

PASSWORDSOURCE Statement#

Linux/UNIX only.

The PASSWORDSOURCE statement specifies the location of the passwd or shadow formatted file where the encrypted passwords reside on the system and is typically not used.

Syntax:#

PASSWORDSOURCE fully-qualified-path-to-file
An important example of the PASSWORDSOURCE statement’s use is on HP-UX, when shadow passwords are enabled. The default location to look for encrypted passwords on non-trusted-mode HP-UX is /etc/passwd. When shadow passwords are enabled on HP-UX, PASSWORDSOURCE should be set like the following example:
PASSWORDSOURCE /etc/shadow

PROVISIONING Statement#

The PROVISIONING statement specifies the network address and port of one Provisioning Manager Core Driver. A PROVISIONING statement must appear in the configuration file for the Platform Receiver and when obtaining a security certificate.

You can code more than one PROVISIONING statement. The first PROVISIONING statement in the file identifies the Provisioning Manager that is tried first. If a connection with the Provisioning Manager identified by the first PROVISIONING statement fails, the Provisioning Managers identified by any other PROVISIONING statements are tried, in the order the PROVISIONING statements appear in the configuration file, until a connection is successful or there are no more PROVISIONING statements.

Syntax:#

PROVISIONING Address [PORT PortNumber]
Address specifies the DNS name or IP address of a Provisioning Manager.

PortNumber specifies the TCP port number that is to be used to communicate with the Provisioning Manager. PORT is optional. The default port number for the Provisioning Manager is 3451.

IMPORTANT:If you specify a port number other than the default, you must also use the Web interface to specify the same port number for the Core Driver configuration object.

Example:#

PROVISIONING cdriver1.digitalairlines.com
PROVISIONING cdriver4.digitalairlines.com

RUNMODE Statement#

The RUNMODE statement specifies the mode of operation the Platform Receiver uses. Command line parameters that specify a mode of operation override the mode specified on the RUNMODE statement.

Syntax:#

RUNMODE Mode
Mode specifies the mode of operation for the Platform Receiver. Possible values follow.

Values For Specified Mode#

ValueDescription
PERSISTENTThe Platform Receiver uses Persistent Mode.
POLLINGThe Platform Receiver uses Polling Mode.
SCHEDULEDThe Platform Receiver uses Scheduled Mode.

If no RUNMODE statement or mode-related command line parameter is present, the Platform Receiver uses persistent Mode.

For more information about Platform Receiver modes of operation, see Modes of Operation.

Example:#

RUNMODE polling

SECURITY Statement#

z/OS only.

The SECURITY statement specifies the type of security system in use. ASCLIENT attempts to determine the security system type by examining the subsystem table. RACF and CA ACF2 normally have subsystem table entries, but CA Top Secret does not.

If ASCLIENT cannot determine the security system that is in use, it writes a message to the log and disables password migration.

Syntax:#

SECURITY SecuritySystemType
SecuritySystemType must be ACF2, RACF, or TSS.

Example:#

SECURITY TSS

SMF Statement#

z/OS only.

The SMF statement specifies the SMF record type for the z/OS platform's performance statistics record. If the SMF statement is not present, the z/OS platform does not produce SMF records.

Syntax:#

SMF RecordType
RecordType must be an integer between 128 and 255.

Example:

SMF 240

SYSLOGFACILITY Statement#

Linux/UNIX only.

The SYSLOGFACILITY statement specifies the SYSLOG facility name to use for message logging on Linux/UNIX systems.

Syntax:#

SYSLOGFACILITY	 FacilityName
FacilityName specifies the SYSLOG facility to use for logging messages. The possible values for a specific Linux/UNIX system are mapped by the syslog.h file of that particular system.

If no SYSLOGFACILITY statement is coded, the default value is LOG_DAEMON.

Example:#

SYSLOGFACILITY LOG_DAEMON		

TRACEFILE Statement#

The TRACEFILE statement specifies that debugging output is generated and the file path where it is written. If the TRACEFILE statement is present in the platform configuration file, full debugging output is generated even if the -d command line parameter is not present.

To obtain debugging output from the system intercepts when you use the DIRECTTOAUTHENTICATION statement, you must use either the TRACEFILE or the TRACETOSTDOUT statement.

The TRACEFILE statement is not available in z/OS.

Syntax:#

TRACEFILE FilePath
FilePath specifies the location in the file system where debugging output is written.

Example:#

TRACEFILE c:\novell\asam\debug.txt

TRACETOSTDOUT Statement#

The TRACETOSTDOUT statement specifies that debugging output is generated and that it is written to the standard output channel stdout. If the TRACETOSTDOUT statement is present in the platform configuration file, full debugging output is generated even if the -d command line parameter is not present.

To obtain debugging output from the system intercepts when you use the DIRECTTOAUTHENTICATION statement, you must use either the TRACEFILE or the TRACETOSTDOUT statement.

The TRACETOSTDOUT statement is not available in z/OS.

Syntax:#

TRACETOSTDOUT

Example:#

TRACETOSTDOUT

UPDATEPASSWORD Statement#

Linux/UNIX only.

The UPDATEPASSWORD statement specifies that the driver updates the local security system upon a successful check password or change password operation, or when password replication information is received from the Core Driver. This allows a user to log in using the last password that worked on the system if the driver, eDirectory, or the network is not available, and the local security system is appropriately configured.

If there is no UPDATEPASSWORD statement present in the platform configuration file, the driver does not store passwords in the local security system.

Syntax:#

UPDATEPASSWORD

Example:#

UPDATEPASSWORD

UPDATESAMBA Statement#

Linux/UNIX only.

The UPDATESAMBA statement specifies that the driver updates the Samba password file upon a successful check password or change password operation, or when password replication information is received from the Core Driver.

If there is no UPDATESAMBA statement present in the platform configuration file, the driver does not store passwords in the Samba password file.

Syntax:#

UPDATESAMBA FilePath
FilePath specifies the location of the smbpasswd program in file system.

Example:#

UPDATESAMBA /usr/local/samba/bin/smbpasswd

USEFILEIPC Statement#

Linux/UNIX only.

The USEFILEIPC statement specifies that data from the Platform Receiver should be made accessible by the Platform Receiver scripts by using file Input/Output rather than environment variables.

While environment variables are a convenient method for communicating data between the Platform Receiver and the scripts, they have size limitations, based on the operationg system parameter ARG_MAX, that make it impossible to process events when they become too large. For example, a group that contains many users could exceed this size limit. The value of ARG_MAX varies on different operating systems.

Syntax:#

USEFILEIPC

Example:#

USEFILEIPC

More Information#

There might be more information for this subject on one of the following: