Aaru/Aaru.Checksums/SHA384Context.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : SHA384Context.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Checksums.
//
// --[ Description ] ----------------------------------------------------------
//
//     Wraps up .NET SHA384 implementation to a Init(), Update(), Final() context.
//
// --[ License ] --------------------------------------------------------------
//
//     This library is free software; you can redistribute it and/or modify
//     it under the terms of the GNU Lesser General Public License as
//     published by the Free Software Foundation; either version 2.1 of the
//     License, or (at your option) any later version.
//
//     This library 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
//     Lesser General Public License for more details.
//
//     You should have received a copy of the GNU Lesser General Public
//     License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2025 Natalia Portillo
// ****************************************************************************/

using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Aaru.CommonTypes.Interfaces;

namespace Aaru.Checksums;

/// <inheritdoc />
/// <summary>Wraps up .NET SHA384 implementation to a Init(), Update(), Final() context.</summary>
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
[SuppressMessage("ReSharper", "MemberCanBeInternal")]
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public sealed class Sha384Context : IChecksum
{
    readonly SHA384 _provider;

    /// <summary>Initializes the SHA384 hash provider</summary>
    public Sha384Context() => _provider = SHA384.Create();

#region IChecksum Members

    /// <inheritdoc />
    public string Name => Localization.SHA384_Name;

    /// <inheritdoc />
    public Guid Id => new("4A2A1820-E157-4842-B1E2-0E629FA60DDD");

    /// <inheritdoc />
    public string Author => Authors.NataliaPortillo;

    /// <inheritdoc />
    /// <summary>Updates the hash with data.</summary>
    /// <param name="data">Data buffer.</param>
    /// <param name="len">Length of buffer to hash.</param>
    public void Update(byte[] data, uint len) => _provider.TransformBlock(data, 0, (int)len, data, 0);

    /// <inheritdoc />
    /// <summary>Updates the hash with data.</summary>
    /// <param name="data">Data buffer.</param>
    public void Update(byte[] data) => Update(data, (uint)data.Length);

    /// <inheritdoc />
    /// <summary>Returns a byte array of the hash value.</summary>
    public byte[] Final()
    {
        _provider.TransformFinalBlock([], 0, 0);

        return _provider.Hash;
    }

    /// <inheritdoc />
    /// <summary>Returns a hexadecimal representation of the hash value.</summary>
    public string End()
    {
        _provider.TransformFinalBlock([], 0, 0);
        var sha384Output = new StringBuilder();

        if(_provider.Hash is null) return null;

        foreach(byte h in _provider.Hash) sha384Output.Append(h.ToString("x2"));

        return sha384Output.ToString();
    }

#endregion

    /// <summary>Gets the hash of a file</summary>
    /// <param name="filename">File path.</param>

    // ReSharper disable once ReturnTypeCanBeEnumerable.Global
    public static byte[] File(string filename)
    {
        var    localSha384Provider = SHA384.Create();
        var    fileStream          = new FileStream(filename, FileMode.Open);
        byte[] result              = localSha384Provider.ComputeHash(fileStream);
        fileStream.Close();

        return result;
    }

    /// <summary>Gets the hash of a file in hexadecimal and as a byte array.</summary>
    /// <param name="filename">File path.</param>
    /// <param name="hash">Byte array of the hash value.</param>
    public static string File(string filename, out byte[] hash)
    {
        var localSha384Provider = SHA384.Create();
        var fileStream          = new FileStream(filename, FileMode.Open);
        hash = localSha384Provider.ComputeHash(fileStream);
        var sha384Output = new StringBuilder();

        foreach(byte h in hash) sha384Output.Append(h.ToString("x2"));

        fileStream.Close();

        return sha384Output.ToString();
    }

    /// <summary>Gets the hash of the specified data buffer.</summary>
    /// <param name="data">Data buffer.</param>
    /// <param name="len">Length of the data buffer to hash.</param>
    /// <param name="hash">Byte array of the hash value.</param>
    public static string Data(byte[] data, uint len, out byte[] hash)
    {
        var localSha384Provider = SHA384.Create();
        hash = localSha384Provider.ComputeHash(data, 0, (int)len);
        var sha384Output = new StringBuilder();

        foreach(byte h in hash) sha384Output.Append(h.ToString("x2"));

        return sha384Output.ToString();
    }

    /// <summary>Gets the hash of the specified data buffer.</summary>
    /// <param name="data">Data buffer.</param>
    /// <param name="hash">Byte array of the hash value.</param>
    public static string Data(byte[] data, out byte[] hash) => Data(data, (uint)data.Length, out hash);
}