Skip to main content

%SOAP.WST.BinarySecret

Class %SOAP.WST.BinarySecret Extends %XML.Security.KeyInfoClause [ System = 4 ]

BinarySecretType type from 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";

Properties

value

Property value As %xsd.base64Binary(XMLPROJECTION = "content");

Key

Property Key As %xsd.base64Binary(XMLPROJECTION = "none") [ Calculated ];

Alias for the BinarySecret value when being used as a key

Type

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

KeySize

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

Size of key. This property overrides key size that implied by Algorithm.

Methods

KeyGet

Method KeyGet() As %xsd.base64Binary [ CodeMode = expression, Internal ]

KeySet

Method KeySet(value As %xsd.base64Binary) As %Status [ Internal ]

Create

ClassMethod Create(type As %xsd.anyURI = "", size As %Integer = "") As %SOAP.WST.BinarySecret

Create a BinarySecret element of specified type and size. Default type is $$$SOAPWSTNonce and default size is $$$SOAPWSSCDEFAULTKEYSIZE.

Initialize

Method Initialize() As %Status

Initialize an BinarySecret element that is intended for elements which will not be in the Security header. Type and KeySize are expected to be set or defaulted.

InitializeKey

Method InitializeKey(service As %SOAP.WebBase, algorithm As %String) As %Status [ Internal ]

Initialize the symmetric key

ValidateKey

Method ValidateKey(service As %SOAP.WebBase) As %String [ Internal ]

Validate the key decryption. If invalid return an error code.

ValidateTokenRef

Method ValidateTokenRef(service As %SOAP.WebBase, ByRef tokenType As %String, Output credentials As %RawString) As %String [ Internal ]

Validate this input BinarySecret used as a KeyInfo clause. If valid, set credentials and tokenType and return "". credentials is this EncryptedKey element

Equals

Method Equals(credentials As %SOAP.WST.BinarySecret) As %Boolean

Return true if the same Key.