From f3175178e7a4ce19ab368cfa05e5ef0e6e78c002 Mon Sep 17 00:00:00 2001 From: Dima Date: Wed, 11 Nov 2026 21:46:14 +0100 Subject: [PATCH] fix: restore folderencoder source validation and add read-only CI --- .github/workflows/source-folderencoder.yml | 15 + .gitignore | 1 + FolderEncoder/FolderEncoder.Tests.ps1 | 25 ++ FolderEncoder/FolderEncoder.psd1 | 2 +- FolderEncoder/Functions.ps1 | 326 +++++++++++++++++++++ FolderEncoder/README.md | 11 +- 6 files changed, 378 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/source-folderencoder.yml create mode 100644 FolderEncoder/FolderEncoder.Tests.ps1 create mode 100644 FolderEncoder/Functions.ps1 diff --git a/.github/workflows/source-folderencoder.yml b/.github/workflows/source-folderencoder.yml new file mode 100644 index 0000000..98642ca --- /dev/null +++ b/.github/workflows/source-folderencoder.yml @@ -0,0 +1,15 @@ +name: FolderEncoder source checks +on: + push: + branches: [fix/build-folderencoder] + pull_request: + branches: [FolderEncoder/develop] +permissions: + contents: read +jobs: + source: + uses: stadub/PowershellScripts/.github/workflows/validate-module-source.yml@d3fa5897213e3ff4e0d64897559bdfb516356512 + with: + module: FolderEncoder + source_sha: ${{ github.event.pull_request.head.sha || github.sha }} + automation_sha: d3fa5897213e3ff4e0d64897559bdfb516356512 diff --git a/.gitignore b/.gitignore index 931f30c..e4d962c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ # File types to ignore globally .history .vscode +TestResults/ diff --git a/FolderEncoder/FolderEncoder.Tests.ps1 b/FolderEncoder/FolderEncoder.Tests.ps1 new file mode 100644 index 0000000..50d66be --- /dev/null +++ b/FolderEncoder/FolderEncoder.Tests.ps1 @@ -0,0 +1,25 @@ +$manifest = Join-Path $PSScriptRoot 'FolderEncoder.psd1' +Describe 'FolderEncoder source import' { + BeforeAll { + Push-Location $TestDrive + try { $script:loaded = @(Import-Module $manifest -Force -PassThru -ErrorAction Stop) } + finally { Pop-Location } + } + AfterAll { Remove-Module FolderEncoder -Force -ErrorAction SilentlyContinue } + It 'validates the restored manifest and exports the documented command' { + (Test-ModuleManifest $manifest).Name | Should -BeExactly 'FolderEncoder' + $script:loaded.Count | Should -Be 1 + $script:loaded[0].ExportedFunctions.Count | Should -Be 1 + $script:loaded[0].ExportedFunctions.ContainsKey('Invoke-FolderEncode') | Should -BeTrue + } + It 'keeps the destination mandatory and source optional' { + $command = $script:loaded[0].ExportedFunctions['Invoke-FolderEncode'] + @($command.Parameters['DestFolder'].Attributes | Where-Object { $_ -is [System.Management.Automation.ParameterAttribute] })[0].Mandatory | Should -BeTrue + @($command.Parameters['SrcFolder'].Attributes | Where-Object { $_ -is [System.Management.Automation.ParameterAttribute] })[0].Mandatory | Should -BeFalse + } + It 'does not encode, initialize key files or install tools during import' { + @(Get-ChildItem $TestDrive -Force -Recurse).Count | Should -Be 0 + $script:loaded[0].ExportedFunctions.ContainsKey('CheckUtils') | Should -BeFalse + $script:loaded[0].ExportedFunctions.ContainsKey('EncodeFile') | Should -BeFalse + } +} diff --git a/FolderEncoder/FolderEncoder.psd1 b/FolderEncoder/FolderEncoder.psd1 index da6851f..7f403b9 100644 --- a/FolderEncoder/FolderEncoder.psd1 +++ b/FolderEncoder/FolderEncoder.psd1 @@ -69,7 +69,7 @@ Description = 'Encode files from folder for(for example) uploading to cloud' NestedModules = @('Functions.ps1') # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = @('EncodeFolder') +FunctionsToExport = @('Invoke-FolderEncode') # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() diff --git a/FolderEncoder/Functions.ps1 b/FolderEncoder/Functions.ps1 new file mode 100644 index 0000000..c25a66a --- /dev/null +++ b/FolderEncoder/Functions.ps1 @@ -0,0 +1,326 @@ +<#PSScriptInfo + +.VERSION 2.0 + +.GUID 6d06e54e-f29e-4c27-9fb2-ed1dfbd0dc79 + +.AUTHOR Dima Stadub + +.COMPANYNAME + +.COPYRIGHT + +.TAGS 7zip encode zip archive + +.LICENSEURI + +.PROJECTURI https://github.com/stadub/PowershellScripts + +.ICONURI + +.EXTERNALMODULEDEPENDENCIES + +.REQUIREDSCRIPTS + +.EXTERNALSCRIPTDEPENDENCIES + +.RELEASENOTES + + +#> + + +<# +.SYNOPSIS + Encode files from folder for(for example) uploading to cloud +.DESCRIPTION +Used as backups encoding solution. +Encoding performed with 7z password protection + +There was no reasons (thank goodness) decoding stored data so currently there no decoder script +It you need - please create github issue and I'll add scrpit for folder decoding. +Manually files can be decoded with the next algorithm: +1)Concat value from .masterKey and add ':' to beginign and by using resulting key extract .keys file from .keys.7z +2)Find apropriate row in .key for file that shoudl be decoded. +3)Concat first row from .masterKey with first row from .key file and ':' to beginign +4)Use key from previouse step as 7z password for decode file +.EXAMPLE + Invoke-FolderEncode "c:\windows\System42" "d:\System" +.PARAMETER SrcFolder (optional) + Folder to be encoded +.PARAMETER DestFolder + Destanation folder where encoded files be created + #> +param ( + [string]$SrcFolder = (Get-Location).Path, + + [string]$DestFolder = (Get-Location).Path +) + +#$DebugPreference = "Continue" + +$Slash = [IO.Path]::DirectorySeparatorChar; + + +$binDir="$PSScriptRoot\bin\${MyInvocation.MyCommand.Name}" +$7zWin = "$binDir\7za.exe" +$sha1 = "$binDir\fciv.exe" +$7zWinDownloadDir='https://www.7-zip.org/a/7za920.zip' + +$sha1Win="https://download.microsoft.com/download/c/f/4/cf454ae0-a4bb-4123-8333-a1b6737712f7/Windows-KB841290-x86-ENU.exe" + + +$script:7zPath = $null; +$script:shaTool = $null + + +function DownloadUtil { + param ( + [string]$name, + [string]$file, + [string]$url + ) + + $reply = Read-Host -Prompt "Would you like to download '$name'?[y/n] ` + [Y] Yes [N] No [S] Suspend(default is ""Yes""):" + + if ( -not $reply -match "[yY]" -and $null -ne $reply ) { + throw "Execution aborted" + } + + Write-Output "Starting download '$name'" + + Write-Debug "Downoad url:${url}" + + (New-Object System.Net.WebClient).DownloadFile($url, $file) + + Write-Debug "File downloaded to ${file}." + +} + + + +function CheckUtils { + $os = [System.Environment]::OSVersion.Platform + #windows + if($os -like 'win*'){ + Write-Debug "Os:Windows" + + #7-zip + Write-Debug "Trying to locate 7-zip by the path: ${7zWin}" + + if( ! (Test-Path $7zWin)){ + Write-Output '7Zip didn''t found.' + + $file = [System.IO.Path]::GetTempFileName() + Write-Debug "Temp file: ${file}" + + DownloadUtil "7-Zip" $file $7zWinDownloadDir + Write-Debug "Extracting to directory ${binDir}" + if ( ! (Test-Path $binDir )) {mkdir $binDir} + Add-Type -AssemblyName System.IO.Compression.FileSystem + [System.IO.Compression.ZipFile]::ExtractToDirectory($file, $binDir) + } + $script:7zPath = $7zWin + + #sha1 + Write-Debug "Trying to locate sha1 util by the path: ${sha1Win}" + if( ! (Test-Path $sha1)){ + Write-Output 'fciv didn''t found.' + + $file = [System.IO.Path]::GetTempFileName() + Write-Debug "Temp file: ${file}" + + DownloadUtil "fciv" $file $sha1Win + if ( ! (Test-Path $binDir )) {mkdir $binDir} + & $7zPath e $file "-o${binDir}" -y + } + $script:shaTool = "${sha1} -sha1 "; + + } + else{ + #linux or macOs + get-command p7zip -Erroraction 'silentlycontinue'| ForEach-Object{ $7zPath= $_.Path} + if ( ! $7zPath ){ + #sudo apt-get install p7zip + $script:aborted = $true + throw "p7zip application is not installed. + If you using debian/ubuntu run `sudo apt-get install p7zip` then restart the script" + } + $shaTool = "shasum " + } +} + +$script:aborted = $false + +$Keyfile = ".keys"; +$KeyfilePath = $DestFolder + $Slash + $Keyfile; +$MaserKeyfilePath = $DestFolder + $Slash + ".masterKey" + + +function ZipFile { + param ( + [ValidateScript( { Test-Path ( $SrcFolder + $Slash + $_ ) -pathType leaf })] + [Parameter(Mandatory = $true)] + [string]$FileName, + + [Parameter(Mandatory = $true)] + [string]$Key, + [string]$SrcFolder, + [string]$DestFolder + ) + Write-Output "Creating Archive for file ""$FileName""" + + $_srcFile = $SrcFolder + $Slash + $FileName + $_dstFile = $DestFolder + $Slash + $FileName.Replace('.', '_') + + + if( Test-Path $DestFolder -PathType Leaf){ + Write-Error "The destanation path ${DestFolder} is file." + } + if( ! (Test-Path $DestFolder) ){ + Write-Information "The destanation path ${DestFolder} doesn't exist. Creating folder." + mkdir $DestFolder + } + + if ( Test-Path "${_dstFile}.7z" ) { + Write-Error "Arhive ""$FileName"" allready exist in folder ""$DestFolder"", please select another destination." + return -1; + } + + $AllArgs = @('a', "$_dstFile", "$_srcFile", "-p:$Key"); + + $process = Start-Process -FilePath $7zPath -ArgumentList $AllArgs -NoNewWindow -PassThru -Wait + + $code = $process.ExitCode.ToString(); + + Write-Output "File compressed. Return code: $code" + return $process.ExitCode + +} + +function GetFileHash { + param ( + [ValidateScript( { Test-Path ($_ ) -pathType leaf })] + [Parameter(Mandatory = $true)] + [string]$FilePath + ) + + # --- getting file sha1 checksum + + $_hash = Invoke-Expression "$shaTool $FilePath" + #remove extra lines + $_hash = $_hash | ForEach-Object { + if ( ![string]::IsNullOrEmpty($_.ToString()) -and !$_.ToString().StartsWith("//")) { + Write-Output $_; + } + }; + #extract hash + $_hash = $_hash.Split(' ')[0]; + + + Write-Output $_hash +} + +function EncodeFile() { + param ( + [Parameter(Mandatory = $true)] + [string]$Salt, + [Parameter(Mandatory = $true)] + [string]$SrcFolder, + [Parameter(Mandatory = $true)] + [string]$DestFolder, + [ValidateScript( { Test-Path ( $SrcFolder + $Slash + $_ ) -pathType leaf })] + [Parameter(Mandatory = $true)] + [string]$FileName + ) + + Write-Output "Encoding file ""$FileName""" + + $srcFile = $SrcFolder + $Slash + $FileName; + + + $hash = GetFileHash -FilePath $srcFile; + + $key = $Salt + $hash; + + Write-Output "$hash $FileName">>$KeyfilePath; + + $result = ZipFile -FileName $FileName -Key $Key -SrcFolder $SrcFolder -DestFolder $DestFolder; + + if ( $result -eq "0" ) { + Write-Error "Encoding aborted. Some error occured." + $script:aborted = $false + } + +} + +<# + .Synopsis + Encode files from folder for(for example) uploading to cloud + + .Description + Used as backups encoding solution. + Encoding performed with 7z password protection + + .Parameter DestFolder + Destanation folder where encoded files be created. + + .Parameter SrcFolder + Folder to be encoded. + + .Example + # Add bookmark with name. + />Invoke-FolderEncode "c:\windows\System42" "d:\System\" +#> +function Invoke-FolderEncode { + param ( + [Parameter(Mandatory = $true)][string]$DestFolder, + [Parameter(Mandatory = $false)][string]$SrcFolder + ) + $ErrorActionPreference ="Stop" + + if ( [string]::IsNullOrEmpty($SrcFolder) ) { + $SrcFolder = (Get-Location).Path + } + CheckUtils + if ( Test-Path $KeyfilePath ) { + Write-Error "Key file already exist" -ErrorAction:Continue + + $reply = Read-Host -Prompt "Would you like to remove it? [y/n] ` + [Y] Yes [N] No [S] Suspend(default is ""Yes""):" + if ( -not $reply -match "[yY]" -and $null -ne $reply ) { + Write-Error "Execution aborted" + return -1; + } + + Remove-Item -Force $KeyfilePath | out-null + } + + $salt = [System.Guid]::NewGuid().ToString(); + + Write-Output "Start encoding the folder ${SrcFolder}" + Get-ChildItem $SrcFolder | ForEach-Object { + if ($script:aborted -eq $true) { return; } + $FileName = $_.Name; + if( $_.Attributes -eq [System.IO.FileAttributes]::Directory ){ + Write-Warning -Message "Cannot process the deirectory ${FileName}. Directories are not supported." + }else{ + EncodeFile $salt $SrcFolder $DestFolder $FileName + } + + } + + EncodeFile $salt $SrcFolder $DestFolder $Keyfile + + $KeysFileHash = Get-Content $KeyfilePath | Select-Object -last 1 + $KeysFileHash = $KeysFileHash.Split(' ')[0]; + + Write-Output "$salt $KeysFileHash">$MaserKeyfilePath +} + +#CheckUtils + +#EncodFolder $SrcFolder $DestFolder; + +Export-ModuleMember -Function Invoke-FolderEncode \ No newline at end of file diff --git a/FolderEncoder/README.md b/FolderEncoder/README.md index 21269a7..57ad2b2 100644 --- a/FolderEncoder/README.md +++ b/FolderEncoder/README.md @@ -107,4 +107,13 @@ so if you found it useful you can Buy me a beer/cup of tea 😊. If you have any idea or suggestion - please add a github issue and I'll try to implement it as soon as possible😉 - \ No newline at end of file + +## Source import validation + +The missing Functions.ps1 is restored unchanged from the last repository version +before its deletion in 4a336c7. The manifest now exports the documented +Invoke-FolderEncode command. Importing the module does not invoke CheckUtils or +encoding, download tools, prompt, or create key/archive files. CI checks manifest, +import/export and parameter contracts only. The legacy encoder algorithm, external +tools and archive roundtrip are unchanged and are not validated by these checks. +There is no Gallery publication route or release package in this source repair.