/
WinHTTPWrappers.h
1412 lines (1207 loc) · 53.2 KB
/
WinHTTPWrappers.h
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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Module : WinHTTPWrappers.H
Purpose: Defines the interface for a set of MFC class which encapsulate WinHTTP. The classes are based on
the MSDN Magazine article by Kenny Kerr at http://msdn.microsoft.com/en-gb/magazine/cc716528.aspx
History: PJN / 30-05-2011 1. All tracing in CWinHTTPHandle::OnCallback has been moved into a new TraceCallback
method which client code is free to call. Also all tracing in CWinHTTPHandle::
OnCallbackComplete has been moved into a new TraceCallbackComplete method. Also all
tracing in CDownloadFileWinHttpRequest::OnCallbackComplete has been moved into a new
TraceCallbackComplete method.
2. Moved cleanup of resources from CDownloadFileWinHttpRequest::OnCallbackComplete
to a new public method called ReleaseResources()
PJN / 30-07-2011 1. CDownloadFileWinHttpRequest class is now called CAsyncWinHttpDownloader
2. Major rework of the CAsyncWinHttpDownloader to now support HTTP and Proxy
authentication, pre-authentication, resumed downloads, file uploads, in-memory arrays
and bandwidth throttling.
3. Fixed an issue in TraceCallback where WINHTTP_CALLBACK_STATUS_SECURE_FAILURE would
be reported incorrectly by TRACE statements
4. Addition of a new CSyncWinHttpDownloader class which provides for synchronous
WinHTTP downloads.
5. Updated the sample app to allow all of the new configuration settings of
CAsyncWinHttpDownloader and CSyncWinHttpDownloader classes to be exercised.
6. Fixed a bug in CWinHTTPRequest::WriteData() where buffer parameter was incorrectly
set as a LPVOID instead of a LPCVOID.
PJN / 30-03-2013 1. Updated copyright details.
2. Updated the sample app to correctly release the file handles when the file is
downloaded. Thanks to David Lowndes for reporting this bug.
3. Updated the code to clean compile on VC 2012
4. TimeSinceStartDownload() method has been extended to return a __int64 return value
instead of a DWORD.
5. Changed class names to use C*WinHTTP* prefix instead of C*WinHttp*.
PJN / 01-12-2013 1. Updated the code to clean compile on VC 2013.
PJN / 08-06-2014 1. Updated copyright details.
2. Updated CAsyncWinHTTPDownloader::Initialize to allow the dwShareMode parameter of
the ATL::CAtlFile::Create call for the file instances to be download and uploaded to
be customized. The default value for the share mode is now 0 instead of FILE_SHARE_READ.
Thanks to Simon Orde for providing this nice addition.
3. All the class methods have had SAL annotations added
Copyright (c) 2011 - 2014 by PJ Naughter (Web: www.naughter.com, Email: pjna@naughter.com)
All rights reserved.
Copyright / Usage Details:
You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise)
when your product is released in binary form. You are allowed to modify the source code in any way you want
except you cannot modify the copyright details at the top of each module. If you want to distribute source
code with your application, then you are only allowed to distribute versions released by the author. This is
to maintain a single distribution point for the source code.
*/
////////////////////////////////// Macros ///////////////////////////
#ifndef __WINHTTPWRAPPERS_H__
#define __WINHTTPWRAPPERS_H__
#ifndef CWINHTTPWRAPPERS_EXT_CLASS
#define CWINHTTPWRAPPERS_EXT_CLASS
#endif
#ifndef _Out_writes_bytes_to_opt_
#define _Out_writes_bytes_to_opt_(size,count) OUT OPTIONAL
#endif
#ifndef _Out_writes_bytes_to_
#define _Out_writes_bytes_to_(size,count) OUT
#endif
#ifndef _In_reads_opt_
#define _In_reads_opt_(size) _In_opt_
#endif
#ifndef _In_reads_bytes_opt_
#define _In_reads_bytes_opt_(size) _In_opt_
#endif
#ifndef _In_reads_bytes_
#define _In_reads_bytes_(size) _In_
#endif
/////////////////////////// Includes ////////////////////////////////
#ifndef _WINHTTPX_
#pragma message("To avoid this message, please put WinHttp.h in your pre compiled header (normally stdafx.h)")
#include <WinHttp.h>
#endif
#ifndef __ATLFILE_H__
#pragma message("To avoid this message, please put atlfile.h in your pre compiled header (normally stdafx.h)")
#include <atlFile.h>
#endif
#ifndef __AFXMT_H__
#pragma message("To avoid this message, please put afxmt.h in your pre compiled header (normally stdafx.h)")
#include <afxmt.h>
#endif
/////////////////////////// Classes /////////////////////////////////
//Wrapper for a WinHttp HINTERNET handle
class CWINHTTPWRAPPERS_EXT_CLASS CWinHTTPHandle
{
public:
//Constructors / Destructors
CWinHTTPHandle() : m_h(NULL)
{
}
CWinHTTPHandle(_In_ CWinHTTPHandle& h) : m_h(NULL)
{
Attach(h.Detach());
}
explicit CWinHTTPHandle(_In_ HINTERNET h) : m_h(h)
{
}
~CWinHTTPHandle()
{
if (m_h != NULL)
Close();
}
CWinHTTPHandle& operator=(_In_ CWinHTTPHandle& h)
{
if (this != &h)
{
if (m_h != NULL)
Close();
Attach(h.Detach());
}
return *this;
}
//Methods
operator HINTERNET() const
{
return m_h;
}
void Attach(_In_ HINTERNET h)
{
ATLASSUME(m_h == NULL);
m_h = h;
}
HINTERNET Detach()
{
HINTERNET h = m_h;
m_h = NULL;
return h;
}
void Close()
{
if (m_h != NULL)
{
WinHttpCloseHandle(m_h);
m_h = NULL;
}
}
HRESULT QueryOption(IN DWORD dwOption, _Out_writes_bytes_to_opt_(dwBufferLength, dwBufferLength) __out_data_source(NETWORK) void* pBuffer, IN OUT DWORD& dwBufferLength)
{
if (!WinHttpQueryOption(m_h, dwOption, pBuffer, &dwBufferLength))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT SetOption(_In_ DWORD dwOption,
#ifdef _When
_When_(((dwOption == WINHTTP_OPTION_USERNAME) || (dwOption == WINHTTP_OPTION_PASSWORD) ||
(dwOption == WINHTTP_OPTION_PROXY_USERNAME) || (dwOption == WINHTTP_OPTION_PROXY_PASSWORD) ||
(dwOption == WINHTTP_OPTION_USER_AGENT)), _At_((LPCWSTR)pBuffer, _In_reads_(dwBufferLength)))
_When_(((dwOption != WINHTTP_OPTION_USERNAME) && (dwOption != WINHTTP_OPTION_PASSWORD) &&
(dwOption != WINHTTP_OPTION_PROXY_USERNAME) && (dwOption != WINHTTP_OPTION_PROXY_PASSWORD) &&
(dwOption != WINHTTP_OPTION_USER_AGENT)), _In_reads_bytes_(dwBufferLength)) void* pBuffer,
#else
_In_ void* pBuffer,
#endif
_In_ DWORD dwBufferLength)
{
if (!WinHttpSetOption(m_h, dwOption, pBuffer, dwBufferLength))
return ATL::AtlHresultFromLastError();
return S_OK;
}
WINHTTP_STATUS_CALLBACK SetStatusCallback(_In_ WINHTTP_STATUS_CALLBACK lpfnInternetCallback, _In_ DWORD dwNotificationFlags = WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS)
{
return WinHttpSetStatusCallback(m_h, lpfnInternetCallback, dwNotificationFlags, NULL);
}
WINHTTP_STATUS_CALLBACK SetStatusCallback(_In_ DWORD dwNotificationFlags = WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS)
{
return SetStatusCallback(_Callback, dwNotificationFlags);
}
//Member variables
HINTERNET m_h;
protected:
//Methods
static void CALLBACK _Callback(_In_ HINTERNET hInternet, _In_ DWORD_PTR dwContext, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
//Check to see if we have a context value
if (dwContext != 0)
{
//Convert from the SDK world to the C++ world.
CWinHTTPHandle* pThis = reinterpret_cast<CWinHTTPHandle*>(dwContext);
//Call the virtual "OnCallback" method
HRESULT hr = pThis->OnCallback(hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
//If the "Callback" method failed called the "OnCallbackComplete" method
if (FAILED(hr))
pThis->OnCallbackComplete(hr, hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
}
}
#ifdef _DEBUG
static void TraceCallback(_In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
switch (dwInternetStatus)
{
case WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION:
{
ATLTRACE(_T("Closing the connection to the server, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER:
{
ATLTRACE(_T("Successfully connected to the server:%ls, Handle:%p\n"), static_cast<LPWSTR>(lpvStatusInformation), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER:
{
ATLTRACE(_T("Connecting to the server:%ls, Handle:%p\n"), static_cast<LPWSTR>(lpvStatusInformation), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED:
{
ATLTRACE(_T("Successfully closed the connection to the server, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Data is available to be retrieved, Handle:%p, Data Available:%u\n"), hInternet, *(static_cast<DWORD*>(lpvStatusInformation)));
break;
}
case WINHTTP_CALLBACK_STATUS_HANDLE_CREATED:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Handle created, Handle:%p\n"), *(static_cast<HINTERNET*>(lpvStatusInformation)));
break;
}
case WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Handle closing, Handle:%p\n"), *(static_cast<HINTERNET*>(lpvStatusInformation)));
break;
}
case WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE:
{
ATLTRACE(_T("The response header has been received, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Received an intermediate (100 level) status code message from the server, Handle:%p, Status:%u\n"), hInternet, *(static_cast<DWORD*>(lpvStatusInformation)));
break;
}
case WINHTTP_CALLBACK_STATUS_NAME_RESOLVED:
{
ATLTRACE(_T("Successfully found the IP address of the server:%ls, Handle:%p\n"), static_cast<LPWSTR>(lpvStatusInformation), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_READ_COMPLETE:
{
ATLTRACE(_T("Data was successfully read from the server, Data Read:%u, Handle:%p\n"), dwStatusInformationLength, hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE:
{
ATLTRACE(_T("Waiting for the server to respond to a request, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_REDIRECT:
{
ATLTRACE(_T("An HTTP request is about to automatically redirect the request to %ls, Handle:%p\n"), static_cast<LPWSTR>(lpvStatusInformation), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_REQUEST_ERROR:
{
ATLASSUME(lpvStatusInformation != NULL);
WINHTTP_ASYNC_RESULT* pResult = static_cast<WINHTTP_ASYNC_RESULT*>(lpvStatusInformation);
ATLTRACE(_T("An error occurred while sending an HTTP request, Error:%u, Handle:%p\n"), pResult->dwError, hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_REQUEST_SENT:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Successfully sent the information request to the server, Data Sent:%u, Handle:%p\n"), *(static_cast<DWORD*>(lpvStatusInformation)), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_RESOLVING_NAME:
{
ATLTRACE(_T("Looking up the IP address of a server name:%ls, Handle:%p\n"), static_cast<LPWSTR>(lpvStatusInformation), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Successfully received a response from the server, Data Received:%u, Handle:%p\n"), *(static_cast<DWORD*>(lpvStatusInformation)), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_SECURE_FAILURE:
{
ATLASSUME(lpvStatusInformation != NULL);
DWORD dwStatusInformation = *(static_cast<DWORD*>(lpvStatusInformation));
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_CERT_REV_FAILED)
{
ATLTRACE(_T("Certification revocation checking has been enabled, but the revocation check failed to verify whether a certificate has been revoked, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CERT)
{
ATLTRACE(_T("SSL certificate is invalid, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_CERT_REVOKED)
{
ATLTRACE(_T("SSL certificate was revoked, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CA)
{
ATLTRACE(_T("The function is unfamiliar with the Certificate Authority that generated the server's certificate, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_CERT_CN_INVALID)
{
ATLTRACE(_T("SSL certificate common name (host name field) is incorrect, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_CERT_DATE_INVALID)
{
ATLTRACE(_T("SSL certificate date that was received from the server is bad. The certificate is expired, Handle:%p\n"), hInternet);
}
if (dwStatusInformation & WINHTTP_CALLBACK_STATUS_FLAG_SECURITY_CHANNEL_ERROR)
{
ATLTRACE(_T("The application experienced an internal error loading the SSL libraries, Handle:%p\n"), hInternet);
}
break;
}
case WINHTTP_CALLBACK_STATUS_SENDING_REQUEST:
{
ATLTRACE(_T("Sending the information request to the server, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE:
{
ATLTRACE(_T("The request completed successfully, Handle:%p\n"), hInternet);
break;
}
case WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE:
{
ATLASSUME(lpvStatusInformation != NULL);
ATLTRACE(_T("Data was successfully written to the server, Data Written:%u, Handle:%p\n"), *(static_cast<DWORD*>(lpvStatusInformation)), hInternet);
break;
}
default:
{
ATLTRACE(_T("Unknown status:%08X, Handle:%p\n"), dwInternetStatus, hInternet);
break;
}
}
}
#endif
virtual HRESULT OnCallback(_In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
UNREFERENCED_PARAMETER(hInternet);
UNREFERENCED_PARAMETER(dwInternetStatus);
UNREFERENCED_PARAMETER(lpvStatusInformation);
UNREFERENCED_PARAMETER(dwStatusInformationLength);
return S_FALSE; //S_FALSE means not handled in our callback
}
#ifdef _DEBUG
static void TraceCallbackComplete(_In_ HRESULT hr, _In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
UNREFERENCED_PARAMETER(lpvStatusInformation);
UNREFERENCED_PARAMETER(dwStatusInformationLength);
ATLTRACE(_T("CWinHTTPHandle::TraceCallbackComplete, HRESULT:%08X, InternetStatus:%08X, Handle:%p\n"), hr, dwInternetStatus, hInternet);
}
#endif
virtual HRESULT OnCallbackComplete(_In_ HRESULT hr, _In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
UNREFERENCED_PARAMETER(hr);
UNREFERENCED_PARAMETER(hInternet);
UNREFERENCED_PARAMETER(dwInternetStatus);
UNREFERENCED_PARAMETER(lpvStatusInformation);
UNREFERENCED_PARAMETER(dwStatusInformationLength);
return E_NOTIMPL;
}
};
//Wrapper for a WinHttp Session HINTERNET handle
class CWINHTTPWRAPPERS_EXT_CLASS CWinHTTPSession : public CWinHTTPHandle
{
public:
//Methods
HRESULT Initialize(_In_opt_z_ LPCWSTR pwszUserAgent, _In_ DWORD dwAccessType = WINHTTP_ACCESS_TYPE_DEFAULT_PROXY, _In_opt_z_ LPCWSTR pwszProxyName = WINHTTP_NO_PROXY_NAME,
_In_opt_z_ LPCWSTR pwszProxyBypass = WINHTTP_NO_PROXY_BYPASS, _In_ DWORD dwFlags = WINHTTP_FLAG_ASYNC)
{
HINTERNET hSession = WinHttpOpen(pwszUserAgent, dwAccessType, pwszProxyName, pwszProxyBypass, dwFlags);
if (hSession == NULL)
return ATL::AtlHresultFromLastError();
Attach(hSession);
return S_OK;
}
HRESULT GetProxyForUrl(_In_ LPCWSTR lpcwszUrl, _In_ WINHTTP_AUTOPROXY_OPTIONS& AutoProxyOptions, _Out_ DWORD& dwAccessType, _Out_ CStringW& sProxy, _Out_ CStringW& sProxyBypass)
{
WINHTTP_PROXY_INFO proxyInfo;
if (!WinHttpGetProxyForUrl(m_h, lpcwszUrl, &AutoProxyOptions, &proxyInfo))
return ATL::AtlHresultFromLastError();
//Update the output parameters
dwAccessType = proxyInfo.dwAccessType;
sProxy = proxyInfo.lpszProxy;
sProxyBypass = proxyInfo.lpszProxyBypass;
//Free up the allocated memory
if (proxyInfo.lpszProxy != NULL)
GlobalFree(proxyInfo.lpszProxy);
if (proxyInfo.lpszProxyBypass != NULL)
GlobalFree(proxyInfo.lpszProxyBypass);
return S_OK;
}
HRESULT SetTimeouts(_In_ int dwResolveTimeout, _In_ int dwConnectTimeout, _In_ int dwSendTimeout, _In_ int dwReceiveTimeout)
{
if (!WinHttpSetTimeouts(m_h, dwResolveTimeout, dwConnectTimeout, dwSendTimeout, dwReceiveTimeout))
return ATL::AtlHresultFromLastError();
return S_OK;
}
};
//Wrapper for a WinHttp connection HINTERNET handle
class CWINHTTPWRAPPERS_EXT_CLASS CWinHTTPConnection : public CWinHTTPHandle
{
public:
//Methods
HRESULT Initialize(_In_ const CWinHTTPSession& session, _In_z_ LPCWSTR pwszServerName, _In_ INTERNET_PORT nServerPort = INTERNET_DEFAULT_PORT)
{
HINTERNET hConnection = WinHttpConnect(session, pwszServerName, nServerPort, 0);
if (hConnection == NULL)
return ATL::AtlHresultFromLastError();
Attach(hConnection);
return S_OK;
}
};
//Wrapper for a WinHttp request HINTERNET handle
class CWINHTTPWRAPPERS_EXT_CLASS CWinHTTPRequest : public CWinHTTPHandle
{
public:
//Methods
HRESULT Initialize(_In_ const CWinHTTPConnection& connection, _In_z_ LPCWSTR pwszObjectName, _In_opt_z_ LPCWSTR pwszVerb = NULL, _In_opt_z_ LPCWSTR pwszVersion = NULL, _In_opt_z_ LPCWSTR pwszReferrer = WINHTTP_NO_REFERER,
_In_opt_ LPCWSTR* ppwszAcceptTypes = WINHTTP_DEFAULT_ACCEPT_TYPES, _In_ DWORD dwFlags = 0)
{
HINTERNET hRequest = WinHttpOpenRequest(connection, pwszVerb, pwszObjectName, pwszVersion, pwszReferrer, ppwszAcceptTypes, dwFlags);
if (hRequest == NULL)
return ATL::AtlHresultFromLastError();
Attach(hRequest);
return S_OK;
}
HRESULT AddHeaders(
#ifdef _When_
_When_(dwHeadersLength == (DWORD)-1, _In_z_)
_When_(dwHeadersLength != (DWORD)-1, _In_reads_(dwHeadersLength)) LPCWSTR pwszHeaders,
#else
_In_ LPCWSTR pwszHeaders,
#endif
_In_ DWORD dwHeadersLength, _In_ DWORD dwModifiers)
{
//Validate our parameters
ATLASSUME(m_h != NULL);
if (!WinHttpAddRequestHeaders(m_h, pwszHeaders, dwHeadersLength, dwModifiers))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT QueryAuthSchemes(_Out_ DWORD& dwSupportedSchemes, _Out_ DWORD& dwFirstScheme, _Out_ DWORD& dwAuthTarget)
{
if (!WinHttpQueryAuthSchemes(m_h, &dwSupportedSchemes, &dwFirstScheme, &dwAuthTarget))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT QueryDataAvailable(__out_data_source(NETWORK) DWORD* lpdwNumberOfBytesAvailable)
{
if (!WinHttpQueryDataAvailable(m_h, lpdwNumberOfBytesAvailable))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT QueryHeaders(IN DWORD dwInfoLevel, IN LPCWSTR pwszName OPTIONAL, _Out_writes_bytes_to_opt_(dwBufferLength, dwBufferLength) __out_data_source(NETWORK) LPVOID lpBuffer, IN OUT DWORD& dwBufferLength, IN OUT DWORD* lpdwIndex OPTIONAL)
{
if (!WinHttpQueryHeaders(m_h, dwInfoLevel, pwszName, lpBuffer, &dwBufferLength, lpdwIndex))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT ReadData(_Out_writes_bytes_to_(dwNumberOfBytesToRead, *lpdwNumberOfBytesRead) __out_data_source(INTERNET) LPVOID lpBuffer, IN DWORD dwNumberOfBytesToRead, OUT DWORD* lpdwNumberOfBytesRead)
{
if (!WinHttpReadData(m_h, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT ReceiveResponse()
{
if (!WinHttpReceiveResponse(m_h, NULL))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT SendRequest(_In_reads_opt_(dwHeadersLength) LPCWSTR pwszHeaders = WINHTTP_NO_ADDITIONAL_HEADERS, _In_ DWORD dwHeadersLength = 0, _In_reads_bytes_opt_(dwOptionalLength) LPVOID lpOptional = WINHTTP_NO_REQUEST_DATA, _In_ DWORD dwOptionalLength = 0, _In_ DWORD dwTotalLength = 0, _In_ DWORD_PTR dwContext = 0)
{
if (!WinHttpSendRequest(m_h, pwszHeaders, dwHeadersLength, lpOptional, dwOptionalLength, dwTotalLength, dwContext))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT SetCredentials(_In_ DWORD AuthTargets, _In_ DWORD AuthScheme, _In_ LPCWSTR pwszUserName, _In_ LPCWSTR pwszPassword)
{
if (!WinHttpSetCredentials(m_h, AuthTargets, AuthScheme, pwszUserName, pwszPassword, NULL))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT SetTimeouts(_In_ int dwResolveTimeout, _In_ int dwConnectTimeout, _In_ int dwSendTimeout, _In_ int dwReceiveTimeout)
{
if (!WinHttpSetTimeouts(m_h, dwResolveTimeout, dwConnectTimeout, dwSendTimeout, dwReceiveTimeout))
return ATL::AtlHresultFromLastError();
return S_OK;
}
HRESULT WriteData(_In_reads_bytes_opt_(dwNumberOfBytesToWrite) LPCVOID lpBuffer, _In_ DWORD dwNumberOfBytesToWrite, _Out_opt_ DWORD* lpdwNumberOfBytesWritten)
{
if (!WinHttpWriteData(m_h, lpBuffer, dwNumberOfBytesToWrite, lpdwNumberOfBytesWritten))
return ATL::AtlHresultFromLastError();
return S_OK;
}
};
//Wrapper for a simple WinHttp async download
class CWINHTTPWRAPPERS_EXT_CLASS CAsyncWinHTTPDownloader : public CWinHTTPRequest
{
public:
//Constructors / Destructors
CAsyncWinHTTPDownloader() : m_dwReadBufferLength(0),
m_dwWriteBufferLength(0),
m_dwProxyPreauthenticationScheme(WINHTTP_AUTH_SCHEME_NEGOTIATE),
m_dwHTTPPreauthenticationScheme(WINHTTP_AUTH_SCHEME_NEGOTIATE),
m_bProxyPreauthentication(TRUE),
m_bHTTPPreauthentication(TRUE),
m_nDownloadStartPos(0),
m_dwLastStatusCode(0),
m_pOptionalBuffer(NULL),
m_dwOptionalBufferLength(0),
m_dwProxyAuthScheme(0),
m_nContentLength(-1),
m_bNoURLRedirect(FALSE),
m_nFileToUploadSize(0),
m_nFileToUploadIndex(0),
m_dbLimit(0),
m_nTotalBytesRead(0),
m_lpRequest(NULL),
m_dwRequestSize(0)
{
m_dwStartTicksDownload.dwHighDateTime = 0;
m_dwStartTicksDownload.dwLowDateTime = 0;
}
//Methods
HRESULT Initialize(_In_ const CWinHTTPConnection& connection, _In_z_ LPCWSTR pwszObjectName, _In_opt_z_ LPCWSTR pwszVerb = NULL, _In_opt_z_ LPCWSTR pwszVersion = NULL, _In_opt_z_ LPCWSTR pwszReferrer = WINHTTP_NO_REFERER,
_In_opt_ LPCWSTR* ppwszAcceptTypes = WINHTTP_DEFAULT_ACCEPT_TYPES, _In_ DWORD dwFlags = 0, _In_ DWORD dwBufferLength = 8096, _In_ DWORD dwShareMode = 0)
{
//Let the base class do its thing
HRESULT hr = __super::Initialize(connection, pwszObjectName, pwszVerb, pwszVersion, pwszReferrer, ppwszAcceptTypes, dwFlags);
if (FAILED(hr))
return hr;
//Disable redirects if required
if (m_bNoURLRedirect)
{
DWORD dwOptionValue = WINHTTP_DISABLE_REDIRECTS;
hr = SetOption(WINHTTP_DISABLE_REDIRECTS, &dwOptionValue, sizeof(dwOptionValue));
if (FAILED(hr))
return hr;
}
//Hook up the callback function
if (SetStatusCallback() == WINHTTP_INVALID_STATUS_CALLBACK)
return ATL::AtlHresultFromLastError();
//Release our resources if currently in use
ReleaseResources();
//Serialize access to our member variables
CSingleLock sl(&m_cs, TRUE);
//Allocate the receive buffer
if (!m_ReadBuffer.Allocate(dwBufferLength))
return E_OUTOFMEMORY;
m_dwReadBufferLength = dwBufferLength;
//Open up the file for downloading if necessary
if (m_sFileToDownloadInto.GetLength())
{
hr = m_fileToDownloadInto.Create(m_sFileToDownloadInto, GENERIC_WRITE, dwShareMode, OPEN_ALWAYS);
if (FAILED(hr))
return hr;
//Seek to the start position of the download
hr = m_fileToDownloadInto.Seek(m_nDownloadStartPos, FILE_BEGIN);
if (FAILED(hr))
return hr;
hr = m_fileToDownloadInto.SetSize(m_nDownloadStartPos);
if (FAILED(hr))
return hr;
}
//Also open up the file to upload if necessary
if (m_sFileToUpload.GetLength())
{
//Allocate the send buffer
if (!m_WriteBuffer.Allocate(dwBufferLength))
return E_OUTOFMEMORY;
m_dwWriteBufferLength = dwBufferLength;
//Open up the file for downloading into
hr = m_fileToUpload.Create(m_sFileToUpload, GENERIC_READ, dwShareMode, OPEN_EXISTING);
if (FAILED(hr))
return hr;
//Remember the size of the file to upload
hr = m_fileToUpload.GetSize(m_nFileToUploadSize);
if (FAILED(hr))
return hr;
}
return S_OK;
}
void ReleaseResources()
{
//Serialize access to our member variables
CSingleLock sl(&m_cs, TRUE);
//Ensure the files are closed and the buffers are deleted
m_fileToDownloadInto.Close();
if (m_ReadBuffer.m_pData != NULL)
m_ReadBuffer.Free();
m_dwReadBufferLength = 0;
m_fileToUpload.Close();
if (m_WriteBuffer.m_pData != NULL)
m_WriteBuffer.Free();
m_dwWriteBufferLength = 0;
m_nFileToUploadSize = 0;
m_nFileToUploadIndex = 0;
m_pOptionalBuffer = NULL;
m_dwOptionalBufferLength = 0;
}
HRESULT DeleteDownloadedFile()
{
//What will be the return value from this method (assume the best)
HRESULT hr = S_OK;
//Serialize access to our member variables
CSingleLock sl(&m_cs, TRUE);
//Delete the partially downloaded file if unsuccessful
if (!DeleteFile(m_sFileToDownloadInto))
hr = ATL::AtlHresultFromLastError();
return hr;
}
__int64 TimeSinceStartDownload() const
{
SYSTEMTIME st;
GetSystemTime(&st);
FILETIME ft;
memset(&ft, 0, sizeof(ft));
if (SystemTimeToFileTime(&st, &ft))
return ((static_cast<__int64>(ft.dwHighDateTime) << 32) + ft.dwLowDateTime - (static_cast<__int64>(m_dwStartTicksDownload.dwHighDateTime) << 32) - m_dwStartTicksDownload.dwLowDateTime) / 10000;
else
return 0;
}
virtual CStringW GetHeaders()
{
//What will be the return value from this method
CStringW sHeaders;
//Create the Range header here if required
if (m_nDownloadStartPos != 0) //we will build the range request
{
CStringW sHeader;
sHeader.Format(L"Range: bytes=%I64u-\r\n", m_nDownloadStartPos);
sHeaders += sHeader;
}
//Update the content length if we have a file to upload
if (m_fileToUpload.operator HANDLE())
{
CStringW sHeader;
sHeader.Format(L"Content-Length: %I64u\r\n", m_nFileToUploadSize);
sHeaders += sHeader;
}
return sHeaders;
}
virtual DWORD GetContentLength()
{
if (m_fileToUpload.operator HANDLE())
{
if (m_nFileToUploadSize > UINT_MAX)
return WINHTTP_IGNORE_REQUEST_TOTAL_LENGTH;
else
return static_cast<DWORD>(m_nFileToUploadSize);
}
else
return m_dwRequestSize;
}
HRESULT SendRequest(_In_reads_bytes_opt_(dwOptionalLength) LPVOID lpOptional = WINHTTP_NO_REQUEST_DATA, _In_ DWORD dwOptionalLength = 0)
{
//Remember the parameters passed in case we need to resend the request
m_dwOptionalBufferLength = dwOptionalLength;
m_pOptionalBuffer = lpOptional;
//Reset the last proxy auth scheme used before we send the request
m_dwProxyAuthScheme = 0;
//Do preauthentication if required
if (m_bProxyPreauthentication)
{
HRESULT hr = DoAuthentication(m_dwProxyPreauthenticationScheme, 0, WINHTTP_AUTH_TARGET_PROXY);
if (FAILED(hr))
return hr;
}
if (m_bHTTPPreauthentication)
{
HRESULT hr = DoAuthentication(m_dwHTTPPreauthenticationScheme, 0, WINHTTP_AUTH_TARGET_SERVER);
if (FAILED(hr))
return hr;
}
//Form the headers we are sending
CStringW sHeaders(GetHeaders());
int nHeadersLength = sHeaders.GetLength();
//Reset the total bytes read in the response
m_nTotalBytesRead = 0;
//Remember the time we started the download at
SYSTEMTIME st;
GetSystemTime(&st);
SystemTimeToFileTime(&st, &m_dwStartTicksDownload);
//Reset the last status code
m_dwLastStatusCode = 0;
//Call the base class using the this pointer as the context value
return __super::SendRequest(nHeadersLength ? sHeaders.operator LPCWSTR() : WINHTTP_NO_ADDITIONAL_HEADERS, nHeadersLength, lpOptional, dwOptionalLength, GetContentLength(), reinterpret_cast<DWORD_PTR>(this));
}
virtual HRESULT DoAuthentication(_In_ DWORD dwAuthenticationScheme, _In_ DWORD /*dwFirstScheme*/, _In_ DWORD dwAuthTarget)
{
//What will be the return value from this method
HRESULT hr = S_FALSE;
switch (dwAuthTarget)
{
case WINHTTP_AUTH_TARGET_SERVER:
{
if (m_sHTTPUserName.GetLength())
hr = SetCredentials(dwAuthTarget, dwAuthenticationScheme, m_sHTTPUserName, m_sHTTPPassword);
break;
}
case WINHTTP_AUTH_TARGET_PROXY:
{
if (m_sProxyUserName.GetLength())
hr = SetCredentials(dwAuthTarget, dwAuthenticationScheme, m_sProxyUserName, m_sProxyPassword);
break;
}
default:
{
hr = E_UNEXPECTED;
break;
}
}
return hr;
}
virtual DWORD ChooseAuthScheme(_In_ DWORD dwSupportedSchemes, _In_ DWORD /*dwFirstScheme*/, _In_ DWORD /*dwAuthTarget*/)
{
//This default implementation will allow any authentication scheme support
//and will pick in order of "decreasing strength"
if (dwSupportedSchemes & WINHTTP_AUTH_SCHEME_NEGOTIATE)
return WINHTTP_AUTH_SCHEME_NEGOTIATE;
else if (dwSupportedSchemes & WINHTTP_AUTH_SCHEME_NTLM)
return WINHTTP_AUTH_SCHEME_NTLM;
else if (dwSupportedSchemes & WINHTTP_AUTH_SCHEME_PASSPORT)
return WINHTTP_AUTH_SCHEME_PASSPORT;
else if (dwSupportedSchemes & WINHTTP_AUTH_SCHEME_DIGEST)
return WINHTTP_AUTH_SCHEME_DIGEST;
else if (dwSupportedSchemes & WINHTTP_AUTH_SCHEME_BASIC)
return WINHTTP_AUTH_SCHEME_BASIC;
else
return 0;
}
//Member variables
CStringW m_sHTTPUserName; //The username to use for HTTP authentication
CStringW m_sHTTPPassword; //the password to use for HTTP authentication
CStringW m_sProxyUserName; //The username to use for Proxy authentication
CStringW m_sProxyPassword; //The password to use for Proxy authentication
DWORD m_dwProxyPreauthenticationScheme; //The authentication scheme to use for proxy preauthentication
DWORD m_dwHTTPPreauthenticationScheme; //The authentication scheme to use for HTTP server preauthentication
BOOL m_bProxyPreauthentication; //Should we supply credentials on the first request for the Proxy rather than starting out with anonymous credentials
//and only authenticating when challenged
BOOL m_bHTTPPreauthentication; //Should we supply credentials on the first request for the HTTP Server rather than starting out with anonymous credentials
//and only authenticating when challenged
ULONGLONG m_nDownloadStartPos; //Offset to resume the download at
BOOL m_bNoURLRedirect; //Set to TRUE if you want to disable URL redirection following
CString m_sFileToUpload; //The path of the file to upload
CString m_sFileToDownloadInto; //The path of the file to download into
CByteArray m_Response; //The in memory copy of the HTTP response
LPCVOID m_lpRequest; //The in memory data to send in the HTTP request
DWORD m_dwRequestSize; //The size in bytes of m_lpRequest
double m_dbLimit; //For BANDWIDTH Throptling, The value in KB/Second to limit the connection to
protected:
//Methods
virtual HRESULT OnCallback(_In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
//What will be the return value from this function (S_FALSE means not handled in our callback)
HRESULT hr = S_FALSE;
switch (dwInternetStatus)
{
case WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE:
case WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE:
{
hr = OnWriteCallback(hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
break;
}
case WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE:
{
hr = OnHeadersAvailableCallback(hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
break;
}
case WINHTTP_CALLBACK_STATUS_READ_COMPLETE:
{
hr = OnReadCompleteCallback(hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
break;
}
case WINHTTP_CALLBACK_STATUS_REQUEST_ERROR:
{
hr = OnRequestErrorCallback(hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
break;
}
default:
{
break;
}
}
return hr;
}
virtual HRESULT OnReadCompleteCallback(_In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
//What will be the return value from the function
HRESULT hr = E_UNEXPECTED;
if (dwStatusInformationLength > 0)
{
//Serialize access to our member variables
CSingleLock sl(&m_cs, TRUE);
//Call the virtual OnReadData method if we have received some response data
hr = OnReadData(m_ReadBuffer.m_pData, dwStatusInformationLength);
if (FAILED(hr))
return hr;
//Continue to read the HTTP response
hr = ReadData(m_ReadBuffer.m_pData, m_dwReadBufferLength, 0);
if (FAILED(hr))
return hr;
}
else
{
//A dwStatusInformationLength of 0 indicates that the response is complete, call
//the OnResponseComplete method to indicate that the download is complete
hr = OnCallbackComplete(S_OK, hInternet, dwInternetStatus, lpvStatusInformation, dwStatusInformationLength);
}
return hr;
}
virtual HRESULT OnWriteCallback(_In_ HINTERNET hInternet, _In_ DWORD dwInternetStatus, _In_opt_ LPVOID lpvStatusInformation, _In_ DWORD dwStatusInformationLength)
{
UNREFERENCED_PARAMETER(hInternet);
UNREFERENCED_PARAMETER(dwInternetStatus);
UNREFERENCED_PARAMETER(lpvStatusInformation);
UNREFERENCED_PARAMETER(dwStatusInformationLength);
//Call the virtual OnWriteData method to allow this class a chance to send additional request data
HRESULT hr = OnWriteData();
if (FAILED(hr))
return hr;
//When the request was sent successfully, lets kick off reading the response
if (hr == S_FALSE)
hr = ReceiveResponse();
return hr;
}
virtual HRESULT On407Response()
{
//Serialize access to our member variables
CSingleLock sl(&m_cs, TRUE);
//Fail the request if we got the same status code a second time
if (m_dwLastStatusCode == HTTP_STATUS_PROXY_AUTH_REQ)
return ATL::AtlHresultFromWin32(ERROR_WINHTTP_LOGIN_FAILURE);
//Check what authentication schemes the server supports
DWORD dwSupportedSchemes = 0;
DWORD dwFirstScheme = 0;
DWORD dwAuthTarget = 0;
HRESULT hr = QueryAuthSchemes(dwSupportedSchemes, dwFirstScheme, dwAuthTarget);
if (FAILED(hr))
return hr;
//Pick an authentication scheme
m_dwProxyAuthScheme = ChooseAuthScheme(dwSupportedSchemes, dwFirstScheme, dwAuthTarget);
if (m_dwProxyAuthScheme == 0)
return ATL::AtlHresultFromWin32(ERROR_WINHTTP_LOGIN_FAILURE);
//Do the authentication
hr = DoAuthentication(m_dwProxyAuthScheme, dwFirstScheme, dwAuthTarget);
if (FAILED(hr))
return hr;
//Remember the last status code
m_dwLastStatusCode = HTTP_STATUS_PROXY_AUTH_REQ;
//Form the headers we are sending
CStringW sHeaders(GetHeaders());