🌟 [Major]: Align function naming with libsodium - #22
Merged
Conversation
… encryption functions in examples
…for message handling
…ntations for improved clarity and performance
…To SodiumSealedBox functions
…diumKeyPair functions
…or key pair generation
…ion and replace outdated test file with comprehensive tests
…by throwing an exception for invalid Base64 input
…ons; replace calls with direct Base64 conversion
…nd ConvertTo-SodiumSealedBox functions for Base64 conversion
…function and update tests to remove specific error messages
Marius Storhaug (MariusStorhaug)
temporarily deployed
to
github-pages
February 8, 2025 18:54 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
|
Module Sodium - v2.0.0 published to the PowerShell Gallery. |
|
GitHub release for Sodium v2.0.0 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 attempts to align naming of functions, parameters and outputs to be closer with
libsodiiumterminology. This includes significant changes to the encryption and decryption functions, transitioning from using the term "SodiumEncryptedString" to "SodiumSealedBox".Changes to function names and parameters
ConvertFrom-SodiumEncryptedStringrenamed toConvertFrom-SodiumSealedBoxString, with updates to function name, parameters, and documentation to use "SealedBox" instead of "EncryptedString". Also updates the parameter fromSecrettoSealedBoxto better align withlibsodium.ConvertTo-SodiumEncryptedStringrenamed toConvertTo-SodiumSealedBoxString, with updates to function name, parameters, and documentation to use "SealedBox" instead of "EncryptedString". Also uipdates the parameter fromSecrettoMessageto better align withlibsodium.Updates to examples
examples/CreateGitHubSecret.ps1: Updated the encryption function call to useConvertTo-SodiumSealedBoxinstead ofConvertTo-SodiumEncryptedString.examples/GitHubSecretService.ps1: Updated encryption and decryption function calls to useConvertTo-SodiumSealedBoxandConvertFrom-SodiumSealedBoxrespectively. [1] [2]Documentation updates
README.md: Updated examples to use "Sealed Boxes encryption" and changed function calls toConvertTo-SodiumSealedBoxandConvertFrom-SodiumSealedBox.Test updates:
tests/Module.Tests.ps1: Added new tests for encryption and decryption usingConvertTo-SodiumSealedBoxandConvertFrom-SodiumSealedBox, including error cases for invalid keys.Type of change
Checklist