summaryrefslogtreecommitdiff
path: root/src/vm/pefingerprint.cpp
blob: 10d28b2dfb8ecd245a06005d1e617f29a5391818 (plain)
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
// --------------------------------------------------------------------------------
// PEFingerprint.cpp
// 

//
//
// Dev11 note on timing of torn state detection:
//
//   This implementation of PEFingerprint contains a known flaw: The MVID/SNHash/TPBand
//   torn state test only occurs after the file is already opened and made available
//   for the runtime to use. In fact, we don't do it until someone asks for a Commit
//   on the fingerprint.
//
//   This is clearly a perversion of the design: however, it was not feasible
//   to do the check beforehand within the current codebase without incurring
//   severe performance costs or major code surgery.
//
//   For Dev11, however, we accept this because of two things:
//
//     - GAC assemblies are installed through gacutil.exe which always timestamps
//       the assembly based on the time of install. Thus, timestamp collisions
//       inside the GAC should not happen unless someone manually tampers with the GAC.
//       Since we do verify the timestamp and lock the file before opening it,
//       it is not a problem that the actual mvid/snhash check happens later than it should.
// --------------------------------------------------------------------------------



#include "common.h"
#include "pefile.h"
#include "pefingerprint.h"

#ifdef FEATURE_FUSION

static VOID ThrowTornState(LPCWSTR path);
static void FetchILTimestampAndSize(LPCWSTR path, FILETIME *pTimestamp, DWORD *pSize, HANDLE hFileHandleIfOpen = INVALID_HANDLE_VALUE);


const size_t PEFingerprint::s_offsets[] =
{
    offsetof(PEFingerprint, m_timeStamp),
    offsetof(PEFingerprint, m_size),
    offsetof(PEFingerprint, m_mvid),
};

const DWORD PEFingerprint::s_sizes[] =
{
    sizeof(((PEFingerprint *)NULL)->m_timeStamp),
    sizeof(((PEFingerprint *)NULL)->m_size),
    sizeof(((PEFingerprint *)NULL)->m_mvid),
};



//---------------------------------------------------------------
// Ctor
//---------------------------------------------------------------
PEFingerprint::PEFingerprint(PEImage *owner) :
   m_pcrst(NULL)
  ,m_peimage(owner)
  ,m_commitMask(0)
  ,m_alreadyLoaded(FALSE)
  ,m_priorLockAndLoadFailure(S_OK)
{

    LIMITED_METHOD_CONTRACT;

    _ASSERTE(owner);

    memset(&m_timeStamp, 0xcc, sizeof(m_timeStamp));
    memset(&m_size, 0xcc, sizeof(m_size));
    memset(&m_mvid, 0xcc, sizeof(m_mvid));

    return;
}


//---------------------------------------------------------------
// PEFingerprint factory
//---------------------------------------------------------------
/*static*/ PEFingerprint *PEFingerprint::CreatePEFingerprint(PEImage *owner)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    NewHolder<PEFingerprint> pPEFingerprint = new PEFingerprint(owner);
    pPEFingerprint->m_pcrst = new Crst(CrstLeafLock);

    //---------------------------------------------------------------
    // Since obtaining the timestamp is cheap and doesn't need to open the
    // file, go ahead and get it now and commit into the fingerprint.
    //
    // @review: Would it be better to lock the file right now to
    // prevent overwriter for the life of the fingerprint?
    //---------------------------------------------------------------
    LPCWSTR path = pPEFingerprint->m_peimage->GetPath();
    _ASSERTE(path);

    FILETIME lastWriteTime;
    DWORD size;
    FetchILTimestampAndSize(path, &lastWriteTime, &size);

    ILFingerprintComponent components[] =
    {
        { ILFTagTimestamp, &lastWriteTime },
        { ILFTagSize, &size },
    };
    BOOL success = pPEFingerprint->CommitAndCompareMulti(COUNTOF(components), components);
    _ASSERTE(success);  // No way this commit can fail - we own the only pointer!
    return pPEFingerprint.Extract();
}



//---------------------------------------------------------------
// Dtor
//---------------------------------------------------------------
PEFingerprint::~PEFingerprint()
{
    LIMITED_METHOD_CONTRACT;
    delete m_pcrst;
    return;
}

//---------------------------------------------------------------
// AddRef
//---------------------------------------------------------------
ULONG PEFingerprint::AddRef()
{
    LIMITED_METHOD_CONTRACT;
    return m_peimage->AddRef();
}

//---------------------------------------------------------------
// Release
//---------------------------------------------------------------
ULONG PEFingerprint::Release()
{
    LIMITED_METHOD_CONTRACT;
    STATIC_CONTRACT_GC_TRIGGERS;
    STATIC_CONTRACT_CAN_TAKE_LOCK;
    return m_peimage->Release();
}

