crypto/src/crypto/ISigner.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
44
45
46
47
48
49
50
51
52

using System;

namespace Org.BouncyCastle.Crypto
{
    public interface ISigner
    {
        /// <summary>The algorithm name.</summary>
        string AlgorithmName { get; }

        /// <summary>Initialise the signer for signing or verification.</summary>
        /// <param name="forSigning">true if for signing, false otherwise.</param>
        /// <param name="parameters">necessary parameters.</param>
        void Init(bool forSigning, ICipherParameters parameters);

        /// <summary>Update the signer with a single byte.</summary>
        /// <param name="input">the input byte to be entered.</param>
        void Update(byte input);

        /// <summary>Update the signer with a block of bytes.</summary>
        /// <param name="input">the byte array containing the data.</param>
        /// <param name="inOff">the offset into the byte array where the data starts.</param>
        /// <param name="inLen">the length of the data.</param>
        void BlockUpdate(byte[] input, int inOff, int inLen);

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
        /// <summary>Update the signer with a span of bytes.</summary>
        /// <param name="input">the span containing the data.</param>
        void BlockUpdate(ReadOnlySpan<byte> input);
#endif

        int GetMaxSignatureSize();

        /// <summary>Generate a signature for the message we've been loaded with using the key we were initialised with.
        /// </summary>
        /// <returns>A byte array containing the signature for the message.</returns>
        byte[] GenerateSignature();

        /// <summary>Return true if the internal state represents the signature described in the passed in array.
        /// </summary>
        /// <param name="signature">an array containing the candidate signature to verify.</param>
        /// <returns>true if the internal state represents the signature described in the passed in array.</returns>
        bool VerifySignature(byte[] signature);

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
        // TODO[api]
        //bool VerifySignature(ReadOnlySpan<byte> signature);
#endif

        /// <summary>Reset the signer back to its initial state.</summary>
        void Reset();
    }
}