SAML Class

Properties   Methods   Events   Config Settings   Errors  

The SAML class is used to obtain security tokens and assertions.

Syntax

ipworksauth.saml()

Remarks

The SAML class provides an easy-to-use interface to obtain security tokens and assertions. The class can also be used to parse assertions and inspect the claims within.

The component has built in support for working with Microsoft SharePoint Online and Microsoft Dynamics CRM Online. This support means only a minimum of information needs to be supplied to the component.

Microsoft SharePoint Online and Dynamics CRM Online

To begin working with SharePoint Online or Dynamics CRM Online first set the AuthMode to the appropriate value. The class will automatically populate several properties to known values. Set the User, Password, ApplicationURN properties and call GetSecurityToken. For instance:

component.AuthMode = SAMLAuthModes.amDynamicsCRM; //dynamic crm component.User = "user@mycrm.onmicrosoft.com"; component.Password = "password"; component.ApplicationURN = "urn:crmapac:dynamics.com"; component.GetSecurityToken(); After calling GetSecurityToken the SecurityTokenXML property will be populated.

ADFS and Others

When working with ADFS or another Security Token Service (STS) the GetAssertion method may be used to obtain an assertion. To begin set AuthMode to either amADFS or amCustom. Then set LocalSTS, User, Password, and ApplicationURN. For instance:

component.AuthMode = SAMLAuthModes.amADFS; component.User = "administrator"; component.Password = "admin"; component.LocalSTS = "https://adfs.contoso.com"; component.ApplicationURN = "https://fsweb.contoso.com/ClaimsAwareWebAppWithManagedSTS/"; component.GetAssertion(); If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

Parsing an Assertion

The class may also be used to parse an existing assertion without contacting a STS. To parse an existing assertion call ParseAssertion with the assertion XML. If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ApplicationURN	The application's Uniform Resource Name (URN).
AssertionId	The assertion id.
AssertionIssueInstant	The time in UTC that the assertion was issued.
AssertionIssuer	The assertion issuer.
AssertionNotBefore	The date on which the assertion becomes valid.
AssertionNotOnOrAfter	The time at which the assertion expires.
AssertionSubject	The subject of the assertion.
AssertionVersion	The version of the assertion.
AssertionXML	The assertion XML.
AuthMode	The authentication mode.
Certificate	The certificate used for decryption.
Claims	A collection of claims.
FederationSTS	The URL of the federation Security Token Service (STS).
FederationURN	The federation Uniform Resource Name (URN).
LocalSTS	The local Security Token Service (STS).
Password	The user's password.
Proxy	This property includes a set of properties related to proxy access.
SecurityTokenXML	The security token XML.
SignerCert	The certificate used for signature verification.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCert	The server certificate for the last established connection.
User	The username.
XAttributes	A collection of attributes of the current element.
XChildren	Collection of child elements of the currently selected XML element.
XElement	The name of the current element.
XNamespace	The namespace of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the document.
XPrefix	The prefix of the current element.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Config	Sets or retrieves a configuration setting.
GetAssertion	Gets the assertion.
GetSecurityToken	Gets the security token.
ParseAssertion	Parses the specified assertion.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Characters	Fired for plain text segments of the input stream.
Comment	Fired when a comment section is encountered.
EndElement	Fired when an end-element tag is encountered.
Error	Information about errors during data delivery.
PI	Fired when a processing instruction section is encountered.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartElement	Fired when a begin-element tag is encountered in the document.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AssertionXPath	The XPath to the assertion.
DecryptAssertion	Whether to decrypt the assertion.
EncryptedAssertionXPath	The XPath to the encrypted assertion.
RawRequest	Returns the raw HTTP request.
RawResponse	Returns the raw HTTP response.
UserRealm	The URL of a web service to determine the LocalSTS (if any).
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

SAML.ApplicationURN Property

The application's Uniform Resource Name (URN).

Syntax

 getApplicationURN(): string;

 setApplicationURN(applicationURN: string): void;

Default Value

""

Remarks

This property specifies the application's Uniform Resource Name (URN). This must be set before calling GetAssertion or GetSecurityToken.

