wrappers/dotnet/VNLib.Utils.Cryptography.Noscrypt/src/INostrEncryptionVersion.cs


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

// 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/>.

namespace VNLib.Utils.Cryptography.Noscrypt
{
    /// <summary>
    /// Represents a message encryption version used by the Nostr protocol
    /// </summary>
    public interface INostrEncryptionVersion
    {
        /// <summary>
        /// The noscrypt compatible encryption version
        /// </summary>
        internal uint Version { get; }

        /// <summary>
        /// Calculates the required payload buffer size for the specified data size
        /// </summary>
        /// <param name="dataSize">The size of the input data</param>
        /// <returns>The estimated size of the buffer required to complete the opeation</returns>
        internal int GetPayloadBufferSize(int dataSize);

        /// <summary>
        /// Calculates the required message buffer size for the specified data size
        /// </summary>
        /// <param name="dataSize">Plain text data size</param>
        /// <returns>The estimated size of the buffer required to complete the opeation</returns>
        internal int GetMessageBufferSize(int dataSize);
    }

}