Annotation of truecrypt/common/apidrvr.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.6   root       12: #pragma once
                     13: 
                     14: #include "Tcdefs.h"
1.1.1.15  root       15: #include "Boot/Windows/BootDefs.h"
1.1.1.6   root       16: #include "Common.h"
                     17: #include "Crypto.h"
1.1.1.12  root       18: #include "Wipe.h"
1.1.1.6   root       19: 
                     20: #ifdef _WIN32
                     21: 
1.1.1.13  root       22: /* WARNING: Modifying the following values or their meanings can introduce incompatibility with previous versions. */
1.1       root       23: 
1.1.1.12  root       24: #define TC_IOCTL(CODE) (CTL_CODE (FILE_DEVICE_UNKNOWN, 0x800 + (CODE), METHOD_BUFFERED, FILE_ANY_ACCESS))
1.1       root       25: 
1.1.1.12  root       26: #define TC_IOCTL_GET_DRIVER_VERSION                                            TC_IOCTL (1)
                     27: #define TC_IOCTL_GET_BOOT_LOADER_VERSION                               TC_IOCTL (2)
                     28: #define TC_IOCTL_MOUNT_VOLUME                                                  TC_IOCTL (3)
                     29: #define TC_IOCTL_DISMOUNT_VOLUME                                               TC_IOCTL (4)
                     30: #define TC_IOCTL_DISMOUNT_ALL_VOLUMES                                  TC_IOCTL (5)
                     31: #define TC_IOCTL_GET_MOUNTED_VOLUMES                                   TC_IOCTL (6)
                     32: #define TC_IOCTL_GET_VOLUME_PROPERTIES                                 TC_IOCTL (7)
                     33: #define TC_IOCTL_GET_DEVICE_REFCOUNT                                   TC_IOCTL (8)
                     34: #define TC_IOCTL_WAS_REFERENCED_DEVICE_DELETED                 TC_IOCTL (9)
                     35: #define TC_IOCTL_IS_ANY_VOLUME_MOUNTED                                 TC_IOCTL (10)
                     36: #define TC_IOCTL_GET_PASSWORD_CACHE_STATUS                             TC_IOCTL (11)
                     37: #define TC_IOCTL_WIPE_PASSWORD_CACHE                                   TC_IOCTL (12)
                     38: #define TC_IOCTL_OPEN_TEST                                                             TC_IOCTL (13)
                     39: #define TC_IOCTL_GET_DRIVE_PARTITION_INFO                              TC_IOCTL (14)
                     40: #define TC_IOCTL_GET_DRIVE_GEOMETRY                                            TC_IOCTL (15)
                     41: #define TC_IOCTL_PROBE_REAL_DRIVE_SIZE                                 TC_IOCTL (16)
                     42: #define TC_IOCTL_GET_RESOLVED_SYMLINK                                  TC_IOCTL (17)
                     43: #define TC_IOCTL_GET_BOOT_ENCRYPTION_STATUS                            TC_IOCTL (18)
                     44: #define TC_IOCTL_BOOT_ENCRYPTION_SETUP                                 TC_IOCTL (19)
                     45: #define TC_IOCTL_ABORT_BOOT_ENCRYPTION_SETUP                   TC_IOCTL (20)
                     46: #define TC_IOCTL_GET_BOOT_ENCRYPTION_SETUP_RESULT              TC_IOCTL (21)
                     47: #define TC_IOCTL_GET_BOOT_DRIVE_VOLUME_PROPERTIES              TC_IOCTL (22)
                     48: #define TC_IOCTL_REOPEN_BOOT_VOLUME_HEADER                             TC_IOCTL (23)
1.1.1.13  root       49: #define TC_IOCTL_GET_BOOT_ENCRYPTION_ALGORITHM_NAME            TC_IOCTL (24)
                     50: #define TC_IOCTL_GET_TRAVELER_MODE_STATUS                              TC_IOCTL (25)
                     51: #define TC_IOCTL_SET_TRAVELER_MODE_STATUS                              TC_IOCTL (26)
1.1.1.14  root       52: #define TC_IOCTL_IS_HIDDEN_SYSTEM_RUNNING                              TC_IOCTL (27)
                     53: #define TC_IOCTL_GET_SYSTEM_DRIVE_CONFIG                               TC_IOCTL (28)
                     54: #define TC_IOCTL_DISK_IS_WRITABLE                                              TC_IOCTL (29)
