docs/api/xmlsec-notes-sign-x509.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>Signing data with X509 certificate.</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="Using X509 Certificates." href="xmlsec-notes-x509.html">
   8 <link rel="PREVIOUS" title="Using X509 Certificates." href="xmlsec-notes-x509.html">
   9 <link rel="NEXT" title="Verifing document signed with X509 certificates." href="xmlsec-notes-verify-x509.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-x509.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  82 <td><a accesskey="u" href="xmlsec-notes-x509.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-verify-x509.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-SIGN-X509">Signing data with X509 certificate.</a></h1>
  89 <p>To sign a file using X509 certificate,
  90         an application need to associate the certificate (or certificates)
  91         with the private key using one of the following functions:
  92         </p>
  93 <p></p>
  94 <ul>
  95 <li><p>     <a href="xmlsec-openssl-app.html#XMLSECOPENSSLAPPKEYCERTLOAD">xmlSecOpenSSLAppKeyCertLoad</a> - loads
  96             certificate from a file and adds to the key;
  97             </p></li>
  98 <li><p>     <a href="xmlsec-openssl-app.html#XMLSECOPENSSLAPPPKCS12LOAD">xmlSecOpenSSLAppPkcs12Load</a> -
  99             loads private key and all the certificates associated with it from a PKCS12 file;
 100             </p></li>
 101 <li><p>     <a href="xmlsec-keys.html#XMLSECKEYADOPTDATA">xmlSecKeyAdoptData</a> - low level
 102             function to add key data (including X509 key data) to the key.
 103             </p></li>
 104 </ul>
 105 <div class="EXAMPLE">
 106 <a name="AEN423"></a><p><b>Example 1. Loading private key and X509 certificate.</b></p>
 107 <pre class="PROGRAMLISTING">    /* load private key, assuming that there is not password */
 108     key = xmlSecCryptoAppKeyLoad(key_file, xmlSecKeyDataFormatPem, NULL, NULL, NULL);
 109     if(key == NULL) {
 110         fprintf(stderr,"Error: failed to load private pem key from \"%s\"\n", key_file);
 111         goto done;
 112     }
 113
 114     /* load certificate and add to the key */
 115     if(xmlSecCryptoAppKeyCertLoad(key, cert_file, xmlSecKeyDataFormatPem) &lt; 0) {
 116         fprintf(stderr,"Error: failed to load pem certificate \"%s\"\n", cert_file);
 117         goto done;
 118     }
 119             </pre>
 120 <p><a href="xmlsec-examples-sign-x509.html#XMLSEC-EXAMPLE-SIGN3">Full program listing</a></p>
 121 </div>
 122         <p>Next step is to prepare signature template with &lt;dsig:X509Data/&gt;
 123         child of the &lt;dsig:KeyInfo/&gt; element. When XML Security Library finds
 124         this node in the template, it automaticaly creates &lt;dsig:X509Certificate/&gt;
 125         children of the &lt;dsig:X509Data/&gt; element and writes to result XML document
 126         all the certificates associated with the signature key.
 127         </p>
 128 <div class="EXAMPLE">
 129 <a name="AEN429"></a><p><b>Example 2. Dynamicaly creating a signature template for signing document using X509 certificate.</b></p>
 130 <pre class="PROGRAMLISTING">    /* create signature template for RSA-SHA1 enveloped signature */
 131     signNode = xmlSecTmplSignatureCreate(doc, xmlSecTransformExclC14NId,
 132                                          xmlSecTransformRsaSha1Id, NULL);
 133     if(signNode == NULL) {
 134         fprintf(stderr, "Error: failed to create signature template\n");
 135         goto done;
 136     }
 137
 138     /* add &lt;dsig:Signature/&gt; node to the doc */
 139     xmlAddChild(xmlDocGetRootElement(doc), signNode);
 140
 141     /* add reference */
 142     refNode = xmlSecTmplSignatureAddReference(signNode, xmlSecTransformSha1Id,
 143                                         NULL, NULL, NULL);
 144     if(refNode == NULL) {
 145         fprintf(stderr, "Error: failed to add reference to signature template\n");
 146         goto done;
 147     }
 148
 149     /* add enveloped transform */
 150     if(xmlSecTmplReferenceAddTransform(refNode, xmlSecTransformEnvelopedId) == NULL) {
 151         fprintf(stderr, "Error: failed to add enveloped transform to reference\n");
 152         goto done;
 153     }
 154
 155     /* add &lt;dsig:KeyInfo/&gt; and &lt;dsig:X509Data/&gt; */
 156     keyInfoNode = xmlSecTmplSignatureEnsureKeyInfo(signNode, NULL);
 157     if(keyInfoNode == NULL) {
 158         fprintf(stderr, "Error: failed to add key info\n");
 159         goto done;
 160     }
 161
 162     if(xmlSecTmplKeyInfoAddX509Data(keyInfoNode) == NULL) {
 163         fprintf(stderr, "Error: failed to add X509Data node\n");
 164         goto done;
 165     }
 166             </pre>
 167 <p><a href="xmlsec-examples-sign-x509.html#XMLSEC-EXAMPLE-SIGN3">Full program listing</a></p>
 168 </div>
 169         </div>
 170 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 171 <td align="left"><a accesskey="p" href="xmlsec-notes-x509.html"><b>&lt;&lt;&lt; Using X509 Certificates.</b></a></td>
 172 <td align="right"><a accesskey="n" href="xmlsec-notes-verify-x509.html"><b>Verifing document signed with X509 certificates. &gt;&gt;&gt;</b></a></td>
 173 </tr></table>
 174 </td></tr></table></td>
 175 </tr></table></body>
 176 </html>