/usr/include/libknot/cookies/client.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 | /* Copyright (C) 2016 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/>.
*/
#pragma once
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
/*!
* \brief Input data needed to compute the client cookie value.
*/
struct knot_cc_input {
const struct sockaddr *clnt_sockaddr; /*!< Client (local) socket address. */
const struct sockaddr *srvr_sockaddr; /*!< Server (remote) socket address. */
const uint8_t *secret_data; /*!< Client secret data. */
size_t secret_len; /*!< Secret data length. */
};
/*!
* \brief Check client cookie input data for basic sanity.
*
* \param input Data which to generate the cookie from.
*
* \retval true if input contains at least one socket and secret data
* \retval false if input is insufficient or NULL pointer passed
*/
bool knot_cc_input_is_valid(const struct knot_cc_input *input);
/*!
* \brief Client cookie generator function type.
*
* \param input Data which to generate the cookie from.
* \param cc_out Buffer to write the resulting client cookie data into.
* \param cc_len Cookie buffer size.
*
* \retval non-zero size of written data on successful return
* \retval 0 on error
*/
typedef uint16_t (knot_cc_gen_t)(const struct knot_cc_input *input,
uint8_t *cc_out, uint16_t cc_len);
/*!
* \brief Holds description of the client cookie algorithm.
*/
struct knot_cc_alg {
const uint16_t cc_size; /*!< Cookie size the algorithm operates with. */
knot_cc_gen_t *gen_func; /*!< Cookie generator function. */
};
/*!
* \brief Check whether client cookie \a cc was generated from given \a input.
*
* \param cc Client cookie that should be checked.
* \param cc_len Client cookie size.
* \param input Client cookie input algorithm parameters.
* \param cc_alg Client cookie algorithm.
*
* \retval KNOT_EOK
* \retval KNOT_EINVAL
*/
int knot_cc_check(const uint8_t *cc, uint16_t cc_len,
const struct knot_cc_input *input,
const struct knot_cc_alg *cc_alg);
|