1.1.1.15  root       55: #define TC_IOCTL_START_DECOY_SYSTEM_WIPE                               TC_IOCTL (30)
                     56: #define TC_IOCTL_ABORT_DECOY_SYSTEM_WIPE                               TC_IOCTL (31)
                     57: #define TC_IOCTL_GET_DECOY_SYSTEM_WIPE_STATUS                  TC_IOCTL (32)
                     58: #define TC_IOCTL_GET_DECOY_SYSTEM_WIPE_RESULT                  TC_IOCTL (33)
                     59: #define TC_IOCTL_WRITE_BOOT_DRIVE_SECTOR                               TC_IOCTL (34)
1.1.1.12  root       60: 
                     61: // Legacy IOCTLs used before version 5.0
                     62: #define TC_IOCTL_LEGACY_GET_DRIVER_VERSION             466968
                     63: #define TC_IOCTL_LEGACY_GET_MOUNTED_VOLUMES            466948
1.1       root       64: 
                     65: 
                     66: /* Start of driver interface structures, the size of these structures may
                     67:    change between versions; so make sure you first send DRIVER_VERSION to
                     68:    check that it's the correct device driver */
                     69: 
                     70: #pragma pack (push)
                     71: #pragma pack(1)
                     72: 
                     73: typedef struct
                     74: {
1.1.1.6   root       75:        int nReturnCode;                                        /* Return code back from driver */
1.1.1.15  root       76:        BOOL FilesystemDirty;
1.1.1.16  root       77:        BOOL VolumeMountedReadOnlyAfterAccessDenied;
1.1.1.17  root       78:        BOOL VolumeMountedReadOnlyAfterDeviceWriteProtected;
1.1.1.15  root       79: 
1.1.1.6   root       80:        short wszVolume[TC_MAX_PATH];           /* Volume to be mounted */
                     81:        Password VolumePassword;                        /* User password */
                     82:        BOOL bCache;                                            /* Cache passwords in driver */
                     83:        int nDosDriveNo;                                        /* Drive number to mount */
1.1.1.10  root       84:        int BytesPerSector;
1.1.1.6   root       85:        BOOL bMountReadOnly;                            /* Mount volume in read-only mode */
                     86:        BOOL bMountRemovable;                           /* Mount volume as removable media */
                     87:        BOOL bExclusiveAccess;                          /* Open host file/device in exclusive access mode */
                     88:        BOOL bMountManager;                                     /* Announce volume to mount manager */
                     89:        BOOL bPreserveTimestamp;                        /* Preserve file container timestamp */
1.1.1.13  root       90:        BOOL bPartitionInInactiveSysEncScope;           /* If TRUE, we are to attempt to mount a partition located on an encrypted system drive without pre-boot authentication. */
                     91:        int nPartitionInInactiveSysEncScopeDriveNo;     /* If bPartitionInInactiveSysEncScope is TRUE, this contains the drive number of the system drive on which the partition is located. */
1.1.1.6   root       92:        // Hidden volume protection
                     93:        BOOL bProtectHiddenVolume;                      /* TRUE if the user wants the hidden volume within this volume to be protected against being overwritten (damaged) */
                     94:        Password ProtectedHidVolPassword;       /* Password to the hidden volume to be protected against overwriting */
1.1.1.14  root       95:        BOOL UseBackupHeader;
1.1.1.15  root       96:        BOOL RecoveryMode;
1.1       root       97: } MOUNT_STRUCT;
                     98: 
                     99: typedef struct
                    100: {
                    101:        int nDosDriveNo;        /* Drive letter to unmount */
1.1.1.4   root      102:        BOOL ignoreOpenFiles;
1.1.1.14  root      103:        BOOL HiddenVolumeProtectionTriggered;
1.1.1.4   root      104:        int nReturnCode;        /* Return code back from driver */
1.1       root      105: } UNMOUNT_STRUCT;
                    106: 
                    107: typedef struct
                    108: {
1.1.1.6   root      109:        unsigned __int32 ulMountedDrives;       /* Bitfield of all mounted drive letters */
1.1.1.7   root      110:        short wszVolume[26][TC_MAX_PATH];       /* Volume names of mounted volumes */
1.1       root      111:        unsigned __int64 diskLength[26];
1.1.1.4   root      112:        int ea[26];
1.1.1.6   root      113:        int volumeType[26];     /* Volume type (e.g. PROP_VOL_TYPE_OUTER, PROP_VOL_TYPE_OUTER_VOL_WRITE_PREVENTED, etc.) */
1.1       root      114: } MOUNT_LIST_STRUCT;
                    115: 
                    116: typedef struct
                    117: {
                    118:        int driveNo;
1.1.1.6   root      119:        int uniqueId;
1.1.1.7   root      120:        short wszVolume[TC_MAX_PATH];
1.1       root      121:        unsigned __int64 diskLength;
1.1.1.4   root      122:        int ea;
1.1.1.7   root      123:        int mode;
1.1       root      124:        int pkcs5;
                    125:        int pkcs5Iterations;
1.1.1.4   root      126:        BOOL hiddenVolume;
1.1.1.6   root      127:        BOOL readOnly;
1.1.1.17  root      128:        BOOL removable;
1.1.1.15  root      129: #if 0
                    130:        unsigned __int64 volumeCreationTime;    // Deprecated in v6.0
                    131:        unsigned __int64 headerCreationTime;    // Deprecated in v6.0
                    132: #endif
                    133:        uint32 volumeHeaderFlags;
1.1.1.6   root      134:        unsigned __int64 totalBytesRead;
                    135:        unsigned __int64 totalBytesWritten;
                    136:        int hiddenVolProtection;        /* Hidden volume protection status (e.g. HIDVOL_PROT_STATUS_NONE, HIDVOL_PROT_STATUS_ACTIVE, etc.) */
1.1.1.14  root      137:        int volFormatVersion;
1.1       root      138: } VOLUME_PROPERTIES_STRUCT;
                    139: 
                    140: typedef struct
                    141: {
1.1.1.4   root      142:        WCHAR symLinkName[TC_MAX_PATH];
                    143:        WCHAR targetName[TC_MAX_PATH];
                    144: } RESOLVE_SYMLINK_STRUCT;
                    145: 
                    146: typedef struct
                    147: {
1.1.1.10  root      148:        WCHAR deviceName[TC_MAX_PATH];
                    149:        PARTITION_INFORMATION partInfo;
1.1.1.12  root      150:        BOOL IsGPT;
1.1.1.15  root      151:        BOOL IsDynamic;
1.1.1.10  root      152: }
                    153: DISK_PARTITION_INFO_STRUCT;
                    154: 
                    155: typedef struct
                    156: {
                    157:        WCHAR deviceName[TC_MAX_PATH];
                    158:        DISK_GEOMETRY diskGeometry;
                    159: }
                    160: DISK_GEOMETRY_STRUCT;
                    161: 
                    162: typedef struct
                    163: {
1.1.1.12  root      164:        WCHAR DeviceName[TC_MAX_PATH];
                    165:        LARGE_INTEGER RealDriveSize;
1.1.1.13  root      166:        BOOL TimeOut;
1.1.1.12  root      167: } ProbeRealDriveSizeRequest;
                    168: 
                    169: typedef struct
                    170: {
1.1.1.13  root      171:        short wszFileName[TC_MAX_PATH];         // Volume to be "open tested"
                    172:        BOOL bDetectTCBootLoader;                       // Whether the driver is to determine if the first sector contains a portion of the TrueCrypt Boot Loader
1.1.1.17  root      173:        BOOL TCBootLoaderDetected;
                    174:        BOOL DetectFilesystem;
                    175:        BOOL FilesystemDetected;
1.1       root      176: } OPEN_TEST_STRUCT;
                    177: 
                    178: 
