aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheLIstener.cs42
-rw-r--r--lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheListenerConfig.cs51
-rw-r--r--lib/VNLib.Data.Caching.ObjectCache/src/CacheEntry.cs4
-rw-r--r--lib/VNLib.Data.Caching/src/ClientExtensions.cs63
-rw-r--r--lib/VNLib.Data.Caching/src/Constants.cs21
-rw-r--r--lib/VNLib.Data.Caching/src/Exceptions/InvalidChecksumException.cs45
-rw-r--r--lib/VNLib.Data.Caching/src/Exceptions/InvalidStatusException.cs4
-rw-r--r--lib/VNLib.Data.Caching/src/FbmMessageChecksum.cs90
8 files changed, 300 insertions, 20 deletions
diff --git a/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheLIstener.cs b/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheLIstener.cs
index 972bf5e..3584344 100644
--- a/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheLIstener.cs
+++ b/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheLIstener.cs
@@ -43,7 +43,6 @@ using System.Threading;
using System.Threading.Tasks;
using VNLib.Utils.Logging;
-using VNLib.Net.Messaging.FBM;
using VNLib.Net.Messaging.FBM.Server;
using static VNLib.Data.Caching.Constants;
@@ -57,18 +56,22 @@ namespace VNLib.Data.Caching.ObjectCache
/// </remarks>
/// <param name="cache">The cache table to work from</param>
/// <param name="queue">The event queue to publish changes to</param>
- /// <param name="log">Writes error and debug logging information</param>
- /// <param name="memoryManager">The heap to alloc FBM buffers and <see cref="CacheEntry"/> cache buffers from</param>
+ /// <param name="config">The listener configuration object</param>
/// <exception cref="ArgumentNullException"></exception>
- public class BlobCacheListener<T>(IBlobCacheTable cache, ICacheListenerEventQueue<T> queue, ILogProvider log, IFBMMemoryManager memoryManager)
+ public class BlobCacheListener<T>(IBlobCacheTable cache, BlobCacheListenerConfig config, ICacheListenerEventQueue<T> queue)
: FBMListenerBase<T>, IDisposable
{
private bool disposedValue;
///<inheritdoc/>
- protected override ILogProvider Log { get; } = log;
+ protected override ILogProvider Log { get; } = config.Log;
///<inheritdoc/>
- protected override FBMListener Listener { get; } = new(memoryManager);
+ protected override FBMListener Listener { get; } = new(config.MemoryManager);
+
+ /// <summary>
+ /// The configuration instance for the listener
+ /// </summary>
+ public BlobCacheListenerConfig Config { get; } = config ?? throw new ArgumentNullException(nameof(config));
/// <summary>
/// A queue that stores update and delete events
@@ -110,6 +113,25 @@ namespace VNLib.Data.Caching.ObjectCache
//Create change event for the object
ChangeEvent change = new(objectId, alternateId, false);
+ if (config.EnableMessageChecksums)
+ {
+ switch (context.Request.IsClientChecksumValid())
+ {
+ //0 is checksum sent, supported, but invalid
+ case 0:
+ context.CloseResponse(ResponseCodes.InvalidChecksum);
+ return;
+
+ case -2: //Method not supported, set an error header but allow the request
+ context.Response.WriteHeader(ChecksumWarning, "Checksum method not supported");
+ break;
+
+ case 1: //1 is checksum sent and valid
+ case -1: //No checksum sent
+ break;
+ }
+ }
+
await AddOrUpdateAsync(context, change, exitToken);
return;
}
@@ -199,6 +221,12 @@ namespace VNLib.Data.Caching.ObjectCache
if (handle.Cache.TryGetValue(objectId, out CacheEntry data))
{
+ //Compute an fnv message checksum and send it to the client
+ if (config.EnableMessageChecksums)
+ {
+ FbmMessageChecksum.WriteFnv1aChecksum(context.Response, data.GetDataSegment());
+ }
+
//Set the status code and write the buffered data to the response buffer
context.CloseResponse(ResponseCodes.Okay);
@@ -239,7 +267,7 @@ namespace VNLib.Data.Caching.ObjectCache
{
EventQueue.PublishEvent(change);
}
-
+
///<inheritdoc/>
protected virtual void Dispose(bool disposing)
diff --git a/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheListenerConfig.cs b/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheListenerConfig.cs
new file mode 100644
index 0000000..1098be4
--- /dev/null
+++ b/lib/VNLib.Data.Caching.ObjectCache/src/BlobCacheListenerConfig.cs
@@ -0,0 +1,51 @@
+/*
+* Copyright (c) 2024 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Data.Caching.ObjectCache
+* File: BlobCacheListenerConfig.cs
+*
+* BlobCacheListenerConfig.cs is part of VNLib.Data.Caching.ObjectCache which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* VNLib.Data.Caching.ObjectCache 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.ObjectCache 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 VNLib.Utils.Logging;
+using VNLib.Net.Messaging.FBM;
+
+namespace VNLib.Data.Caching.ObjectCache
+{
+ /// <summary>
+ /// A configuration object for <see cref="BlobCacheListener{T}"/>
+ /// </summary>
+ public sealed record class BlobCacheListenerConfig
+ {
+ /// <summary>
+ /// Writes error and debug logging information
+ /// </summary>
+ public ILogProvider Log { get; init; } = null!;
+
+ /// <summary>
+ /// The memory manager used for the internal FBM server listener
+ /// </summary>
+ public IFBMMemoryManager MemoryManager { get; init; } = null!;
+
+ /// <summary>
+ /// A flag that enables verifying and sending checksums with message
+ /// data in FBM header fields
+ /// </summary>
+ public bool EnableMessageChecksums { get; init; } = true;
+ }
+}
diff --git a/lib/VNLib.Data.Caching.ObjectCache/src/CacheEntry.cs b/lib/VNLib.Data.Caching.ObjectCache/src/CacheEntry.cs
index 9370901..eddfc42 100644
--- a/lib/VNLib.Data.Caching.ObjectCache/src/CacheEntry.cs
+++ b/lib/VNLib.Data.Caching.ObjectCache/src/CacheEntry.cs
@@ -89,8 +89,8 @@ namespace VNLib.Data.Caching
/// <exception cref="ArgumentException"></exception>
public static CacheEntry FromExistingHandle(object handle, ICacheEntryMemoryManager manager)
{
- _ = handle ?? throw new ArgumentNullException(nameof(handle));
- _ = manager ?? throw new ArgumentNullException(nameof(manager));
+ ArgumentNullException.ThrowIfNull(handle);
+ ArgumentNullException.ThrowIfNull(manager);
//validate handle size it at least the minimum size
if (manager.GetHandleSize(handle) < DATA_SEGMENT_START)
diff --git a/lib/VNLib.Data.Caching/src/ClientExtensions.cs b/lib/VNLib.Data.Caching/src/ClientExtensions.cs
index e0aa744..bfc8ddc 100644
--- a/lib/VNLib.Data.Caching/src/ClientExtensions.cs
+++ b/lib/VNLib.Data.Caching/src/ClientExtensions.cs
@@ -37,7 +37,7 @@ using VNLib.Data.Caching.Exceptions;
using static VNLib.Data.Caching.Constants;
namespace VNLib.Data.Caching
-{
+{
/// <summary>
/// Provides caching extension methods for <see cref="FBMClient"/>
@@ -212,11 +212,11 @@ namespace VNLib.Data.Caching
return ExecAsync(client, request, objectId, cancellationToken);
}
- catch
+ catch(Exception e)
{
//Return the request(clears data and reset)
client.ReturnRequest(request);
- throw;
+ return Task.FromException(e);
}
static async Task ExecAsync(FBMClient client, FBMRequest request, string objectId, CancellationToken cancellationToken)
@@ -239,6 +239,10 @@ namespace VNLib.Data.Caching
{
throw new ObjectNotFoundException($"object {objectId} not found on remote server");
}
+ else if(status.ValueEquals(ResponseCodes.InvalidChecksum, StringComparison.OrdinalIgnoreCase))
+ {
+ throw new InvalidChecksumException($"The server rejected the message {objectId} due to an invalid checksum");
+ }
//Invalid status
throw new InvalidStatusException("Invalid status code recived for object upsert request", status.ToString());
@@ -256,6 +260,7 @@ namespace VNLib.Data.Caching
/// Gets an object from the server if it exists
/// </summary>
/// <typeparam name="T"></typeparam>
+ /// <typeparam name="TState"></typeparam>
/// <param name="client"></param>
/// <param name="objectId">The id of the object to get</param>
/// <param name="cancellationToken">A token to cancel the operation</param>
@@ -368,18 +373,35 @@ namespace VNLib.Data.Caching
response.ThrowIfNotSet();
//Get the status code
- FBMMessageHeader status = response.Headers.FirstOrDefault(static a => a.Header == HeaderCommand.Status);
+ FBMMessageHeader status = response.Headers.FirstOrDefault(static a => a.Header == HeaderCommand.Status);
//Check ok status code, then its safe to deserialize
- if (status.Value.Equals(ResponseCodes.Okay, StringComparison.Ordinal))
+ if (status.ValueEquals(ResponseCodes.Okay, StringComparison.Ordinal))
{
+ //Add message integrity check
+ FBMMessageHeader checksumType = response.Headers.FirstOrDefault(static a => a.Header == ChecksumType);
+ FBMMessageHeader checksum = response.Headers.FirstOrDefault(static a => a.Header == ChecksumValue);
+
+ if(checksumType.ValueEquals(ChecksumTypes.Fnv1a, StringComparison.OrdinalIgnoreCase))
+ {
+ //Verify the checksum
+ if (!FbmMessageChecksum.VerifyFnv1aChecksum(checksum.Value, response.ResponseBody))
+ {
+ throw new InvalidChecksumException(
+ $"The response data integrety check failed. The message data was corrupted for id: {checksum.GetValueString()}"
+ );
+ }
+
+ //Valid checksum, continue
+ }
+
//Write the object data
setter(state, response.ResponseBody);
return true;
}
//Object may not exist on the server yet
- if (status.Value.Equals(ResponseCodes.NotFound, StringComparison.Ordinal))
+ if (status.ValueEquals(ResponseCodes.NotFound, StringComparison.Ordinal))
{
return false;
}
@@ -540,5 +562,34 @@ namespace VNLib.Data.Caching
return new (worker, retryDelay, serverUri);
}
+ /// <summary>
+ /// Determines if the the client sent a message checksum, and if so, verifies the checksum
+ /// if the checksum type is supported.
+ /// </summary>
+ /// <param name="message"></param>
+ /// <returns>
+ /// -1 if the checksum type or value is not set,
+ /// -2 if the checksum type is not supported,
+ /// 0 if the checksum is invalid,
+ /// 1 if the checksum is valid
+ /// </returns>
+ public static int IsClientChecksumValid(this FBMRequestMessage message)
+ {
+ string? type = message.Headers.FirstOrDefault(static h => h.Header == ChecksumType).GetValueString();
+ ReadOnlySpan<char> value = message.Headers.FirstOrDefault(static h => h.Header == ChecksumValue).Value;
+
+ if (type == null || value.IsEmpty)
+ {
+ return -1;
+ }
+
+ if(type.Equals(ChecksumTypes.Fnv1a, StringComparison.OrdinalIgnoreCase))
+ {
+ //Verify the checksum
+ return FbmMessageChecksum.VerifyFnv1aChecksum(value, message.BodyData) ? 1 : 0;
+ }
+
+ return -2;
+ }
}
}
diff --git a/lib/VNLib.Data.Caching/src/Constants.cs b/lib/VNLib.Data.Caching/src/Constants.cs
index 3fb87e0..6c2051a 100644
--- a/lib/VNLib.Data.Caching/src/Constants.cs
+++ b/lib/VNLib.Data.Caching/src/Constants.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching
@@ -22,12 +22,11 @@
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
-using System;
-
using VNLib.Net.Messaging.FBM;
namespace VNLib.Data.Caching
{
+
public static class Constants
{
/// <summary>
@@ -48,9 +47,25 @@ namespace VNLib.Data.Caching
public const string Okay = "ok";
public const string Error = "err";
public const string NotFound = "nf";
+ public const string InvalidChecksum = "cm";
}
public const HeaderCommand ObjectId = (HeaderCommand)0xAA;
public const HeaderCommand NewObjectId = (HeaderCommand)0xAB;
+ public const HeaderCommand ChecksumType = (HeaderCommand)0xA1;
+ public const HeaderCommand ChecksumValue = (HeaderCommand)0xA2;
+ public const HeaderCommand ChecksumWarning = (HeaderCommand)0xA3;
+
+ /// <summary>
+ /// Contains constants for checksum type names for FBM headers
+ /// </summary>
+ public static class ChecksumTypes
+ {
+ public const string Fnv1a = "fnv1a";
+ public const string Crc32 = "crc32";
+ public const string Md5 = "md5";
+ public const string Sha1 = "sha1";
+ public const string Sha256 = "sha256";
+ }
}
}
diff --git a/lib/VNLib.Data.Caching/src/Exceptions/InvalidChecksumException.cs b/lib/VNLib.Data.Caching/src/Exceptions/InvalidChecksumException.cs
new file mode 100644
index 0000000..4e60b4b
--- /dev/null
+++ b/lib/VNLib.Data.Caching/src/Exceptions/InvalidChecksumException.cs
@@ -0,0 +1,45 @@
+/*
+* Copyright (c) 2022 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Data.Caching
+* File: InvalidStatusException.cs
+*
+* InvalidStatusException.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 VNLib.Net.Messaging.FBM;
+
+namespace VNLib.Data.Caching.Exceptions
+{
+ /// <summary>
+ /// Raised when the checksum of a cache result does not match the expected checksum
+ /// </summary>
+ public class InvalidChecksumException : InvalidResponseException
+ {
+ public InvalidChecksumException(string message) : base(message)
+ { }
+
+ public InvalidChecksumException(string message, Exception innerException) : base(message, innerException)
+ { }
+
+ public InvalidChecksumException()
+ { }
+ }
+}
diff --git a/lib/VNLib.Data.Caching/src/Exceptions/InvalidStatusException.cs b/lib/VNLib.Data.Caching/src/Exceptions/InvalidStatusException.cs
index 2296774..ad880b7 100644
--- a/lib/VNLib.Data.Caching/src/Exceptions/InvalidStatusException.cs
+++ b/lib/VNLib.Data.Caching/src/Exceptions/InvalidStatusException.cs
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2022 Vaughn Nugent
+* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching
@@ -42,7 +42,7 @@ namespace VNLib.Data.Caching.Exceptions
/// <param name="statusCode"></param>
public InvalidStatusException(string message, string statusCode):this(message)
{
- this.StatusCode = statusCode;
+ StatusCode = statusCode;
}
///<inheritdoc/>
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]);
+ }
+ }
+}