blob: 3c949769ee5061ac5565b0d7c07149b2398096a5 (
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* 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 ccnxValidation_EcSecp256K1.h
* @brief <#Brief Description#>
*
* <#Detailed Description#>
*
*/
#ifndef CCNx_Common_ccnxValidation_EcSecp256K1_h
#define CCNx_Common_ccnxValidation_EcSecp256K1_h
#include <stdbool.h>
#include <ccnx/common/internal/ccnx_TlvDictionary.h>
#include <ccnx/common/ccnx_KeyLocator.h>
/**
*
* Sets the validation algorithm to be Elliptical Curve with SECP-256K1 parameters.
* Optionally includes a KeyId and KeyLocator with the message.
*
* @param [in] message The message dictionary
* @param [in] keyid (Optional) The KEYID to include the the message
* @param [in] keyLocator (Optional) The KEY LOCATOR to include in the message
*
* @return true success
* @return false failure
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool ccnxValidationEcSecp256K1_Set(CCNxTlvDictionary *message, const PARCBuffer *keyid, const CCNxKeyLocator *keyLocator);
/**
* Determines if the validation algorithm is Elliptical Curve with SECP-256K1 parameters.
*
* <#Paragraphs Of Explanation#>
*
* @param [in] message The message to check
*
* @return true The validation algorithm in the dictionary is this one
* @return false The validaiton algorithm in the dictionary is something else or not present
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool ccnxValidationEcSecp256K1_Test(const CCNxTlvDictionary *message);
/**
* Returns the KeyId associated with the validation algorithm
*
* <#Paragraphs Of Explanation#>
*
* @param [in] message The message to check
*
* @return non-NULL the keyid
* @return null An error or no keyid or no validation algorithm in the message
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBuffer *ccnxValidationEcSecp256K1_GetKeyId(const CCNxTlvDictionary *message);
/**
* Returns the KeyName associated with the validation algorithm
*
* This should return a LINK, see case 1018
*
* @param [in] message The message to check
*
* @return non-NULL the KeyName
* @return null An error or no keyid or no validation algorithm in the message
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxName *ccnxValidationEcSecp256K1_GetKeyLocatorName(const CCNxTlvDictionary *message);
/**
* Returns the PublicKey associated with the validation algorithm
*
* @param [in] message The message to check
*
* @return non-NULL the PublicKey (DER encoded)
* @return null An error or no public key or no validation algorithm in the message
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBuffer *ccnxValidationEcSecp256K1_GetKeyLocatorPublicKey(const CCNxTlvDictionary *message);
/**
* Returns the Certificate associated with the validation algorithm
*
* @param [in] message The message to check
*
* @return non-NULL the Certificate (DER encoded)
* @return null An error or no certificate or no validation algorithm in the message
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBuffer *ccnxValidationEcSecp256K1_GetKeyLocatorCertificate(const CCNxTlvDictionary *message);
#endif // CCNx_Common_ccnxValidation_EcSecp256K1_h
|