1.1.1.12  root      179: typedef enum
                    180: {
                    181:        SetupNone = 0,
                    182:        SetupEncryption,
                    183:        SetupDecryption
                    184: } BootEncryptionSetupMode;
                    185: 
                    186: 
                    187: typedef struct
                    188: {
1.1.1.14  root      189:        // New fields must be added at the end of the structure to maintain compatibility with previous versions
1.1.1.12  root      190:        BOOL DeviceFilterActive;
                    191: 
                    192:        uint16 BootLoaderVersion;
                    193: 
                    194:        BOOL DriveMounted;
                    195:        BOOL VolumeHeaderPresent;
                    196:        BOOL DriveEncrypted;
                    197: 
                    198:        LARGE_INTEGER BootDriveLength;
                    199: 
                    200:        int64 ConfiguredEncryptedAreaStart;
                    201:        int64 ConfiguredEncryptedAreaEnd;
                    202:        int64 EncryptedAreaStart;
                    203:        int64 EncryptedAreaEnd;
                    204: 
                    205:        uint32 VolumeHeaderSaltCrc32;
                    206: 
                    207:        BOOL SetupInProgress;
                    208:        BootEncryptionSetupMode SetupMode;
                    209:        BOOL TransformWaitingForIdle;
                    210: 
                    211:        uint32 HibernationPreventionCount;
                    212: 
1.1.1.14  root      213:        BOOL HiddenSystem;
                    214:        int64 HiddenSystemPartitionStart;
                    215: 
                    216:        // Number of times the filter driver answered that an unencrypted volume
                    217:        // is read-only (or mounted an outer/normal TrueCrypt volume as read only)
                    218:        uint32 HiddenSysLeakProtectionCount;
                    219: 
1.1.1.12  root      220: } BootEncryptionStatus;
                    221: 
                    222: 
                    223: typedef struct
                    224: {
                    225:        BootEncryptionSetupMode SetupMode;
                    226:        WipeAlgorithmId WipeAlgorithm;
1.1.1.15  root      227:        BOOL ZeroUnreadableSectors;
1.1.1.17  root      228:        BOOL DiscardUnreadableEncryptedSectors;
1.1.1.12  root      229: } BootEncryptionSetupRequest;
                    230: 
                    231: 
                    232: typedef struct
                    233: {
                    234:        Password VolumePassword;
                    235: } ReopenBootVolumeHeaderRequest;
                    236: 
                    237: 
