/
mspyUser.c
979 lines (702 loc) · 25.1 KB
/
mspyUser.c
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
/*++
Copyright (c) 1989-2002 Microsoft Corporation
Module Name:
mspyUser.c
Abstract:
This file contains the implementation for the main function of the
user application piece of MiniSpy. This function is responsible for
controlling the command mode available to the user to control the
kernel mode driver.
Environment:
User mode
--*/
#include <DriverSpecs.h>
_Analysis_mode_(_Analysis_code_type_user_code_)
#include <stdlib.h>
#include <stdio.h>
#include <windows.h>
#include <assert.h>
#include "mspyLog.h"
#include <strsafe.h>
#define SUCCESS 0
#define USAGE_ERROR 1
#define EXIT_INTERPRETER 2
#define EXIT_PROGRAM 4
#define INTERPRETER_EXIT_COMMAND1 "go"
#define INTERPRETER_EXIT_COMMAND2 "g"
#define PROGRAM_EXIT_COMMAND "exit"
#define CMDLINE_SIZE 256
#define NUM_PARAMS 40
#define MINISPY_NAME L"MiniSpy"
DWORD
InterpretCommand (
_In_ int argc,
_In_reads_(argc) char *argv[],
_In_ PLOG_CONTEXT Context
);
VOID
ListDevices (
VOID
);
VOID
DisplayError (
_In_ DWORD Code
)
/*++
Routine Description:
This routine will display an error message based off of the Win32 error
code that is passed in. This allows the user to see an understandable
error message instead of just the code.
Arguments:
Code - The error code to be translated.
Return Value:
None.
--*/
{
WCHAR buffer[MAX_PATH] = { 0 };
DWORD count;
HMODULE module = NULL;
HRESULT status;
count = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM,
NULL,
Code,
0,
buffer,
sizeof(buffer) / sizeof(WCHAR),
NULL);
if (count == 0) {
count = GetSystemDirectory( buffer,
sizeof(buffer) / sizeof( WCHAR ) );
if (count==0 || count > sizeof(buffer) / sizeof( WCHAR )) {
//
// In practice we expect buffer to be large enough to hold the
// system directory path.
//
printf(" Could not translate error: %d\n", Code);
return;
}
status = StringCchCat( buffer,
sizeof(buffer) / sizeof( WCHAR ),
L"\\fltlib.dll" );
if (status != S_OK) {
printf(" Could not translate error: %d\n", Code);
return;
}
module = LoadLibraryExW( buffer, NULL, LOAD_LIBRARY_AS_DATAFILE );
//
// Translate the Win32 error code into a useful message.
//
count = FormatMessage (FORMAT_MESSAGE_FROM_HMODULE,
module,
Code,
0,
buffer,
sizeof(buffer) / sizeof(WCHAR),
NULL);
if (module != NULL) {
FreeLibrary( module );
}
//
// If we still couldn't resolve the message, generate a string
//
if (count == 0) {
printf(" Could not translate error: %d\n", Code);
return;
}
}
//
// Display the translated error.
//
printf(" %ws\n", buffer);
}
//
// Main uses a loop which has an assignment in the while
// conditional statement. Suppress the compiler's warning.
//
#pragma warning(push)
#pragma warning(disable:4706) // assignment within conditional expression
int _cdecl
main (
_In_ int argc,
_In_reads_(argc) char *argv[]
)
/*++
Routine Description:
Main routine for minispy
Arguments:
Return Value:
--*/
{
HANDLE port = INVALID_HANDLE_VALUE;
HRESULT hResult = S_OK;
DWORD result;
ULONG threadId;
HANDLE thread = NULL;
LOG_CONTEXT context;
CHAR inputChar;
//
// Initialize handle in case of error
//
context.ShutDown = NULL;
//
// Open the port that is used to talk to
// MiniSpy.
//
printf( "Connecting to filter's port...\n" );
hResult = FilterConnectCommunicationPort( MINISPY_PORT_NAME,
0,
NULL,
0,
NULL,
&port );
if (IS_ERROR( hResult )) {
printf( "Could not connect to filter: 0x%08x\n", hResult );
DisplayError( hResult );
goto Main_Exit;
}
//
// Initialize the fields of the LOG_CONTEXT
//
context.Port = port;
context.ShutDown = CreateSemaphore( NULL,
0,
1,
L"MiniSpy shut down" );
context.CleaningUp = FALSE;
context.LogToFile = FALSE;
context.LogToScreen = FALSE; //don't start logging yet
context.NextLogToScreen = TRUE;
context.OutputFile = NULL;
if (context.ShutDown == NULL) {
result = GetLastError();
printf( "Could not create semaphore: %d\n", result );
DisplayError( result );
goto Main_Exit;
}
//
// Check the valid parameters for startup
//
if (argc > 1) {
if (InterpretCommand( argc - 1, &(argv[1]), &context ) == USAGE_ERROR) {
goto Main_Exit;
}
}
//
// Create the thread to read the log records that are gathered
// by MiniSpy.sys.
//
printf( "Creating logging thread...\n" );
thread = CreateThread( NULL,
0,
RetrieveLogRecords,
(LPVOID)&context,
0,
&threadId);
if (!thread) {
result = GetLastError();
printf( "Could not create logging thread: %d\n", result );
DisplayError( result );
goto Main_Exit;
}
//
// Check to see what devices we are attached to from
// previous runs of this program.
//
ListDevices();
//
// Process commands from the user
//
printf( "\nHit [Enter] to begin command mode...\n\n" );
fflush( stdout );
//
// set screen logging state
//
context.LogToScreen = context.NextLogToScreen;
while (inputChar = (CHAR)getchar()) {
CHAR *parms[NUM_PARAMS];
CHAR commandLine[CMDLINE_SIZE+1];
INT parmCount, count;
DWORD returnValue = SUCCESS;
BOOL newParm;
CHAR ch;
if (inputChar == '\n') {
//
// Start command interpreter. First we must turn off logging
// to screen if we are. Also, remember the state of logging
// to the screen, so that we can reinstate that when command
// interpreter is finished.
//
context.NextLogToScreen = context.LogToScreen;
context.LogToScreen = FALSE;
while (returnValue != EXIT_INTERPRETER) {
//
// Print prompt
//
printf( ">" );
//
// Read in next line, keeping track of the number of parameters
// as we go.
//
parmCount = 0;
newParm = TRUE;
for ( count = 0;
(count < CMDLINE_SIZE) && ((ch = (CHAR)getchar()) != '\n');
count++)
{
commandLine[count] = ch;
if (newParm && (ch != ' ')) {
parms[parmCount++] = &commandLine[count];
}
if (parmCount >= NUM_PARAMS) {
break;
}
//
// Always insert NULL's for spaces
//
if (ch == ' ') {
newParm = TRUE;
commandLine[count] = 0;
} else {
newParm = FALSE;
}
}
commandLine[count] = '\0';
if (parmCount == 0) {
continue;
}
//
// We've got our parameter count and parameter list, so
// send it off to be interpreted.
//
returnValue = InterpretCommand( parmCount, parms, &context );
if (returnValue == EXIT_PROGRAM) {
// Time to stop the program
goto Main_Cleanup;
}
}
//
// Set LogToScreen appropriately based on any commands seen
//
context.LogToScreen = context.NextLogToScreen;
if (context.LogToScreen) {
printf( "Should be logging to screen...\n" );
}
}
}
Main_Cleanup:
//
// Clean up the threads, then fall through to Main_Exit
//
printf( "Cleaning up...\n" );
//
// Set the Cleaning up flag to TRUE to notify other threads
// that we are cleaning up
//
context.CleaningUp = TRUE;
//
// Wait for everyone to shut down
//
WaitForSingleObject( context.ShutDown, INFINITE );
if (context.LogToFile) {
fclose( context.OutputFile );
}
Main_Exit:
//
// Clean up the data that is always around and exit
//
if(context.ShutDown) {
CloseHandle( context.ShutDown );
}
if (thread) {
CloseHandle( thread );
}
if (INVALID_HANDLE_VALUE != port) {
CloseHandle( port );
}
return 0;
}
#pragma warning(pop)
DWORD
InterpretCommand (
_In_ int argc,
_In_reads_(argc) char *argv[],
_In_ PLOG_CONTEXT Context
)
/*++
Routine Description:
Process options from the user
Arguments:
Return Value:
--*/
{
LONG parmIndex;
PCHAR parm;
HRESULT hResult;
DWORD returnValue = SUCCESS;
CHAR buffer[BUFFER_SIZE];
DWORD bufferLength;
PWCHAR instanceString;
WCHAR instanceName[INSTANCE_NAME_MAX_CHARS + 1];
//
// Interpret the command line parameters
//
for (parmIndex = 0; parmIndex < argc; parmIndex++) {
parm = argv[parmIndex];
if (parm[0] == '/') {
//
// Have the beginning of a switch
//
switch (parm[1]) {
case 'a':
case 'A':
//
// Attach to the specified drive letter
//
parmIndex++;
if (parmIndex >= argc) {
//
// Not enough parameters
//
goto InterpretCommand_Usage;
}
parm = argv[parmIndex];
printf( " Attaching to %s... ", parm );
bufferLength = MultiByteToWideChar( CP_ACP,
MB_ERR_INVALID_CHARS,
parm,
-1,
(LPWSTR)buffer,
BUFFER_SIZE/sizeof( WCHAR ) );
if (bufferLength == 0) {
//
// We do not expect the user to provide a parm that
// causes buffer to overflow.
//
goto InterpretCommand_Usage;
}
hResult = FilterAttach( MINISPY_NAME,
(PWSTR)buffer,
NULL, // instance name
sizeof( instanceName ),
instanceName );
if (SUCCEEDED( hResult )) {
printf( " Instance name: %S\n", instanceName );
} else {
printf( "\n Could not attach to device: 0x%08x\n", hResult );
DisplayError( hResult );
returnValue = SUCCESS;
}
break;
case 'd':
case 'D':
//
// Detach to the specified drive letter
//
parmIndex++;
if (parmIndex >= argc) {
//
// Not enough parameters
//
goto InterpretCommand_Usage;
}
parm = argv[parmIndex];
printf( " Detaching from %s\n", parm );
bufferLength = MultiByteToWideChar( CP_ACP,
MB_ERR_INVALID_CHARS,
parm,
-1,
(LPWSTR)buffer,
BUFFER_SIZE/sizeof( WCHAR ) );
if (bufferLength == 0) {
//
// We do not expect the user to provide a parm that
// causes buffer to overflow.
//
goto InterpretCommand_Usage;
}
//
// Get the next argument to see if it is an InstanceId
//
parmIndex++;
if (parmIndex >= argc) {
instanceString = NULL;
} else {
if (argv[parmIndex][0] == '/') {
//
// This is just the next command, so don't
// internet it as the InstanceId.
//
instanceString = NULL;
parmIndex--;
} else {
parm = argv[parmIndex];
bufferLength = MultiByteToWideChar( CP_ACP,
MB_ERR_INVALID_CHARS,
parm,
-1,
(LPWSTR)instanceName,
sizeof( instanceName )/sizeof( WCHAR ) );
if (bufferLength == 0) {
//
// We do not expect the user to provide a parm that
// causes buffer to overflow.
//
goto InterpretCommand_Usage;
}
instanceString = instanceName;
}
}
//
// Detach from the volume and instance specified.
//
hResult = FilterDetach( MINISPY_NAME,
(PWSTR)buffer,
instanceString );
if (IS_ERROR( hResult )) {
printf( " Could not detach from device: 0x%08x\n", hResult );
DisplayError( hResult );
returnValue = SUCCESS;
}
break;
case 'l':
case 'L':
//
// List all devices that are currently being monitored
//
ListDevices();
break;
case 's':
case 'S':
//
// Output logging results to screen, save new value to
// instate when command interpreter is exited.
//
if (Context->NextLogToScreen) {
printf( " Turning off logging to screen\n" );
} else {
printf( " Turning on logging to screen\n" );
}
Context->NextLogToScreen = !Context->NextLogToScreen;
break;
case 'f':
case 'F':
//
// Output logging results to file
//
if (Context->LogToFile) {
printf( " Stop logging to file \n" );
Context->LogToFile = FALSE;
assert( Context->OutputFile );
_Analysis_assume_( Context->OutputFile != NULL );
fclose( Context->OutputFile );
Context->OutputFile = NULL;
} else {
parmIndex++;
if (parmIndex >= argc) {
//
// Not enough parameters
//
goto InterpretCommand_Usage;
}
parm = argv[parmIndex];
printf( " Log to file %s\n", parm );
if (fopen_s( &Context->OutputFile, parm, "w" ) != 0 ) {
assert( Context->OutputFile );
}
Context->LogToFile = TRUE;
}
break;
default:
//
// Invalid switch, goto usage
//
goto InterpretCommand_Usage;
}
} else {
//
// Look for "go" or "g" to see if we should exit interpreter
//
if (!_strnicmp( parm,
INTERPRETER_EXIT_COMMAND1,
sizeof( INTERPRETER_EXIT_COMMAND1 ))) {
returnValue = EXIT_INTERPRETER;
goto InterpretCommand_Exit;
}
if (!_strnicmp( parm,
INTERPRETER_EXIT_COMMAND2,
sizeof( INTERPRETER_EXIT_COMMAND2 ))) {
returnValue = EXIT_INTERPRETER;
goto InterpretCommand_Exit;
}
//
// Look for "exit" to see if we should exit program
//
if (!_strnicmp( parm,
PROGRAM_EXIT_COMMAND,
sizeof( PROGRAM_EXIT_COMMAND ))) {
returnValue = EXIT_PROGRAM;
goto InterpretCommand_Exit;
}
//
// Invalid parameter
//
goto InterpretCommand_Usage;
}
}
InterpretCommand_Exit:
return returnValue;
InterpretCommand_Usage:
printf("Valid switches: [/a <drive>] [/d <drive>] [/l] [/s] [/f [<file name>]]\n"
" [/a <drive>] starts monitoring <drive>\n"
" [/d <drive> [<instance id>]] detaches filter <instance id> from <drive>\n"
" [/l] lists all the drives the monitor is currently attached to\n"
" [/s] turns on and off showing logging output on the screen\n"
" [/f [<file name>]] turns on and off logging to the specified file\n"
" If you are in command mode:\n"
" [enter] will enter command mode\n"
" [go|g] will exit command mode\n"
" [exit] will terminate this program\n"
);
returnValue = USAGE_ERROR;
goto InterpretCommand_Exit;
}
ULONG
IsAttachedToVolume(
_In_ LPCWSTR VolumeName
)
/*++
Routine Description:
Determine if our filter is attached to this volume
Arguments:
VolumeName - The volume we are checking
Return Value:
TRUE - we are attached
FALSE - we are not attached (or we couldn't tell)
--*/
{
PWCHAR filtername;
CHAR buffer[1024];
PINSTANCE_FULL_INFORMATION data = (PINSTANCE_FULL_INFORMATION)buffer;
HANDLE volumeIterator = INVALID_HANDLE_VALUE;
ULONG bytesReturned;
ULONG instanceCount = 0;
HRESULT hResult;
//
// Enumerate all instances on this volume
//
hResult = FilterVolumeInstanceFindFirst( VolumeName,
InstanceFullInformation,
data,
sizeof(buffer)-sizeof(WCHAR),
&bytesReturned,
&volumeIterator );
if (IS_ERROR( hResult )) {
return instanceCount;
}
do {
assert((data->FilterNameBufferOffset+data->FilterNameLength) <= (sizeof(buffer)-sizeof(WCHAR)));
_Analysis_assume_((data->FilterNameBufferOffset+data->FilterNameLength) <= (sizeof(buffer)-sizeof(WCHAR)));
//
// Get the name. Note that we are NULL terminating the buffer
// in place. We can do this because we don't care about the other
// information and we have guaranteed that there is room for a NULL
// at the end of the buffer.
//
filtername = Add2Ptr(data,data->FilterNameBufferOffset);
filtername[data->FilterNameLength/sizeof( WCHAR )] = L'\0';
//
// Bump the instance count when we find a match
//
if (_wcsicmp(filtername,MINISPY_NAME) == 0) {
instanceCount++;
}
} while (SUCCEEDED( FilterVolumeInstanceFindNext( volumeIterator,
InstanceFullInformation,
data,
sizeof(buffer)-sizeof(WCHAR),
&bytesReturned ) ));
//
// Close the handle
//
FilterVolumeInstanceFindClose( volumeIterator );
return instanceCount;
}
void
ListDevices(
VOID
)
/*++
Routine Description:
Display the volumes we are attached to
Arguments:
Return Value:
--*/
{
UCHAR buffer[1024];
PFILTER_VOLUME_BASIC_INFORMATION volumeBuffer = (PFILTER_VOLUME_BASIC_INFORMATION)buffer;
HANDLE volumeIterator = INVALID_HANDLE_VALUE;
ULONG volumeBytesReturned;
HRESULT hResult = S_OK;
WCHAR driveLetter[15] = { 0 };
ULONG instanceCount;
try {
//
// Find out size of buffer needed
//
hResult = FilterVolumeFindFirst( FilterVolumeBasicInformation,
volumeBuffer,
sizeof(buffer)-sizeof(WCHAR), //save space to null terminate name
&volumeBytesReturned,
&volumeIterator );
if (IS_ERROR( hResult )) {
leave;
}
assert( INVALID_HANDLE_VALUE != volumeIterator );
//
// Output the header
//
printf( "\n"
"Dos Name Volume Name Status \n"
"-------------- ------------------------------------ --------\n" );
//
// Loop through all of the filters, displaying instance information
//
do {
assert((FIELD_OFFSET(FILTER_VOLUME_BASIC_INFORMATION,FilterVolumeName) + volumeBuffer->FilterVolumeNameLength) <= (sizeof(buffer)-sizeof(WCHAR)));
_Analysis_assume_((FIELD_OFFSET(FILTER_VOLUME_BASIC_INFORMATION,FilterVolumeName) + volumeBuffer->FilterVolumeNameLength) <= (sizeof(buffer)-sizeof(WCHAR)));
volumeBuffer->FilterVolumeName[volumeBuffer->FilterVolumeNameLength/sizeof( WCHAR )] = UNICODE_NULL;
instanceCount = IsAttachedToVolume(volumeBuffer->FilterVolumeName);
printf( "%-14ws %-36ws %s",
(SUCCEEDED( FilterGetDosName(
volumeBuffer->FilterVolumeName,
driveLetter,
sizeof(driveLetter)/sizeof(WCHAR) )) ? driveLetter : L""),
volumeBuffer->FilterVolumeName,
(instanceCount > 0) ? "Attached" : "");
if (instanceCount > 1) {
printf( " (%d)\n", instanceCount );
} else {
printf( "\n" );
}
} while (SUCCEEDED( hResult = FilterVolumeFindNext( volumeIterator,
FilterVolumeBasicInformation,
volumeBuffer,
sizeof(buffer)-sizeof(WCHAR), //save space to null terminate name
&volumeBytesReturned ) ));
if (HRESULT_FROM_WIN32( ERROR_NO_MORE_ITEMS ) == hResult) {
hResult = S_OK;
}
} finally {
if (INVALID_HANDLE_VALUE != volumeIterator) {
FilterVolumeFindClose( volumeIterator );
}
if (IS_ERROR( hResult )) {
if (HRESULT_FROM_WIN32( ERROR_NO_MORE_ITEMS ) == hResult) {
printf( "No volumes found.\n" );
} else {
printf( "Volume listing failed with error: 0x%08x\n",
hResult );
}
}
}
}