Cytoplasm/src/include/Sha2.h

51 lines
1.9 KiB
C
Raw Normal View History

/*
* Copyright (C) 2022-2023 Jordan Bancino <@jordan:bancino.net>
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef CYTOPLASM_SHA2_H
#define CYTOPLASM_SHA2_H
/***
* @Nm Sha2
* @Nd A simple implementation of the SHA2 hashing functions.
* @Dd December 19 2022
* @Xr Memory Base64
*
* This API defines simple functions for computing SHA2 hashes.
* At the moment, it only defines
* .Fn Sha256 ,
* which computes the SHA-256 hash of the given C string. It is
* not trivial to implement SHA-512 in ANSI C due to the lack of
* a 64-bit integer type, so that hash function has been omitted.
*/
/**
* This function takes a pointer to a NULL-terminated C string, and
* returns a string allocated on the heap using the Memory API, or
* NULL if there was an error allocating memory. The returned string
* should be freed when it is no longer needed.
*/
extern char * Sha256(char *);
#endif /* CYTOPLASM_SHA2_H */