IPWorks Auth 2020 .NET Edition

Questions / Feedback?

SAML Configuration

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

SAML Configuration Settings

AssertionXPath:   The XPath to the assertion.

Normally when calling ParseAssertion, only the assertion itself should be passed in. In the event that the assertion is nested in other markup, set this to the XPath of the assertion to instruct the component where to find it. For encrypted assertions there is a similar EncryptedAssertionXPath configuration setting.

DecryptAssertion:   Whether to decrypt the assertion.

This setting specifies whether the component should decrypt the assertion. If set to True the component will use the certificate specified by Certificate to decrypt the assertion. The default value is False.

EncryptedAssertionXPath:   The XPath to the encrypted assertion.

Normally when calling ParseAssertion, only the encrypted assertion itself should be passed in. In the event that the encrypted assertion is nested in other markup, set this to the XPath of the encrypted assertion to instruct the component where to find it. For plaintext assertions there is a similar AssertionXPath configuration setting.

RawRequest:   Returns the raw HTTP request.

This may be queried after calling GetAssertion or GetSecurityToken. This will return the raw HTTP request which may be useful for troubleshooting purposes. For instance:

component.GetAssertion();
MyString = component.Config("RawRequest");
RawResponse:   Returns the raw HTTP response.

This may be queried after calling GetAssertion or GetSecurityToken. This will return the raw HTTP response which may be useful for troubleshooting purposes. For instance:

component.GetAssertion();
MyString = component.Config("RawResponse");
UserRealm:   The URL of a web service to determine the LocalSTS (if any).

This setting specifies the URL of a web service which will be queried to determine the LocalSTS value. This is only applicable when AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM). When AuthMode is set to either 0 or 1 this setting is automatically set to "https://login.microsoftonline.com/GetUserRealm.srf". In most cases this does not need to be changed.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g. RuntimeLicense, License File).
  • License Type: The type of license installed (e.g. Royalty Free, Single Server).
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 .NET Edition - Version 20.0 [Build 8155]