Annotation of truecrypt/driver/ntdriver.h, revision 1.1.1.18

1.1.1.10  root        1: /*
1.1.1.12  root        2:  Legal Notice: Some portions of the source code contained in this file were
                      3:  derived from the source code of Encryption for the Masses 2.02a, which is
                      4:  Copyright (c) 1998-2000 Paul Le Roux and which is governed by the 'License
                      5:  Agreement for Encryption for the Masses'. Modifications and additions to
                      6:  the original source code (contained in this file) and all other portions of
1.1.1.17  root        7:  this file are Copyright (c) 2003-2009 TrueCrypt Foundation and are governed
1.1.1.18! root        8:  by the TrueCrypt License 2.7 the full text of which is contained in the
1.1.1.12  root        9:  file License.txt included in TrueCrypt binary and source code distribution
1.1.1.10  root       10:  packages. */
1.1       root       11: 
1.1.1.12  root       12: #ifndef TC_HEADER_NTDRIVER
                     13: #define TC_HEADER_NTDRIVER
                     14: 
                     15: #include "EncryptedIoQueue.h"
                     16: 
1.1       root       17: /* This structure is used to start new threads */
                     18: typedef struct _THREAD_BLOCK_
                     19: {
                     20:        PDEVICE_OBJECT DeviceObject;
                     21:        NTSTATUS ntCreateStatus;
1.1.1.7   root       22:        WCHAR wszMountVolume[TC_MAX_PATH + 8];
1.1       root       23:        MOUNT_STRUCT *mount;
                     24: } THREAD_BLOCK, *PTHREAD_BLOCK;
                     25: 
1.1.1.12  root       26: 
1.1       root       27: /* This structure is allocated for non-root devices! WARNING: bRootDevice
                     28:    must be the first member of the structure! */
                     29: typedef struct EXTENSION
                     30: {
1.1.1.14  root       31:        BOOL bRootDevice;       /* Is this the root device ? which the user-mode apps talk to */
1.1.1.15  root       32:        BOOL IsVolumeDevice;
1.1.1.12  root       33:        BOOL IsDriveFilterDevice;
1.1.1.15  root       34:        BOOL IsVolumeFilterDevice;
1.1       root       35: 
1.1.1.14  root       36:        ULONG lMagicNumber;     /* To ensure the completion routine is not sending us bad IRP's */
1.1       root       37: 
1.1.1.6   root       38:        int UniqueVolumeId;
1.1.1.14  root       39:        int nDosDriveNo;        /* Drive number this extension is mounted against */
                     40: 
1.1       root       41:        BOOL bShuttingDown;                     /* Is the driver shutting down ? */
                     42:        BOOL bThreadShouldQuit;         /* Instruct per device worker thread to quit */
                     43:        PETHREAD peThread;                      /* Thread handle */
                     44:        KEVENT keCreateEvent;           /* Device creation event */
                     45:        KSPIN_LOCK ListSpinLock;        /* IRP spinlock */
                     46:        LIST_ENTRY ListEntry;           /* IRP listentry */
                     47:        KSEMAPHORE RequestSemaphore;    /* IRP list request  Semaphore */
                     48: 
                     49:        HANDLE hDeviceFile;                     /* Device handle for this device */
                     50:        PFILE_OBJECT pfoDeviceFile;     /* Device fileobject for this device */
                     51:        PDEVICE_OBJECT pFsdDevice;      /* lower level device handle */
                     52: 
1.1.1.6   root       53:        CRYPTO_INFO *cryptoInfo;        /* Cryptographic and other information for this device */
1.1       root       54: 
1.1.1.17  root       55:        __int64 HostLength;
1.1       root       56:        __int64 DiskLength;                     /* The length of the disk referred to by this device */  
                     57:        __int64 NumberOfCylinders;              /* Partition info */
                     58:        ULONG TracksPerCylinder;        /* Partition info */
                     59:        ULONG SectorsPerTrack;          /* Partition info */
                     60:        ULONG BytesPerSector;           /* Partition info */
                     61:        UCHAR PartitionType;            /* Partition info */
1.1.1.10  root       62:        
                     63:        int HostBytesPerSector;
1.1       root       64: 
                     65:        KEVENT keVolumeEvent;           /* Event structure used when setting up a device */
                     66: 
1.1.1.12  root       67:        EncryptedIoQueue Queue;
1.1.1.8   root       68: 
1.1.1.4   root       69:        BOOL bReadOnly;                         /* Is this device read-only ? */
                     70:        BOOL bRemovable;                        /* Is this device removable media ? */
                     71:        BOOL bRawDevice;                        /* Is this a raw-partition or raw-floppy device ? */
                     72:        BOOL bMountManager;                     /* Mount manager knows about volume */
1.1       root       73: 
1.1.1.7   root       74:        WCHAR wszVolume[TC_MAX_PATH];   /*  DONT change this size without also changing MOUNT_LIST_STRUCT! */
1.1       root       75: 
1.1.1.6   root       76:        // Container file date/time (used to reset date and time of file-hosted volumes after dismount or unsuccessful mount attempt, to preserve plausible deniability of hidden volumes).
1.1.1.4   root       77:        LARGE_INTEGER fileCreationTime;
                     78:        LARGE_INTEGER fileLastAccessTime;
                     79:        LARGE_INTEGER fileLastWriteTime;
                     80:        LARGE_INTEGER fileLastChangeTime;
1.1.1.6   root       81:        BOOL bTimeStampValid;
                     82: 
1.1.1.16  root       83:        PSID UserSid;
                     84:        BOOL SecurityClientContextValid;
                     85:        SECURITY_CLIENT_CONTEXT SecurityClientContext;
                     86: 
1.1       root       87: } EXTENSION, *PEXTENSION;
                     88: 
