blob: 3ab1d9c9b399106bc6ac9b4285cf0447dcc8b104 (
plain)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file parc_CryptoHashType.h
* @ingroup security
* @brief A type specifying a cryptographic hash (or CRC check) algorithm.
*
* This type is overloaded to support both cryptographic hash digest algorithms and cyclical-reduncancy
* check (CRC) algorithms. See the available `PARCCryptoHashType` enum types for an exhaustive
* list of the supported algorithms.
*
*/
#ifndef libparc_parc_CryptoHashType_h
#define libparc_parc_CryptoHashType_h
typedef enum {
PARCCryptoHashType_SHA256,
PARCCryptoHashType_SHA512,
PARCCryptoHashType_CRC32C,
PARCCryptoHashType_NULL
} PARCCryptoHashType;
/**
* Convert the `PARCCryptoHashType` value to a human-readable string representation.
*
* @param [in] type A `PARCCryptoHashType` value
*
* @return A static, null-terminated string.
*
* Example:
* @code
* {
* PARCCryptoHashType type = PARCCryptoHashType_SHA256;
* const char *stringRep = parcCryptoHashType_ToString(type);
* // use stringRep as necessary, and then free
* }
* @endcode
*/
const char *parcCryptoHashType_ToString(PARCCryptoHashType type);
/**
* Convert a string representation value of a `PARCCryptoHashType` to an actual value.
*
* @param [in] name A string representation of a `PARCCryptoHashType` value.
*
* @return A `PARCCryptoHashType` value.
*
* Example:
* @code
* {
* const char stringRep[17] = "PARCCryptoHashType_SHA256";
* PARCCryptoHashType type = parcCryptoHashType_FromString(stringRep);
* // use stringRep as necessary, and then free
* }
* @endcode
*/
PARCCryptoHashType parcCryptoHashType_FromString(const char *name);
#endif // libparc_parc_CryptoHashType_h
|
