FeatureRequest: Add opt-in possibility to zeroed-out buffers about microsoft.io.recyclablememorystream HOT 10 CLOSED

What about adding API to zero out the stream, so the caller is responsible. That would avoid having to add an if check that most people don't need.

from microsoft.io.recyclablememorystream.

I want to add zeroing to prevent accidental data leaks.

from microsoft.io.recyclablememorystream.

I'm not opposed to this. Go for it.

from microsoft.io.recyclablememorystream.

Do you want to add zeroing to prevent accidental data leaks or so that new streams only contain zeros? In the latter case, note that new blocks are allocated using GC.AllocateUninitializedArray which can return arrays with non-zero content.

from microsoft.io.recyclablememorystream.

What about adding API to zero out the stream, so the caller is responsible. That would avoid having to add an if check that most people don't need.

With the API approach one would have the risk of accidental data leak in case the caller forgets to explicitly zero out memory. Also the combination with `AggressiveBufferReturn`` seems tricky.
I see the point of not adding an if check that most people don't need.
Not sure how to proceed as i think the API approach is already possible by wrapping the stream and calling

CryptographicOperations.ZeroMemory(wrappedStream.GetBuffer());

from microsoft.io.recyclablememorystream.

Calling GetBuffer() won't return the encapsulated buffers if there are more than one. Do something like this instead:

var buffers = someStream.GetReadOnlySequence();
foreach (var buffer in buffers)
{
    CryptographicOperations.ZeroMemory(buffer.Span);
}

from microsoft.io.recyclablememorystream.

This won't work as the buffers are read-only. buffer.Span will return a ReadOnlySpan

from microsoft.io.recyclablememorystream.

D'oh, you're right. It'd have to be something like this:

var buffers = someStream.GetReadOnlySequence();
foreach (var buffer in buffers)
{
    ref var bytes = ref MemoryMarshal.GetReference(buffer.Span);
    var span = MemoryMarshal.CreateSpan(ref bytes, buffer.Length);
    CryptographicOperations.ZeroMemory(span);
}

But that still won't handle the large buffer if GetBuffer() was ever called during the lifetime of the stream.

from microsoft.io.recyclablememorystream.

Would it be okay then to zero out the buffers (only if configured) before returning them to the pool ?
This would require an additional if check

from microsoft.io.recyclablememorystream.

Would it be okay then to zero out the buffers (only if configured) before returning them to the pool ? This would require an additional if check

I think this fine. Let's make this a 3.0 feature.

from microsoft.io.recyclablememorystream.