Skip to content

Commit 2f4f036

Browse files
mhendricmhendric
authored
Merge pull request #39 from mhendric/FixREADMEandAddCHANGELOG2
Create CHANGELOG.md, fix README.md warnings, and add .MetaTestOptIn.json
2 parents 44076a5 + 10fc376 commit 2f4f036

File tree

6 files changed

+192
-124
lines changed

6 files changed

+192
-124
lines changed

‎.MetaTestOptIn.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[
2+
"Common Tests - Validate Markdown Files",
3+
"Common Tests - Validate Module Files",
4+
"Common Tests - Validate Script Files",
5+
"Common Tests - Validate Example Files",
6+
"Common Tests - Validate Example Files To Be Published",
7+
"Common Tests - Required Script Analyzer Rules",
8+
"Common Tests - New Error-Level Script Analyzer Rules",
9+
"Common Tests - Custom Script Analyzer Rules",
10+
"Common Tests - Flagged Script Analyzer Rules",
11+
"Common Tests - Relative Path Length",
12+
"Common Tests - Validate Markdown Links"
13+
]

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
Change to [x] for each task in the task list that applies to your PR.
3535
For those task that don't apply to you PR, leave those as is.
3636
-->
37-
- [ ] Added an entry under the Unreleased section of the change log in the README.md.
37+
- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
3838
Entry should say what was changed, and how that affects users (if applicable).
3939
- [ ] Resource documentation added/updated in README.md.
4040
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof

‎CHANGELOG.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Change log for xBitlocker
2+
3+
## Unreleased
4+
5+
- Update appveyor.yml to use the default template.
6+
- Added default template files .gitattributes, and .vscode settings.
7+
- Fixes most PSScriptAnalyzer issues.
8+
- Fix issue where AutoUnlock is not set if requested, if the disk was
9+
originally encrypted and AutoUnlock was not used.
10+
- Add remaining Unit Tests for xBitlockerCommon.
11+
- Add Unit tests for MSFT_xBLTpm
12+
- Add remaining Unit Tests for xBLAutoBitlocker
13+
- Add Unit tests for MSFT_xBLBitlocker
14+
- Moved change log to CHANGELOG.md file
15+
- Fixed Markdown validation warnings in README.md
16+
- Added .MetaTestOptIn.json file to root of module
17+
18+
## 1.2.0.0
19+
20+
- Converted appveyor.yml to install Pester from PSGallery instead of from
21+
Chocolatey.
22+
- Added Codecov support.
23+
- Updated appveyor.yml to use the one in template.
24+
- Added folders for future unit and integration tests.
25+
- Added Visual Studio Code formatting settings.
26+
- Added .gitignore file.
27+
- Added markdown lint rules.
28+
- Fixed encoding on README.md.
29+
- Added `PowerShellVersion = '4.0'`, and updated copyright information, in the
30+
module manifest.
31+
- Fixed issue which caused Test to incorrectly succeed on fully decrypted
32+
volumes when correct Key Protectors were present
33+
([issue #13](https://github.com/PowerShell/xBitlocker/issues/13))
34+
- Fixed issue which caused xBLAutoBitlocker to incorrectly detect Fixed vs
35+
Removable volumes.
36+
([issue #11](https://github.com/PowerShell/xBitlocker/issues/11))
37+
- Fixed issue which made xBLAutoBitlocker unable to encrypt volumes with drive
38+
letters assigned.
39+
([issue #10](https://github.com/PowerShell/xBitlocker/issues/10))
40+
- Fixed an issue in CheckForPreReqs function where on Server Core the
41+
installation of the non existing Windows Feature
42+
'RSAT-Feature-Tools-BitLocker-RemoteAdminTool' was erroneously checked.
43+
([issue #8](https://github.com/PowerShell/xBitlocker/issues/8))
44+
45+
## 1.1.0.0
46+
47+
- Versioning updates
48+
49+
## 1.0.1.1
50+
51+
- Reduced the number of acceptable values for PrimaryProtector in
52+
xBLAutoBitlocker and xBLBitlocker.
53+
- Changed the properties that are returned by Get-TargetResource in
54+
xBLAutoBitlocker, xBLBitlocker, and xBLTpm.
55+
- Fixed issue which caused protectors to be continually re-added.
56+
57+
## 1.0.0.0
58+
59+
- Initial release with the following resources
60+
- xBLAutoBitlocker
61+
- xBLBitlocker
62+
- xBLTpm

‎Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Configuration ConfigureBitlockerAndAutoBitlocker
22
{
3-
Import-DscResource -Module xBitlocker
3+
Import-DscResource –ModuleName PSDesiredStateConfiguration
4+
Import-DscResource -ModuleName xBitlocker
45

56
Node 'E15-1'
67
{

‎Examples/ConfigureBitlockerOnOSDrive/ConfigureBitlockerOnOSDrive.ps1‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Configuration ConfigureBitlockerOnOSDrive
22
{
3-
Import-DscResource -Module xBitlocker
3+
Import-DscResource –ModuleName PSDesiredStateConfiguration
4+
Import-DscResource -ModuleName xBitlocker
45

56
Node "E15-1"
67
{

‎README.md‎

Lines changed: 112 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# xBitlocker
22

3-
The **xBitlocker** module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team.
3+
The **xBitlocker** module is a part of the Windows PowerShell Desired State
4+
Configuration (DSC) Resource Kit, which is a collection of DSC Resources
5+
produced by the PowerShell Team.
46
This module contains the **xBLAutoBitlocker, xBLBitlocker, xBLTpm** resources.
5-
This DSC Module allows you to configure Bitlocker on a single disk, configure a TPM chip, or automatically enable Bitlocker on multiple disks.
7+
This DSC Module allows you to configure Bitlocker on a single disk, configure a
8+
TPM chip, or automatically enable Bitlocker on multiple disks.
69

7-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
8-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
10+
This project has adopted the
11+
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
12+
. For more information see the
13+
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
14+
contact [[email protected]](mailto:[email protected]) with any
15+
additional questions or comments.
916

1017
## Branches
1118

@@ -28,7 +35,9 @@ This development branch will periodically be merged to the master branch,
2835
and be released to [PowerShell Gallery](https://www.powershellgallery.com/).
2936

3037
## Contributing
31-
Please check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).
38+
39+
Please check out common DSC Resources
40+
[contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).
3241

3342
## Installation
3443

@@ -38,143 +47,125 @@ To install **xBitlocker** module
3847

3948
To confirm installation:
4049

41-
* Run **Get-DSCResource** to see that **xBLAutoBitlocker, xBLBitlocker, xBLTpm** are among the DSC Resources listed
50+
* Run **Get-DSCResource** to see that **xBLAutoBitlocker**, **xBLBitlocker**,
51+
**xBLTpm** are among the DSC Resources listed.
4252

4353
## Requirements
4454

45-
This module requires that both the 'Bitlocker' and 'RSAT-Feature-Tools-Bitlocker' features are installed.
46-
It also requires the latest version of PowerShell (v4.0, which ships in Windows 8.1 or Windows Server 2012R2).
47-
To easily use PowerShell 4.0 on older operating systems, [<span style="color:#0000ff">install WMF 4.0](http://www.microsoft.com/en-us/download/details.aspx?id=40855).
48-
Please read the installation instructions that are present on both the download page and the release notes for WMF 4.0.
55+
This module requires that both the **Bitlocker** and
56+
**RSAT-Feature-Tools-Bitlocker** features are installed.
57+
It also requires the latest version of PowerShell (v4.0, which ships in Windows
58+
8.1 or Windows Server 2012R2).
59+
To easily use PowerShell 4.0 on older operating systems,
60+
[Install WMF 4.0](http://www.microsoft.com/en-us/download/details.aspx?id=40855)
61+
. Please read the installation instructions that are present on both the
62+
download page and the release notes for WMF 4.0.
4963

5064
## Description
5165

52-
The **xBitlocker ** module contains the **xBLAutoBitlocker, xBLBitlocker, xBLTpm** DSC Resources.
53-
This DSC Module allows you to configure Bitlocker on a single disk, configure a TPM chip, or automatically enable Bitlocker on multiple disks.
66+
The **xBitlocker** module contains the **xBLAutoBitlocker, xBLBitlocker,
67+
xBLTpm** DSC Resources.
68+
This DSC Module allows you to configure Bitlocker on a single disk, configure a
69+
TPM chip, or automatically enable Bitlocker on multiple disks.
5470

5571
## Resources
5672

57-
**xBLAutoBitlocker** is used to automatically enable Bitlocker on drives of type Fixed or Removable.
73+
**xBLAutoBitlocker** is used to automatically enable Bitlocker on drives of
74+
type Fixed or Removable.
5875
It does not work on Operating System drives.
5976
**xBLAutoBitlocker** has the following properties.
60-
Where no description is listed, properties correspond directly to [Enable-Bitlocker](http://technet.microsoft.com/en-us/library/jj649837.aspx) parameters.
61-
62-
* *DriveType:The type of volume to auto apply Bitlocker to. Valid values are "Fixed" or "Removable"
63-
* *PrimaryProtector:The primary protector type to be used for AutoBitlocker.
64-
Valid values are: "AdAccountOrGroupProtector", "PasswordProtector", "Pin", "RecoveryKeyProtector", "RecoveryPasswordProtector", "StartupKeyProtector", or "TpmProtector"
65-
* MinDiskCapacityGB:If specified, only disks this size or greater will auto apply Bitlocker
66-
* AutoUnlock:Whether volumes should be enabled for auto unlock using Enable-BitlockerAutoUnlock
67-
* AdAccountOrGroup
68-
* AdAccountOrGroupProtector
69-
* EncryptionMethod
70-
* HardwareEncryption
71-
* Password
72-
* PasswordProtector
73-
* Pin
74-
* RecoveryKeyPath
75-
* RecoveryKeyProtector
76-
* RecoveryPasswordProtector
77-
* Service
78-
* SkipHardwareTest
79-
* StartupKeyPath
80-
* StartupKeyProtector
81-
* TpmProtector
82-
* UsedSpaceOnly
77+
Where no description is listed, properties correspond directly to
78+
[Enable-Bitlocker](https://docs.microsoft.com/en-us/powershell/module/bitlocker/enable-bitlocker)
79+
parameters.
80+
81+
* DriveType: The type of volume to auto apply Bitlocker to. Valid values are
82+
"Fixed" or "Removable"
83+
* PrimaryProtector: The primary protector type to be used for AutoBitlocker.
84+
Valid values are: "AdAccountOrGroupProtector", "PasswordProtector", "Pin",
85+
"RecoveryKeyProtector", "RecoveryPasswordProtector", "StartupKeyProtector",
86+
or "TpmProtector"
87+
* MinDiskCapacityGB: If specified, only disks this size or greater will auto
88+
apply Bitlocker
89+
* AutoUnlock: Whether volumes should be enabled for auto unlock using
90+
Enable-BitlockerAutoUnlock
91+
* AdAccountOrGroup
92+
* AdAccountOrGroupProtector
93+
* EncryptionMethod
94+
* HardwareEncryption
95+
* Password
96+
* PasswordProtector
97+
* Pin
98+
* RecoveryKeyPath
99+
* RecoveryKeyProtector
100+
* RecoveryPasswordProtector
101+
* Service
102+
* SkipHardwareTest
103+
* StartupKeyPath
104+
* StartupKeyProtector
105+
* TpmProtector
106+
* UsedSpaceOnly
83107

84108
**xBLBitlocker** has the following properties.
85-
Where no description is listed, properties correspond directly to [Enable-Bitlocker](http://technet.microsoft.com/en-us/library/jj649837.aspx) parameters.
86-
87-
* *MountPoint:The MountPoint name as reported in Get-BitLockerVolume
88-
* *PrimaryProtector:The primary protector type to be used for AutoBitlocker.
89-
Valid values are: "AdAccountOrGroupProtector", "PasswordProtector", "Pin", "RecoveryKeyProtector", "RecoveryPasswordProtector", "StartupKeyProtector", or "TpmProtector"
90-
* AutoUnlock:Whether volumes should be enabled for auto unlock using Enable-BitlockerAutoUnlock
91-
* AllowImmediateReboot:Whether the computer can be immediately rebooted after enabling Bitlocker on an OS drive.
92-
Defaults to false.
93-
94-
* AdAccountOrGroup
95-
* AdAccountOrGroupProtector
96-
* EncryptionMethod
97-
* HardwareEncryption
98-
* Password
99-
* PasswordProtector
100-
* Pin
101-
* RecoveryKeyPath
102-
* RecoveryKeyProtector
103-
* RecoveryPasswordProtector
104-
* Service
105-
* SkipHardwareTest
106-
* StartupKeyPath
107-
* StartupKeyProtector
108-
* TpmProtector
109-
* UsedSpaceOnly
110-
111-
**xBLTpm** is used to initialize a TPM chip using [Initialize-TPM](http://technet.microsoft.com/en-us/library/jj603112.aspx).
109+
Where no description is listed, properties correspond directly to
110+
[Enable-Bitlocker](https://docs.microsoft.com/en-us/powershell/module/bitlocker/enable-bitlocker)
111+
parameters.
112+
113+
* MountPoint: The MountPoint name as reported in Get-BitLockerVolume
114+
* PrimaryProtector: The primary protector type to be used for AutoBitlocker.
115+
Valid values are: "AdAccountOrGroupProtector", "PasswordProtector", "Pin",
116+
"RecoveryKeyProtector", "RecoveryPasswordProtector", "StartupKeyProtector",
117+
or "TpmProtector"
118+
* AutoUnlock: Whether volumes should be enabled for auto unlock using
119+
Enable-BitlockerAutoUnlock
120+
* AllowImmediateReboot: Whether the computer can be immediately rebooted after
121+
enabling Bitlocker on an OS drive.
122+
Defaults to false.
123+
124+
* AdAccountOrGroup
125+
* AdAccountOrGroupProtector
126+
* EncryptionMethod
127+
* HardwareEncryption
128+
* Password
129+
* PasswordProtector
130+
* Pin
131+
* RecoveryKeyPath
132+
* RecoveryKeyProtector
133+
* RecoveryPasswordProtector
134+
* Service
135+
* SkipHardwareTest
136+
* StartupKeyPath
137+
* StartupKeyProtector
138+
* TpmProtector
139+
* UsedSpaceOnly
140+
141+
**xBLTpm** is used to initialize a TPM chip using
142+
[Initialize-TPM](https://docs.microsoft.com/en-us/powershell/module/trustedplatformmodule/initialize-tpm)
143+
.
112144
**xBLTpm** has the following properties.
113145

114-
* *Identity:Not actually used, so could be anything
115-
* AllowClear:Indicates that the provisioning process clears the TPM, if necessary, to move the TPM closer to complying with Windows Server 2012 standards
116-
* AllowPhysicalPresence:Indicates that the provisioning process may send physical presence commands that require a user to be present in order to continue.
117-
* AllowImmediateReboot:Whether the computer can rebooted immediately after initializing the TPM
118-
119-
## Versions
120-
121-
### Unreleased
122-
123-
* Update appveyor.yml to use the default template.
124-
* Added default template files .gitattributes, and .vscode settings.
125-
* Fixes most PSScriptAnalyzer issues.
126-
* Fix issue where AutoUnlock is not set if requested, if the disk was
127-
originally encrypted and AutoUnlock was not used.
128-
* Add remaining Unit Tests for xBitlockerCommon.
129-
* Add Unit tests for MSFT_xBLTpm
130-
* Add remaining Unit Tests for xBLAutoBitlocker
131-
* Add Unit tests for MSFT_xBLBitlocker
132-
133-
### 1.2.0.0
134-
135-
* Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
136-
* Added Codecov support.
137-
* Updated appveyor.yml to use the one in template.
138-
* Added folders for future unit and integration tests.
139-
* Added Visual Studio Code formatting settings.
140-
* Added .gitignore file.
141-
* Added markdown lint rules.
142-
* Fixed encoding on README.md.
143-
* Added `PowerShellVersion = '4.0'`, and updated copyright information, in the
144-
module manifest.
145-
* Fixed issue which caused Test to incorrectly succeed on fully decrypted volumes when correct Key Protectors were present ([issue #13](https://github.com/PowerShell/xBitlocker/issues/13))
146-
* Fixed issue which caused xBLAutoBitlocker to incorrectly detect Fixed vs Removable volumes. ([issue #11](https://github.com/PowerShell/xBitlocker/issues/11))
147-
* Fixed issue which made xBLAutoBitlocker unable to encrypt volumes with drive letters assigned. ([issue #10](https://github.com/PowerShell/xBitlocker/issues/10))
148-
* Fixed an issue in CheckForPreReqs function where on Server Core the installation of the non existing Windows Feature 'RSAT-Feature-Tools-BitLocker-RemoteAdminTool' was erroneously checked. ([issue #8](https://github.com/PowerShell/xBitlocker/issues/8))
149-
150-
151-
### 1.1.0.0
152-
153-
* Versioning updates
154-
155-
### 1.0.1.1
156-
157-
* Reduced the number of acceptable values for PrimaryProtector in xBLAutoBitlocker and xBLBitlocker.
158-
* Changed the properties that are returned by Get-TargetResource in xBLAutoBitlocker, xBLBitlocker, and xBLTpm.
159-
* Fixed issue which caused protectors to be continually re-added.
160-
161-
162-
### 1.0.0.0
163-
164-
* Initial release with the following resources
165-
* xBLAutoBitlocker
166-
* xBLBitlocker
167-
* xBLTpm
146+
* Identity: Not actually used, so could be anything
147+
* AllowClear: Indicates that the provisioning process clears the TPM, if
148+
necessary, to move the TPM closer to complying with Windows Server 2012
149+
standards
150+
* AllowPhysicalPresence: Indicates that the provisioning process may send
151+
physical presence commands that require a user to be present in order to
152+
continue.
153+
* AllowImmediateReboot: Whether the computer can rebooted immediately after
154+
initializing the TPM
168155

169156
## Examples
170157

171158
### [ConfigureBitlockerOnOSDrive](Examples/ConfigureBitlockerOnOSDrive)
172159

173160
This example enables Bitlocker on an Operating System drive.
174-
The example code for ConfigureBitlockerOnOSDrive is located in [`ConfigureBitlockerOnOSDrive.ps1`](Examples/ConfigureBitlockerOnOSDrive/ConfigureBitlockerOnOSDrive.ps1).
161+
The example code for ConfigureBitlockerOnOSDrive is located in
162+
[`ConfigureBitlockerOnOSDrive.ps1`](Examples/ConfigureBitlockerOnOSDrive/ConfigureBitlockerOnOSDrive.ps1)
163+
.
175164

176165
### [ConfigureBitlockerAndAutoBitlocker](Examples/ConfigureBitlockerAndAutoBitlocker)
177166

178-
Enables Bitlocker on an Operating System drive, and automatically enables Bitlocker on all drives of type 'Fixed'.
179-
The example code for ConfigureBitlockerAndAutoBitlocker is located in [`ConfigureBitlockerAndAutoBitlocker.ps1`](Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1).
180-
167+
Enables Bitlocker on an Operating System drive, and automatically enables
168+
Bitlocker on all drives of type 'Fixed'. The example code for
169+
ConfigureBitlockerAndAutoBitlocker is located in
170+
[`ConfigureBitlockerAndAutoBitlocker.ps1`](Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1)
171+
.

0 commit comments

Comments
 (0)