When AuthMode is set to amDynamicsCRM the value specified here depends on the location of the account. Valid values are:

Dynamics CRM Location	URN
North America	urn:crmna:dynamics.com
EMEA	urn:crmemea:dynamics.com
APAC	urn:crmapac:dynamics.com

When AuthMode is set to camSharePointOnline this value is typically the URL to your site. For instance: "https://mycrm.sharepoint.com".

This property is not available at design time.

SAML.AssertionId Property

The assertion id.

Syntax

 getAssertionId(): string;

Default Value

""

Remarks

This property hold the id of the assertion.

This property is read-only and not available at design time.

SAML.AssertionIssueInstant Property

The time in UTC that the assertion was issued.

Syntax

 getAssertionIssueInstant(): string;

Default Value

""

Remarks

This property holds the time that the assertion was issued.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

This property is read-only and not available at design time.

SAML.AssertionIssuer Property

The assertion issuer.

Syntax

 getAssertionIssuer(): string;

Default Value

""

Remarks

This property holds the issuer of the assertion.

This property is read-only and not available at design time.

SAML.AssertionNotBefore Property

The date on which the assertion becomes valid.

Syntax

 getAssertionNotBefore(): string;

Default Value

""

Remarks

This property specifies the earliest time instant at which the assertion is valid.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

This property is read-only and not available at design time.

SAML.AssertionNotOnOrAfter Property

The time at which the assertion expires.

Syntax

 getAssertionNotOnOrAfter(): string;

Default Value

""

Remarks

This property specifies the time instant at which the assertion has expired.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

This property is read-only and not available at design time.

SAML.AssertionSubject Property

The subject of the assertion.

Syntax

 getAssertionSubject(): string;

Default Value

""

Remarks

This property holds the subject of the assertion.

This property is read-only and not available at design time.

SAML.AssertionVersion Property

The version of the assertion.

Syntax

 getAssertionVersion(): SamlAssertionVersions;

 setAssertionVersion(assertionVersion: SamlAssertionVersions): void;

enum SamlAssertionVersions {
  svSAMLv11,
  svSAMLv20
}

Default Value

0

Remarks

This property specifies the version of the assertion. This may be set before calling GetAssertion. This will be populated after calling ParseAssertion. Possible values are:

0 (svSAMLv11 - default)	SAML version 1.1
1 (svSAMLv20)	SAML version 2.0

This property is not available at design time.

SAML.AssertionXML Property

The assertion XML.

Syntax

 getAssertionXML(): string;

Default Value

""

Remarks

This property holds the returned assertion. This is populated after calling GetAssertion.

This property is read-only and not available at design time.

SAML.AuthMode Property

The authentication mode.

Syntax

 getAuthMode(): SamlAuthModes;

 setAuthMode(authMode: SamlAuthModes): void;

enum SamlAuthModes {
  camSharePointOnline,
  camDynamicsCRM,
  camADFS,
  camCustom
}

Default Value

0

Remarks

This property specifies the authentication mode. Possible values are:

0 (camSharePointOnline - default)	Microsoft SharePoint Online
1 (camDynamicsCRM)	Microsoft Dynamics CRM
2 (camADFS)	Active Directory Federation Services
3 (camCustom)	Custom

When this property is set the component is initialized based on common settings for the selected mode.

Setting this property to 2 (camADFS) or 3 (camCustom) will clear the values in FederationURN, and FederationSTS. There is no functional difference between 2 (camADFS) and 3 (camCustom), they operate identically.

Setting this property to 0 (camSharePointOnline) or 1 (camDynamicsCRM) will populate FederationURN, and FederationSTS with known valid values for FederationURN, and FederationSTS.

The table below shows which properties are set depending on the value of this property.

AuthMode	FederationURN	FederationSTS	UserRealm
camSharePointOnline	urn:federation:MicrosoftOnline	"https://login.microsoftonline.com/RST2.srf"	"https://login.microsoftonline.com/GetUserRealm.srf"
camDynamicsCRM	urn:federation:MicrosoftOnline	"https://login.microsoftonline.com/RST2.srf"	"https://login.microsoftonline.com/GetUserRealm.srf"
camADFS	""	""	""
camCustom	""	""	""

