/usr/include/dnssec/tsig.h is in libknot-dev 2.4.0-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | /* Copyright (C) 2014 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file
*
* Low-level TSIG signing API.
*
* \defgroup tsig TSIG
*
* Low-level TSIG signing API.
*
* Example:
*
* ~~~~~ {.c}
*
* int result;
*
* dnssec_binary_t *covered = // ... ;
* dnssec_binary_t *signature = // ... ;
*
* // convert algorithm from textual representation
* dnssec_tsig_algorithm_t algorithm;
* algorithm = dnssec_tsig_algorithm_from_name("hmac-sha256");
* assert(algorithm == DNSSEC_TSIG_HMAC_SHA256);
*
* // get shared key
* dnssec_binary_t key = {
* .size = 4,
* .data = (uint8_t *) { 0x11, 0x22, 0x33, 0x44 }
* };
*
* // create computation context
* dnssec_tsig_ctx_t *ctx;
* result = dnssec_tsig_new(&ctx, algorithm, &key);
* if (result != DNSSEC_EOK) {
* return result;
* }
*
* // add data to be covered by the signature
* dnssec_tsig_add(ctx, covered);
*
* // compute the expected signature (MAC)
* size_t size = dnssec_tsig_size(ctx);
* dnssec_binary_t expected_signature = { 0 };
* result = dnssec_binary_alloc(&expected_signature, size);
* if (result != DNSSEC_EOK) {
* dnssec_tsig_free(ctx);
* return result;
* }
* dnssec_tsig_write(ctx, &expected_signature);
*
* // compare the signatures
* if (dnssec_binary_cmp(signature, &expected_signature) == 0) {
* // valid signature
* } else {
* // invalid signature
* }
*
* // cleanup
* dnssec_binary_free(&expected_signature);
* dnssec_tsig_free(ctx);
*
* ~~~~~
*
* @{
*/
#pragma once
#include <stdint.h>
#include <dnssec/binary.h>
/*!
* TSIG algorithms.
*
* \note The numeric values are library specific.
*/
typedef enum dnssec_tsig_algorithm {
DNSSEC_TSIG_UNKNOWN = 0,
DNSSEC_TSIG_HMAC_MD5,
DNSSEC_TSIG_HMAC_SHA1,
DNSSEC_TSIG_HMAC_SHA224,
DNSSEC_TSIG_HMAC_SHA256,
DNSSEC_TSIG_HMAC_SHA384,
DNSSEC_TSIG_HMAC_SHA512
} dnssec_tsig_algorithm_t;
/*!
* Get TSIG algorithm number from domain name.
*
* \see https://www.iana.org/assignments/tsig-algorithm-names/tsig-algorithm-names.xhtml
*
* \param dname Domain name of the algorithm (e.g., 0x0b hmac-sha256).
*
* \return TSIG algorithm.
*/
dnssec_tsig_algorithm_t dnssec_tsig_algorithm_from_dname(const uint8_t *dname);
/*!
* Get a domain name of the TSIG algorithm.
*
* \param algorithm TSIG algorithm.
*
* \return Domain name of the TSIG algorithm.
*/
const uint8_t *dnssec_tsig_algorithm_to_dname(dnssec_tsig_algorithm_t algorithm);
/*!
* Get TSIG algorithm from a MAC name.
*
* \param name MAC name (e.g., hmac-sha256).
*
* \return TSIG algorithm.
*/
dnssec_tsig_algorithm_t dnssec_tsig_algorithm_from_name(const char *name);
/*!
* Get MAC name from a TSIG algorithm.
*
* \param algorithm TSIG algorithm.
*
* \return MAC name of the TSIG algorithm.
*/
const char *dnssec_tsig_algorithm_to_name(dnssec_tsig_algorithm_t algorithm);
/*!
* Get optimal size of a TSIG algorithm.
*/
int dnssec_tsig_optimal_key_size(dnssec_tsig_algorithm_t algorithm);
struct dnssec_tsig_ctx;
/*!
* TSIG signing context.
*/
typedef struct dnssec_tsig_ctx dnssec_tsig_ctx_t;
/*!
* Create new TSIG signing context.
*
* \param[out] ctx Resulting TSIG context.
* \param[in] algorithm TSIG algorithm.
* \param[in] key Shared key to be used for signing.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_tsig_new(dnssec_tsig_ctx_t **ctx, dnssec_tsig_algorithm_t algorithm,
const dnssec_binary_t *key);
/*!
* Free the TSIG signing context.
*
* \param ctx TSIG signing context to be freed.
*/
void dnssec_tsig_free(dnssec_tsig_ctx_t *ctx);
/*!
* Add data to be signed by TSIG.
*
* \param ctx TSIG signing context.
* \param data Data to be signed.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_tsig_add(dnssec_tsig_ctx_t *ctx, const dnssec_binary_t *data);
/*!
* Get size of the TSIG signature for given signing context.
*
* \param ctx TSIG signing context.
*
* \return The size of the TSIG signature.
*/
size_t dnssec_tsig_size(dnssec_tsig_ctx_t *ctx);
/*!
* Get size of the TSIG signature for given algorithm.
*
* \param algorithm TSIG algorithm.
*
* \return The size of the TSIG signature.
*/
size_t dnssec_tsig_algorithm_size(dnssec_tsig_algorithm_t algorithm);
/*!
* Write TSIG signature.
*
* \param[in] ctx TSIG signing context.
* \param[out] mac Resulting TSIG signature.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_tsig_write(dnssec_tsig_ctx_t *ctx, uint8_t *mac);
/*! @} */
|