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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <config_gpgme.h>
#include <sal/config.h>
#include <rtl/uuid.h>
#include <cppuhelper/supportsservice.hxx>
#include <gpg/xmlsignature_gpgimpl.hxx>
#if defined _MSC_VER && defined __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wundef"
#endif
#include <gpgme.h>
#if defined _MSC_VER && defined __clang__
#pragma clang diagnostic pop
#endif
#include <context.h>
#include <key.h>
#include <data.h>
#include <signingresult.h>
#include <importresult.h>
#include <xmlsec/xmldocumentwrapper_xmlsecimpl.hxx>
#include <xmlelementwrapper_xmlsecimpl.hxx>
#include <xmlsec/xmlstreamio.hxx>
#include <xmlsec/errorcallback.hxx>
#include "SecurityEnvironment.hxx"
#include <xmlsec-wrapper.h>
using namespace css::uno;
using namespace css::lang;
using namespace css::xml::wrapper;
using namespace css::xml::crypto;
XMLSignature_GpgImpl::XMLSignature_GpgImpl() {
}
XMLSignature_GpgImpl::~XMLSignature_GpgImpl() {
}
/* XXMLSignature */
Reference< XXMLSignatureTemplate >
SAL_CALL XMLSignature_GpgImpl::generate(
const Reference< XXMLSignatureTemplate >& aTemplate ,
const Reference< XSecurityEnvironment >& aEnvironment
)
{
xmlSecDSigCtxPtr pDsigCtx = nullptr ;
xmlNodePtr pNode = nullptr ;
if( !aTemplate.is() )
throw RuntimeException() ;
if( !aEnvironment.is() )
throw RuntimeException() ;
//Get the xml node
Reference< XXMLElementWrapper > xElement = aTemplate->getTemplate() ;
if( !xElement.is() ) {
throw RuntimeException() ;
}
XMLElementWrapper_XmlSecImpl* pElement =
dynamic_cast<XMLElementWrapper_XmlSecImpl*>(xElement.get());
if( pElement == nullptr ) {
throw RuntimeException() ;
}
pNode = pElement->getNativeElement() ;
//Get the stream/URI binding
Reference< XUriBinding > xUriBinding = aTemplate->getBinding() ;
if( xUriBinding.is() ) {
//Register the stream input callbacks into libxml2
if( xmlRegisterStreamInputCallbacks( xUriBinding ) < 0 )
throw RuntimeException() ;
}
//Get Keys Manager
SecurityEnvironmentGpg* pSecEnv =
dynamic_cast<SecurityEnvironmentGpg*>(aEnvironment.get());
if( pSecEnv == nullptr )
throw RuntimeException() ;
setErrorRecorder();
//Create Signature context
pDsigCtx = xmlSecDSigCtxCreate( nullptr ) ;
if( pDsigCtx == nullptr )
{
clearErrorRecorder();
return aTemplate;
}
// set intended operation to sign - several asserts inside libxmlsec
// wanting that for digest / transforms
pDsigCtx->operation = xmlSecTransformOperationSign;
// we default to SHA512 for all digests - nss crypto does not have it...
//pDsigCtx->defDigestMethodId = xmlSecTransformSha512Id;
// Calculate digest for all references
xmlNodePtr cur = xmlSecGetNextElementNode(pNode->children);
if( cur != nullptr )
cur = xmlSecGetNextElementNode(cur->children);
while( cur != nullptr )
{
// some of those children I suppose should be reference elements
if( xmlSecCheckNodeName(cur, xmlSecNodeReference, xmlSecDSigNs) )
{
xmlSecDSigReferenceCtxPtr pDsigRefCtx =
xmlSecDSigReferenceCtxCreate(pDsigCtx,
xmlSecDSigReferenceOriginSignedInfo);
if(pDsigRefCtx == nullptr)
throw RuntimeException();
// add this one to the list
if( xmlSecPtrListAdd(&(pDsigCtx->signedInfoReferences),
pDsigRefCtx) < 0 )
{
// TODO resource handling
xmlSecDSigReferenceCtxDestroy(pDsigRefCtx);
throw RuntimeException();
}
if( xmlSecDSigReferenceCtxProcessNode(pDsigRefCtx, cur) < 0 )
throw RuntimeException();
// final check - all good?
if(pDsigRefCtx->status != xmlSecDSigStatusSucceeded)
{
pDsigCtx->status = xmlSecDSigStatusInvalid;
return aTemplate; // TODO - harder error?
}
}
cur = xmlSecGetNextElementNode(cur->next);
}
// get me a digestible buffer from the signature template!
// -------------------------------------------------------
// run the transformations over SignedInfo element (first child of
// pNode)
xmlSecNodeSetPtr nodeset = nullptr;
cur = xmlSecGetNextElementNode(pNode->children);
// TODO assert that...
nodeset = xmlSecNodeSetGetChildren(pNode->doc, cur, 1, 0);
if(nodeset == nullptr)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
if( xmlSecTransformCtxXmlExecute(&(pDsigCtx->transformCtx), nodeset) < 0 )
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// now extract the keyid from PGPData
// walk xml tree to PGPData node - go to children, first is
// SignedInfo, 2nd is signaturevalue, 3rd is KeyInfo
// 1st child is PGPData, 1st grandchild is PGPKeyID
cur = xmlSecGetNextElementNode(pNode->children);
// TODO error handling
cur = xmlSecGetNextElementNode(cur->next);
cur = xmlSecGetNextElementNode(cur->next);
cur = xmlSecGetNextElementNode(cur->children);
// check that this is now PGPData
if(!xmlSecCheckNodeName(cur, xmlSecNodePGPData, xmlSecDSigNs))
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// check that this is now PGPKeyID
cur = xmlSecGetNextElementNode(cur->children);
static const xmlChar xmlSecNodePGPKeyID[] = "PGPKeyID";
if(!xmlSecCheckNodeName(cur, xmlSecNodePGPKeyID, xmlSecDSigNs))
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
GpgME::Context& rCtx=pSecEnv->getGpgContext();
rCtx.setKeyListMode(GPGME_KEYLIST_MODE_LOCAL);
GpgME::Error err;
xmlChar* pKey=xmlNodeGetContent(cur);
if(xmlSecBase64Decode(pKey, reinterpret_cast<xmlSecByte*>(pKey), xmlStrlen(pKey)) < 0)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
if( rCtx.addSigningKey(
rCtx.key(
reinterpret_cast<char*>(pKey), err, true)) )
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
xmlFree(pKey);
// good, ctx is setup now, let's sign the lot
GpgME::Data data_in(
reinterpret_cast<char*>(xmlSecBufferGetData(pDsigCtx->transformCtx.result)),
xmlSecBufferGetSize(pDsigCtx->transformCtx.result), false);
GpgME::Data data_out;
SAL_INFO("xmlsecurity.xmlsec.gpg", "Generating signature for: " << xmlSecBufferGetData(pDsigCtx->transformCtx.result));
// we base64-encode anyway
rCtx.setArmor(false);
GpgME::SigningResult sign_res=rCtx.sign(data_in, data_out,
GpgME::Detached);
off_t result = data_out.seek(0,SEEK_SET);
(void) result;
assert(result == 0);
int len=0, curr=0; char buf;
while( (curr=data_out.read(&buf, 1)) )
len += curr;
if(sign_res.error() || !len)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// write signed data to xml
xmlChar* signature = static_cast<xmlChar*>(xmlMalloc(len + 1));
if(signature == nullptr)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
result = data_out.seek(0,SEEK_SET);
assert(result == 0);
if( data_out.read(signature, len) != len )
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// conversion to base64
xmlChar* signatureEncoded=nullptr;
if( !(signatureEncoded=xmlSecBase64Encode(reinterpret_cast<xmlSecByte*>(signature), len, 79)) )
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
xmlFree(signature);
// walk xml tree to sign value node - go to children, first is
// SignedInfo, 2nd is signaturevalue
cur = xmlSecGetNextElementNode(pNode->children);
cur = xmlSecGetNextElementNode(cur->next);
// TODO some assert would be good...
xmlNodeSetContentLen(cur, signatureEncoded, xmlStrlen(signatureEncoded));
xmlFree(signatureEncoded);
aTemplate->setStatus(SecurityOperationStatus_OPERATION_SUCCEEDED);
// done
xmlSecDSigCtxDestroy( pDsigCtx ) ;
//Unregistered the stream/URI binding
if( xUriBinding.is() )
xmlUnregisterStreamInputCallbacks() ;
clearErrorRecorder();
return aTemplate ;
}
/* XXMLSignature */
Reference< XXMLSignatureTemplate >
SAL_CALL XMLSignature_GpgImpl::validate(
const Reference< XXMLSignatureTemplate >& aTemplate ,
const Reference< XXMLSecurityContext >& aSecurityCtx
) {
xmlSecDSigCtxPtr pDsigCtx = nullptr ;
xmlNodePtr pNode = nullptr ;
if( !aTemplate.is() )
throw RuntimeException() ;
if( !aSecurityCtx.is() )
throw RuntimeException() ;
//Get the xml node
Reference< XXMLElementWrapper > xElement = aTemplate->getTemplate() ;
if( !xElement.is() )
throw RuntimeException() ;
XMLElementWrapper_XmlSecImpl* pElement =
dynamic_cast<XMLElementWrapper_XmlSecImpl*>(xElement.get());
if( pElement == nullptr )
throw RuntimeException() ;
pNode = pElement->getNativeElement() ;
//Get the stream/URI binding
Reference< XUriBinding > xUriBinding = aTemplate->getBinding() ;
if( xUriBinding.is() ) {
//Register the stream input callbacks into libxml2
if( xmlRegisterStreamInputCallbacks( xUriBinding ) < 0 )
throw RuntimeException() ;
}
setErrorRecorder();
sal_Int32 nSecurityEnvironment = aSecurityCtx->getSecurityEnvironmentNumber();
sal_Int32 i;
for (i=0; i<nSecurityEnvironment; ++i)
{
Reference< XSecurityEnvironment > aEnvironment = aSecurityCtx->getSecurityEnvironmentByIndex(i);
SecurityEnvironmentGpg* pSecEnv =
dynamic_cast<SecurityEnvironmentGpg*>(aEnvironment.get());
if( pSecEnv == nullptr )
throw RuntimeException() ;
// TODO figure out key from pSecEnv!
// unclear how/where that is transported in nss impl...
//Create Signature context
pDsigCtx = xmlSecDSigCtxCreate( nullptr ) ;
if( pDsigCtx == nullptr )
{
clearErrorRecorder();
return aTemplate;
}
// set intended operation to verify - several asserts inside libxmlsec
// wanting that for digest / transforms
pDsigCtx->operation = xmlSecTransformOperationVerify;
// reset status - to be set later
pDsigCtx->status = xmlSecDSigStatusUnknown;
// get me a digestible buffer from the SignatureInfo node!
// -------------------------------------------------------
// run the transformations - first child node is required to
// be SignatureInfo
xmlSecNodeSetPtr nodeset = nullptr;
xmlNodePtr cur = xmlSecGetNextElementNode(pNode->children);
// TODO assert that...
nodeset = xmlSecNodeSetGetChildren(pNode->doc, cur, 1, 0);
if(nodeset == nullptr)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// TODO assert we really have the SignatureInfo here?
if( xmlSecTransformCtxXmlExecute(&(pDsigCtx->transformCtx), nodeset) < 0 )
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// Validate the template via gpgme
GpgME::Context& rCtx=pSecEnv->getGpgContext();
GpgME::Data data_text(
reinterpret_cast<char*>(xmlSecBufferGetData(pDsigCtx->transformCtx.result)),
xmlSecBufferGetSize(pDsigCtx->transformCtx.result), false);
SAL_INFO("xmlsecurity.xmlsec.gpg", "Validating SignatureInfo: " << xmlSecBufferGetData(pDsigCtx->transformCtx.result));
// walk xml tree to sign value node - go to children, first is
// SignedInfo, 2nd is signaturevalue
cur = xmlSecGetNextElementNode(pNode->children);
cur = xmlSecGetNextElementNode(cur->next);
if(!xmlSecCheckNodeName(cur, xmlSecNodeSignatureValue, xmlSecDSigNs))
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
xmlChar* pSignatureValue=xmlNodeGetContent(cur);
int nSigSize = xmlSecBase64Decode(pSignatureValue, reinterpret_cast<xmlSecByte*>(pSignatureValue), xmlStrlen(pSignatureValue));
if( nSigSize < 0)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
GpgME::Data data_signature(
reinterpret_cast<char*>(pSignatureValue),
nSigSize, false);
GpgME::VerificationResult verify_res=rCtx.verifyDetachedSignature(
data_signature, data_text);
// TODO: needs some more error handling, needs checking _all_ signatures
if( verify_res.isNull() || verify_res.numSignatures() == 0
// there is at least 1 signature and it is anything else than fully valid
|| ( (verify_res.numSignatures() > 0)
&& verify_res.signature(0).status().encodedError() > 0 ) )
{
// let's try again, but this time import the public key
// payload (avoiding that in a first cut for being a bit
// speedier. also prevents all too easy poisoning/sha1
// fingerprint collision attacks)
// walk xml tree to PGPData node - go to children, first is
// SignedInfo, 2nd is signaturevalue, 3rd is KeyInfo
// 1st child is PGPData, 1st or 2nd grandchild is PGPKeyPacket
cur = xmlSecGetNextElementNode(pNode->children);
// TODO error handling
cur = xmlSecGetNextElementNode(cur->next);
cur = xmlSecGetNextElementNode(cur->next);
cur = xmlSecGetNextElementNode(cur->children);
// check that this is now PGPData
if(!xmlSecCheckNodeName(cur, xmlSecNodePGPData, xmlSecDSigNs))
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
// check that this is now PGPKeyPacket
cur = xmlSecGetNextElementNode(cur->children);
static const xmlChar xmlSecNodePGPKeyPacket[] = "PGPKeyPacket";
if(!xmlSecCheckNodeName(cur, xmlSecNodePGPKeyPacket, xmlSecDSigNs))
{
// not this one, maybe the next?
cur = xmlSecGetNextElementNode(cur->next);
if(!xmlSecCheckNodeName(cur, xmlSecNodePGPKeyPacket, xmlSecDSigNs))
{
// ok, giving up
clearErrorRecorder();
xmlFree(pSignatureValue);
return aTemplate;
}
}
// got a key packet, import & re-validate
xmlChar* pKeyPacket=xmlNodeGetContent(cur);
int nKeyLen = xmlSecBase64Decode(pKeyPacket, reinterpret_cast<xmlSecByte*>(pKeyPacket), xmlStrlen(pKeyPacket));
if( nKeyLen < 0)
throw RuntimeException("The GpgME library failed to initialize for the OpenPGP protocol.");
GpgME::Data data_key(
reinterpret_cast<char*>(pKeyPacket),
nKeyLen, false);
GpgME::ImportResult import_res=rCtx.importKeys(data_key);
xmlFree(pKeyPacket);
// and re-run (rewind text and signature streams to position 0)
(void)data_text.seek(0,SEEK_SET);
(void)data_signature.seek(0,SEEK_SET);
verify_res=rCtx.verifyDetachedSignature(data_signature, data_text);
// TODO: needs some more error handling, needs checking _all_ signatures
if( verify_res.isNull() || verify_res.numSignatures() == 0
// there is at least 1 signature and it is anything else than valid
|| ( (verify_res.numSignatures() > 0)
&& verify_res.signature(0).status().encodedError() > 0 ) )
{
clearErrorRecorder();
xmlFree(pSignatureValue);
return aTemplate;
}
}
xmlFree(pSignatureValue);
// now verify digest for all references
cur = xmlSecGetNextElementNode(pNode->children);
if( cur != nullptr )
cur = xmlSecGetNextElementNode(cur->children);
while( cur != nullptr )
{
// some of those children I suppose should be reference elements
if( xmlSecCheckNodeName(cur, xmlSecNodeReference, xmlSecDSigNs) )
{
xmlSecDSigReferenceCtxPtr pDsigRefCtx =
xmlSecDSigReferenceCtxCreate(pDsigCtx,
xmlSecDSigReferenceOriginSignedInfo);
if(pDsigRefCtx == nullptr)
throw RuntimeException();
// add this one to the list
if( xmlSecPtrListAdd(&(pDsigCtx->signedInfoReferences),
pDsigRefCtx) < 0 )
{
// TODO resource handling
xmlSecDSigReferenceCtxDestroy(pDsigRefCtx);
throw RuntimeException();
}
if( xmlSecDSigReferenceCtxProcessNode(pDsigRefCtx, cur) < 0 )
throw RuntimeException();
// final check - all good?
if(pDsigRefCtx->status != xmlSecDSigStatusSucceeded)
{
pDsigCtx->status = xmlSecDSigStatusInvalid;
return aTemplate; // TODO - harder error?
}
}
cur = xmlSecGetNextElementNode(cur->next);
}
// TODO - also verify manifest (only relevant for ooxml)?
aTemplate->setStatus(SecurityOperationStatus_OPERATION_SUCCEEDED);
// done
xmlSecDSigCtxDestroy( pDsigCtx ) ;
}
//Unregistered the stream/URI binding
if( xUriBinding.is() )
xmlUnregisterStreamInputCallbacks() ;
clearErrorRecorder();
return aTemplate ;
}
/* XServiceInfo */
OUString SAL_CALL XMLSignature_GpgImpl::getImplementationName() {
return impl_getImplementationName() ;
}
/* XServiceInfo */
sal_Bool SAL_CALL XMLSignature_GpgImpl::supportsService( const OUString& serviceName) {
return cppu::supportsService(this, serviceName);
}
/* XServiceInfo */
Sequence< OUString > SAL_CALL XMLSignature_GpgImpl::getSupportedServiceNames() {
return impl_getSupportedServiceNames() ;
}
//Helper for XServiceInfo
Sequence< OUString > XMLSignature_GpgImpl::impl_getSupportedServiceNames() {
::osl::Guard< ::osl::Mutex > aGuard( ::osl::Mutex::getGlobalMutex() ) ;
Sequence<OUString> seqServiceNames { "com.sun.star.xml.crypto.XMLSignature" };
return seqServiceNames ;
}
OUString XMLSignature_GpgImpl::impl_getImplementationName() {
return OUString("com.sun.star.xml.security.bridge.xmlsec.XMLSignature_GpgImpl") ;
}
//Helper for registry
Reference< XInterface > SAL_CALL XMLSignature_GpgImpl::impl_createInstance( const Reference< XMultiServiceFactory >& ) {
return Reference< XInterface >( *new XMLSignature_GpgImpl ) ;
}
Reference< XSingleServiceFactory > XMLSignature_GpgImpl::impl_createFactory( const Reference< XMultiServiceFactory >& aServiceManager ) {
return ::cppu::createSingleFactory( aServiceManager , impl_getImplementationName() , impl_createInstance , impl_getSupportedServiceNames() ) ;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|