-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathLxssUserSession.cpp
More file actions
4140 lines (3424 loc) · 158 KB
/
LxssUserSession.cpp
File metadata and controls
4140 lines (3424 loc) · 158 KB
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
/*++
Copyright (c) Microsoft. All rights reserved.
Module Name:
LxssUserSession.cpp
Abstract:
This file contains session function definitions.
--*/
#include "precomp.h"
#include "Localization.h"
#include "LxssUserSession.h"
#include "LxssInstance.h"
#include "LxssSecurity.h"
#include "WslCoreInstance.h"
#include "resource.h"
#include <winrt\Windows.ApplicationModel.Background.h>
#include <nlohmann\json.hpp>
// Registry keys for migrating legacy distro user config.
#define LXSS_LEGACY_APPEND_NT_PATH L"AppendNtPath"
#define LXSS_LEGACY_INTEROP_ENABLED L"InteropEnabled"
#define LXSS_BSDTAR_PATH LXSS_TOOLS_MOUNT "/bsdtar"
#define LXSS_BSDTAR_CREATE_ARGS " -c --one-file-system --xattrs -f - ."
#define LXSS_BSDTAR_CREATE_ARGS_GZIP " -cz --one-file-system --xattrs -f - ."
#define LXSS_BSDTAR_CREATE_ARGS_XZIP " -cJ --one-file-system --xattrs -f - ."
#define LXSS_BSDTAR_EXTRACT_ARGS " -x -p --xattrs --no-acls -f -"
#define LXSS_ROOTFS_MOUNT "/rootfs"
#define LXSS_TOOLS_MOUNT "/tools"
constexpr auto c_shortIconName = L"shortcut.ico";
// 16 MB buffer used for relaying tar contents via hvsocket.
#define LXSS_RELAY_BUFFER_SIZE (0x1000000)
extern bool g_lxcoreInitialized;
using namespace std::placeholders;
using namespace Microsoft::WRL;
using namespace wsl::windows::service;
using wsl::windows::common::Context;
using wsl::windows::common::ExecutionContext;
using wsl::windows::common::ServiceExecutionContext;
LxssUserSession::LxssUserSession(_In_ const std::weak_ptr<LxssUserSessionImpl>& Session) : m_session(Session)
{
return;
}
HRESULT STDMETHODCALLTYPE LxssUserSession::ConfigureDistribution(_In_opt_ LPCGUID DistroGuid, _In_ ULONG DefaultUid, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->ConfigureDistribution(DistroGuid, DefaultUid, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::AttachDisk(_In_ LPCWSTR Disk, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
if constexpr (wsl::shared::Arm64)
{
// Pass-through disk support for ARM64 was added to Windows version 27653.
if (wsl::windows::common::helpers::GetWindowsVersion().BuildNumber < 27653)
{
return WSL_E_WSL_MOUNT_NOT_SUPPORTED;
}
}
RETURN_HR_IF(
WSL_E_DISK_MOUNT_DISABLED,
!wsl::windows::policies::IsFeatureAllowed(wsl::windows::policies::OpenPoliciesKey().get(), wsl::windows::policies::c_allowDiskMount));
RETURN_HR_IF(
E_INVALIDARG,
((WI_IsFlagSet(Flags, LXSS_ATTACH_MOUNT_FLAGS_VHD) && WI_IsFlagSet(Flags, LXSS_ATTACH_MOUNT_FLAGS_PASS_THROUGH)) ||
(WI_IsAnyFlagSet(Flags, ~(LXSS_ATTACH_MOUNT_FLAGS_VHD | LXSS_ATTACH_MOUNT_FLAGS_PASS_THROUGH)))));
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->AttachDisk(Disk, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::CreateInstance(_In_opt_ LPCGUID DistroGuid, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->CreateInstance(DistroGuid, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::CreateInstance(_In_ LPCWSTR DistributionName, _In_ ULONG Flags)
try
{
RETURN_HR_IF(E_INVALIDARG, WI_IsAnyFlagSet(Flags, ~WslSupportCreateInstanceFlags::IgnoreClient));
GUID distroGuid{};
RETURN_IF_FAILED(GetDistributionId(DistributionName, 0, nullptr, &distroGuid));
ULONG internalFlags = 0;
WI_SetFlagIf(internalFlags, LXSS_CREATE_INSTANCE_FLAGS_IGNORE_CLIENT, WI_IsFlagSet(Flags, WslSupportCreateInstanceFlags::IgnoreClient));
return CreateInstance(&distroGuid, internalFlags, nullptr);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::CreateLxProcess(
_In_opt_ LPCGUID DistroGuid,
_In_opt_ LPCSTR Filename,
_In_ ULONG CommandLineCount,
_In_reads_opt_(CommandLineCount) LPCSTR* CommandLine,
_In_opt_ LPCWSTR CurrentWorkingDirectory,
_In_opt_ LPCWSTR NtPath,
_In_reads_opt_(NtEnvironmentLength) PWCHAR NtEnvironment,
_In_ ULONG NtEnvironmentLength,
_In_opt_ LPCWSTR Username,
_In_ SHORT Columns,
_In_ SHORT Rows,
_In_ ULONG ConsoleHandle,
_In_ PLXSS_STD_HANDLES StdHandles,
_In_ ULONG Flags,
_Out_ GUID* DistributionId,
_Out_ GUID* InstanceId,
_Out_ HANDLE* ProcessHandle,
_Out_ HANDLE* ServerHandle,
_Out_ HANDLE* StandardIn,
_Out_ HANDLE* StandardOut,
_Out_ HANDLE* StandardErr,
_Out_ HANDLE* CommunicationChannel,
_Out_ HANDLE* InteropSocket,
_Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->CreateLxProcess(
DistroGuid,
Filename,
CommandLineCount,
CommandLine,
CurrentWorkingDirectory,
NtPath,
NtEnvironment,
NtEnvironmentLength,
Username,
Columns,
Rows,
ULongToHandle(ConsoleHandle),
StdHandles,
Flags,
DistributionId,
InstanceId,
ProcessHandle,
ServerHandle,
StandardIn,
StandardOut,
StandardErr,
CommunicationChannel,
InteropSocket);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::DetachDisk(_In_ LPCWSTR Disk, _Out_ int* Result, _Out_ int* Step, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->DetachDisk(Disk, Result, Step);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::EnumerateDistributions(
_Out_ PULONG DistributionCount, _Out_ LXSS_ENUMERATE_INFO** Distributions, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->EnumerateDistributions(DistributionCount, Distributions);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::ExportDistribution(
_In_opt_ LPCGUID DistroGuid, _In_ HANDLE FileHandle, _In_ HANDLE ErrorHandle, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->ExportDistribution(DistroGuid, FileHandle, ErrorHandle, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::ExportDistributionPipe(
_In_opt_ LPCGUID DistroGuid, _In_ HANDLE PipeHandle, _In_ HANDLE ErrorHandle, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->ExportDistribution(DistroGuid, PipeHandle, ErrorHandle, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::GetDefaultDistribution(_Out_ LXSS_ERROR_INFO* Error, _Out_ LPGUID DefaultDistribution)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->GetDefaultDistribution(DefaultDistribution);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::GetDistributionConfiguration(
_In_opt_ LPCGUID DistroGuid,
_Out_ LPWSTR* DistributionName,
_Out_ ULONG* Version,
_Out_ ULONG* DefaultUid,
_Out_ ULONG* DefaultEnvironmentCount,
_Out_ LPSTR** DefaultEnvironment,
_Out_ ULONG* Flags,
_Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->GetDistributionConfiguration(
DistroGuid, DistributionName, Version, DefaultUid, DefaultEnvironmentCount, DefaultEnvironment, Flags);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::GetDistributionConfiguration(
_In_ LPCWSTR DistributionName,
_Out_ ULONG* Version,
_Out_ ULONG* DefaultUid,
_Out_ ULONG* DefaultEnvironmentCount,
_Out_ LPSTR** DefaultEnvironment,
_Out_ ULONG* WslFlags)
try
{
GUID distroGuid{};
RETURN_IF_FAILED(GetDistributionId(DistributionName, 0, nullptr, &distroGuid));
wil::unique_cotaskmem_string distroNameLocal;
const auto result = GetDistributionConfiguration(
&distroGuid, &distroNameLocal, Version, DefaultUid, DefaultEnvironmentCount, DefaultEnvironment, WslFlags, nullptr);
WI_ASSERT(FAILED(result) || wsl::shared::string::IsEqual(DistributionName, distroNameLocal.get(), true));
return result;
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::GetDistributionId(_In_ LPCWSTR DistributionName, _In_ ULONG Flags, _Out_ LXSS_ERROR_INFO* Error, _Out_ GUID* pDistroGuid)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->GetDistributionId(DistributionName, Flags, pDistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::ImportDistributionInplace(
_In_ LPCWSTR DistributionName, _In_ LPCWSTR VhdPath, _Out_ LXSS_ERROR_INFO* Error, _Out_ GUID* pDistroGuid)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->ImportDistributionInplace(DistributionName, VhdPath, pDistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::ListDistributions(_Out_ ULONG* Count, _Out_ LPWSTR** Distributions)
try
{
wil::unique_cotaskmem_array_ptr<LXSS_ENUMERATE_INFO> distributions;
RETURN_IF_FAILED(EnumerateDistributions(distributions.size_address<ULONG>(), &distributions, nullptr));
// Filter out distributions that are not in the installed or running state.
std::vector<wil::unique_cotaskmem_string> installedDistros{};
for (size_t index = 0; index < distributions.size(); index += 1)
{
if ((distributions[index].State == LxssDistributionStateInstalled) || (distributions[index].State == LxssDistributionStateRunning))
{
installedDistros.emplace_back(wil::make_unique_string<wil::unique_cotaskmem_string>(distributions[index].DistroName));
}
}
auto userDistributions(wil::make_unique_cotaskmem<LPWSTR[]>(installedDistros.size()));
for (size_t index = 0; index < installedDistros.size(); index += 1)
{
userDistributions.get()[index] = installedDistros[index].release();
}
*Count = gsl::narrow_cast<ULONG>(installedDistros.size());
*Distributions = userDistributions.release();
return S_OK;
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::MountDisk(
_In_ LPCWSTR Disk,
_In_ ULONG Flags,
_In_ ULONG PartitionIndex,
_In_opt_ LPCWSTR Name,
_In_opt_ LPCWSTR Type,
_In_opt_ LPCWSTR Options,
_Out_ int* Result,
_Out_ int* Step,
_Out_ LPWSTR* MountName,
_Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->MountDisk(Disk, Flags, PartitionIndex, Name, Type, Options, Result, Step, MountName);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::MoveDistribution(_In_ LPCGUID DistroGuid, _In_ LPCWSTR Location, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->MoveDistribution(DistroGuid, Location);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::RegisterDistribution(
_In_ LPCWSTR DistributionName,
_In_ ULONG Version,
_In_ HANDLE FileHandle,
_In_ HANDLE ErrorHandle,
_In_ LPCWSTR TargetDirectory,
_In_ ULONG Flags,
_In_ ULONG64 VhdSize,
_In_opt_ LPCWSTR PackageFamilyName,
_Out_ LPWSTR* InstalledDistributionName,
_Out_ LXSS_ERROR_INFO* Error,
_Out_ GUID* pDistroGuid)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->RegisterDistribution(
DistributionName, Version, FileHandle, ErrorHandle, TargetDirectory, Flags, VhdSize, PackageFamilyName, InstalledDistributionName, pDistroGuid);
}
CATCH_RETURN()
HRESULT LxssUserSession::RegisterDistribution(
_In_ LPCWSTR DistributionName, _In_ ULONG Version, _In_opt_ HANDLE TarGzFile, _In_opt_ HANDLE TarGzPipe, _In_ LPCWSTR TargetDirectory)
try
{
const auto clientProcess = wsl::windows::common::wslutil::OpenCallingProcess(PROCESS_QUERY_LIMITED_INFORMATION);
const auto packageFamilyName = wsl::windows::common::wslutil::GetPackageFamilyName(clientProcess.get());
GUID distroGuid{};
return RegisterDistribution(
DistributionName,
Version,
TarGzFile,
nullptr,
TargetDirectory,
0,
0,
packageFamilyName.empty() ? nullptr : packageFamilyName.c_str(),
nullptr,
nullptr,
&distroGuid);
}
CATCH_RETURN();
HRESULT STDMETHODCALLTYPE LxssUserSession::RegisterDistributionPipe(
_In_ LPCWSTR DistributionName,
_In_ ULONG Version,
_In_ HANDLE PipeHandle,
_In_ HANDLE ErrorHandle,
_In_ LPCWSTR TargetDirectory,
_In_ ULONG Flags,
_In_ ULONG64 VhdSize,
_In_opt_ LPCWSTR PackageFamilyName,
_Out_ LPWSTR* InstalledDistributionName,
_Out_ LXSS_ERROR_INFO* Error,
_Out_ GUID* pDistroGuid)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->RegisterDistribution(
DistributionName, Version, PipeHandle, ErrorHandle, TargetDirectory, Flags, VhdSize, PackageFamilyName, InstalledDistributionName, pDistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::SetDefaultDistribution(_In_ LPCGUID DistroGuid, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->SetDefaultDistribution(DistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::SetDistributionConfiguration(_In_ LPCWSTR DistributionName, _In_ ULONG DefaultUid, _In_ ULONG WslFlags)
try
{
GUID distroGuid{};
RETURN_IF_FAILED(GetDistributionId(DistributionName, 0, nullptr, &distroGuid));
return ConfigureDistribution(&distroGuid, DefaultUid, WslFlags, nullptr);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::SetSparse(_In_ LPCGUID DistroGuid, _In_ BOOLEAN Sparse, _In_ BOOLEAN AllowUnsafe, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->SetSparse(DistroGuid, Sparse, AllowUnsafe);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::ResizeDistribution(_In_ LPCGUID DistroGuid, _In_ HANDLE OutputHandle, _In_ ULONG64 NewSize, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->ResizeDistribution(DistroGuid, OutputHandle, NewSize);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::SetVersion(_In_ LPCGUID DistroGuid, _In_ ULONG Version, _In_ HANDLE StdErrHandle, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->SetVersion(DistroGuid, Version, StdErrHandle);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::Shutdown(BOOL Force)
try
{
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->Shutdown(false, Force ? ShutdownBehavior::Force : ShutdownBehavior::Wait);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::Shutdown()
try
{
return Shutdown(false);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::TerminateDistribution(_In_opt_ LPCGUID DistroGuid, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->TerminateDistribution(DistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::UnregisterDistribution(_In_ LPCGUID DistroGuid, _Out_ LXSS_ERROR_INFO* Error)
try
{
ServiceExecutionContext context(Error);
const auto session = m_session.lock();
RETURN_HR_IF(RPC_E_DISCONNECTED, !session);
return session->UnregisterDistribution(DistroGuid);
}
CATCH_RETURN()
HRESULT STDMETHODCALLTYPE LxssUserSession::UnregisterDistribution(_In_ LPCWSTR DistributionName)
try
{
GUID distroGuid;
RETURN_IF_FAILED(GetDistributionId(DistributionName, 0, nullptr, &distroGuid));
return UnregisterDistribution(&distroGuid, nullptr);
}
CATCH_RETURN()
LxssUserSessionImpl::LxssUserSessionImpl(_In_ PSID userSid, _In_ DWORD sessionId, _Inout_ wsl::windows::service::PluginManager& pluginManager) :
m_sessionId(sessionId), m_pluginManager(pluginManager)
{
THROW_IF_WIN32_BOOL_FALSE(::CopySid(sizeof(m_userSid), &m_userSid.Sid, userSid));
try
{
wil::unique_hkey lxssKey;
wil::unique_handle userToken;
{
auto runAsUser = wil::CoImpersonateClient();
userToken = wsl::windows::common::security::GetUserToken(TokenImpersonation);
lxssKey = wsl::windows::common::registry::OpenLxssUserKey();
}
static std::atomic<DWORD> sessionCookie;
m_session = {sessionCookie++, nullptr, &m_userSid.Sid};
// Detect existing legacy installs and convert them to the new format.
const DWORD state =
wsl::windows::common::registry::ReadDword(lxssKey.get(), nullptr, LXSS_LEGACY_INSTALL_VALUE, LxssDistributionStateInvalid);
if (state == LxssDistributionStateInstalled)
{
// Create a registration for legacy installs and delete legacy
// installed state.
std::lock_guard lock(m_instanceLock);
_CreateLegacyRegistration(lxssKey.get(), userToken.get());
wsl::windows::common::registry::DeleteKeyValue(lxssKey.get(), LXSS_LEGACY_INSTALL_VALUE);
}
// Create a threadpool timer to terminate a Linux utility VM that is idle.
m_vmTerminationTimer.reset(CreateThreadpoolTimer(s_VmIdleTerminate, this, nullptr));
THROW_IF_NULL_ALLOC(m_vmTerminationTimer);
// Register for timezone update notifications.
auto listenForTimeZoneChanges = [this] {
try
{
WNDCLASSEX windowClass{};
windowClass.cbSize = sizeof(windowClass);
windowClass.lpfnWndProc = s_TimezoneWindowProc;
windowClass.hInstance = nullptr;
windowClass.lpszClassName = L"wslservice-timezone-notifications";
THROW_LAST_ERROR_IF(RegisterClassExW(&windowClass) == 0);
// Note: HWND_MESSAGE cannot be used here because such windows don't receive broadcast messages like WM_TIMECHANGE
const wil::unique_hwnd windowHandle{CreateWindowExW(
0,
windowClass.lpszClassName,
nullptr,
WS_OVERLAPPEDWINDOW,
CW_USEDEFAULT,
CW_USEDEFAULT,
CW_USEDEFAULT,
CW_USEDEFAULT,
nullptr,
nullptr,
windowClass.hInstance,
nullptr)};
THROW_LAST_ERROR_IF(!windowHandle);
SetWindowLongPtr(windowHandle.get(), GWLP_USERDATA, reinterpret_cast<LONG_PTR>(this));
MSG windowMessage{};
while (GetMessageW(&windowMessage, nullptr, 0, 0))
{
TranslateMessage(&windowMessage);
DispatchMessage(&windowMessage);
}
}
CATCH_LOG();
};
m_timezoneThread = std::thread{listenForTimeZoneChanges};
// Shutdown the inbox session for the current user if needed, this is only required once after the
// lifted package is installed to ensure that the inbox service has released per-user resources.
LOG_IF_FAILED(wil::ResultFromException(WI_DIAGNOSTICS_INFO, [&] {
// Open a handle to the service control manager and check if the inbox service is registered.
const wil::unique_schandle manager{OpenSCManager(nullptr, nullptr, SC_MANAGER_ENUMERATE_SERVICE)};
THROW_LAST_ERROR_IF(!manager);
const wil::unique_schandle service{OpenServiceW(manager.get(), LXSS_INBOX_SERVICE_NAME, SERVICE_QUERY_STATUS)};
if (!service)
{
return;
}
// Check if the service is already stopped.
SERVICE_STATUS status;
THROW_IF_WIN32_BOOL_FALSE(QueryServiceStatus(service.get(), &status));
if (status.dwCurrentState == SERVICE_STOPPED)
{
return;
}
// Shutdown the user's session.
auto runAsUser = wil::impersonate_token(userToken.get());
const auto wslSupport = wil::CoCreateInstance<LxssUserSessionInBox, IWslSupport>(CLSCTX_LOCAL_SERVER | CLSCTX_ENABLE_CLOAKING);
THROW_IF_FAILED(wslSupport->Shutdown());
}));
}
CATCH_LOG()
}
LxssUserSessionImpl::~LxssUserSessionImpl()
{
if (m_timezoneThread.joinable())
{
LOG_IF_WIN32_BOOL_FALSE(PostThreadMessage(GetThreadId(m_timezoneThread.native_handle()), WM_QUIT, 0, 0));
m_timezoneThread.join();
}
m_lifetimeManager.ClearCallbacks();
// Ensure that if there are no running instances.
WI_ASSERT(m_runningInstances.empty());
}
HRESULT LxssUserSessionImpl::AttachDisk(_In_ LPCWSTR Disk, _In_ ULONG Flags)
{
ExecutionContext context(Context::AttachDisk);
std::lock_guard lock(m_instanceLock);
const wil::unique_hkey lxssKey = s_OpenLxssUserKey();
// Validate that at least one WSL2 distro is installed
auto pred = [&](const auto& e) { return WI_IsFlagSet(e.Read(Property::Flags), LXSS_DISTRO_FLAGS_VM_MODE); };
auto distributions = _EnumerateDistributions(lxssKey.get(), true);
RETURN_HR_IF(WSL_E_WSL2_NEEDED, !std::any_of(distributions.begin(), distributions.end(), pred));
return wil::ResultFromException([&]() {
_CreateVm();
const auto diskType = WI_IsFlagSet(Flags, LXSS_ATTACH_MOUNT_FLAGS_VHD) ? WslCoreVm::DiskType::VHD : WslCoreVm::DiskType::PassThrough;
const auto userToken = wsl::windows::common::security::GetUserToken(TokenImpersonation);
m_utilityVm->AttachDisk(Disk, diskType, {}, true, userToken.get());
});
}
HRESULT LxssUserSessionImpl::ConfigureDistribution(_In_opt_ LPCGUID DistroGuid, _In_ ULONG DefaultUid, _In_ ULONG Flags)
try
{
ExecutionContext context(Context::ConfigureDistro);
WSL_LOG("ConfigureDistribution", TraceLoggingValue(DefaultUid, "DefaultUid"), TraceLoggingValue(Flags, "Flags"));
const wil::unique_hkey lxssKey = s_OpenLxssUserKey();
std::lock_guard lock(m_instanceLock);
// Ensure the distribution exists.
auto distribution = DistributionRegistration::OpenOrDefault(lxssKey.get(), DistroGuid);
auto configuration = s_GetDistributionConfiguration(distribution);
// Validate parameters.
RETURN_HR_IF(
E_INVALIDARG,
((DefaultUid == LX_UID_INVALID) || (Flags != LXSS_DISTRO_FLAGS_UNCHANGED && WI_IsAnyFlagSet(Flags, ~LXSS_DISTRO_FLAGS_ALL))));
// If the configuration is changed, terminate the distribution so the new settings will take effect.
bool modified = false;
if (DefaultUid != distribution.Read(Property::DefaultUid))
{
distribution.Write(Property::DefaultUid, DefaultUid);
modified = true;
}
if (Flags != LXSS_DISTRO_FLAGS_UNCHANGED)
{
// The VM Mode flag is not configurable via this API.
if (WI_IsFlagSet(configuration.Flags, LXSS_DISTRO_FLAGS_VM_MODE))
{
WI_SetFlag(Flags, LXSS_DISTRO_FLAGS_VM_MODE);
}
else
{
WI_ClearFlag(Flags, LXSS_DISTRO_FLAGS_VM_MODE);
}
if (Flags != configuration.Flags)
{
distribution.Write(Property::Flags, Flags);
modified = true;
}
}
if (modified)
{
_TerminateInstanceInternal(&distribution.Id(), false);
}
return S_OK;
}
CATCH_RETURN()
HRESULT LxssUserSessionImpl::CreateInstance(_In_opt_ LPCGUID DistroGuid, _In_ ULONG Flags)
try
{
// Register the client process with the lifetime manager so when the last
// client goes away the instance is terminated (after a timeout).
_CreateInstance(DistroGuid, Flags);
return S_OK;
}
CATCH_RETURN()
HRESULT LxssUserSessionImpl::CreateLxProcess(
_In_opt_ LPCGUID DistroGuid,
_In_opt_ LPCSTR Filename,
_In_ ULONG CommandLineCount,
_In_reads_opt_(CommandLineCount) LPCSTR* CommandLine,
_In_opt_ LPCWSTR CurrentWorkingDirectory,
_In_opt_ LPCWSTR NtPath,
_In_reads_opt_(NtEnvironmentLength) PWCHAR NtEnvironment,
_In_ ULONG NtEnvironmentLength,
_In_opt_ LPCWSTR Username,
_In_ SHORT Columns,
_In_ SHORT Rows,
_In_ HANDLE ConsoleHandle,
_In_ PLXSS_STD_HANDLES StdHandles,
_In_ ULONG Flags,
_Out_ GUID* DistributionId,
_Out_ GUID* InstanceId,
_Out_ HANDLE* ProcessHandle,
_Out_ HANDLE* ServerHandle,
_Out_ HANDLE* StandardIn,
_Out_ HANDLE* StandardOut,
_Out_ HANDLE* StandardErr,
_Out_ HANDLE* CommunicationChannel,
_Out_ HANDLE* InteropSocket)
try
{
// This API handles launching processes three ways:
// 1. If Filename and CommandLine are both NULL, the user's default shell
// is launched. The default shell is stored in /etc/passwd.
// 2. If Filename is NULL but CommandLine is not, the user's default shell
// is used to invoke the specified command. For example:
// /bin/bash -c "command"
// 3. If Filename and CommandLine are both non-NULL, they are passed along
// as-is to the exec system call by the init daemon.
// Create an instance to run the process.
auto instance = _CreateInstance(DistroGuid, Flags);
// Query process creation context.
auto distributionId = instance->GetDistributionId();
auto context = s_GetCreateProcessContext(distributionId, WI_IsFlagSet(Flags, LXSS_CREATE_INSTANCE_FLAGS_USE_SYSTEM_DISTRO));
_SetHttpProxyInfo(context.DefaultEnvironment);
// Parse the create process params.
auto parsed = LxssCreateProcess::ParseArguments(
Filename,
CommandLineCount,
CommandLine,
CurrentWorkingDirectory,
NtPath,
NtEnvironment,
NtEnvironmentLength,
Username,
context.DefaultEnvironment,
context.Flags);
if (WI_IsFlagSet(Flags, LXSS_CREATE_INSTANCE_FLAGS_SHELL_LOGIN))
{
THROW_HR_IF(E_INVALIDARG, ARGUMENT_PRESENT(Filename));
parsed.ShellOptions = ShellOptionsLogin;
}
// Initialize console data and launch the process.
CreateLxProcessConsoleData consoleData;
if (ConsoleHandle)
{
consoleData.ConsoleHandle.reset(wsl::windows::common::wslutil::DuplicateHandleFromCallingProcess(ConsoleHandle));
}
consoleData.ClientProcess = wsl::windows::common::wslutil::OpenCallingProcess(PROCESS_VM_READ | GENERIC_READ | SYNCHRONIZE);
instance->CreateLxProcess(
parsed, context, consoleData, Columns, Rows, StdHandles, InstanceId, ProcessHandle, ServerHandle, StandardIn, StandardOut, StandardErr, CommunicationChannel, InteropSocket);
*DistributionId = distributionId;
return S_OK;
}
CATCH_RETURN()
void LxssUserSessionImpl::ClearDiskStateInRegistry(_In_ const LPCWSTR Disk)
{
bool deleted = !ARGUMENT_PRESENT(Disk);
const auto key = wsl::windows::common::registry::OpenOrCreateLxssDiskMountsKey(&m_userSid.Sid);
for (const auto& e : wsl::windows::common::registry::EnumKeys(key.get(), KEY_READ))
{
if (Disk == nullptr || wsl::windows::common::registry::ReadString(e.second.get(), nullptr, c_diskValueName) == Disk)
{
wsl::windows::common::registry::DeleteKey(key.get(), e.first.c_str());
deleted = true;
}
}
THROW_HR_IF(HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND), !deleted);
}
HRESULT LxssUserSessionImpl::DetachDisk(_In_ LPCWSTR Disk, _Out_ int* Result, _Out_ int* Step)
{
ExecutionContext context(Context::DetachDisk);
std::lock_guard lock(m_instanceLock);
// If the UVM isn't running, simply clear the disk state in the registry, if any
if (!m_utilityVm)
{
return wil::ResultFromException([&]() {
ClearDiskStateInRegistry(Disk);
*Result = 0;
*Step = LxMiniInitMountStepNone;
});
}
return wil::ResultFromException([&]() { std::tie(*Result, *Step) = m_utilityVm->DetachDisk(Disk); });
}
HRESULT LxssUserSessionImpl::MountDisk(
_In_ LPCWSTR Disk,
_In_ ULONG Flags,
_In_ ULONG PartitionIndex,
_In_opt_ LPCWSTR Name,
_In_opt_ LPCWSTR Type,
_In_opt_ LPCWSTR Options,
_Out_ int* Result,
_Out_ int* Step,
_Out_ LPWSTR* MountName)
{
ExecutionContext context(Context::DetachDisk);
std::lock_guard lock(m_instanceLock);
return wil::ResultFromException([&]() {
_CreateVm();
const auto MountDiskType = WI_IsFlagSet(Flags, LXSS_ATTACH_MOUNT_FLAGS_VHD) ? WslCoreVm::DiskType::VHD : WslCoreVm::DiskType::PassThrough;
const auto MountResult = m_utilityVm->MountDisk(Disk, MountDiskType, PartitionIndex, Name, Type, Options);
const auto MountNameWide = wsl::shared::string::MultiByteToWide(MountResult.MountPointName);
*Result = MountResult.Result;
*Step = MountResult.Step;
*MountName = wil::make_unique_string<wil::unique_cotaskmem_string>(MountNameWide.c_str()).release();
});
}
HRESULT LxssUserSessionImpl::MoveDistribution(_In_ LPCGUID DistroGuid, _In_ LPCWSTR Location)
{
ExecutionContext context(Context::MoveDistro);
std::lock_guard lock(m_instanceLock);
// Fail if the distribution is running.
RETURN_HR_IF(WSL_E_DISTRO_NOT_STOPPED, m_runningInstances.contains(*DistroGuid));
// Lookup the distribution configuration
const auto lxssKey = s_OpenLxssUserKey();
_ValidateDistributionNameAndPathNotInUse(lxssKey.get(), Location, nullptr);
auto registration = DistributionRegistration::Open(lxssKey.get(), *DistroGuid);
auto distro = s_GetDistributionConfiguration(registration);
RETURN_HR_IF(E_NOTIMPL, WI_IsFlagClear(distro.Flags, LXSS_DISTRO_FLAGS_VM_MODE));
// Build the final vhd path.
std::filesystem::path newVhdPath = Location;
RETURN_HR_IF(E_INVALIDARG, newVhdPath.empty());
newVhdPath /= distro.VhdFilePath.filename();
auto impersonate = wil::CoImpersonateClient();
// Create the distribution base folder
std::error_code error;
std::filesystem::create_directories(Location, error);
if (error.value())
{
THROW_WIN32(error.value());
}
// Move the VHD to the new location.
THROW_IF_WIN32_BOOL_FALSE(MoveFileEx(distro.VhdFilePath.c_str(), newVhdPath.c_str(), MOVEFILE_COPY_ALLOWED | MOVEFILE_WRITE_THROUGH));
auto revert = wil::scope_exit_log(WI_DIAGNOSTICS_INFO, [&]() {
THROW_IF_WIN32_BOOL_FALSE(MoveFileEx(
newVhdPath.c_str(), distro.VhdFilePath.c_str(), MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH));
// Write the location back to the original path in case the second registry write failed. Otherwise, this is a no-op.
registration.Write(Property::BasePath, distro.BasePath.c_str());
});
// Update the registry location
registration.Write(Property::BasePath, Location);
registration.Write(Property::VhdFileName, newVhdPath.filename().c_str());
revert.release();
return S_OK;
}
HRESULT LxssUserSessionImpl::EnumerateDistributions(_Out_ PULONG DistributionCount, _Out_ LXSS_ENUMERATE_INFO** Distributions)
{
// Get a list of all registered distributions.
const wil::unique_hkey lxssKey = s_OpenLxssUserKey();
std::lock_guard lock(m_instanceLock);
const auto distributions = _EnumerateDistributions(lxssKey.get(), true);
// Get the default distribution.
//
// N.B. It is possible the default to not exist, for example if there is
// a single distribution that is being installed.
GUID defaultGuid = GUID_NULL;
try
{
defaultGuid = _GetDefaultDistro(lxssKey.get());
}
CATCH_LOG()
const ULONG numberOfDistributions = gsl::narrow_cast<ULONG>(distributions.size());
auto userDistributions(wil::make_unique_cotaskmem<LXSS_ENUMERATE_INFO[]>(numberOfDistributions));
// Fill in information about each distribution.
for (ULONG index = 0; index < numberOfDistributions; index += 1)
{
auto configuration = s_GetDistributionConfiguration(distributions[index]);
auto state = static_cast<LxssDistributionState>(configuration.State);
if (m_runningInstances.contains(distributions[index].Id()))
{
state = LxssDistributionStateRunning;
}
else if (state == LxssDistributionStateInstalled)
{
auto distro = std::find_if(m_lockedDistributions.begin(), m_lockedDistributions.end(), [&](const auto& pair) {
return IsEqualGUID(distributions[index].Id(), pair.first);
});
if (distro != m_lockedDistributions.end())