🩹 [Patch]: Support pipeline input on ConvertTo- and ConvertFrom-SodiumSealedBox and New-SodiumKeyPair#24
Merged
Marius Storhaug (MariusStorhaug) merged 8 commits intomainfrom Feb 9, 2025
Conversation
…onvertTo-SodiumSealedBox functions to include pipeline input examples and output descriptions
…o-SodiumSealedBox, and New-SodiumKeyPair functions for clarity on return values
…diumSealedBox, ConvertTo-SodiumSealedBox, and New-SodiumKeyPair functions
…o-SodiumSealedBox, and New-SodiumKeyPair functions for clarity on output descriptions
… by merging .OUTPUTS and .NOTES sections
…onvertFrom-SodiumSealedBox, ConvertTo-SodiumSealedBox, and New-SodiumKeyPair functions
… seed in New-SodiumKeyPair
… in New-SodiumKeyPair function
Marius Storhaug (MariusStorhaug)
changed the title
ConvertTo- and ConvertFrom-SodiumSealedBoxConvertTo- and ConvertFrom-SodiumSealedBox and New-SodiumKeyPair
Marius Storhaug (MariusStorhaug)
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
Module Sodium - v2.1.2 published to the PowerShell Gallery. |
|
GitHub release for Sodium v2.1.2 has been created. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request enhances the
SodiumPowerShell module by adding support for pipeline input to various functions, updating documentation, and adding new tests to ensure proper functionality. The most important changes include the addition of pipeline input support, updates to function documentation, and new tests for pipeline input scenarios.Enhancements to functions:
src/functions/public/ConvertFrom-SodiumSealedBox.ps1: Added support forValueFromPipelineandValueFromPipelineByPropertyNameto theSealedBoxparameter.src/functions/public/ConvertTo-SodiumSealedBox.ps1: Added support forValueFromPipelineandValueFromPipelineByPropertyNameto theMessageparameter.src/functions/public/New-SodiumKeyPair.ps1: Added support forValueFromPipelineto theSeedparameter.Documentation updates:
src/functions/public/ConvertFrom-SodiumSealedBox.ps1: Enhanced documentation with examples, outputs, and notes for better clarity.src/functions/public/ConvertTo-SodiumSealedBox.ps1: Enhanced documentation with examples, outputs, and notes for better clarity.src/functions/public/New-SodiumKeyPair.ps1: Enhanced documentation with examples, outputs, and notes for better clarity.New tests:
tests/Sodium.Tests.ps1: Added tests to verify encryption and decryption using pipeline input forConvertTo-SodiumSealedBoxandConvertFrom-SodiumSealedBox.tests/Sodium.Tests.ps1: Added tests to verify deterministic key generation using pipeline input forNew-SodiumKeyPair.Type of change
Checklist