summaryrefslogtreecommitdiffstats
path: root/src/libdnssec/keytag.h
blob: 5a8424ef8b8b8b3d99cc5f59d159ad13a22c17b0 (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
/*  Copyright (C) 2018 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
 *
 * \addtogroup keytag
 *
 * \brief Low-level key tag computation API.
 *
 * The module provides simple interface for DNSKEY key id computation.
 *
 * Example:
 *
 * ~~~~~ {.c}
 *
 * dnssec_binary_t dnskey_rdata = // ... ;
 *
 * int result;
 * uint16_t keytag = 0;
 *
 * result = dnssec_keytag(&dnskey_rdata, &keytag);
 * if (result != DNSSEC_EOK) {
 *     return result;
 * }
 *
 * printf("keytag: %s\n", keytag);
 *
 * ~~~~~
 *
 * @{
 */

#pragma once

#include <stdint.h>
#include <libdnssec/binary.h>

/*!
 * Compute a key tag for a DNSSEC key.
 *
 * \param[in]  rdata   DNSKEY RDATA.
 * \param[out] keytag  Computed keytag.
 *
 * \return Error code, DNSSEC_EOK of successful.
 */
int dnssec_keytag(const dnssec_binary_t *rdata, uint16_t *keytag);

/*!
 * @}
 */