<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head profile="http://internetalchemy.org/2003/02/profile"> <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" /> <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" /> <meta name="dc.title" content="Function: xenc_decrypt_soap - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: xenc_decrypt_soap - Virtuoso Functions Guide" /> <meta name="dc.creator" content="OpenLink Software Documentation Team ; " /> <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" /> <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" /> <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" /> <link rel="parent" href="functions.html" title="Chapter Contents" /> <link rel="prev" href="appendixa.html" title="Appendix" /> <link rel="next" href="functions.html#.html" title="" /> <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" /> <link rel="stylesheet" type="text/css" href="doc.css" /> <link rel="stylesheet" type="text/css" href="/doc/translation.css" /> <title>Function: xenc_decrypt_soap - Virtuoso Functions Guide</title> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" /> <meta name="author" content="OpenLink Software Documentation Team ; " /> <meta name="copyright" content="OpenLink Software, 1999 - 2009" /> <meta name="keywords" content="" /> <meta name="GENERATOR" content="OpenLink XSLT Team" /> </head> <body> <div id="header"> <a name="fn_xenc_decrypt_soap" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - xenc_decrypt_soap</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_xenc_X509_certificate_serialize.html" title="xenc_X509_certificate_serialize">Prev</a> | <a class="link" href="fn_xenc_delete_temp_keys.html" title="xenc_delete_temp_keys">Next</a> </div> </div> <div id="currenttoc"> <form method="post" action="/doc/adv_search.vspx"> <div class="search">Keyword Search: <br /> <input type="text" name="q" /> <input type="submit" name="go" value="Go" /> </div> </form> <div> <a href="http://www.openlinksw.com/">www.openlinksw.com</a> </div> <div> <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a> </div> <br /> <div> <a href="index.html">Book Home</a> </div> <br /> <div> <a href="contents.html">Contents</a> </div> <div> <a href="preface.html">Preface</a> </div> <br /> <div> <a class="selected" href="functions.html">Virtuoso Functions Guide</a> </div> <br /> <div> <a href="functions.html#admin">Administration</a> </div> <div> <a href="functions.html#aggr">Aggregate Functions</a> </div> <div> <a href="functions.html#array">Array Manipulation</a> </div> <div> <a href="functions.html#bpel">BPEL APIs</a> </div> <div> <a href="functions.html#backup">Backup</a> </div> <div> <a href="functions.html#compression">Compression</a> </div> <div> <a href="functions.html#cursors">Cursor</a> </div> <div> <a href="functions.html#time">Date & Time Manipulation</a> </div> <div> <a href="functions.html#debug">Debug</a> </div> <div> <a href="functions.html#dict">Dictionary Manipulation</a> </div> <div> <a href="functions.html#encoding">Encoding & Decoding</a> </div> <div> <a href="functions.html#file">File Manipulation</a> </div> <div> <a href="functions.html#ft">Free Text</a> </div> <div> <a class="selected" href="functions.html#hash">Hashing / Cryptographic</a> </div> <div class="selected"> <div> <a href="fn_dsig_template_ext.html">dsig_template_ext</a> </div> <div> <a href="fn_md5.html">md5</a> </div> <div> <a href="fn_md5_final.html">md5_final</a> </div> <div> <a href="fn_md5_init.html">md5_init</a> </div> <div> <a href="fn_md5_update.html">md5_update</a> </div> <div> <a href="fn_tree_md5.html">tree_md5</a> </div> <div> <a href="fn_x509_certificate_verify.html">x509_certificate_ver...</a> </div> <div> <a href="fn_x509_csr_generate.html">x509_csr_generate</a> </div> <div> <a href="fn_xenc_SPKI_read.html">xenc_spki_read</a> </div> <div> <a href="fn_xenc_X509_certificate_serialize.html">xenc_x509_certificat...</a> </div> <div> <a href="fn_xenc_bn2dec.html">xenc_bn2dec</a> </div> <div> <a class="selected" href="fn_xenc_decrypt_soap.html">xenc_decrypt_soap</a> </div> <div> <a href="fn_xenc_delete_temp_keys.html">xenc_delete_temp_key...</a> </div> <div> <a href="fn_xenc_encrypt.html">xenc_encrypt</a> </div> <div> <a href="fn_xenc_get_key_algo.html">xenc_get_key_algo</a> </div> <div> <a href="fn_xenc_get_key_identifier.html">xenc_get_key_identif...</a> </div> <div> <a href="fn_xenc_key_3DES_create.html">xenc_key_3des_create</a> </div> <div> <a href="fn_xenc_key_3DES_rand_create.html">xenc_key_3des_rand_c...</a> </div> <div> <a href="fn_xenc_key_3DES_read.html">xenc_key_3des_read</a> </div> <div> <a href="fn_xenc_key_AES_create.html">xenc_key_aes_create</a> </div> <div> <a href="fn_xenc_key_AES_rand_create.html">xenc_key_aes_rand_cr...</a> </div> <div> <a href="fn_xenc_key_DSA_create.html">xenc_key_dsa_create</a> </div> <div> <a href="fn_xenc_key_DSA_read.html">xenc_key_dsa_read</a> </div> <div> <a href="fn_xenc_key_RSA_create.html">xenc_key_rsa_create</a> </div> <div> <a href="fn_xenc_key_RSA_read.html">xenc_key_rsa_read</a> </div> <div> <a href="fn_xenc_key_create_cert.html">xenc_key_create_cert</a> </div> <div> <a href="fn_xenc_key_exists.html">xenc_key_exists</a> </div> <div> <a href="fn_xenc_key_inst_create.html">xenc_key_inst_create</a> </div> <div> <a href="fn_xenc_key_remove.html">xenc_key_remove</a> </div> <div> <a href="fn_xenc_key_serialize.html">xenc_key_serialize</a> </div> <div> <a href="fn_xenc_pem_export.html">xenc_pem_export</a> </div> <div> <a href="fn_xenc_pkcs12_export.html">xenc_pkcs12_export</a> </div> <div> <a href="fn_xenc_set_primary_key.html">xenc_set_primary_key</a> </div> <div> <a href="fn_xenc_x509_generate.html">xenc_x509_generate</a> </div> <div> <a href="fn_xenc_x509_ss_generate.html">xenc_x509_ss_generat...</a> </div> </div> <div> <a href="functions.html#ldap">LDAP</a> </div> <div> <a href="functions.html#localization">Locale</a> </div> <div> <a href="functions.html#mail">Mail</a> </div> <div> <a href="functions.html#misc">Miscellaneous</a> </div> <div> <a href="functions.html#number">Number</a> </div> <div> <a href="functions.html#phrz">Phrases</a> </div> <div> <a href="functions.html#rdf">RDF data</a> </div> <div> <a href="functions.html#rmt">Remote SQL Data Source</a> </div> <div> <a href="functions.html#repl">Replication</a> </div> <div> <a href="functions.html#soap">SOAP</a> </div> <div> <a href="functions.html#sql">SQL</a> </div> <div> <a href="functions.html#string">String</a> </div> <div> <a href="functions.html#txn">Transaction</a> </div> <div> <a href="functions.html#type">Type Mapping</a> </div> <div> <a href="functions.html#uddi">UDDI</a> </div> <div> <a href="functions.html#udt">User Defined Types & The CLR</a> </div> <div> <a href="functions.html#vad">VAD</a> </div> <div> <a href="functions.html#jvmpl">Virtuoso Java PL API</a> </div> <div> <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a> </div> <div> <a href="functions.html#ws">Web & Internet</a> </div> <div> <a href="functions.html#xml">XML</a> </div> <div> <a href="functions.html#XPATH">XPATH & XQUERY</a> </div> <br /> <div> <a href="functionidx.html">Functions Index</a> </div> <br /> </div> <div id="text"> <h2>xenc_decrypt_soap</h2> <div class="refpurpose">Decrypt and verify a SOAP message</div> <div class="funcsynopsis"> <span class="funcdef">varchar <span class="function">xenc_decrypt_soap</span> </span> (<span class="paramdef">in <span class="parameter">xml_text</span> varchar</span>, <span class="paramdef">in <span class="parameter">soap_version</span> int</span>, <span class="paramdef">in <span class="parameter">validate_flag</span> int</span>, <span class="paramdef">in <span class="parameter">encoding</span> varchar</span>, <span class="paramdef">in <span class="parameter">lang</span> varchar</span>, <span class="paramdef">in <span class="parameter">opts</span> any</span>, <span class="paramdef">out <span class="parameter">keys</span> any</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p> The function is used to decrypt and optionally verify signature (depends of a <span class="computeroutput">validate_flag</span> parameter) of a SOAP message. </p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">xml_text – </span> A string containing SOAP message </div> <div class="refsect2"> <span class="refsect2title">soap_version – </span> An integer indication SOAP version (11 for v1.1, 10 for 1.0 etc) </div> <div class="refsect2"> <span class="refsect2title">validate_flag – </span> Bit mask flag. See below for details. <ul> <li>bit 0 and 1 : 00 - do not validate, 01 (decimal 1) - validate, 10 (decimal 2) - validate if signature exists</li> <li>bit 2 : 100 (decimal 4) - try to decode, do not signal error if WS-Security is not supplied</li> </ul> </div> <div class="refsect2"> <span class="refsect2title">encoding – </span> The message (<span class="computeroutput">xml_text</span>) character encoding </div> <div class="refsect2"> <span class="refsect2title">lang – </span> The message (<span class="computeroutput">xml_text</span>) language </div> <div class="refsect2"> <span class="refsect2title">opts – </span> A vector containing options for User Name token profile. For example : vector ('UsernameToken', vector ('label', 'lab1', 'keyAlgorithm' , '[3des algo uri]')) </div> <div class="refsect2"> <span class="refsect2title">keys – </span> if supplied the parameter will be set with keys names used for decryption and signature verification. The structure is as follows : vector (vector ([enc-key1],[enc-key2],...), vector ('[signing token name]', '[matching token]')). Where enc-key is a key used to decrypt the message fragment; '[signing token name]' is the temporary key used to validate the signature and '[matching token]' is the token (key) from user's space that matches the signing token. </div> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p>On success the function returns decrypted SOAP message.</p> </div> <div class="refsect1title">Errors</div> <p>This function can generate the following errors:</p> <p> <a href="errors.html#err" />.</p> <div class="refsect1"> <div class="refsect1title">Examples</div> <a name="ex_xenc_decrypt_soap" /> <div class="example"> <div class="exampletitle">Decrypting SOAP message</div> <div> <pre class="screen"> declare ekeys, opts, decoded any; opts := vector ('UsernameToken', vector ('label', 'Application-Label', 'keyAlgorithm', 'http://www.w3.org/2001/04/xmlenc#tripledes-cbc')); decoded := xenc_decrypt_soap (body_str, 11, 6, 'UTF-8', 'x-any', opts, ekeys); </pre> </div> </div> </div> <div class="refsect1"> <div class="refsect1title">See Also</div> <p> <a href="fn_xenc_encrypt.html">xenc_encrypt()</a> </p> </div> </div> <div id="footer"> <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div> <div id="validation"> <a href="http://validator.w3.org/check/referer"> <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /> </a> <a href="http://jigsaw.w3.org/css-validator/"> <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /> </a> </div> </div> </body> </html>