1.1.1.16  root       89: 
                     90: typedef enum
                     91: {
                     92:        ValidateInput,
                     93:        ValidateOutput,
                     94:        ValidateInputOutput
                     95: } ValidateIOBufferSizeType;
                     96: 
                     97: 
1.1.1.14  root       98: extern PDRIVER_OBJECT TCDriverObject;
1.1.1.12  root       99: extern BOOL DriverShuttingDown;
1.1.1.10  root      100: extern ULONG OsMajorVersion;
1.1.1.14  root      101: extern ULONG OsMinorVersion;
1.1.1.17  root      102: extern BOOL VolumeClassFilterRegistered;
1.1.1.16  root      103: extern BOOL CacheBootPassword;
1.1.1.10  root      104: 
1.1       root      105: /* Helper macro returning x seconds in units of 100 nanoseconds */
1.1.1.4   root      106: #define WAIT_SECONDS(x) ((x)*10000000)
1.1       root      107: 
                    108: NTSTATUS DriverEntry (PDRIVER_OBJECT DriverObject, PUNICODE_STRING RegistryPath);
1.1.1.15  root      109: NTSTATUS DriverAddDevice (PDRIVER_OBJECT driverObject, PDEVICE_OBJECT pdo);
1.1.1.12  root      110: void DumpMemory (void *memory, int size);
                    111: BOOL IsAccessibleByUser (PUNICODE_STRING objectFileName, BOOL readOnly);
                    112: NTSTATUS ProcessMainDeviceControlIrp (PDEVICE_OBJECT DeviceObject, PEXTENSION Extension, PIRP Irp);
                    113: NTSTATUS ProcessVolumeDeviceControlIrp (PDEVICE_OBJECT DeviceObject, PEXTENSION Extension, PIRP Irp);
                    114: NTSTATUS SendDeviceIoControlRequest (PDEVICE_OBJECT deviceObject, ULONG ioControlCode, void *inputBuffer, int inputBufferSize, void *outputBuffer, int outputBufferSize);
1.1       root      115: NTSTATUS TCDispatchQueueIRP (PDEVICE_OBJECT DeviceObject, PIRP Irp);
                    116: NTSTATUS TCCreateRootDeviceObject (PDRIVER_OBJECT DriverObject);
1.1.1.4   root      117: NTSTATUS TCCreateDeviceObject (PDRIVER_OBJECT DriverObject, PDEVICE_OBJECT * ppDeviceObject, MOUNT_STRUCT * mount);
1.1.1.12  root      118: NTSTATUS TCReadDevice (PDEVICE_OBJECT deviceObject, PVOID buffer, LARGE_INTEGER offset, ULONG length);
                    119: NTSTATUS TCWriteDevice (PDEVICE_OBJECT deviceObject, PVOID buffer, LARGE_INTEGER offset, ULONG length);
                    120: NTSTATUS TCStartThread (PKSTART_ROUTINE threadProc, PVOID threadArg, PKTHREAD *kThread);
1.1.1.13  root      121: NTSTATUS TCStartThreadInProcess (PKSTART_ROUTINE threadProc, PVOID threadArg, PKTHREAD *kThread, PEPROCESS process);
1.1.1.12  root      122: NTSTATUS TCStartVolumeThread (PDEVICE_OBJECT DeviceObject, PEXTENSION Extension, MOUNT_STRUCT * mount);
                    123: void TCStopThread (PKTHREAD kThread, PKEVENT wakeUpEvent);
                    124: void TCStopVolumeThread (PDEVICE_OBJECT DeviceObject, PEXTENSION Extension);
                    125: VOID VolumeThreadProc (PVOID Context);
1.1.1.5   root      126: void TCSleep (int milliSeconds);
1.1       root      127: void TCGetNTNameFromNumber (LPWSTR ntname, int nDriveNo);
                    128: void TCGetDosNameFromNumber (LPWSTR dosname, int nDriveNo);
                    129: LPWSTR TCTranslateCode (ULONG ulCode);
                    130: PDEVICE_OBJECT TCDeleteDeviceObject (PDEVICE_OBJECT DeviceObject, PEXTENSION Extension);
                    131: VOID TCUnloadDriver (PDRIVER_OBJECT DriverObject);
