When you configure an authentication scheme through a Perl script, you provide information that would otherwise be provided through the Authentication Scheme Properties dialog of the Administrative UI. This section describes the information you need to configure a given authentication scheme using the Policy Management API.
Note: When modifying an authentication scheme, be sure to call Save() after calling all the configuration methods.
Typically, you configure an authentication scheme when you create the scheme with CreateAuthScheme() or when you modify the scheme with the methods in the PolicyMgtAuthScheme object.
Note: The exception to this rule is an authentication scheme based on the SAML 2.0 Template. You create and configure a SAML 2.0 authentication scheme with the method CreateSAMLAuthScheme().
You can provide the following kinds of configuration information for an authentication scheme. Not every authentication scheme template uses all categories of configuration information:
SiteMinder provides a number of standard authentication scheme types (also known as templates). Each authentication scheme type is configured differently.
Brief description of the authentication scheme.
Protection level values can range from 1 through 1000. The higher the number, the greater the degree of protection provided by the scheme.
An authentication scheme library performs authentication processing for the associated authentication scheme type. Each predefined authentication scheme is shipped with a default library. Optionally, you can use a custom library instead of the default.
Additional information that the authentication scheme requires, such as the URL of an HTML login page.
With some authentication schemes, the parameter information is constructed from field values in the Scheme Type Setup tab of the Authentication Scheme Properties dialog. To see how a parameter string is constructed for a given scheme type, open this dialog, select the appropriate scheme type, provide values to the fields in the Scheme Type Setup tab, and view the constructed parameter in the Advanced tab.
Information that is known to both the authentication scheme and the Policy Server. Different authentication schemes use different kinds of secrets. Most schemes use no secret.
A flag that specifies whether the authentication scheme is a template.
Note: Setting an authentication scheme as a template with the Perl Policy Management API is deprecated in SiteMinder v6.0 SP3.
A flag that specifies whether the authentication scheme can be used to authenticate administrators.
A flag that specifies whether the user’s credentials are saved.
A flag that specifies whether the scheme can be used with RADIUS agents.
A flag that specifies whether password policies for the scheme are enabled. If 1, password policies are disabled.
Note: The Ignore password check flag must be set to True for anonymous authentication schemes.
The following tables will help you configure authentication schemes. Each table applies to a particular authentication scheme type and contains the following information:
The values in the Information Type column can be used for different purposes in different authentication schemes. For example, with TeleID authentication schemes, the shared secret is used to supply the encryption seed.
Use this table when configuring an authentication scheme based on the scheme type Anonymous.
Note: The Ignore password check flag must be set to True for anonymous authentication schemes.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Anonymous. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(0) Set to 0. Not applicable to this scheme type. |
|
Library |
CustomLib("smauthanon") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the guest DN. Policies associated with the guest DN must apply to anonymous users. |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an authentication scheme based on the scheme type Basic over SSL.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Basic over SSL. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 10. |
|
Library |
CustomLib("smauthcert") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the domain or IP address of the SSL server and the name of the SSL Credentials Collector (SCC). Format: https://server/SCC?basic The following example uses the default SCC: https://my.server.com/siteminderagent/ |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0 for this scheme. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type Basic.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Basic. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthdir") The default library for this scheme type. |
|
Parameter |
CustomParam("") Set to an empty string. Not applicable to this scheme. |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type Custom. You create custom schemes using the C-language Authentication API, which is available with the SiteMinder SDK.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Custom. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 0 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib(customLibName) The name of the custom shared library you created using the C Authentication API. |
|
Parameter |
CustomParam(param) Any string of one or more parameters required by your custom authentication scheme. For a custom authentication scheme that uses SSL, you must supply a URL that points to a SiteMinder Web Agent library required for the SSL-based authentication. |
|
Shared secret |
CustomSecret(secret) CreateAuthScheme() param: secret The shared secret, if any, that your custom authentication scheme uses for encryption of credentials. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(flag) Set to true (1) to specify that the scheme can be used to authenticate administrators, or to false (0) to specify that the scheme cannot be used to authenticate administrators. Default is 0. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type HTML Form.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type HTML Form. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthhtml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing a user attribute list plus the location of the forms credential collector (FCC). The attribute list must begin with AL= and use commas as the list delimiter character, and it must end with a semicolon—for example: AL=Password,SSN,age,zipcode; The complete parameter format is: attr-list;https:/server/fcc The following example uses the default FCC: AL=PASSWORD,SSN,age,zipcode; |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(credFlag) Set to 1 to indicate that user credentials should be saved, or 0 to indicate that user credentials should not be saved. Default is 0. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type RADIUS CHAP/PAP.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type RADIUS CHAP/PAP. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthchap") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the name of a user directory attribute. This attribute is used as the clear text password for authentication. |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
setIgnorePwCheck(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type RADIUS Server.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type RADIUS Server. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthradius") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the IP address and port of the RADIUS server—for example: 123.123.12.12:1645 The default UDP port is 1645. |
|
Shared secret |
CustomSecret(secret) CreateAuthScheme() param: secret The user attribute that the RADIUS Server will use as the clear text password. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type SafeWord.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SafeWord HTML Form. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 10. |
|
Library |
CustomLib("smauthenigmahtml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the name and location of the forms credentials collector. This example shows the default credentials collector: http://my.server.com/ |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an authentication scheme based on the scheme type SafeWord.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SafeWord. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 10. |
|
Library |
CustomLib("smauthenigma") The default library for this scheme type. |
|
Parameter |
CustomParam("") Set to an empty string. Not applicable to this scheme. |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring a SAML authentication scheme based on the profile type artifact for communicating security assertions. With the artifact profile type, the URL for retrieving the SAML assertion is referenced within the AssertionRetrievalURL portion of the Parameter string.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SAML Artifact. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthsaml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) The following required parameters:
0. Meaning: 302 No Data. 1. Meaning: 302 Cookie Data. 2. Meaning: Server Redirect. 3. Meaning: Persist Attributes.
|
|
Parameter (con't) |
//saml:AttributeValue/SM:/SMContent This query gets the text of the Username element.
0. Meaning: Basic authentication. 1. Meaning: Client certificate authentication.
Format of the parameter string is as follows. Separate name-value pairs with semi-colons ( ; ). The format example includes LDAP and ODBC attributes: Name=name;RedirectMode=0|1|2;SRCID=srcid; |
|
Shared secret |
CustomSecret(secret) CreateAuthScheme() param: secret The password for the affiliate site. The password must match the password entered for the affiliate at the site where the SAML assertion is produced. |
|
Is template? |
IsTemplate(0) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme cannot be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring a SAML authentication scheme based on the profile type POST for communicating security assertions. With the POST profile type, the generated SAML assertion is POSTed to the URL specified in the AssertionConsumerURL portion of the Parameter string.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SAML POST. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthsaml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) The following required parameters:
0. Meaning: 302 No Data. 1. Meaning: 302 Cookie Data. 2. Meaning: Server Redirect. 3. Meaning: Persist Attributes.
|
|
Parameter (con't) |
//saml:AttributeValue/SM:/SMContent This query gets the text of the Username element.
Format of the parameter string is as follows. Separate name-value pairs with semi-colons ( ; ). The format example includes LDAP and ODBC attributes: Name=name;SAMLProfile=POST; |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(0) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme cannot be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
This authentication scheme is based on the SAML 2.0 scheme type. It is configured by a SAML 2.0 Service Provider.
A Service Provider uses this authentication scheme to transparently validate a user based on the information in a SAML 2.0 assertion.
An authentication scheme based on the SAML 2.0 Template differs from other types of authentication schemes in two ways:
Typically, the only properties in this set that you might choose to modify in an existing SAML 2.0 authentication scheme are name, description, and protection level. Modify these properties with the appropriate method in the PolicyMgtAuthScheme object.
These properties are stored with the PolicyMgtAuthScheme object as a hashtable.
For information about the metadata properties you can assign to a SAML 2.0 authentication scheme, see the section SAML 2.0 Property Reference in this guide.
Where applicable, the method CreateSAMLAuthScheme() is referenced in place of CreateAuthScheme().
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Metadata properties |
CreateSAMLAuthScheme() param: propsHash_ref The hashtable of SAML 2.0 metadata properties associated with the authentication scheme object. Call SAMLAuthSchemeProperties() to modify metadata properties associated with an existing SAML 2.0 authentication scheme. |
|
Scheme type |
Type(templateObject) The scheme type SAML 2.0. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthsaml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) Set as an empty string. |
|
Shared secret |
CustomSecret("") Set as an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(0) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme cannot be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an authentication scheme based on the scheme type SecureID HTML Form.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SecureID HTML Form. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 15. |
|
Library |
CustomLib("smauthacehtml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the name of the attribute that contains the ACE IDs, the Web server where the forms credential collector (FCC) is installed, and the target executable file required for processing SecureID authentication with forms support. It also specifies whether an SSL connection is required. Format: attr;https://server/target The "s" in "https" is optional, depending on whether you want an SSL connection. The following example uses the default for processing SecureID authentication with forms support: ace_id;https://my.server.com/siteminderagent/pwcgi/smpwservicescgi.exe
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an authentication scheme based on the scheme type SecureID.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type SecureID. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 15. |
|
Library |
CustomLib("smauthace") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the attribute in the authentication user directory that contains the ACE Server user ID.
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
This authentication scheme is similar to the SiteMinder X.509 certification scheme, but with an eSSO cookie as the authentication credential instead of an X.509 credential.
If this scheme is configured for either cookieorbasic or cookieorforms mode, and both an eSSO cookie and login name and password credentials are passed to it, the eSSO cookie is ignored, and the login name and password are used to authenticate the user to SiteMinder.
When the eSSO cookie is the only credential, the authentication scheme uses the ETWAS API to connect to the configured eSSO Policy Server to validate the cookie and extract the user Distinguished Name (DN) from it.
Use this table when configuring an an smauthetsso authentication scheme, which is based on the scheme type Custom. You create custom schemes using the C-language Authentication API, which is available with the SiteMinder SDK.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Custom. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 0 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthetsso") The name of the library for this authentication scheme. |
|
Parameter |
CustomParam(param)
An ordered set of tokens, separated by semi-colons: You can add spaces to make the string easier to read. <Mode> specifies the type of credentials that the authenticaion scheme will accept. The following values are possible:
<Target> is valid only with cookieorforms mode. This is identical to the Target field for standard HTML Forms Authentication Scheme. <Admin> specifies the login ID of an administrator for the Policy Server. The password for this administrator has been specified in the Shared Secret field. <eTPO_Host> specifies the name of the amchine on which the Policy Server is installed. SiteMinder will authenticate itself as <Admin> to the Policy Server on the <eTPS_Host> so that SiteMinder can request validation of eTrust SSO cookies. Examples: "cookie; SMPS_sso; myserver.myco.com"
|
|
Shared secret |
CustomSecret(secret) CreateAuthScheme() param: secret The password of the Policy Server administrator named in the Parameter field. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(flag) Set to true (1) to specify that the scheme can be used to authenticate administrators, or to false (0) to specify that the scheme cannot be used to authenticate administrators. Default is 0. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type TeleID.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type TeleID. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 15. |
|
Library |
CustomLib("smauthencotone") The default library for this scheme type. |
|
Parameter |
CustomParam("") Set to an empty string. Not applicable to this scheme. |
|
Shared secret |
CustomSecret(seed) CreateAuthScheme() param: secret The encryption seed. SiteMinder uses this value as an encryption seed for initializing hardware tokens. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(1) Set to 1—scheme can be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(1) Set to 1—scheme can be used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an Integrated Windows Authentication scheme based on the scheme type Windows Authentication (previously known as NTLM). This scheme type is used to authenticate against WinNT or Active Directory user stores.
An Active Directory can be configured to run in mixed mode or native mode. An Active Directory supports WinNT style authentication when running in mixed mode. In native mode, an Active Directory supports only LDAP style lookups.
This authentication scheme supports either mixed mode or native mode.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type Windows Authentication (NTLM). |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthntlm") The default library for this scheme type. |
|
Parameter |
CustomParam(param) The value of param determines the style of authentication to perform for this scheme: NTLM authentication (for WinNT or Active Directory running in mixed mode) Format: iis-web-server-url/path-to-ntc-file In the format, iis-web-server-url is the name of the IIS web server that is the target of the redirection, and path-to-ntc-file is the location of the .ntc file that collects the WinNT credentials. For example: http://myiiswebserver.mycompany.com/ A SiteMinder Web Agent must be installed on the specified server. By default, the Web Agent installation creates a virtual directory for NTLM credential collection. Windows Authentication (for Active Directory running in native mode) With this authentication style, param has an LDAP filter added to the beginning of the redirection URL. The filter and URL are separated by a semi-colon (;). For example: cn=%{UID},ou=Users,ou=USA,dc=%{DOMAIN}, SiteMinder uses the LDAP filter to map credentials received from the browser/Web Agent to an LDAP DN or search filter. |
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) For WinNT and for Active Directory running in mixed mode, this property must be true (1)—ignore password checking. For Active Directory running in native mode, set to true (1) to ignore password checking, or false (0) to check passwords. Default is 0. |
This authentication scheme is based on the WS-Federation scheme type. It is configured by a WS-Federation Resource Partner.
A Resource Partner uses this authentication scheme to validate a user transparently based on the information in a SAML 1.1 assertion.
An authentication scheme based on the WS-Federation Template differs from other types of authentication schemes in two ways:
Typically, the only properties in this set that you might choose to modify in an existing WS-Federation authentication scheme are name, description, and protection level. Modify these properties with the appropriate method in the PolicyMgtAuthScheme object.
These properties are stored with the PolicyMgtAuthScheme object as a hashtable.
Note: For information about the metadata properties you can assign to a WS-Federation authentication scheme, see the section WS-Federation Property Reference in the online Policy Management API Reference.
This authentication scheme requires CA SiteMinder Federation Legacy Federation. Legacy Federation is licensed separately.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Metadata properties |
CreateWSFEDAuthScheme() param: propsHash_ref The hashtable of WS-Federation metadata properties associated with the authentication scheme object. Call WSFEDAuthSchemeProperties() to modify metadata properties associated with an existing WS-Federation authentication scheme. |
|
Scheme type |
Type(templateObject) The scheme type WSFED. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthsaml") The default library for this scheme type. |
|
Parameter |
CustomParam(param) Set as an empty string. |
|
Shared secret |
CustomSecret("") Set as an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(0) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme cannot be used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
Use this table when configuring an authentication scheme based on the scheme type X.509 Client Certificate and Basic.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type X.509 Client Certificate and Basic. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 15. |
|
Library |
CustomLib("smauthcert") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the domain or IP address of the SSL server and the name and path of the SSL Credentials Collector (SCC). The server redirects a user’s X.509 certificate over an SSL connection. Format: https://server:port/SCC?cert+basic The following example uses the default SCC: https://my.server.com:80/siteminderagent/
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type X.509 Client Certificate and Form.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type X.509 Client Certificate and HTML Form. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 15. |
|
Library |
CustomLib("smauthcert") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the domain or IP address of the SSL server and the name and path of the forms credentials collector (FCC). The server redirects a user’s X.509 certificate over an SSL connection. Format: https://server:port/FCC?cert+forms The following example uses the default FCC: https://my.server.com:80/siteminderagent/
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type X.509 Client Certificate or Basic.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type X.509 Client Certificate or Basic. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthcert") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the following information:
If you are using basic authentication over SSL, also provide the following two pieces of information:
https://SSLserver:port/SCC?certorbasic; The following example uses the default SCC values: https://my.SSLserver.com:80/siteminderagent/
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type X.509 Client Certificate or Form.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type X.509 Client Certificate or HTML Form. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthcertorform") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the following information:
If you are using an alternate forms-based authentication over SSL, also provide the following two pieces of information:
https://SSLserver:port/SFCC?certorform; The following example uses the default SCC values: https://my.SSLserver.com:80/siteminderagent/
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
SaveCredentials(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(flag) Set to 1 to ignore password checking, or 0 to check passwords. Default is 0. |
Use this table when configuring an authentication scheme based on the scheme type X.509 Client Certificate.
|
Information Type |
Value Assignment and Meaning |
|---|---|
|
Scheme type |
Type(templateObject) The scheme type X.509 Client Certificate. |
|
Description |
Description(schemeDesc) The description of the authentication scheme. |
|
Protection level |
ProtectionLevel(nLevel) A value of 1 through 1000. The higher the number, the greater degree of protection provided by the scheme. Default is 5. |
|
Library |
CustomLib("smauthcert") The default library for this scheme type. |
|
Parameter |
CustomParam(param) A string containing the domain or IP address of the server responsible for establishing the SSL connection and the name and path of the SSL Credentials Collector (SCC). The server redirects a user’s X.509 certificate over an SSL connection. Format: https://server/SCC?cert The following example uses the default SCC value: https://my.server.com/siteminderagent/
|
|
Shared secret |
CustomSecret("") CreateAuthScheme() param: secret Set to an empty string. Not applicable to this scheme. |
|
Is template? |
IsTemplate(templateFlag) Set to 0 to indicate that the scheme is not a template. Any other value is ignored. |
|
Is used by administrator? |
IsUsedByAdmin(0) Set to 0—scheme is not used to authenticate administrators. |
|
Save credentials? |
setAllowSaveCreds(0) Set to 0 to indicate that user credentials will not be saved. |
|
Is RADIUS? |
IsRadius(0) Set to 0—scheme is not used with RADIUS agents. |
|
Ignore password check? |
IgnorePwd(1) Set to 1—ignore password checking. |
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|