Skip to main content

%SOAP.WST.RequestSecurityToken

Class %SOAP.WST.RequestSecurityToken Extends %SOAP.RequestMessage [ System = 4 ]

RequestSecurityToken as used for request body in WS-Trust 1.3.

Parameters​

XMLFORMAT​

Parameter XMLFORMAT = "literal";

NAMESPACE​

Parameter NAMESPACE = "http://docs.oasis-open.org/ws-sx/ws-trust/200512";

ELEMENTQUALIFIED​

Parameter ELEMENTQUALIFIED = 1;

XMLPREFIX​

Parameter XMLPREFIX = "wst";

XMLSEQUENCE​

Parameter XMLSEQUENCE = 0;

XMLIGNOREINVALIDTAG​

Parameter XMLIGNOREINVALIDTAG = 1;

Properties​

TokenType​

Property TokenType As %xsd.anyURI(XMLREF = 1);

RequestType​

Property RequestType As %xsd.anyURI(XMLREF = 1) [ Required ];

Context​

Property Context As %xsd.anyURI(XMLPROJECTION = "attribute");

AppliesTo​

Property AppliesTo As %XML.String(REFNAMESPACE = "http://www.w3.org/ns/ws-policy", XMLREF = 1);

Claims​

Property Claims As %SOAP.WST.Claims;

Entropy​

Property Entropy As %SOAP.WST.Entropy;

Lifetime​

Property Lifetime As %SOAP.WST.Lifetime;

RenewTarget​

Property RenewTarget As %SOAP.WST.Target;

AllowPostdating​

Property AllowPostdating As %String;

Renewing​

Property Renewing As %SOAP.WST.Renewing;

OnBehalfOf​

Property OnBehalfOf As %SOAP.WST.Target;

Issuer​

Property Issuer As %SOAP.Addressing.EndpointReference(REFNAMESPACE = "http://www.w3.org/2005/08/addressing", XMLREF = 1);

AuthenticationType​

Property AuthenticationType As %xsd.anyURI;

KeyType​

Property KeyType As %xsd.anyURI;

KeySize​

Property KeySize As %xsd.unsignedInt;

SignatureAlgorithm​

Property SignatureAlgorithm As %xsd.anyURI;

Encryption​

Property Encryption As %XML.String;

EncryptionAlgorithm​

Property EncryptionAlgorithm As %xsd.anyURI;

CanonicalizationAlgorithm​

Property CanonicalizationAlgorithm As %xsd.anyURI;

ComputedKeyAlgorithm​

Property ComputedKeyAlgorithm As %xsd.anyURI;

ProofEncryption​

Property ProofEncryption As %SOAP.WST.Target;

KeyWrapAlgorithm​

Property KeyWrapAlgorithm As %xsd.anyURI;

UseKey​

Property UseKey As %SOAP.WST.Target;

SignWith​

Property SignWith As %xsd.anyURI;

EncryptWith​

Property EncryptWith As %xsd.anyURI;

DelegateTo​

Property DelegateTo As %SOAP.WST.Target;

Forwardable​

Property Forwardable As %Boolean;

Delegatable​

Property Delegatable As %Boolean;

Policy​

Property Policy As %SOAP.Policy(REFNAMESPACE = "http://www.w3.org/ns/ws-policy", XMLREF = 1);

PolicyReference​

Property PolicyReference As %SOAP.PolicyReference(REFNAMESPACE = "http://www.w3.org/ns/ws-policy", XMLREF = 1);

Participants​

Property Participants As %SOAP.WST.Participants;

CancelTarget​

Property CancelTarget As %SOAP.WST.Target;

RequireServerEntropy​

Property RequireServerEntropy As %Boolean(XMLPROJECTION = "none") [ Internal ];

If RequireServerEntropy is true, then the response to this request must have server entropy

ComputedKeySize​

Property ComputedKeySize As %Integer(XMLPROJECTION = "none");

ComputedKeySize specifies the size in bytes of the computed key which will be established. ComputedKeySize is meaningful only if client and server entropy are both specified for a computed key. Default is $$$SOAPWSSCDEFAULTKEYSIZE.

Methods​

CreateIssueRequest​

ClassMethod CreateIssueRequest(interval As %Integer = 300, clientEntropy As %SOAP.WST.Entropy = "", requireServerEntropy As %Boolean) As %SOAP.WST.RequestSecurityToken

Create an Issue request for WS-SecureConversation SecurityContextToken.
If ComputedKeySize is not pre-agreed or specified by a WS-Policy then the ComputedKeySize property should be set to indicate the desired KeySize in bytes before calling StartSecureConversation.

  • interval is lifetime of the requested token. To include no Lifetime element pass interval as "". The default interval is 300 seconds.
  • clientEntropy is the client entropy to be included in the request which is created using ##class(%SOAP.WST.Entropy).Create(....
  • requireServerEntropy is a %Boolean argument which specifies if server entropy must be supplied. Default is false.

CreateIssueResponse​

Method CreateIssueResponse(soapClass As %SOAP.WebService, keysize As %Integer, requireClientEntropy As %Boolean, serverEntropy As %SOAP.WST.Entropy = "", Output error As %String, lifetime As %Integer) As %SOAP.WST.RequestSecurityTokenResponseCollection

Create and return an Issue response for this request with WS-SecureConversation SecurityContextToken.

  • soapClass is the web service to which the request was sent.
  • keysize is the size of the desired key in bytes. This argument is used only when key is computed based on both client and server entropy. Default is the smaller of length of client entropy and server entropy.
  • requireClientEntropy is true if the request must include client entropy. requireClientEntropy is false if the request must not include client entropy.
  • serverEntropy is %SOAP.WST.Entropy with server entropy or "" if no server entropy.
  • error contained the returned error string. "" if successful. Otherwise, fault code from section 11 of WS-Trust 1.3 specification.
  • lifetime is the required duration of the lifetime token in seconds. If not specifed, the client requested lifetime is used or 300 secondss if no client requested lifetime

CreateCancelResponse​

Method CreateCancelResponse(soapClass As %SOAP.WebService, Output error As %String) As %SOAP.WST.RequestSecurityTokenResponseCollection

Create and return an Cancel response for this Cancel request.

  • soapClass is the web service to which the request was sent.
  • error contained the returned error string. "" if successful. Otherwise, fault code from section 11 of WS-Trust 1.3 specification.

NotSupported​

Method NotSupported(property As %String, Output error As %String) As %SOAP.WST.RequestSecurityTokenResponseCollection [ Internal ]

Return not supported error in request