The value 3 (camCustom) may be used with any STS as long as WS-TRUST is supported.

This property is not available at design time.

SAML.Certificate Property

The certificate used for decryption.

Syntax

 getCertificate(): Certificate;

 setCertificate(certificate: Certificate): void;

Default Value

Remarks

This property specifies the certificate used for decryption. This is only applicable if DecryptAssertion is set to True.

This property is not available at design time.

SAML.Claims Property

A collection of claims.

Syntax

 getClaims(): ClaimList;

Default Value

Remarks

This property is a collection of claims parsed from the assertion. This is populated after calling GetAssertion or ParseAssertion.

This property is read-only and not available at design time.

SAML.FederationSTS Property

The URL of the federation Security Token Service (STS).

Syntax

 getFederationSTS(): string;

 setFederationSTS(federationSTS: string): void;

Default Value

""

Remarks

This property specifies the URL of the federation Security Token Service (STS). When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) this property is automatically populated.

This property is not available at design time.

SAML.FederationURN Property

The federation Uniform Resource Name (URN).

Syntax

 getFederationURN(): string;

 setFederationURN(federationURN: string): void;

Default Value

""

Remarks

This property specifies the federation Uniform Resource Name (URN). This property is automatically populated when AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM).

This property is not available at design time.

SAML.LocalSTS Property

The local Security Token Service (STS).

Syntax

 getLocalSTS(): string;

 setLocalSTS(localSTS: string): void;

Default Value

""

Remarks

This property specifies the URL of the local Security Token Service(STS).

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) if this is not specified, then the class will attempt to determine this value automatically by querying the UserRealm.

When AuthMode is set to 2 (camADFS) or 3 (camCustom) this property is required.

This property is not available at design time.

SAML.Password Property

The user's password.

Syntax

 getPassword(): string;

 setPassword(password: string): void;

Default Value

""

Remarks

This property specifies the user's password. This must be set before calling GetAssertion or GetSecurityToken.

This property is not available at design time.

SAML.Proxy Property

This property includes a set of properties related to proxy access.

Syntax

 getProxy(): Proxy;

 setProxy(proxy: Proxy): void;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

SAML.SecurityTokenXML Property

The security token XML.

Syntax

 getSecurityTokenXML(): string;

Default Value

""

Remarks

This property holds the security token. This is populated after calling GetSecurityToken.

This property is read-only and not available at design time.

SAML.SignerCert Property

The certificate used for signature verification.

Syntax

 getSignerCert(): Certificate;

 setSignerCert(signerCert: Certificate): void;

Default Value

Remarks

This property optionally specifies a certificate used for signature verification. When calling GetAssertion or ParseAssertion, if the assertion is signed the class will use the certificate specified in this property to verify the signature. If this property is not set the class will attempt to parse the certificate present in the assertion to perform verification.

This property is not available at design time.

SAML.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

 getSSLAcceptServerCert(): Certificate;

 setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SAML.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

 getSSLCert(): Certificate;

 setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SAML.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

 getSSLProvider(): SamlSSLProviders;

 setSSLProvider(SSLProvider: SamlSSLProviders): void;

enum SamlSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

SAML.SSLServerCert Property

The server certificate for the last established connection.

Syntax

 getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SAML.User Property

The username.

Syntax

 getUser(): string;

 setUser(user: string): void;

Default Value

""

Remarks

This property specifies the username. This must be set before calling GetAssertion or GetSecurityToken.

This property is not available at design time.

SAML.XAttributes Property

A collection of attributes of the current element.

Syntax

 getXAttributes(): XMLAttributeList;

 setXAttributes(XAttributes: XMLAttributeList): void;

Default Value

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

This property is not available at design time.

SAML.XChildren Property

Collection of child elements of the currently selected XML element.

Syntax

 getXChildren(): XMLElementList;

 setXChildren(XChildren: XMLElementList): void;

Default Value

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

This property is not available at design time.

SAML.XElement Property

The name of the current element.