//---------------------------------------------------------------------------------------------
// Convenience fcn: equivalent to calling CommitAndCompareMulti() with one component.
//---------------------------------------------------------------------------------------------
BOOL PEFingerprint::CommitAndCompare(ILFingerprintTag componentType, LPCVOID data)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    ILFingerprintComponent c = {componentType, data};
    return CommitAndCompareMulti(1, &c);
}


 //---------------------------------------------------------------------------------------------
 // CommitAndCompareMulti(): Atomically commits one or more fingerprint components into
 // the fingerprint. Once a component is committed, its value can never change.
 //
 // An attempt to commit a component succeeds only if the component was not already committed
 // or the prior value maches the new one exactly.
 //
 // Calling CommitAndCompare() multiple times is not equivalent to calling CommitAndCompareMulti().
 // CommitAndCompareMulti() is atomic - either all the commits happen or none of them do.
 //
 // Returns:
 //    TRUE:  All passed components committed successful.
 //    FALSE: At leat one component failed to commit successfully.
 //---------------------------------------------------------------------------------------------
BOOL PEFingerprint::CommitAndCompareMulti(UINT numComponents, const ILFingerprintComponent *pComponents)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    //------------------------------------------------------------------------------
    // See "Dev11 note on timing of torn state detection". This step should not be
    // here but this is how we "verify" the MVID/SNHash on IL open. We wait until
    // the first time someone attempts a commit on an opened file to do the check.
    // The caller will think we did the check at file open time, even though we
    // actually left a window of vulnerability.
    //------------------------------------------------------------------------------
    if (!m_alreadyLoaded)
    {
        PEImageHolder pOpenedILimage;
        m_peimage->Clone(MDInternalImport_OnlyLookInCache,&pOpenedILimage);

        if(pOpenedILimage != NULL && pOpenedILimage->IsOpened())
        {

            for (UINT j = 0; j < numComponents; j++)
            {
                // Don't open if we're just checking timestamp (forecloses possible reentrancy problems
                // due to timestamp commits occurring within PEImage itself.)
                ILFingerprintTag tag = pComponents[j]._tag;
                if (tag == ILFTagMvid)
                {
                    this->LockAndLoadIL();
                    break;
                }

            }
        }
    }

    //------------------------------------------------------------------------------
    // Inside the crit section, make sure all the components can successfully commit
    // before commitng any of them.
    //------------------------------------------------------------------------------
    CrstHolder ch(m_pcrst);
    UINT i;
    for (i = 0; i < numComponents; i++)
    {
        ILFingerprintTag tag = pComponents[i]._tag;
        if (IsComponentCommitted(tag))
        {
            if (0 != memcmp(pComponents[i]._data, TagDataStart(tag), TagDataSize(tag)))
                return FALSE;
        }
    }
    for (i = 0; i < numComponents; i++)
    {
        ILFingerprintTag tag = pComponents[i]._tag;
        if (!IsComponentCommitted(tag))
        {
            memcpy(TagDataStart(tag), pComponents[i]._data, TagDataSize(tag));
            SetComponentCommitted(tag);
        }
    }

    return TRUE;
}



//---------------------------------------------------------------------------------------------
// LockAndLoadIL()
//
//   Forces the runtime to open the IL file and lock it against future overwrites. This
//   is bad for working set so this should be avoided.
//
//   Once opened and locked, this method extracts the actual fingerprint from the IL file
//   and attempts to commit it into the ILFingerprint. If successful, all future commits
//   will now be compared against this trusted data. If unsuccessful, this is a torn state
//   situation and LockAndLoadIL() throws the torn state exception.
//---------------------------------------------------------------------------------------------
void PEFingerprint::LockAndLoadIL()
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    //----------------------------------------------------------------------------------
    // If already loaded, return the prior result.
    //----------------------------------------------------------------------------------
    if (m_alreadyLoaded)
    {
        if (FAILED(m_priorLockAndLoadFailure))
        {
            ThrowHR(m_priorLockAndLoadFailure);
        }
        else
        {
            return;
        }
    }
    PEImageHolder pOpenedILimage;
    m_peimage->Clone(MDInternalImport_Default,&pOpenedILimage);
    HRESULT hr = S_OK;
    {
        GCX_PREEMP();
        IfFailThrow(m_peimage->TryOpenFile());
    }
    //----------------------------------------------------------------------------------
    // Force the file open (by requesting a metadata pointer to it.)
    //----------------------------------------------------------------------------------
    IMDInternalImport *pMDImport = NULL;
    EX_TRY
    {
        pMDImport = pOpenedILimage->GetMDImport();
        hr = S_OK;
    }
    EX_CATCH_HRESULT(hr);
    if (Exception::IsTransient(hr))
        ThrowHR(hr);
    if (FAILED(hr))
    {
        m_priorLockAndLoadFailure = hr;
        m_alreadyLoaded = TRUE;
        ThrowHR(hr);
    }

    m_alreadyLoaded = TRUE;

    //------------------------------------------------------------------------------
    // See "Dev11 note on timing of torn state detection". This step should not be
    // here as the "right" design is to extract the actual MVID before we officially
    // open the file. But since we don't do that in the current implementation, we do
    // it now.
    //------------------------------------------------------------------------------
    GUID mvid;
    pOpenedILimage->GetMVID(&mvid);

    BOOL success = this->CommitAndCompare(ILFTagMvid, &mvid);
    if (!success)
        ThrowTornState(m_peimage->GetPath());
}


