diff options
author | vnugent <public@vaughnnugent.com> | 2024-03-24 21:26:44 -0400 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2024-03-24 21:26:44 -0400 |
commit | 49c3641def5ae1b7557ed61ed7bb28bbf425ccc9 (patch) | |
tree | 4eb1bd863074e64922e35ff730f354ac40528698 /lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs | |
parent | e5bb0ee302e789cb96e7ecfe839cbbcc8e3fd5d7 (diff) |
Squashed commit of the following:
commit a504435151efbe1d19404fa44859b15c629f6d5d
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 24 20:55:01 2024 -0400
chore: Updated compose and added some more logging
commit c74440ff12daa03cc4b7792d0c3baad46a11a465
Author: vnugent <public@vaughnnugent.com>
Date: Mon Mar 18 21:57:57 2024 -0400
feat: message checksum support & dynamic serializers
commit 9983582db08d3e6c456295ea96e482cbb4f31f42
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 10 21:58:28 2024 -0400
source tree project location updated
commit 60f09bde87b5c59ef937c62ef64b7745bc3711b5
Merge: 2f75659 e5bb0ee
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 10 16:50:09 2024 -0400
Merge remote-tracking branch 'origin/master' into develop
commit 2f7565976472f0f056db60520bf253a776112c10
Merge: 323ff67 6b87785
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 10 16:45:23 2024 -0400
merge master
commit 323ff67badfc46ad638d75f059d60d9425ccb2fa
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 10 15:50:07 2024 -0400
ci(server): Conainerize and add vncache server packages
commit 5d4192880654fd6e00e587814169415b42621327
Author: vnugent <public@vaughnnugent.com>
Date: Sat Mar 9 19:13:21 2024 -0500
chore: #2 Minor fixes and polish before release
commit a4b3504bb891829074d1efde0433eae010862181
Author: vnugent <public@vaughnnugent.com>
Date: Sat Mar 9 16:30:44 2024 -0500
package updates
commit 4d8cfc10382105b0acbd94df93ad3d05ff91db54
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 6 21:30:58 2024 -0500
refactor: #2 Centralize server state, default discovery endpoints & more
commit 016a96a80cce025a86c6cf26707738f6a2eb2658
Author: vnugent <public@vaughnnugent.com>
Date: Thu Feb 29 21:22:38 2024 -0500
feat: add future support for memory diagnostics, and some docs
commit 456ead9bc8b0f61357bae93152ad0403c4940101
Author: vnugent <public@vaughnnugent.com>
Date: Tue Feb 13 14:46:35 2024 -0500
fix: #1 shared cluster index on linux & latested core updates
commit a481d63f964a5d5204cac2e95141f37f9a28d573
Author: vnugent <public@vaughnnugent.com>
Date: Tue Jan 23 15:43:50 2024 -0500
cache extension api tweaks
Diffstat (limited to 'lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs')
-rw-r--r-- | lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs b/lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs new file mode 100644 index 0000000..5a9af31 --- /dev/null +++ b/lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs @@ -0,0 +1,90 @@ +/* +* Copyright (c) 2024 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Data.Caching +* File: FbmMessageChecksum.cs +* +* FbmMessageChecksum.cs is part of VNLib.Data.Caching which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Data.Caching is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 3 of the +* License, or (at your option) any later version. +* +* VNLib.Data.Caching is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.Buffers.Binary; +using System.Diagnostics; + +using VNLib.Utils; +using VNLib.Hashing.Checksums; +using VNLib.Net.Messaging.FBM; + +using static VNLib.Data.Caching.Constants; + +namespace VNLib.Data.Caching +{ + /// <summary> + /// Utility class for verifying and writing checksums for FBM messages + /// </summary> + public static class FbmMessageChecksum + { + /// <summary> + /// Verifies the checksum of the supplied data using the FNV1a algorithm + /// </summary> + /// <param name="checksum">The checksum base32 encoded string of the checksum data</param> + /// <param name="data">The data to compute the checksum on</param> + /// <returns>True if the checksum of the data matches the supplied one</returns> + public static bool VerifyFnv1aChecksum(ReadOnlySpan<char> checksum, ReadOnlySpan<byte> data) + { + //Convert the checksum to bytes + Span<byte> asBytes = stackalloc byte[sizeof(ulong)]; + ERRNO byteSize = VnEncoding.TryFromBase32Chars(checksum, asBytes); + + Debug.Assert(byteSize == sizeof(ulong), "Failed to convert checksum to bytes"); + + //Compute the checksum of the supplied data + ulong computed = FNV1a.Compute64(data); + + //Compare the checksums + return BinaryPrimitives.ReadUInt64BigEndian(asBytes) == computed; + } + + /// <summary> + /// Writes the FNV1a checksum of the supplied data to the message header buffer + /// </summary> + /// <param name="message">The FBM message to write the checksum headers to</param> + /// <param name="data">The message data to compute the checksum of</param> + /// <exception cref="ArgumentNullException"></exception> + public static void WriteFnv1aChecksum(IFBMMessage message, ReadOnlySpan<byte> data) + { + ArgumentNullException.ThrowIfNull(message); + + //Compute the checksum of the data + ulong checksum = FNV1a.Compute64(data); + + Span<byte> asBytes = stackalloc byte[sizeof(ulong)]; + Span<char> asChars = stackalloc char[16]; + + //get big endian bytes + BinaryPrimitives.WriteUInt64BigEndian(asBytes, checksum); + ERRNO charSize = VnEncoding.TryToBase32Chars(asBytes, asChars); + + Debug.Assert(charSize > 0, "Failed to convert checksum to base32"); + + //Write the checksum and type to the response + message.WriteHeader(ChecksumType, ChecksumTypes.Fnv1a); + message.WriteHeader(ChecksumValue, asChars[..(int)charSize]); + } + } +} |