SA-3176: New/Set-JCPolicy Import Reg Files #501

gweinjc · 2023-06-21T19:48:38Z

Issues

SA-3176 - New/Set-JCPolicy Import Reg Files

What does this solve?

This feature will allow admins to upload .reg files into new or existing Windows - Advanced: Custom Registry Keys Policy JumpCloud Policies to deploy to their Windows machines.

Is there anything particularly tricky?

Currently, Windows - Advanced: Custom Registry Keys Policy only accepts registry keys that belong in the HKEY_LOCAL_MACHINE (HKLM) hive. If a .reg file is attempted to be uploaded that contains a non-HKLM key, it will not be valid.

How should this be tested?

Download the sample .reg file and unzip
i. SampleRegFile.reg.zip
Run the following function:
ii. New-JCPolicy -TemplateName windows_Advanced:_Custom_Registry_Keys -Name "Test - Registry File Upload" -registryFile "/path/to/SampleRegFile.reg"
Validate that the "Test - Registry File Upload" Policy was successfully created and contains the expected registry values
Run the following function:
iv. Set-JCPolicy -PolicyName "Test - Registry File Upload" -registryFile "/path/to/SampleRegFile.reg"
Validate that the "Test - Registry File Upload" Policy now has 10 values instead of the original 5
Run the following function to replace the existing values of the policy with just the values from the SampleRegFile:
iv. Set-JCPolicy -PolicyName "Test - Registry File Upload" -registryFile "/path/to/SampleRegFile.reg" -registryOverwrite
Validate that the "Test - Registry File Upload" Policy now has the 5 values from the file

….com/TheJumpCloud/support into SA-3176_ImportRegFilesRegistryPolicy

jworkmanjc

There's a few comments I've left we at least need to fix the dynamic parameter regression. We should add tests to validate that each type of accepted registry data is returned correctly and double check that the dword values are returned as expected

jworkmanjc · 2023-06-27T20:49:34Z

PowerShell/JumpCloud Module/JumpCloud.psd1

@@ -12,7 +12,7 @@
 RootModule = 'JumpCloud.psm1'

 # Version number of this module.
-ModuleVersion = '2.5.1'
+ModuleVersion = '2.6.1'


Module version should be 2.7.0 when we release this new functionality

PowerShell/JumpCloud Module/Private/Policies/Convert-RegToPSObject.ps1

PowerShell/JumpCloud Module/Tests/Private/Policies/Convert-RegToPSObject.Tests.ps1

PowerShell/JumpCloud Module/Private/Policies/Convert-RegToPSObject.ps1

jworkmanjc · 2023-06-28T02:53:39Z

PowerShell/JumpCloud Module/Public/Policies/New-JCPolicy.ps1

