Skip to content

Commit b0e6e74

Browse files
committed
Added release info and updated project description to reference the new doc.
1 parent 9d44de4 commit b0e6e74

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

Cryptography.Fernet/Cryptography.Fernet.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88
<RepositoryUrl>https://github.com/daverayment/Cryptography.Fernet</RepositoryUrl>
99
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1010
<Authors>daverayment</Authors>
11-
<Description>A .NET implementation of the full Fernet symmetric encryption standard.</Description>
11+
<Description>
12+
A .NET implementation of the full Fernet symmetric encryption standard.
13+
See https://github.com/daverayment/Cryptography.Fernet/blob/master/RELEASE.md for further information about this release.
14+
</Description>
1215
<Copyright>Copyright (c) 2022 David Rayment</Copyright>
1316
<PackageReadmeFile>README.md</PackageReadmeFile>
1417
<PackageIcon>Images\001-key-lock-128x128.png</PackageIcon>

Cryptography.Fernet/RELEASE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Version 1.1.0
2+
3+
## New functionality
4+
- 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.
5+
- `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.
6+
7+
## Testing
8+
A significant number of new tests were added to the unit test project, bringing the total up to more than 30:
9+
- Tests added to exercise the entire specification, validation and generation documentation from the Fernet project repository.
10+
- Tests added for the `Utility.Base64UrlEncoder` class.
11+
12+
Most tests now include at least summary documentation.
13+
14+
## API Changes
15+
- `Base64UrlEncoder.DecodeBytes` now throws a `System.FormatException` instead of a `System.ArgumentException` if the string passed in is invalid.
16+
17+
# Version 1.0.1
18+
Minor documentation edit to fix a link which was rendered incorrectly on NuGet.
19+
20+
# Version 1.0.0
21+
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 commit comments

Comments
 (0)