NET_DigestAlgorithm.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_DigestAlgorithm.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __NET_DIGESTALGORITHM_H__
#define __NET_DIGESTALGORITHM_H__

#include "NET_API.h"

#include <UT/UT_NonCopyable.h>
#include <UT/UT_StringHolder.h>

#include <cstdint>

struct evp_md_st;
using EVP_MD = evp_md_st;

class NET_API NET_DigestAlgorithm
{
public:
    explicit NET_DigestAlgorithm(const EVP_MD* md) :
        myMD(md)
    {
    }
    explicit NET_DigestAlgorithm(int type);
    explicit NET_DigestAlgorithm(const UT_StringRef& name);

    const EVP_MD* native() const;
    int type() const;
    const char* name() const;
    int pkeyType() const;
    exint size() const;
    exint blockSize() const;
    std::uint64_t flags() const;

private:
    const EVP_MD* myMD;
};

/// Popular digest algorithms. NET_DigestAlgorithm can take in any digest that
/// the underyling encryption library supports. These are just a list of
/// commonly used digests.
enum class NET_DigestAlgorithmTypes
{
    SHA256,
    SHA512
};

NET_API NET_DigestAlgorithm
NETcreateDigestAlgorithm(NET_DigestAlgorithmTypes alg);
NET_API NET_DigestAlgorithmTypes
NETdigestAlgorithmFromString(const UT_StringRef& str);
NET_API UT_StringHolder
NETdigestAlgorithmToString(NET_DigestAlgorithmTypes types);

#endif // __NET_DIGESTALGORITHM_H__