aboutsummaryrefslogtreecommitdiff
path: root/wrappers/dotnet/VNLib.Utils.Cryptography.Noscrypt/src/Random/UnmanagedRandomSource.cs
blob: 73ff374e204de27e44c26c8e743383785ee29ef8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// Copyright (C) 2024 Vaughn Nugent
//
// This program 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.
//
// This program 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.Runtime.InteropServices;

using VNLib.Utils.Native;
using VNLib.Utils.Extensions;

namespace VNLib.Utils.Cryptography.Noscrypt.Random
{

    /// <summary>
    /// A wrapper class for an unmanaged random source that conforms to the <see cref="IRandomSource"/> interface
    /// </summary>
    public class UnmanagedRandomSource : VnDisposeable, IRandomSource
    {
        /// <summary>
        /// The explicit name of the unmanaged random function to get random bytes
        /// </summary>
        public const string RngFunctionName = "GetRandomBytes";

        unsafe delegate void UnmanagedRandomSourceDelegate(byte* buffer, int size);

        private readonly bool OwnsHandle;
        private readonly SafeLibraryHandle _library;
        private readonly UnmanagedRandomSourceDelegate _getRandomBytes;

        /// <summary>
        /// Loads the unmanaged random source from the given library 
        /// and attempts to get the random bytes method <see cref="RngFunctionName"/>
        /// </summary>
        /// <param name="path"></param>
        /// <param name="search"></param>
        /// <returns>The wrapped library that conforms to the <see cref="IRandomSource"/></returns>
        public static UnmanagedRandomSource LoadLibrary(string path, DllImportSearchPath search)
        {
            //Try to load the library
            SafeLibraryHandle lib = SafeLibraryHandle.LoadLibrary(path, search);
            try
            {
                return new UnmanagedRandomSource(lib, true);
            }
            catch
            {
                //release lib
                lib.Dispose();
                throw;
            }
        }

        /// <summary>
        /// Creates the unmanaged random source from the given library
        /// </summary>
        /// <param name="lib">The library handle to wrap</param>
        /// <exception cref="ObjectDisposedException"></exception>
        /// <exception cref="EntryPointNotFoundException"></exception>
        public UnmanagedRandomSource(SafeLibraryHandle lib, bool ownsHandle)
        {
            lib.ThrowIfClosed();

            _library = lib;

            //get the method delegate
            _getRandomBytes = lib.DangerousGetFunction<UnmanagedRandomSourceDelegate>(RngFunctionName);

            OwnsHandle = ownsHandle;
        }

        ///<inheritdoc/>
        public unsafe void GetRandomBytes(Span<byte> buffer)
        {
            _library.ThrowIfClosed();

            //Fix buffer and call unmanaged method
            fixed (byte* ptr = &MemoryMarshal.GetReference(buffer))
            {
                _getRandomBytes(ptr, buffer.Length);
            }
        }

        ///<inheritdoc/>
        protected override void Free()
        {
            if (OwnsHandle)
            {
                _library.Dispose();
            }
        }
    }
}