LibreOffice Module oox (master)  1
binarycodec.cxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #include "oox/core/binarycodec.hxx"
21 
22 #include <algorithm>
23 #include <string.h>
25 
26 #include <osl/diagnose.h>
29 
30 using namespace ::com::sun::star;
31 
32 namespace oox {
33 namespace core {
34 
35 namespace {
36 
38 template< typename Type >
39 inline void lclRotateLeft( Type& rnValue, size_t nBits )
40 {
41  OSL_ENSURE( nBits < sizeof( Type ) * 8, "lclRotateLeft - rotation count overflow" );
42  rnValue = static_cast< Type >( (rnValue << nBits) | (rnValue >> (sizeof( Type ) * 8 - nBits)) );
43 }
44 
46 template< typename Type >
47 inline void lclRotateLeft( Type& rnValue, size_t nBits, size_t nWidth )
48 {
49  OSL_ENSURE( (nBits < nWidth) && (nWidth < sizeof( Type ) * 8), "lclRotateLeft - rotation count overflow" );
50  Type nMask = static_cast< Type >( (1UL << nWidth) - 1 );
51  rnValue = static_cast< Type >(
52  ((rnValue << nBits) | ((rnValue & nMask) >> (nWidth - nBits))) & nMask );
53 }
54 
55 sal_Int32 lclGetLen( const sal_uInt8* pnPassData, sal_Int32 nBufferSize )
56 {
57  sal_Int32 nLen = 0;
58  while( (nLen < nBufferSize) && pnPassData[ nLen ] ) ++nLen;
59  return nLen;
60 }
61 
62 sal_uInt16 lclGetKey( const sal_uInt8* pnPassData, sal_Int32 nBufferSize )
63 {
64  sal_Int32 nLen = lclGetLen( pnPassData, nBufferSize );
65  if( nLen <= 0 ) return 0;
66 
67  sal_uInt16 nKey = 0;
68  sal_uInt16 nKeyBase = 0x8000;
69  sal_uInt16 nKeyEnd = 0xFFFF;
70  const sal_uInt8* pnChar = pnPassData + nLen - 1;
71  for( sal_Int32 nIndex = 0; nIndex < nLen; ++nIndex, --pnChar )
72  {
73  sal_uInt8 cChar = *pnChar & 0x7F;
74  for( size_t nBit = 0; nBit < 8; ++nBit )
75  {
76  lclRotateLeft( nKeyBase, 1 );
77  if( nKeyBase & 1 ) nKeyBase ^= 0x1020;
78  if( cChar & 1 ) nKey ^= nKeyBase;
79  cChar >>= 1;
80  lclRotateLeft( nKeyEnd, 1 );
81  if( nKeyEnd & 1 ) nKeyEnd ^= 0x1020;
82  }
83  }
84  return nKey ^ nKeyEnd;
85 }
86 
87 sal_uInt16 lclGetHash( const sal_uInt8* pnPassData, sal_Int32 nBufferSize )
88 {
89  sal_Int32 nLen = lclGetLen( pnPassData, nBufferSize );
90 
91  sal_uInt16 nHash = static_cast< sal_uInt16 >( nLen );
92  if( nLen > 0 )
93  nHash ^= 0xCE4B;
94 
95  const sal_uInt8* pnChar = pnPassData;
96  for( sal_Int32 nIndex = 0; nIndex < nLen; ++nIndex, ++pnChar )
97  {
98  sal_uInt16 cChar = *pnChar;
99  size_t nRot = static_cast< size_t >( (nIndex + 1) % 15 );
100  lclRotateLeft( cChar, nRot, 15 );
101  nHash ^= cChar;
102  }
103  return nHash;
104 }
105 
106 } // namespace
107 
108 sal_uInt16 CodecHelper::getPasswordHash( const AttributeList& rAttribs, sal_Int32 nElement )
109 {
110  sal_Int32 nPasswordHash = rAttribs.getIntegerHex( nElement, 0 );
111  OSL_ENSURE( (0 <= nPasswordHash) && (nPasswordHash <= SAL_MAX_UINT16), "CodecHelper::getPasswordHash - invalid password hash" );
112  return static_cast< sal_uInt16 >( ((0 <= nPasswordHash) && (nPasswordHash <= SAL_MAX_UINT16)) ? nPasswordHash : 0 );
113 }
114 
116  meCodecType( eCodecType ),
117  mnOffset( 0 ),
118  mnBaseKey( 0 ),
119  mnHash( 0 )
120 {
121  (void)memset( mpnKey, 0, sizeof( mpnKey ) );
122 }
123 
125 {
126  (void)memset( mpnKey, 0, sizeof( mpnKey ) );
127  mnBaseKey = mnHash = 0;
128 }
129 
130 void BinaryCodec_XOR::initKey( const sal_uInt8 pnPassData[ 16 ] )
131 {
132  // calculate base key and hash from passed password
133  mnBaseKey = lclGetKey( pnPassData, 16 );
134  mnHash = lclGetHash( pnPassData, 16 );
135 
136  static const sal_uInt8 spnFillChars[] =
137  {
138  0xBB, 0xFF, 0xFF, 0xBA,
139  0xFF, 0xFF, 0xB9, 0x80,
140  0x00, 0xBE, 0x0F, 0x00,
141  0xBF, 0x0F, 0x00, 0x00
142  };
143 
144  (void)memcpy( mpnKey, pnPassData, 16 );
145  sal_Int32 nLen = lclGetLen( pnPassData, 16 );
146  const sal_uInt8* pnFillChar = spnFillChars;
147  for (sal_Int32 nIndex = nLen; nIndex < static_cast<sal_Int32>(sizeof(mpnKey)); ++nIndex, ++pnFillChar )
148  mpnKey[ nIndex ] = *pnFillChar;
149 
150  // rotation of key values is application dependent
151  size_t nRotateSize = 0;
152  switch( meCodecType )
153  {
154  case CODEC_WORD: nRotateSize = 7; break;
155  case CODEC_EXCEL: nRotateSize = 2; break;
156  // compiler will warn, if new codec type is introduced and not handled here
157  }
158 
159  // use little-endian base key to create key array
160  sal_uInt8 pnBaseKeyLE[ 2 ];
161  pnBaseKeyLE[ 0 ] = static_cast< sal_uInt8 >( mnBaseKey );
162  pnBaseKeyLE[ 1 ] = static_cast< sal_uInt8 >( mnBaseKey >> 8 );
163  sal_uInt8* pnKeyChar = mpnKey;
164  for (sal_Int32 nIndex = 0; nIndex < static_cast<sal_Int32>(sizeof(mpnKey)); ++nIndex, ++pnKeyChar )
165  {
166  *pnKeyChar ^= pnBaseKeyLE[ nIndex & 1 ];
167  lclRotateLeft( *pnKeyChar, nRotateSize );
168  }
169 }
170 
171 bool BinaryCodec_XOR::initCodec( const uno::Sequence< beans::NamedValue >& aData )
172 {
173  bool bResult = false;
174 
175  ::comphelper::SequenceAsHashMap aHashData( aData );
176  uno::Sequence< sal_Int8 > aKey = aHashData.getUnpackedValueOrDefault("XOR95EncryptionKey", uno::Sequence< sal_Int8 >() );
177 
178  if ( aKey.getLength() == 16 )
179  {
180  (void)memcpy( mpnKey, aKey.getConstArray(), 16 );
181  bResult = true;
182 
183  mnBaseKey = (sal_uInt16)aHashData.getUnpackedValueOrDefault("XOR95BaseKey", (sal_Int16)0 );
184  mnHash = (sal_uInt16)aHashData.getUnpackedValueOrDefault("XOR95PasswordHash", (sal_Int16)0 );
185  }
186  else
187  OSL_FAIL( "Unexpected key size!\n" );
188 
189  return bResult;
190 }
191 
192 uno::Sequence< beans::NamedValue > BinaryCodec_XOR::getEncryptionData()
193 {
195  aHashData[ OUString("XOR95EncryptionKey") ] <<= uno::Sequence<sal_Int8>( reinterpret_cast<sal_Int8*>(mpnKey), 16 );
196  aHashData[ OUString("XOR95BaseKey") ] <<= (sal_Int16)mnBaseKey;
197  aHashData[ OUString("XOR95PasswordHash") ] <<= (sal_Int16)mnHash;
198 
199  return aHashData.getAsConstNamedValueList();
200 }
201 
203 {
204  return (nKey == mnBaseKey) && (nHash == mnHash);
205 }
206 
208 {
209  mnOffset = 0;
210 }
211 
212 void BinaryCodec_XOR::decode( sal_uInt8* pnDestData, const sal_uInt8* pnSrcData, sal_Int32 nBytes )
213 {
214  const sal_uInt8* pnCurrKey = mpnKey + mnOffset;
215  const sal_uInt8* pnKeyLast = mpnKey + 0x0F;
216 
217  // switch/case outside of the for loop (performance)
218  const sal_uInt8* pnSrcDataEnd = pnSrcData + nBytes;
219  switch( meCodecType )
220  {
221  case CODEC_WORD:
222  {
223  for( ; pnSrcData < pnSrcDataEnd; ++pnSrcData, ++pnDestData )
224  {
225  sal_uInt8 nData = *pnSrcData ^ *pnCurrKey;
226  if( (*pnSrcData != 0) && (nData != 0) )
227  *pnDestData = nData;
228  if( pnCurrKey < pnKeyLast ) ++pnCurrKey; else pnCurrKey = mpnKey;
229  }
230  }
231  break;
232  case CODEC_EXCEL:
233  {
234  for( ; pnSrcData < pnSrcDataEnd; ++pnSrcData, ++pnDestData )
235  {
236  *pnDestData = *pnSrcData;
237  lclRotateLeft( *pnDestData, 3 );
238  *pnDestData ^= *pnCurrKey;
239  if( pnCurrKey < pnKeyLast ) ++pnCurrKey; else pnCurrKey = mpnKey;
240  }
241  }
242  break;
243  // compiler will warn, if new codec type is introduced and not handled here
244  }
245 
246  // update offset and leave
247  skip( nBytes );
248 }
249 
250 bool BinaryCodec_XOR::skip( sal_Int32 nBytes )
251 {
252  mnOffset = static_cast< sal_Int32 >( (mnOffset + nBytes) & 0x0F );
253  return true;
254 }
255 
257 {
258  mhCipher = rtl_cipher_create( rtl_Cipher_AlgorithmARCFOUR, rtl_Cipher_ModeStream );
259  OSL_ENSURE( mhCipher != nullptr, "BinaryCodec_RCF::BinaryCodec_RCF - cannot create cipher" );
260 
261  mhDigest = rtl_digest_create( rtl_Digest_AlgorithmMD5 );
262  OSL_ENSURE( mhDigest != nullptr, "BinaryCodec_RCF::BinaryCodec_RCF - cannot create digest" );
263 
264  (void)memset( mpnDigestValue, 0, sizeof( mpnDigestValue ) );
265  (void)memset (mpnUnique, 0, sizeof(mpnUnique));
266 }
267 
269 {
270  (void)memset( mpnDigestValue, 0, sizeof( mpnDigestValue ) );
271  (void)memset (mpnUnique, 0, sizeof(mpnUnique));
272  rtl_digest_destroy( mhDigest );
273  rtl_cipher_destroy( mhCipher );
274 }
275 
276 bool BinaryCodec_RCF::initCodec( const uno::Sequence< beans::NamedValue >& aData )
277 {
278  bool bResult = false;
279 
280  ::comphelper::SequenceAsHashMap aHashData( aData );
281  uno::Sequence< sal_Int8 > aKey = aHashData.getUnpackedValueOrDefault("STD97EncryptionKey", uno::Sequence< sal_Int8 >() );
282 
283  if ( aKey.getLength() == RTL_DIGEST_LENGTH_MD5 )
284  {
285  (void)memcpy( mpnDigestValue, aKey.getConstArray(), RTL_DIGEST_LENGTH_MD5 );
286  uno::Sequence< sal_Int8 > aUniqueID = aHashData.getUnpackedValueOrDefault("STD97UniqueID", uno::Sequence< sal_Int8 >() );
287  if ( aUniqueID.getLength() == 16 )
288  {
289  (void)memcpy( mpnUnique, aUniqueID.getConstArray(), 16 );
290  bResult = false;
291  }
292  else
293  OSL_FAIL( "Unexpected document ID!\n" );
294  }
295  else
296  OSL_FAIL( "Unexpected key size!\n" );
297 
298  return bResult;
299 }
300 
301 uno::Sequence< beans::NamedValue > BinaryCodec_RCF::getEncryptionData()
302 {
304  aHashData[ OUString("STD97EncryptionKey") ] <<= uno::Sequence< sal_Int8 >( reinterpret_cast<sal_Int8*>(mpnDigestValue), RTL_DIGEST_LENGTH_MD5 );
305  aHashData[ OUString("STD97UniqueID") ] <<= uno::Sequence< sal_Int8 >( reinterpret_cast<sal_Int8*>(mpnUnique), 16 );
306 
307  return aHashData.getAsConstNamedValueList();
308 }
309 
310 void BinaryCodec_RCF::initKey( const sal_uInt16 pnPassData[ 16 ], const sal_uInt8 pnSalt[ 16 ] )
311 {
312  uno::Sequence< sal_Int8 > aKey = ::comphelper::DocPasswordHelper::GenerateStd97Key( pnPassData, uno::Sequence< sal_Int8 >( reinterpret_cast<sal_Int8 const *>(pnSalt), 16 ) );
313  // Fill raw digest of above updates into DigestValue.
314 
315  if ( aKey.getLength() == sizeof(mpnDigestValue) )
316  (void)memcpy ( mpnDigestValue, aKey.getConstArray(), sizeof(mpnDigestValue) );
317  else
318  memset( mpnDigestValue, 0, sizeof(mpnDigestValue) );
319 
320  (void)memcpy( mpnUnique, pnSalt, 16 );
321 }
322 
323 bool BinaryCodec_RCF::verifyKey( const sal_uInt8 pnVerifier[ 16 ], const sal_uInt8 pnVerifierHash[ 16 ] )
324 {
325  if( !startBlock( 0 ) )
326  return false;
327 
328  sal_uInt8 pnDigest[ RTL_DIGEST_LENGTH_MD5 ];
329  sal_uInt8 pnBuffer[ 64 ];
330 
331  // decode salt data into buffer
332  rtl_cipher_decode( mhCipher, pnVerifier, 16, pnBuffer, sizeof( pnBuffer ) );
333 
334  pnBuffer[ 16 ] = 0x80;
335  (void)memset( pnBuffer + 17, 0, sizeof( pnBuffer ) - 17 );
336  pnBuffer[ 56 ] = 0x80;
337 
338  // fill raw digest of buffer into digest
339  rtl_digest_updateMD5( mhDigest, pnBuffer, sizeof( pnBuffer ) );
340  rtl_digest_rawMD5( mhDigest, pnDigest, sizeof( pnDigest ) );
341 
342  // decode original salt digest into buffer
343  rtl_cipher_decode( mhCipher, pnVerifierHash, 16, pnBuffer, sizeof( pnBuffer ) );
344 
345  // compare buffer with computed digest
346  bool bResult = memcmp( pnBuffer, pnDigest, sizeof( pnDigest ) ) == 0;
347 
348  // erase buffer and digest arrays and leave
349  rtl_secureZeroMemory (pnBuffer, sizeof(pnBuffer));
350  rtl_secureZeroMemory (pnDigest, sizeof(pnDigest));
351  return bResult;
352 }
353 
354 bool BinaryCodec_RCF::startBlock( sal_Int32 nCounter )
355 {
356  // initialize key data array
357  sal_uInt8 pnKeyData[ 64 ];
358  (void)memset( pnKeyData, 0, sizeof( pnKeyData ) );
359 
360  // fill 40 bit of digest value into [0..4]
361  (void)memcpy( pnKeyData, mpnDigestValue, 5 );
362 
363  // fill little-endian counter into [5..8], static_cast masks out unneeded bits
364  pnKeyData[ 5 ] = static_cast< sal_uInt8 >( nCounter );
365  pnKeyData[ 6 ] = static_cast< sal_uInt8 >( nCounter >> 8 );
366  pnKeyData[ 7 ] = static_cast< sal_uInt8 >( nCounter >> 16 );
367  pnKeyData[ 8 ] = static_cast< sal_uInt8 >( nCounter >> 24 );
368 
369  pnKeyData[ 9 ] = 0x80;
370  pnKeyData[ 56 ] = 0x48;
371 
372  // fill raw digest of key data into key data
373  (void)rtl_digest_updateMD5( mhDigest, pnKeyData, sizeof( pnKeyData ) );
374  (void)rtl_digest_rawMD5( mhDigest, pnKeyData, RTL_DIGEST_LENGTH_MD5 );
375 
376  // initialize cipher with key data (for decoding)
377  rtlCipherError eResult =
378  rtl_cipher_init( mhCipher, rtl_Cipher_DirectionDecode, pnKeyData, RTL_DIGEST_LENGTH_MD5, nullptr, 0 );
379 
380  // erase key data array and leave
381  rtl_secureZeroMemory (pnKeyData, sizeof(pnKeyData));
382  return eResult == rtl_Cipher_E_None;
383 }
384 
385 bool BinaryCodec_RCF::decode( sal_uInt8* pnDestData, const sal_uInt8* pnSrcData, sal_Int32 nBytes )
386 {
387  rtlCipherError eResult = rtl_cipher_decode( mhCipher,
388  pnSrcData, static_cast< sal_Size >( nBytes ),
389  pnDestData, static_cast< sal_Size >( nBytes ) );
390  return eResult == rtl_Cipher_E_None;
391 }
392 
393 void BinaryCodec_RCF::skip( sal_Int32 nBytes )
394 {
395  // decode dummy data in memory to update internal state of RC4 cipher
396  sal_uInt8 pnDummy[ 1024 ];
397  sal_Int32 nBytesLeft = nBytes;
398  bool bResult = true;
399  while( bResult && (nBytesLeft > 0) )
400  {
401  sal_Int32 nBlockLen = ::std::min( nBytesLeft, static_cast< sal_Int32 >( sizeof( pnDummy ) ) );
402  bResult = decode( pnDummy, pnDummy, nBlockLen );
403  nBytesLeft -= nBlockLen;
404  }
405 }
406 
407 } // namespace core
408 } // namespace oox
409 
410 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void decode(sal_uInt8 *pnDestData, const sal_uInt8 *pnSrcData, sal_Int32 nBytes)
Decodes a block of memory.
Type
css::uno::Sequence< css::beans::NamedValue > getEncryptionData()
Retrieves the encryption data.
signed char sal_Int8
void startBlock()
Reinitializes the codec to start a new memory block.
sal_Int32 mnOffset
Key offset.
OOX_DLLPUBLIC sal_uInt16 getPasswordHash(const AttributeList &rAttribs, sal_Int32 nElement)
Returns the password hash if it is in the required 16-bit limit.
BinaryCodec_XOR(CodecType eCodecType)
Default constructor.
sal_uInt8 mpnKey[16]
Encryption key.
BinaryCodec_RCF()
Default constructor.
bool startBlock(sal_Int32 nCounter)
Rekeys the codec using the specified counter.
bool initCodec(const css::uno::Sequence< css::beans::NamedValue > &aData)
Initializes the algorithm with the encryption data.
bool decode(sal_uInt8 *pnDestData, const sal_uInt8 *pnSrcData, sal_Int32 nBytes)
Decodes a block of memory.
void skip(sal_Int32 nBytes)
Lets the cipher skip a specific amount of bytes.
#define SAL_MAX_UINT16
const css::uno::Sequence< css::beans::NamedValue > getAsConstNamedValueList() const
sal_uInt16 mnBaseKey
Base key from password.
TValueType getUnpackedValueOrDefault(const OUString &sKey, const TValueType &aDefault) const
bool skip(sal_Int32 nBytes)
Lets the cipher skip a specific amount of bytes.
void initKey(const sal_uInt8 pnPassData[16])
Initializes the algorithm with the specified password.
CodecType meCodecType
Codec type.
bool verifyKey(const sal_uInt8 pnVerifier[16], const sal_uInt8 pnVerifierHash[16])
Verifies the validity of the password using the passed salt data.
static css::uno::Sequence< sal_Int8 > GenerateStd97Key(const OUString &aPassword, const css::uno::Sequence< sal_Int8 > &aDocId)
bool initCodec(const css::uno::Sequence< css::beans::NamedValue > &aData)
Initializes the algorithm with the encryption data.
sal_uInt16 mnHash
Hash value from password.
Provides access to attribute values of an element.
css::uno::Sequence< css::beans::NamedValue > getEncryptionData()
Retrieves the encryption data.
sal_uInt8 mpnDigestValue[RTL_DIGEST_LENGTH_MD5]
unsigned short sal_uInt16
OptValue< sal_Int32 > getIntegerHex(sal_Int32 nAttrToken) const
Returns the 32-bit signed integer value of the specified attribute (hexadecimal). ...
unsigned char sal_uInt8
void initKey(const sal_uInt16 pnPassData[16], const sal_uInt8 pnSalt[16])
Initializes the algorithm with the specified password and document ID.
GUIDCNamePair aData
Definition: olehelper.cxx:99
CodecType
Enumerates codec types supported by this XOR codec implementation.
Definition: binarycodec.hxx:55
bool verifyKey(sal_uInt16 nKey, sal_uInt16 nHash) const
Verifies the validity of the password using the passed key and hash.
typedef void(CALLTYPE *GetFuncDataPtr)(sal_uInt16 &nNo