Syntax

 getXElement(): string;

 setXElement(XElement: string): void;

Default Value

""

Remarks

The current element is specified via the XPath property.

SAML.XNamespace Property

The namespace of the current element.

Syntax

 getXNamespace(): string;

 setXNamespace(XNamespace: string): void;

Default Value

""

Remarks

The current element is specified via the XPath property.

SAML.XParent Property

The parent of the current element.

Syntax

 getXParent(): string;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

SAML.XPath Property

Provides a way to point to a specific element in the document.

Syntax

 getXPath(): string;

 setXPath(XPath: string): void;

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'	A particular element name
name[i]	The i-th subelement of the current element with the given name
[i]	The i-th subelement of the current element
[last()]	The last subelement of the current element
[last()-i]	The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]	The subelement containing a particular value for a given attribute (supports single AND double quotes)
..	The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and XText providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

Document root	XML.XPath = "/"
Specific Element	XML.XPath = "/root/SubElement1/SubElement2/"
i-th Child	XML.XPath = "/root/SubElement1[i]"

SAML.XPrefix Property

The prefix of the current element.

Syntax

 getXPrefix(): string;

 setXPrefix(XPrefix: string): void;

Default Value

""

Remarks

The current element is specified via the XPath property.

SAML.XSubTree Property

A snapshot of the current element in the document.

Syntax

 getXSubTree(): string;

Default Value

""

Remarks

The current element is specified via the XPath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

SAML.XText Property

The text of the current element.

Syntax

 getXText(): string;

 setXText(XText: string): void;

Default Value

""

Remarks

The current element is specified via the XPath property.

SAML.config Method

Sets or retrieves a configuration setting.

Syntax

async saml.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

SAML.getAssertion Method

Gets the assertion.

Syntax

async saml.getAssertion(): Promise<void>

Remarks

This method communicates with LocalSTS as to obtain an assertion.

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) the class will automatically populate various properties to known values to reduce the number of required settings. Typically only the following properties are required:

• User
• Password
• ApplicationURN

When AuthMode is set to 2 (camADFS) or 3 (camCustom) the following properties are required:

• User
• Password
• ApplicationURN
• LocalSTS

If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

SAML.getSecurityToken Method

Gets the security token.

Syntax

async saml.getSecurityToken(): Promise<void>

Remarks

This method communicates with FederationSTS and LocalSTS as applicable to obtain a security token. The SecurityTokenXML property will be populated with the retrieved token.

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) the class will automatically populate various properties to known values to reduce the number of required settings. Typically only the following properties are required:

• User
• Password
• ApplicationURN

When AuthMode is set to 2 (camADFS) or 3 (camCustom) the following properties are required:

• User
• Password
• ApplicationURN
• LocalSTS
• FederationSTS
• FederationURN

SAML.parseAssertion Method

Parses the specified assertion.

Syntax

async saml.parseAssertion(assertion : string): Promise<void>

Remarks

This method parses the assertion specified by the assertion parameter. If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

SAML.Characters Event

Fired for plain text segments of the input stream.

Syntax

saml.on('Characters', listener: (e: {readonly text: string}) => void )

Remarks

The Characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the IgnorableWhitespace event.

SAML.Comment Event

Fired when a comment section is encountered.

Syntax

saml.on('Comment', listener: (e: {readonly text: string}) => void )

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

SAML.EndElement Event

Fired when an end-element tag is encountered.

Syntax

saml.on('EndElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void )

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

SAML.Error Event

Information about errors during data delivery.

Syntax

saml.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SAML.PI Event

Fired when a processing instruction section is encountered.

Syntax

saml.on('PI', listener: (e: {readonly text: string}) => void )

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

SAML.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

saml.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string "OK"). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before intiating the connection.

SAML.SSLStatus Event

Shows the progress of the secure connection.

Syntax

saml.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

SAML.StartElement Event

Fired when a begin-element tag is encountered in the document.

Syntax

