docs/api/xmlsec-notes-decrypt.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>Decrypting an encrypted document</title>
   5 <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   6 <link rel="HOME" title="XML Security Library Reference Manual" href="index.html">
   7 <link rel="UP" title="Verifing and decrypting documents." href="xmlsec-notes-verify-decrypt.html">
   8 <link rel="PREVIOUS" title="Verifying a signed document" href="xmlsec-notes-verify.html">
   9 <link rel="NEXT" title="Keys." href="xmlsec-notes-keys.html">
  10 <style type="text/css">.synopsis, .classsynopsis {
  11     background: #eeeeee;
  12     border: solid 1px #aaaaaa;
  13     padding: 0.5em;
  14 }
  15 .programlisting {
  16     background: #eeeeff;
  17     border: solid 1px #aaaaff;
  18     padding: 0.5em;
  19 }
  20 .variablelist {
  21     padding: 4px;
  22     margin-left: 3em;
  23 }
  24 .navigation {
  25     background: #ffeeee;
  26     border: solid 1px #ffaaaa;
  27     margin-top: 0.5em;
  28     margin-bottom: 0.5em;
  29 }
  30 .navigation a {
  31     color: #770000;
  32 }
  33 .navigation a:visited {
  34     color: #550000;
  35 }
  36 .navigation .title {
  37     font-size: 200%;
  38 }</style>
  39 </head>
  40 <body><table witdh="100%" valign="top"><tr valign="top">
  41 <td valign="top" align="left" width="210">
  42 <img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
  43 <ul>
  44 <li><a href="../index.html">Home</a></li>
  45 <li><a href="../download.html">Download</a></li>
  46 <li><a href="../news.html">News</a></li>
  47 <li><a href="../documentation.html">Documentation</a></li>
  48 <ul>
  49 <li><a href="../faq.html">FAQ</a></li>
  50 <li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
  51 <li><a href="../api/xmlsec-reference.html">API reference</a></li>
  52 <li><a href="../api/xmlsec-examples.html">Examples</a></li>
  53 </ul>
  54 <li><a href="../xmldsig.html">XML Digital Signature</a></li>
  55 <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
  56 <li><a href="../xmlenc.html">XML Encryption</a></li>
  57 <li><a href="../c14n.html">XML Canonicalization</a></li>
  58 <li><a href="../bugs.html">Reporting Bugs</a></li>
  59 <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
  60 <li><a href="../related.html">Related</a></li>
  61 <li><a href="../authors.html">Authors</a></li>
  62 </ul>
  63 <table width="100%">
  64 <tr>
  65 <td width="15"></td>
  66 <td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
  67 </tr>
  68 <tr>
  69 <td width="15"></td>
  70 <td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
  71 </tr>
  72 <tr>
  73 <td width="15"></td>
  74 <td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
  75 </tr>
  76 <!--Links - start--><!--Links - end-->
  77 </table>
  78 </td>
  79 <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
  80 <table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
  81 <td><a accesskey="p" href="xmlsec-notes-verify.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  82 <td><a accesskey="u" href="xmlsec-notes-verify-decrypt.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  83 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  84 <th width="100%" align="center">XML Security Library Reference Manual</th>
  85 <td><a accesskey="n" href="xmlsec-notes-keys.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  86 </tr></table>
  87 <br clear="all"><div class="SECT1">
  88 <h1 class="SECT1"><a name="XMLSEC-NOTES-DECRYPT">Decrypting an encrypted document</a></h1>
  89 <p>The typical decryption process includes following steps:
  90           </p>
  91 <p></p>
  92 <ul>
  93 <li><p>         Load keys, X509 certificates, etc. in the <a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">keys manager</a> .
  94             </p></li>
  95 <li><p>         Create encryption context <a href="xmlsec-xmlenc.html#XMLSECENCCTX">xmlSecEncCtx</a>
  96                 using <a href="xmlsec-xmlenc.html#XMLSECENCCTXCREATE">xmlSecEncCtxCreate</a> or
  97                 <a href="xmlsec-xmlenc.html#XMLSECENCCTXINITIALIZE">xmlSecEncCtxInitialize</a>
  98                 functions.
  99             </p></li>
 100 <li><p>         Select start decryption &lt;enc:EncryptedData&gt; node.
 101             </p></li>
 102 <li><p>         Decrypt by calling <a href="xmlsec-xmlenc.html#XMLSECENCCTXDECRYPT">xmlSecencCtxDecrypt</a>
 103                 function.
 104             </p></li>
 105 <li><p>         Check returned value and if necessary consume encrypted data.
 106             </p></li>
 107 <li><p>         Destroy encryption context <a href="xmlsec-xmlenc.html#XMLSECENCCTX">xmlSecEncCtx</a>
 108                 using <a href="xmlsec-xmlenc.html#XMLSECENCCTXDESTROY">xmlSecEncCtxDestroy</a> or
 109                 <a href="xmlsec-xmlenc.html#XMLSECENCCTXFINALIZE">xmlSecEncCtxFinalize</a>
 110                 functions.
 111             </p></li>
 112 </ul>
 113 <p>          </p>
 114 <div class="EXAMPLE">
 115 <a name="AEN333"></a><p><b>Example 2. Decrypting a document.</b></p>
 116 <pre class="PROGRAMLISTING">int
 117 decrypt_file(const char* enc_file, const char* key_file) {
 118     xmlDocPtr doc = NULL;
 119     xmlNodePtr node = NULL;
 120     xmlSecEncCtxPtr encCtx = NULL;
 121     int res = -1;
 122
 123     assert(enc_file);
 124     assert(key_file);
 125
 126     /* load template */
 127     doc = xmlParseFile(enc_file);
 128     if ((doc == NULL) || (xmlDocGetRootElement(doc) == NULL)){
 129         fprintf(stderr, "Error: unable to parse file \"%s\"\n", enc_file);
 130         goto done;
 131     }
 132
 133     /* find start node */
 134     node = xmlSecFindNode(xmlDocGetRootElement(doc), xmlSecNodeEncryptedData, xmlSecEncNs);
 135     if(node == NULL) {
 136         fprintf(stderr, "Error: start node not found in \"%s\"\n", enc_file);
 137         goto done;
 138     }
 139
 140     /* create encryption context, we don't need keys manager in this example */
 141     encCtx = xmlSecEncCtxCreate(NULL);
 142     if(encCtx == NULL) {
 143         fprintf(stderr,"Error: failed to create encryption context\n");
 144         goto done;
 145     }
 146
 147     /* load DES key */
 148     encCtx-&gt;encKey = xmlSecKeyReadBinaryFile(xmlSecKeyDataDesId, key_file);
 149     if(encCtx-&gt;encKey == NULL) {
 150         fprintf(stderr,"Error: failed to load des key from binary file \"%s\"\n", key_file);
 151         goto done;
 152     }
 153
 154     /* set key name to the file name, this is just an example! */
 155     if(xmlSecKeySetName(encCtx-&gt;encKey, key_file) &lt; 0) {
 156         fprintf(stderr,"Error: failed to set key name for key from \"%s\"\n", key_file);
 157         goto done;
 158     }
 159
 160     /* decrypt the data */
 161     if((xmlSecEncCtxDecrypt(encCtx, node) &lt; 0) || (encCtx-&gt;result == NULL)) {
 162         fprintf(stderr,"Error: decryption failed\n");
 163         goto done;
 164     }
 165
 166     /* print decrypted data to stdout */
 167     if(encCtx-&gt;resultReplaced != 0) {
 168         fprintf(stdout, "Decrypted XML data:\n");
 169         xmlDocDump(stdout, doc);
 170     } else {
 171         fprintf(stdout, "Decrypted binary data (%d bytes):\n", xmlSecBufferGetSize(encCtx-&gt;result));
 172         if(xmlSecBufferGetData(encCtx-&gt;result) != NULL) {
 173             fwrite(xmlSecBufferGetData(encCtx-&gt;result),
 174                   1,
 175                   xmlSecBufferGetSize(encCtx-&gt;result),
 176                   stdout);
 177         }
 178     }
 179     fprintf(stdout, "\n");
 180
 181     /* success */
 182     res = 0;
 183
 184 done:
 185     /* cleanup */
 186     if(encCtx != NULL) {
 187         xmlSecEncCtxDestroy(encCtx);
 188     }
 189
 190     if(doc != NULL) {
 191         xmlFreeDoc(doc);
 192     }
 193     return(res);
 194 }
 195                 </pre>
 196 <p><a href="xmlsec-decrypt-with-signle-key.html#XMLSEC-EXAMPLE-DECRYPT1">Full Program Listing</a></p>
 197 </div>
 198         </div>
 199 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 200 <td align="left"><a accesskey="p" href="xmlsec-notes-verify.html"><b>&lt;&lt;&lt; Verifying a signed document</b></a></td>
 201 <td align="right"><a accesskey="n" href="xmlsec-notes-keys.html"><b>Keys. &gt;&gt;&gt;</b></a></td>
 202 </tr></table>
 203 </td></tr></table></td>
 204 </tr></table></body>
 205 </html>