Skip to content

Commit

Permalink
Added release info and updated project description to reference the n…
Browse files Browse the repository at this point in the history
…ew doc.
  • Loading branch information
daverayment committed Sep 7, 2022
1 parent 9d44de4 commit b0e6e74
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Cryptography.Fernet/Cryptography.Fernet.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
<RepositoryUrl>https://github.com/daverayment/Cryptography.Fernet</RepositoryUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<Authors>daverayment</Authors>
<Description>A .NET implementation of the full Fernet symmetric encryption standard.</Description>
<Description>
A .NET implementation of the full Fernet symmetric encryption standard.
See https://github.com/daverayment/Cryptography.Fernet/blob/master/RELEASE.md for further information about this release.
</Description>
<Copyright>Copyright (c) 2022 David Rayment</Copyright>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageIcon>Images\001-key-lock-128x128.png</PackageIcon>
Expand Down
21 changes: 21 additions & 0 deletions Cryptography.Fernet/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Version 1.1.0

## New functionality
- A `saveTimestamp` parameter was added to `Encrypt`. This defaults to `true`, which provides the same functionality as prior releases. Setting to `false` means the token will be generated with a zeroed-out creation timestamp. This is a solution for certain scenarios where unencrypted timestamps such as Fernet's are regarded as sensitive information.
- `Decrypt` now features automatic validation for 'clock drift' situations. This is where the decrypting system's internal clock differs from the system which generated the token. An exception is thrown if a token's creation timestamp is too far in the future. The maximum discrepancy is stored within the `MaxClockDrift` TimeSpan in the main project's `Fernet.cs` file.

## Testing
A significant number of new tests were added to the unit test project, bringing the total up to more than 30:
- Tests added to exercise the entire specification, validation and generation documentation from the Fernet project repository.
- Tests added for the `Utility.Base64UrlEncoder` class.

Most tests now include at least summary documentation.

## API Changes
- `Base64UrlEncoder.DecodeBytes` now throws a `System.FormatException` instead of a `System.ArgumentException` if the string passed in is invalid.

# Version 1.0.1
Minor documentation edit to fix a link which was rendered incorrectly on NuGet.

# Version 1.0.0
First deployment to NuGet. Encryption, Decryption, base64url utilities etc. all tested working. Unit test project included. Compatibility tested with Python implementation and token examples given in the specification repository.

0 comments on commit b0e6e74

Please sign in to comment.