saml.on('StartElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void )

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate string	This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.
Encoded Uint8Array	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB byte[]	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
ExpirationDate string	This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00.
ExtendedKeyUsage string	This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint string	This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1 string	This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256 string	This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer string	This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword string	This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys. Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey string	This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable boolean	This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer string	This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey string	This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm string	This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength number	This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber string	This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm string	The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store Uint8Array	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StoreB byte[]	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StorePassword string	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType CertStoreTypes	This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values: 0 (cstUser - default) For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. 1 (cstMachine) For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. 2 (cstPFXFile) The certificate store is the name of a PFX (PKCS12) file containing certificates. 3 (cstPFXBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. 4 (cstJKSFile) The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. 5 (cstJKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. 6 (cstPEMKeyFile) The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. 7 (cstPEMKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. 8 (cstPublicKeyFile) The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. 9 (cstPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. 10 (cstSSHPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. 11 (cstP7BFile) The certificate store is the name of a PKCS7 file containing certificates. 12 (cstP7BBlob) The certificate store is a string (binary) representing a certificate store in PKCS7 format. 13 (cstSSHPublicKeyFile) The certificate store is the name of a file that contains an SSH-style public key. 14 (cstPPKFile) The certificate store is the name of a file that contains a PPK (PuTTY Private Key). 15 (cstPPKBlob) The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). 16 (cstXMLFile) The certificate store is the name of a file that contains a certificate in XML format. 17 (cstXMLBlob) The certificate store is a string that contains a certificate in XML format. 18 (cstJWKFile) The certificate store is the name of a file that contains a JWK (JSON Web Key). 19 (cstJWKBlob) The certificate store is a string that contains a JWK (JSON Web Key). 21 (cstBCFKSFile) The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. 22 (cstBCFKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. 23 (cstPKCS11) The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); 99 (cstAuto) The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.
Subject string	This is the subject of the certificate used for client authentication. This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below. Field Meaning CN Common Name. This is commonly a host name like www.server.com. O Organization OU Organizational Unit L Locality S State C Country E Email Address If a field value contains a comma it must be quoted.
SubjectAltNames string	This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5 string	This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA1 string	This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA256 string	This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.
Usage string	This property contains the text description of . This value will be of one or more of the following strings and will be separated by commas: Digital Signatures Key Authentication Key Encryption Data Encryption Key Agreement Certificate Signing Key Signing If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags number	This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags: 0x80 Digital Signatures 0x40 Key Authentication 0x20 Key Encryption 0x10 Data Encryption 0x08 Key Agreement 0x04 Certificate Signing 0x02 Key Signing Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL.
Version string	This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Claim Type

The claim.

Remarks

This type describes the claim.

Fields

IssuerName string	The name of the issuer. This may be a URL like "http://adfs.contoso.com/adfs/services/trust".
OriginalIssuer string	The name of the original issuer. This may be a URL like "http://adfs.contoso.com/adfs/services/trust".
PropertyCount number	The number of properties in the claim.
PropertyIndex number	Selects a property. This is valid from 0 to . To inspect a property, first set this property and then inspect and . For instance: for(int i=0;i<component.Claims[0].PropertyCount;i++) { component.Claims[0].PropertyIndex = i; Console.WriteLine(component.Claims[0].PropertyName + ": " + component.Claims[0].PropertyValue); }
PropertyName string	The name of the property.
PropertyValue string	The value of the property.
TypeName string	The type name of the claim. This may be a value like "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier".
Value string	The value of the claim.
ValueType string	The type of value. This may be a value like "http://www.w3.org/2001/XMLSchema#string".

Constructors

public Claim();

public Claim(String typeName, String value, String valueType, String issuerName, String originalIssuer);

Proxy Type

This is the proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

AuthScheme ProxyAuthSchemes	This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set. should be set to authNone (3) when no authentication is expected. By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication. If is set to authDigest (1), digest authentication will be attempted instead. If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of and .
AutoDetect boolean	This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password string	This property contains a password if authentication is to be used for the proxy. If is set to Basic Authentication, the and are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
Port number	This property contains the Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.
Server string	If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.
SSL ProxySSLTypes	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: psAutomatic (0) Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. psAlways (1) The connection is always SSL enabled. psNever (2) The connection is not SSL enabled. psTunnel (3) The connection is made through a tunneling (HTTP) proxy.
User string	This property contains a user name, if authentication is to be used for the proxy. If is set to Basic Authentication, the and are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

XMLAttribute Type

An XML attribute from the current XML element.

Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

Fields

Name string	The provides the local name (without prefix) of the attribute.
Namespace string	Attribute namespace.
Prefix string	Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.
Value string	Attribute value.

Constructors

public XMLAttribute();

XMLElement Type

An element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element , , and of the given element.

The elements are inserted into the array in the same order they are found in the document.

Fields

Name string	The property provides the local name (without prefix) of the element.
Namespace string	Namespace of the element.
Prefix string	Prefix of the element (if any). If the element does not have a prefix, this property is empty.
XText string	The inner text of the element.

Constructors

public XMLElement();

Config Settings (class ipworksauth.saml)

The class 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 class, access to these internal properties is provided through the Config method.

SAML Config 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 class 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 class should decrypt the assertion. If set to True the class 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 class 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 Config Settings

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

CodePage:   The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: Identifier Name 037 IBM EBCDIC - U.S./Canada 437 OEM - United States 500 IBM EBCDIC - International 708 Arabic - ASMO 708 709 Arabic - ASMO 449+, BCON V4 710 Arabic - Transparent Arabic 720 Arabic - Transparent ASMO 737 OEM - Greek (formerly 437G) 775 OEM - Baltic 850 OEM - Multilingual Latin I 852 OEM - Latin II 855 OEM - Cyrillic (primarily Russian) 857 OEM - Turkish 858 OEM - Multilingual Latin I + Euro symbol 860 OEM - Portuguese 861 OEM - Icelandic 862 OEM - Hebrew 863 OEM - Canadian-French 864 OEM - Arabic 865 OEM - Nordic 866 OEM - Russian 869 OEM - Modern Greek 870 IBM EBCDIC - Multilingual/ROECE (Latin-2) 874 ANSI/OEM - Thai (same as 28605, ISO 8859-15) 875 IBM EBCDIC - Modern Greek 932 ANSI/OEM - Japanese, Shift-JIS 936 ANSI/OEM - Simplified Chinese (PRC, Singapore) 949 ANSI/OEM - Korean (Unified Hangul Code) 950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) 1026 IBM EBCDIC - Turkish (Latin-5) 1047 IBM EBCDIC - Latin 1/Open System 1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol) 1141 IBM EBCDIC - Germany (20273 + Euro symbol) 1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) 1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) 1144 IBM EBCDIC - Italy (20280 + Euro symbol) 1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) 1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol) 1147 IBM EBCDIC - France (20297 + Euro symbol) 1148 IBM EBCDIC - International (500 + Euro symbol) 1149 IBM EBCDIC - Icelandic (20871 + Euro symbol) 1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646) 1201 Unicode UCS-2 Big-Endian 1250 ANSI - Central European 1251 ANSI - Cyrillic 1252 ANSI - Latin I 1253 ANSI - Greek 1254 ANSI - Turkish 1255 ANSI - Hebrew 1256 ANSI - Arabic 1257 ANSI - Baltic 1258 ANSI/OEM - Vietnamese 1361 Korean (Johab) 10000 MAC - Roman 10001 MAC - Japanese 10002 MAC - Traditional Chinese (Big5) 10003 MAC - Korean 10004 MAC - Arabic 10005 MAC - Hebrew 10006 MAC - Greek I 10007 MAC - Cyrillic 10008 MAC - Simplified Chinese (GB 2312) 10010 MAC - Romania 10017 MAC - Ukraine 10021 MAC - Thai 10029 MAC - Latin II 10079 MAC - Icelandic 10081 MAC - Turkish 10082 MAC - Croatia 12000 Unicode UCS-4 Little-Endian 12001 Unicode UCS-4 Big-Endian 20000 CNS - Taiwan 20001 TCA - Taiwan 20002 Eten - Taiwan 20003 IBM5550 - Taiwan 20004 TeleText - Taiwan 20005 Wang - Taiwan 20105 IA5 IRV International Alphabet No. 5 (7-bit) 20106 IA5 German (7-bit) 20107 IA5 Swedish (7-bit) 20108 IA5 Norwegian (7-bit) 20127 US-ASCII (7-bit) 20261 T.61 20269 ISO 6937 Non-Spacing Accent 20273 IBM EBCDIC - Germany 20277 IBM EBCDIC - Denmark/Norway 20278 IBM EBCDIC - Finland/Sweden 20280 IBM EBCDIC - Italy 20284 IBM EBCDIC - Latin America/Spain 20285 IBM EBCDIC - United Kingdom 20290 IBM EBCDIC - Japanese Katakana Extended 20297 IBM EBCDIC - France 20420 IBM EBCDIC - Arabic 20423 IBM EBCDIC - Greek 20424 IBM EBCDIC - Hebrew 20833 IBM EBCDIC - Korean Extended 20838 IBM EBCDIC - Thai 20866 Russian - KOI8-R 20871 IBM EBCDIC - Icelandic 20880 IBM EBCDIC - Cyrillic (Russian) 20905 IBM EBCDIC - Turkish 20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) 20932 JIS X 0208-1990 & 0121-1990 20936 Simplified Chinese (GB2312) 21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian) 21027 Extended Alpha Lowercase 21866 Ukrainian (KOI8-U) 28591 ISO 8859-1 Latin I 28592 ISO 8859-2 Central Europe 28593 ISO 8859-3 Latin 3 28594 ISO 8859-4 Baltic 28595 ISO 8859-5 Cyrillic 28596 ISO 8859-6 Arabic 28597 ISO 8859-7 Greek 28598 ISO 8859-8 Hebrew 28599 ISO 8859-9 Latin 5 28605 ISO 8859-15 Latin 9 29001 Europa 3 38598 ISO 8859-8 Hebrew 50220 ISO 2022 Japanese with no halfwidth Katakana 50221 ISO 2022 Japanese with halfwidth Katakana 50222 ISO 2022 Japanese JIS X 0201-1989 50225 ISO 2022 Korean 50227 ISO 2022 Simplified Chinese 50229 ISO 2022 Traditional Chinese 50930 Japanese (Katakana) Extended 50931 US/Canada and Japanese 50933 Korean Extended and Korean 50935 Simplified Chinese Extended and Simplified Chinese 50936 Simplified Chinese 50937 US/Canada and Traditional Chinese 50939 Japanese (Latin) Extended and Japanese 51932 EUC - Japanese 51936 EUC - Simplified Chinese 51949 EUC - Korean 51950 EUC - Traditional Chinese 52936 HZ-GB2312 Simplified Chinese 54936 Windows XP: GB18030 Simplified Chinese (4 Byte) 57002 ISCII Devanagari 57003 ISCII Bengali 57004 ISCII Tamil 57005 ISCII Telugu 57006 ISCII Assamese 57007 ISCII Oriya 57008 ISCII Kannada 57009 ISCII Malayalam 57010 ISCII Gujarati 57011 ISCII Punjabi 65000 Unicode UTF-7 65001 Unicode UTF-8 The following is a list of valid code page identifiers for Mac OS only: Identifier Name 1 ASCII 2 NEXTSTEP 3 JapaneseEUC 4 UTF8 5 ISOLatin1 6 Symbol 7 NonLossyASCII 8 ShiftJIS 9 ISOLatin2 10 Unicode 11 WindowsCP1251 12 WindowsCP1252 13 WindowsCP1253 14 WindowsCP1254 15 WindowsCP1250 21 ISO2022JP 30 MacOSRoman 10 UTF16String 0x90000100 UTF16BigEndian 0x94000100 UTF16LittleEndian 0x8c000100 UTF32String 0x98000100 UTF32BigEndian 0x9c000100 UTF32LittleEndian 65536 Proprietary

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class 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). Last Valid Build: The last valid build number for which the license will work.

MaskSensitive:   Whether sensitive data is masked in log messages. In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false. This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms.

Trappable Errors (class ipworksauth.saml)

SAML Errors

	603   Cannot obtain assertion. LocalSTS must be set.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).