Skip to main content

%XML.Security.EncryptedType

Class %XML.Security.EncryptedType Extends %SOAP.Security.Element [ System = 4 ]

XML Encryption element. This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class."

Parameters​

XMLFORMAT​

Parameter XMLFORMAT = "literal";

NAMESPACE​

Parameter NAMESPACE = "http://www.w3.org/2001/04/xmlenc#";

ELEMENTQUALIFIED​

Parameter ELEMENTQUALIFIED = 1;

Properties​

EncryptionMethod​

Property EncryptionMethod As %XML.Security.EncryptionMethod;

KeyInfo​

Property KeyInfo As %XML.Security.KeyInfo(REFNAMESPACE = "http://www.w3.org/2000/09/xmldsig#", XMLREF = 1);

Encoding​

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

Id​

Property Id As %String(MAXLEN = "", XMLPROJECTION = "attribute");

MimeType​

Property MimeType As %String(MAXLEN = "", XMLPROJECTION = "attribute");

Type​

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

X509Credentials​

Property X509Credentials As %RawString(XMLPROJECTION = "none") [ Internal ];

If encryption is based on X509 certificate, this is the X509 certificate class.

Algorithm​

Property Algorithm As %xsd.anyURI(XMLPROJECTION = "none");

Encryption algorithm to use. The default is $$$SOAPWSaes128cbc. Possible values are $$$SOAPWSaes128cbc, $$$SOAPWSaes192cbc, $$$SOAPWSaes256cbc and $$$SOAPWSaes256gcm.

KeySize​

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

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

RequireBestEntropy​

Property RequireBestEntropy As %Boolean(XMLPROJECTION = "none") [ InitialExpression = 0 ];

RequireBestEntropy - Require best entropy source for initialization of key generation. If this parameter equals 1, the function will return an error unless the generator's internal state has been seeded using the best source of true entropy (OS dependent).

Key​

Property Key As %Binary(XMLPROJECTION = "none") [ Internal ];

The symmetric key to be used for encryption.

Methods​

SetEncryptionMethod​

Method SetEncryptionMethod(algorithm As %String)

Set the key transport algorithm to be used to encrypt the symmetric key. The algorithm is reflected in the Algorithm attribute of the EncryptionMethod element of EncryptedKey. Possible values for algortihm are $$$SOAPWSrsaoaep and $$$SOAPWSrsa15

InitializeKey​

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

Initialize the symmetric key based on the specified algorithm.

Reset​

Method Reset() [ Internal ]

Reset the element.