1/*
2 * Copyright (C) 2004-2007, 2009  Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001  Internet Software Consortium.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
16 */
17
18/* $Id: secalg.h,v 1.21 2009/10/12 23:48:02 tbox Exp $ */
19
20#ifndef DNS_SECALG_H
21#define DNS_SECALG_H 1
22
23/*! \file dns/secalg.h */
24
25#include <isc/lang.h>
26
27#include <dns/types.h>
28
29ISC_LANG_BEGINDECLS
30
31isc_result_t
32dns_secalg_fromtext(dns_secalg_t *secalgp, isc_textregion_t *source);
33/*%<
34 * Convert the text 'source' refers to into a DNSSEC security algorithm value.
35 * The text may contain either a mnemonic algorithm name or a decimal algorithm
36 * number.
37 *
38 * Requires:
39 *\li	'secalgp' is a valid pointer.
40 *
41 *\li	'source' is a valid text region.
42 *
43 * Returns:
44 *\li	ISC_R_SUCCESS			on success
45 *\li	ISC_R_RANGE			numeric type is out of range
46 *\li	DNS_R_UNKNOWN			mnemonic type is unknown
47 */
48
49isc_result_t
50dns_secalg_totext(dns_secalg_t secalg, isc_buffer_t *target);
51/*%<
52 * Put a textual representation of the DNSSEC security algorithm 'secalg'
53 * into 'target'.
54 *
55 * Requires:
56 *\li	'secalg' is a valid secalg.
57 *
58 *\li	'target' is a valid text buffer.
59 *
60 * Ensures,
61 *	if the result is success:
62 *\li		The used space in 'target' is updated.
63 *
64 * Returns:
65 *\li	ISC_R_SUCCESS			on success
66 *\li	ISC_R_NOSPACE			target buffer is too small
67 */
68
69#define DNS_SECALG_FORMATSIZE 20
70void
71dns_secalg_format(dns_secalg_t alg, char *cp, unsigned int size);
72/*%<
73 * Wrapper for dns_secalg_totext(), writing text into 'cp'
74 */
75
76ISC_LANG_ENDDECLS
77
78#endif /* DNS_SECALG_H */
79