blob: 23f227680c17209d79258ac40eb39881f91822c9 (
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
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: SecretResult.cs
*
* SecretResult.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading 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.Plugins.Extensions.Loading 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.Utils;
using VNLib.Utils.Memory;
namespace VNLib.Plugins.Extensions.Loading
{
/// <summary>
/// The result of a secret fetch operation
/// </summary>
public sealed class SecretResult : VnDisposeable, ISecretResult
{
private readonly char[] _secretChars;
///<inheritdoc/>
public ReadOnlySpan<char> Result => _secretChars;
private SecretResult(char[] secretChars) => _secretChars = secretChars;
///<inheritdoc/>
protected override void Free() => MemoryUtil.InitializeBlock(_secretChars);
/// <summary>
/// Copies the data from the provided string into a new secret result
/// then erases the original string
/// </summary>
/// <param name="result">The secret string to read</param>
/// <returns>The <see cref="SecretResult"/> wrapper</returns>
internal static SecretResult ToSecret(string? result)
{
if (result == null)
{
return new SecretResult([]);
}
//Copy string data into a new char array
SecretResult res = new(result.ToCharArray());
//PrivateStringManager will safely erase the original string if it is able to
PrivateStringManager.EraseString(result);
return res;
}
/// <summary>
/// Copies the data from the provided span into a new secret result
/// by allocating a new array internally
/// </summary>
/// <param name="secretChars">The array of characters to copy</param>
/// <returns>The wrapped secret</returns>
internal static SecretResult ToSecret(ReadOnlySpan<char> secretChars) => new(secretChars.ToArray());
internal static SecretResult ToSecret(char[] result) => new(result);
}
}
|