-            if ([String]::IsNullOrEmpty($templateObject.defaultName)) {
-                throw "Could not find policy template by ID"
-            }
+        if ($PSCmdlet.ParameterSetName -eq "Standard") {


I think we are breaking our previous functionality here. I know it's not something we have a test for because it's only behavior you'd get out of manually using the module.

On the published version of the module if you type

new-JCPolicy -TemplateName darwin_MDM_Custom_Configuration_Profile -name "soemthing" -*TAB_KEY*

where you press the tab key, the list of dynamic parameters are generated, in the current version, this only happens once we drop into the standard set of parameters which would mean suppling a fake value for the values param. That parameter set won't work with the current set of parameters.

jworkmanjc · 2023-06-28T16:09:12Z

PowerShell/JumpCloud Module/Private/Policies/Convert-RegToPSObject.ps1

+                    if ($valueObject[1].StartsWith("dword:")) {
+                        #DWORD
+                        $customRegType = "DWORD"
+                        $customData = ($valueObject[1]).Substring(5)


[Int]"0x($valueObject[1]).Substring(6)"

jworkmanjc · 2023-07-18T21:53:26Z

PowerShell/JumpCloud Module/Docs/Set-JCPolicy.md

@@ -122,6 +124,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```

+### -registryFile


Coming back to this, we did update this param to be dynamic in New-JCPolicy.ps1, we should do the same for Set-JCPolicy.ps1.

jworkmanjc · 2023-07-18T21:54:45Z

PowerShell/JumpCloud Module/Public/Policies/New-JCPolicy.ps1

@@ -20,6 +20,10 @@ function New-JCPolicy {
            HelpMessage = 'The values object either built manually or passed in through Get-JCPolicy')]
        [System.object[]]
        $Values
+        # [Parameter(Mandatory = $false,


Once we do the work to update Set-JCPolicy, let's remove this set of comments

jworkmanjc · 2023-07-18T21:55:25Z

PowerShell/JumpCloud Module/Public/Policies/Set-JCPolicy.ps1

@@ -22,7 +22,10 @@ function Set-JCPolicy {
        [Parameter(ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'The values object either built manually or passed in through Get-JCPolicy')]
        [System.object[]]
-        $Values
+        $Values,


specifically this param should be dynamic not available for all policies.

PowerShell/JumpCloud Module/Tests/Private/Policies/Convert-RegToPSObject.Tests.ps1

jworkmanjc

Let's plan to make Set-JCPolicy like New-JCPolicy in the sense that the reg file param should only be available for registry policies. Since I've requested that change and I helped do the work for New-JCPolicy I can do that in the morning.

… parameter

…JumpCloud/support into SA-3176_ImportRegFilesRegistryPolicy

kmaranionjc

Tests and code looks good. Great work

jworkmanjc

Looks good, thanks for all the changes, this was a big one, let's change our merge target to a release branch instead of main branch and we'll merge the changes to fix the AWS EC2 tests.

…tryPolicy

gweinjc and others added 10 commits June 12, 2023 11:16

Create Convert-RegToPSObject.ps1

ced5c1f

Update Convert-RegToPSObject.ps1

5221440

Convert hex value to int

4bdb82e

remove HKLM

6b42d18

ParameterSets

351d540

registryFile

fab9dd6

tests

262918d

Updating PowerShell Module;[skip ci]

cb9b778

changelog

a58da1e

fix file path

1b2bafc

gweinjc requested review from jworkmanjc and kmaranionjc June 22, 2023 17:56

gweinjc and others added 15 commits June 22, 2023 12:42

fiix registry file tests

3c2182d

dynamicparam standard paramset

da6cd41

Updating PowerShell Module;[skip ci]

d1da9c5

remove $ from hash

ebc2a2b

Merge branch 'SA-3176_ImportRegFilesRegistryPolicy' of https://github…

a87273c

….com/TheJumpCloud/support into SA-3176_ImportRegFilesRegistryPolicy

Updating PowerShell Module;[skip ci]

3bd9813

use pester environ variable for reg file

a888b6d

Updating PowerShell Module;[skip ci]

c9a955b

remove registryfile paramset and add trycatch

8c479b0

Updating PowerShell Module;[skip ci]

8f500a4

Updating PowerShell Module;[skip ci]

bb06610

Update workflows.yml

767d9da

Updating PowerShell Module;[skip ci]

349c0b2

SA-3406 Bug Fix

b75ee05

Updating PowerShell Module;[skip ci]

72d7ba0

jworkmanjc requested changes Jun 28, 2023

View reviewed changes

gweinjc added 2 commits June 30, 2023 12:15

Update workflows.yml

e50ac36

int dword conversion

08562e4

gweinjc and others added 11 commits July 5, 2023 14:41

validate object size before adding to array

33b9a1e

Updating PowerShell Module;[skip ci]

71d0590

fix registry tests

15eea8d

Updating PowerShell Module;[skip ci]

69311e7

Update Set-JCPolicy.tests.ps1

fec5a02

Updating PowerShell Module;[skip ci]

bc716d9

Updating PowerShell Module;[skip ci]

9af7dc1

adjust conditional

6d66d52

Updating PowerShell Module;[skip ci]

fa73131

Update Get-JCResults.ps1

2b511c2

Updating PowerShell Module;[skip ci]

9d2a787

jworkmanjc reviewed Jul 18, 2023

View reviewed changes

PowerShell/JumpCloud Module/Tests/Private/Policies/Convert-RegToPSObject.Tests.ps1 Show resolved Hide resolved

jworkmanjc requested changes Jul 18, 2023

View reviewed changes

jworkmanjc and others added 9 commits July 19, 2023 10:25

set policy dynamic param

8b5205f

registry file cleanup

1380015

Updating PowerShell Module;[skip ci]

02d99a2

registryOverrwrite param, update tests, fix for single reg item file

33273b5

remove testing vars

b7c4617

Updating PowerShell Module;[skip ci]

7eca361

Throw error when policy with multiple names are matched w/ policyName…

48415c6

… parameter

Merge branch 'SA-3176_ImportRegFilesRegistryPolicy' of github.com:The…

5f9f573

…JumpCloud/support into SA-3176_ImportRegFilesRegistryPolicy

documentation [skip ci]

9e3e792

kmaranionjc approved these changes Jul 20, 2023

View reviewed changes

jworkmanjc approved these changes Jul 20, 2023

View reviewed changes

jworkmanjc changed the base branch from master to JumpCloudModule_2.7.0 July 20, 2023 20:33

Merge branch 'JumpCloudModule_2.7.0' into SA-3176_ImportRegFilesRegis…

bafd8e2

…tryPolicy

jworkmanjc merged commit b403314 into JumpCloudModule_2.7.0 Jul 31, 2023
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SA-3176: New/Set-JCPolicy Import Reg Files #501

SA-3176: New/Set-JCPolicy Import Reg Files #501

gweinjc commented Jun 21, 2023 •

edited by jworkmanjc

Loading

jworkmanjc left a comment

jworkmanjc Jun 27, 2023

jworkmanjc Jun 28, 2023

jworkmanjc Jun 28, 2023

jworkmanjc Jul 18, 2023

jworkmanjc Jul 18, 2023

jworkmanjc Jul 18, 2023

jworkmanjc left a comment

kmaranionjc left a comment

jworkmanjc left a comment

SA-3176: New/Set-JCPolicy Import Reg Files #501

SA-3176: New/Set-JCPolicy Import Reg Files #501

Conversation

gweinjc commented Jun 21, 2023 • edited by jworkmanjc Loading

Issues

What does this solve?

Is there anything particularly tricky?

How should this be tested?

jworkmanjc left a comment

Choose a reason for hiding this comment

jworkmanjc Jun 27, 2023

Choose a reason for hiding this comment

jworkmanjc Jun 28, 2023

Choose a reason for hiding this comment

jworkmanjc Jun 28, 2023

Choose a reason for hiding this comment

jworkmanjc Jul 18, 2023

Choose a reason for hiding this comment

jworkmanjc Jul 18, 2023

Choose a reason for hiding this comment

jworkmanjc Jul 18, 2023

Choose a reason for hiding this comment

jworkmanjc left a comment

Choose a reason for hiding this comment

kmaranionjc left a comment

Choose a reason for hiding this comment

jworkmanjc left a comment

Choose a reason for hiding this comment

gweinjc commented Jun 21, 2023 •

edited by jworkmanjc

Loading