//==================================================================================
// Helper for throwing a torn state exception.
//==================================================================================
static VOID ThrowTornState(LPCWSTR path)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    COMPlusThrow(kFileLoadException, IDS_EE_TORNSTATE, path);
}

#endif // FEATURE_FUSION




//==================================================================================
// This holder must be wrapped around any code that opens an IL image.
// It will verify that the actual fingerprint doesn't conflict with the stored
// assumptions in the PEFingerprint. (If it does, the holder constructor throws
// a torn state exception.)
//
// It is a holder because it needs to keep a file handle open to prevent
// anyone from overwriting the IL after the check has been done. Once
// you've opened the "real" handle to the IL (i.e. LoadLibrary/CreateFile),
// you can safely destruct the holder.
//==================================================================================
PEFingerprintVerificationHolder::PEFingerprintVerificationHolder(PEImage *owner)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

#ifdef FEATURE_FUSION
    if (owner->IsTrustedNativeImage())
        return;   // Waste of cycles to check timestamps for NI images.


    LPCWSTR path = owner->GetPath();
    _ASSERTE(path);

    if (owner->IsOpened()) 
        return;   // Not the first layout to be opened - no need to repeat the work in that case.

    // First, lock the file and verify that the timestamp hasn't changed.
    TESTHOOKCALL(AboutToLockImage(path, IsCompilationProcess())); 
    m_fileHandle = WszCreateFile(path, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
    if (m_fileHandle == INVALID_HANDLE_VALUE)
    {
        // @review: If this call to open the file fails, it sounds a bit risky to fail the PE open altogether
        //          just to do a torn state check. Let the torn state detection bake a bit before we take this step.
        return;
    }

    FILETIME lastWriteTime;
    DWORD size;
    FetchILTimestampAndSize(path, &lastWriteTime, &size, m_fileHandle);
    ReleaseHolder<IILFingerprint> fingerPrint;
    ILFingerprintComponent components[] =
    {
        { ILFTagTimestamp, &lastWriteTime },
        { ILFTagSize, &size },
    };
    IfFailThrow(owner->GetILFingerprint(&fingerPrint));
    if (!fingerPrint->CommitAndCompareMulti(COUNTOF(components), components))
        ThrowTornState(path);


    // Now, verify that the MVID/SNHash/TPBand hasn't changed.
    // Oh wait, where that'd code go? See "Dev11 note on timing of torn state detection".
#endif // FEATURE_FUSION
    return;
}

#ifdef FEATURE_FUSION
#ifndef DACCESS_COMPILE
class CachingILFingerprintFactory : public IILFingerprintFactory
{
private:
    LONG m_refCount;
    Crst m_lock;

    // Hash Type ... NOTE! This is a case sensitive hash of a filename to an IL fingerprint.
    // This is acceptable as duplicates are not errors, and chosen as case insensitive hashes
    // are somewhat slower, and most hash lookups will actually match in case. If this is not
    // the case, converting to a case-insensitive hash should be trivial.
    typedef StringSHashWithCleanup< IILFingerprint, WCHAR > ILFingerprintHash;
    typedef StringHashElement< IILFingerprint, WCHAR > ILFingerprintHashElement;

    ILFingerprintHash m_hash;

    ~CachingILFingerprintFactory()
    {
    }

public:

    CachingILFingerprintFactory() : m_refCount(1), m_lock(CrstILFingerprintCache)
    {
        CONTRACTL
        {
            THROWS;
            GC_TRIGGERS;
        }
        CONTRACTL_END;
    }

    STDMETHOD_(ULONG, AddRef)()
    {
        CONTRACT(ULONG)
        {
            PRECONDITION(m_refCount>0 && m_refCount < COUNT_T_MAX);
            NOTHROW;
            GC_NOTRIGGER;
        }
        CONTRACT_END;

        RETURN (static_cast<ULONG>(FastInterlockIncrement(&m_refCount)));
    }

    STDMETHOD_(ULONG, Release)()
    {
        CONTRACTL
        {
            DESTRUCTOR_CHECK;
            NOTHROW;
            MODE_ANY;
            FORBID_FAULT;
        }
        CONTRACTL_END;

        ULONG result = 0;
        result=FastInterlockDecrement(&m_refCount);
        if (result == 0)
            delete this;

        return result;
    }