1.1.1.13  root      238: typedef struct
                    239: {
                    240:        char BootEncryptionAlgorithmName[256];
                    241: } GetBootEncryptionAlgorithmNameRequest;
                    242: 
1.1.1.14  root      243: typedef struct
                    244: {
                    245:        wchar_t DevicePath[TC_MAX_PATH];
                    246:        byte Configuration;
                    247:        BOOL DriveIsDynamic;
1.1.1.15  root      248:        uint16 BootLoaderVersion;
                    249:        byte UserConfiguration;
                    250:        char CustomUserMessage[TC_BOOT_SECTOR_USER_MESSAGE_MAX_LENGTH + 1];
1.1.1.14  root      251: } GetSystemDriveConfigurationRequest;
1.1.1.13  root      252: 
1.1.1.15  root      253: typedef struct
                    254: {
                    255:        WipeAlgorithmId WipeAlgorithm;
                    256:        byte WipeKey[MASTER_KEYDATA_SIZE];
                    257: } WipeDecoySystemRequest;
                    258: 
                    259: typedef struct
                    260: {
                    261:        BOOL WipeInProgress;
                    262:        WipeAlgorithmId WipeAlgorithm;
                    263:        int64 WipedAreaEnd;
                    264: } DecoySystemWipeStatus;
                    265: 
                    266: typedef struct
                    267: {
                    268:        LARGE_INTEGER Offset;
                    269:        byte Data[SECTOR_SIZE];
                    270: } WriteBootDriveSectorRequest;
                    271: 
1.1       root      272: #pragma pack (pop)
                    273: 
                    274: #ifdef NT4_DRIVER
                    275: #define DRIVER_STR WIDE
                    276: #else
                    277: #define DRIVER_STR
                    278: #endif
                    279: 
                    280: /* NT only */
                    281: 
1.1.1.13  root      282: #define TC_UNIQUE_ID_PREFIX "TrueCryptVolume"
1.1       root      283: #define TC_MOUNT_PREFIX L"\\Device\\TrueCryptVolume"
                    284: 
                    285: #define NT_MOUNT_PREFIX DRIVER_STR("\\Device\\TrueCryptVolume")
                    286: #define NT_ROOT_PREFIX DRIVER_STR("\\Device\\TrueCrypt")
                    287: #define DOS_MOUNT_PREFIX DRIVER_STR("\\DosDevices\\")
                    288: #define DOS_ROOT_PREFIX DRIVER_STR("\\DosDevices\\TrueCrypt")
                    289: #define WIN32_ROOT_PREFIX DRIVER_STR("\\\\.\\TrueCrypt")
1.1.1.6   root      290: 
1.1.1.14  root      291: #define TC_DRIVER_CONFIG_REG_VALUE_NAME DRIVER_STR("TrueCryptConfig")
                    292: 
1.1.1.15  root      293: #define TC_DRIVER_CONFIG_CACHE_BOOT_PASSWORD   0x1
                    294: 
1.1.1.6   root      295: #endif         /* _WIN32 */

unix.superglobalmegacorp.com

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