1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
<chapter id="xmlsec-notes-verify-decrypt">
<title>Verifing and decrypting documents.</title>
<sect1 id="xmlsec-notes-verify-decrypt-overview">
<title>Overview.</title>
<para>Since the template is just an XML file, it might be created in advance
and saved in a file. It's also possible for application to create
templates without using XML Security Library functions. Also in some
cases template should be inserted in the signed or encrypted data
(for example, if you want to create an enveloped or enveloping
signature).</para>
<para>Signature verification and data decryption do not require template
because all the necessary information is provided in the signed or
encrypted document.
<figure>
<title>The verification or decryption processing model.</title>
<graphic fileref="images/verif-dec-model.png" align="center"></graphic>
</figure>
</para>
</sect1>
<sect1 id="xmlsec-notes-verify" >
<title>Verifying a signed document</title>
<para>The typical siganture verification process includes following steps:
<itemizedlist>
<listitem><para>
Load keys, X509 certificates, etc. in the <link linkend="xmlSecKeysMngr">keys manager</link> .
</para></listitem>
<listitem><para>
Create signature context <link linkend="xmlSecDSigCtx">xmlSecDSigCtx</link>
using <link linkend="xmlSecDSigCtxCreate">xmlSecDSigCtxCreate</link> or
<link linkend="xmlSecDSigCtxInitialize">xmlSecDSigCtxInitialize</link>
functions.
</para></listitem>
<listitem><para>
Select start verification
<ulink URL="http://www.w3.org/TR/xmldsig-core/#sec-Signature"><dsig:Signature/></ulink>
node in the signed XML document.
</para></listitem>
<listitem><para>
Verify signature by calling <link linkend="xmlSecDSigCtxVerify">xmlSecDSigCtxVerify</link>
function.
</para></listitem>
<listitem><para>
Check returned value and verification status (<structfield>status</structfield>
member of <link linkend="xmlSecDSigCtx">xmlSecDSigCtx</link> structure).
If necessary, consume returned data from the <link linkend="xmlSecDSigCtx">context</link>.
</para></listitem>
<listitem><para>
Destroy signature context <link linkend="xmlSecDSigCtx">xmlSecDSigCtx</link>
using <link linkend="xmlSecDSigCtxDestroy">xmlSecDSigCtxDestroy</link> or
<link linkend="xmlSecDSigCtxFinalize">xmlSecDSigCtxFinalize</link>
functions.
</para></listitem>
</itemizedlist>
</para>
<para>
<example>
<title>Verifying a document.</title>
<programlisting><![CDATA[
/**
* verify_file:
* @xml_file: the signed XML file name.
* @key_file: the PEM public key file name.
*
* Verifies XML signature in #xml_file using public key from #key_file.
*
* Returns 0 on success or a negative value if an error occurs.
*/
int
verify_file(const char* xml_file, const char* key_file) {
xmlDocPtr doc = NULL;
xmlNodePtr node = NULL;
xmlSecDSigCtxPtr dsigCtx = NULL;
int res = -1;
assert(xml_file);
assert(key_file);
/* load file */
doc = xmlParseFile(xml_file);
if ((doc == NULL) || (xmlDocGetRootElement(doc) == NULL)){
fprintf(stderr, "Error: unable to parse file \"%s\"\n", xml_file);
goto done;
}
/* find start node */
node = xmlSecFindNode(xmlDocGetRootElement(doc), xmlSecNodeSignature, xmlSecDSigNs);
if(node == NULL) {
fprintf(stderr, "Error: start node not found in \"%s\"\n", xml_file);
goto done;
}
/* create signature context, we don't need keys manager in this example */
dsigCtx = xmlSecDSigCtxCreate(NULL);
if(dsigCtx == NULL) {
fprintf(stderr,"Error: failed to create signature context\n");
goto done;
}
/* load public key */
dsigCtx->signKey = xmlSecCryptoAppKeyLoad(key_file,xmlSecKeyDataFormatPem, NULL, NULL, NULL);
if(dsigCtx->signKey == NULL) {
fprintf(stderr,"Error: failed to load public pem key from \"%s\"\n", key_file);
goto done;
}
/* set key name to the file name, this is just an example! */
if(xmlSecKeySetName(dsigCtx->signKey, key_file) < 0) {
fprintf(stderr,"Error: failed to set key name for key from \"%s\"\n", key_file);
goto done;
}
/* Verify signature */
if(xmlSecDSigCtxVerify(dsigCtx, node) < 0) {
fprintf(stderr,"Error: signature verify\n");
goto done;
}
/* print verification result to stdout */
if(dsigCtx->status == xmlSecDSigStatusSucceeded) {
fprintf(stdout, "Signature is OK\n");
} else {
fprintf(stdout, "Signature is INVALID\n");
}
/* success */
res = 0;
done:
/* cleanup */
if(dsigCtx != NULL) {
xmlSecDSigCtxDestroy(dsigCtx);
}
if(doc != NULL) {
xmlFreeDoc(doc);
}
return(res);
}
]]></programlisting>
<simpara><link linkend="xmlsec-example-verify1">Full Program Listing</link></simpara>
</example>
</para>
</sect1>
<sect1 id="xmlsec-notes-decrypt" >
<title>Decrypting an encrypted document</title>
<para>The typical decryption process includes following steps:
<itemizedlist>
<listitem><para>
Load keys, X509 certificates, etc. in the <link linkend="xmlSecKeysMngr">keys manager</link> .
</para></listitem>
<listitem><para>
Create encryption context <link linkend="xmlSecEncCtx">xmlSecEncCtx</link>
using <link linkend="xmlSecEncCtxCreate">xmlSecEncCtxCreate</link> or
<link linkend="xmlSecEncCtxInitialize">xmlSecEncCtxInitialize</link>
functions.
</para></listitem>
<listitem><para>
Select start decryption <enc:EncryptedData> node.
</para></listitem>
<listitem><para>
Decrypt by calling <link linkend="xmlSecEncCtxDecrypt">xmlSecencCtxDecrypt</link>
function.
</para></listitem>
<listitem><para>
Check returned value and if necessary consume encrypted data.
</para></listitem>
<listitem><para>
Destroy encryption context <link linkend="xmlSecEncCtx">xmlSecEncCtx</link>
using <link linkend="xmlSecEncCtxDestroy">xmlSecEncCtxDestroy</link> or
<link linkend="xmlSecEncCtxFinalize">xmlSecEncCtxFinalize</link>
functions.
</para></listitem>
</itemizedlist>
</para>
<para>
<example>
<title>Decrypting a document.</title>
<programlisting><![CDATA[
int
decrypt_file(const char* enc_file, const char* key_file) {
xmlDocPtr doc = NULL;
xmlNodePtr node = NULL;
xmlSecEncCtxPtr encCtx = NULL;
int res = -1;
assert(enc_file);
assert(key_file);
/* load template */
doc = xmlParseFile(enc_file);
if ((doc == NULL) || (xmlDocGetRootElement(doc) == NULL)){
fprintf(stderr, "Error: unable to parse file \"%s\"\n", enc_file);
goto done;
}
/* find start node */
node = xmlSecFindNode(xmlDocGetRootElement(doc), xmlSecNodeEncryptedData, xmlSecEncNs);
if(node == NULL) {
fprintf(stderr, "Error: start node not found in \"%s\"\n", enc_file);
goto done;
}
/* create encryption context, we don't need keys manager in this example */
encCtx = xmlSecEncCtxCreate(NULL);
if(encCtx == NULL) {
fprintf(stderr,"Error: failed to create encryption context\n");
goto done;
}
/* load DES key */
encCtx->encKey = xmlSecKeyReadBinaryFile(xmlSecKeyDataDesId, key_file);
if(encCtx->encKey == NULL) {
fprintf(stderr,"Error: failed to load des key from binary file \"%s\"\n", key_file);
goto done;
}
/* set key name to the file name, this is just an example! */
if(xmlSecKeySetName(encCtx->encKey, key_file) < 0) {
fprintf(stderr,"Error: failed to set key name for key from \"%s\"\n", key_file);
goto done;
}
/* decrypt the data */
if((xmlSecEncCtxDecrypt(encCtx, node) < 0) || (encCtx->result == NULL)) {
fprintf(stderr,"Error: decryption failed\n");
goto done;
}
/* print decrypted data to stdout */
if(encCtx->resultReplaced != 0) {
fprintf(stdout, "Decrypted XML data:\n");
xmlDocDump(stdout, doc);
} else {
fprintf(stdout, "Decrypted binary data (%d bytes):\n", xmlSecBufferGetSize(encCtx->result));
if(xmlSecBufferGetData(encCtx->result) != NULL) {
fwrite(xmlSecBufferGetData(encCtx->result),
1,
xmlSecBufferGetSize(encCtx->result),
stdout);
}
}
fprintf(stdout, "\n");
/* success */
res = 0;
done:
/* cleanup */
if(encCtx != NULL) {
xmlSecEncCtxDestroy(encCtx);
}
if(doc != NULL) {
xmlFreeDoc(doc);
}
return(res);
}
]]></programlisting>
<simpara><link linkend="xmlsec-example-decrypt1">Full Program Listing</link></simpara>
</example>
</para>
</sect1>
</chapter>
|