keyid.h 1.88 KB
Newer Older
1
/*  Copyright (C) 2018 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
2 3 4 5 6 7 8 9 10 11 12 13 14 15

    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/>.
*/
16
/*!
17 18
 * \file
 *
19 20 21
 * \addtogroup keyid
 * 
 * \brief DNSSEC key ID manipulation.
22
 *
23 24 25 26 27 28 29 30 31 32 33 34
 * The module contains auxiliary functions for manipulation with key IDs.
 *
 * Example:
 *
 * ~~~~~ {.c}
 *
 * char *key_id = "ef26672cafede0732dd18fba6488fa390b5589af";
 * assert(dnssec_keyid_is_valid(key_id));
 *
 * char copy[DNSSEC_KEY_ID_SIZE + 1] = { 0 };
 * memcpy(copy, key_id, sizeof(copy));
 * for (int i = 0; i < DNSSEC_KEY_ID_SIZE; i++) {
35
 *     copy[i] = toupper((unsigned char)copy[i]);
36 37 38 39 40 41
 * }
 *
 * assert(dnssec_keyid_equal(key_id, copy));
 *
 * ~~~~~
 *
42
 * @{
43
 */
44

45 46 47 48 49
#pragma once

#include <stdint.h>
#include <stdbool.h>

50 51 52
/*!
 * Length of the key ID in presentation form (ASCII).
 */
53
#define DNSSEC_KEYID_SIZE 40
54 55 56 57

/*!
 * Length of the key ID in internal form (binary).
 */
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
#define DNSSEC_KEYID_BINARY_SIZE 20

/*!
 * Check if a provided string is a valid key ID string.
 */
bool dnssec_keyid_is_valid(const char *id);

/*!
 * Normalize the key ID string.
 */
void dnssec_keyid_normalize(char *id);

/*!
 * Create a normalized copy if the key ID.
 */
char *dnssec_keyid_copy(const char *id);

/*!
 * Check if two key IDs are equal.
 */
bool dnssec_keyid_equal(const char *one, const char *two);
79 80

/*! @} */