    STDMETHOD(GetILFingerprintForPath)(
        LPCWSTR pwzPath, 
        IILFingerprint **ppFingerprint)
    {
        CONTRACTL
        {
            NOTHROW;
            GC_TRIGGERS;
        }
        CONTRACTL_END;
        HRESULT hr = S_OK;

        EX_TRY
        {
            CrstHolder ch(&m_lock);
            // Lookup in cache
            ILFingerprintHashElement *pCacheElement = m_hash.Lookup(pwzPath);

            // If that fails, run the parser, and populate the cache
            if (pCacheElement != NULL)
            {
                *ppFingerprint = clr::SafeAddRef(pCacheElement->Object);
            }
            else
            {
                // Create new assembly name object;
                ReleaseHolder<IILFingerprint> pFingerprint;
                NewArrayHolder<WCHAR> pwzPathCopy;
                IfFailThrow(RuntimeGetILFingerprintForPath(pwzPath, &pFingerprint));

                // Create hash element object
                NewHolder<ILFingerprintHashElement> pHashElem = new ILFingerprintHashElement();
                pwzPathCopy = DuplicateStringThrowing(pwzPath);
                pHashElem->String = pwzPathCopy;
                pHashElem->Object = pFingerprint;

                // Insert into hash table
                m_hash.Add(pHashElem);

                *ppFingerprint = clr::SafeAddRef(pFingerprint);

                // Prevent disastrous cleanup
                pwzPathCopy.SuppressRelease();
                pHashElem.SuppressRelease();
                pFingerprint.SuppressRelease();
            }
        }
        EX_CATCH_HRESULT(hr);

        return hr;
    }
};

HRESULT RuntimeCreateCachingILFingerprintFactory(IILFingerprintFactory **ppILFingerprintFactory)
{
    CONTRACTL
    {
        NOTHROW;
        GC_TRIGGERS;
    }
    CONTRACTL_END;
    HRESULT hr = S_OK;

    EX_TRY
    {
        *ppILFingerprintFactory = new CachingILFingerprintFactory();
    }
    EX_CATCH_HRESULT(hr);

    return hr;
}

//-------------------------------------------------------------------------------------------------------------
// Common routine to fetch the IL file's timestamp and size. If the caller already has an open file handle, it should
// pass that as "hFileHandleIfOpen" to avoid the overhead of opening the file again.
//-------------------------------------------------------------------------------------------------------------
static void FetchILTimestampAndSize(LPCWSTR path, FILETIME *pTimestamp, DWORD *pSize, HANDLE hFileHandleIfOpen /* = INVALID_HANDLE_VALUE*/)
{
    CONTRACTL
    {
        THROWS; 
        GC_TRIGGERS;
        MODE_ANY;
        SO_INTOLERANT;
        INJECT_FAULT(COMPlusThrowOM();); 
    }
    CONTRACTL_END

    _ASSERTE(pTimestamp != NULL && pSize != NULL);

    if (hFileHandleIfOpen != INVALID_HANDLE_VALUE)
    {
        BY_HANDLE_FILE_INFORMATION info;
        if (!GetFileInformationByHandle(hFileHandleIfOpen, &info))
            ThrowLastError();
        *pTimestamp = info.ftLastWriteTime;
        *pSize = info.nFileSizeLow;
        return;
    }

    // For normal files, we can obtain the timestamp without opening the file - attempt to do so.
    WIN32_FILE_ATTRIBUTE_DATA wfd;
    if (!WszGetFileAttributesEx(path, GetFileExInfoStandard, &wfd))
        ThrowLastError();
    if (!(wfd.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT))
    {
        *pTimestamp = wfd.ftLastWriteTime;
        *pSize = wfd.nFileSizeLow;
        return;
    }

    // If we got here, the original path pointed to a symbolic or some other form of reparse point. In such cases, GetFileAttributesEx
    // may not return the same timestamp as GetFileInformationByHandle. (E.g. in the symbolic link case, GetFileAttributeEx returns
    // the symbolic link's timestamp rather than the target's timestamp.)
    //
    // Since this is the uncommon case, we can justify the perf hit of opening the file so we get the timestamp
    // on the actual target. 
    HandleHolder hFile(WszCreateFile(path, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL));
    if (hFile == INVALID_HANDLE_VALUE)
        ThrowLastError();
    BY_HANDLE_FILE_INFORMATION info;
    if (!GetFileInformationByHandle(hFile, &info))
        ThrowLastError();
    *pTimestamp = info.ftLastWriteTime;
    *pSize = info.nFileSizeLow;
    return;
}

#endif // !DACCESS_COMPILE
#endif // FEATURE_FUSION