1.1.1.4   root      132: NTSTATUS TCDeviceIoControl (PWSTR deviceName, ULONG IoControlCode, void *InputBuffer, int InputBufferSize, void *OutputBuffer, int OutputBufferSize);
                    133: NTSTATUS TCOpenFsVolume (PEXTENSION Extension, PHANDLE volumeHandle, PFILE_OBJECT * fileObject);
                    134: void TCCloseFsVolume (HANDLE volumeHandle, PFILE_OBJECT fileObject);
                    135: NTSTATUS TCFsctlCall (PFILE_OBJECT fileObject, LONG IoControlCode, void *InputBuffer, int InputBufferSize, void *OutputBuffer, int OutputBufferSize);
1.1.1.6   root      136: NTSTATUS CreateDriveLink (int nDosDriveNo);
                    137: NTSTATUS RemoveDriveLink (int nDosDriveNo);
1.1.1.4   root      138: NTSTATUS MountManagerMount (MOUNT_STRUCT *mount);
                    139: NTSTATUS MountManagerUnmount (int nDosDriveNo);
                    140: NTSTATUS MountDevice (PDEVICE_OBJECT deviceObject, MOUNT_STRUCT *mount);
1.1.1.15  root      141: NTSTATUS UnmountDevice (UNMOUNT_STRUCT *unmountRequest, PDEVICE_OBJECT deviceObject, BOOL ignoreOpenFiles);
                    142: NTSTATUS UnmountAllDevices (UNMOUNT_STRUCT *unmountRequest, PDEVICE_OBJECT DeviceObject, BOOL ignoreOpenFiles);
1.1.1.4   root      143: NTSTATUS SymbolicLinkToTarget (PWSTR symlinkName, PWSTR targetName, USHORT maxTargetNameLength);
1.1.1.5   root      144: void DriverMutexWait ();
                    145: void DriverMutexRelease ();
1.1.1.6   root      146: BOOL RegionsOverlap (unsigned __int64 start1, unsigned __int64 end1, unsigned __int64 start2, unsigned __int64 end2);
1.1.1.12  root      147: void GetIntersection (uint64 start1, uint32 length1, uint64 start2, uint64 end2, uint64 *intersectStart, uint32 *intersectLength);
                    148: NTSTATUS TCCompleteIrp (PIRP irp, NTSTATUS status, ULONG_PTR information);
                    149: NTSTATUS TCCompleteDiskIrp (PIRP irp, NTSTATUS status, ULONG_PTR information);
                    150: NTSTATUS ProbeRealDriveSize (PDEVICE_OBJECT driveDeviceObject, LARGE_INTEGER *driveSize);
1.1.1.14  root      151: BOOL UserCanAccessDriveDevice ();
1.1.1.15  root      152: size_t GetCpuCount ();
                    153: void EnsureNullTerminatedString (wchar_t *str, size_t maxSizeInBytes);
                    154: void *AllocateMemoryWithTimeout (size_t size, int retryDelay, int timeout);
                    155: BOOL IsDriveLetterAvailable (int nDosDriveNo);
                    156: NTSTATUS TCReadRegistryKey (PUNICODE_STRING keyPath, wchar_t *keyValueName, PKEY_VALUE_PARTIAL_INFORMATION *keyData);
                    157: NTSTATUS TCWriteRegistryKey (PUNICODE_STRING keyPath, wchar_t *keyValueName, ULONG keyValueType, void *valueData, ULONG valueSize);
                    158: BOOL IsVolumeClassFilterRegistered ();
                    159: uint32 ReadRegistryConfigFlags ();
                    160: NTSTATUS WriteRegistryConfigFlags (uint32 flags);
1.1.1.16  root      161: BOOL ValidateIOBufferSize (PIRP irp, size_t requiredBufferSize, ValidateIOBufferSizeType type);
                    162: NTSTATUS GetDeviceSectorSize (PDEVICE_OBJECT deviceObject, ULONG *bytesPerSector);
                    163: NTSTATUS ZeroUnreadableSectors (PDEVICE_OBJECT deviceObject, LARGE_INTEGER startOffset, ULONG size, uint64 *zeroedSectorCount);
1.1.1.17  root      164: NTSTATUS ReadDeviceSkipUnreadableSectors (PDEVICE_OBJECT deviceObject, byte *buffer, LARGE_INTEGER startOffset, ULONG size, uint64 *badSectorCount);
1.1.1.16  root      165: BOOL IsVolumeAccessibleByCurrentUser (PEXTENSION volumeDeviceExtension);
1.1.1.17  root      166: void GetElapsedTimeInit (LARGE_INTEGER *lastPerfCounter);
                    167: int64 GetElapsedTime (LARGE_INTEGER *lastPerfCounter);
1.1.1.12  root      168: 
                    169: #define TC_BUG_CHECK(status) KeBugCheckEx (SECURITY_SYSTEM, __LINE__, status, 0, 'TC')
                    170: 
                    171: #endif // TC_HEADER_NTDRIVER

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.