2 * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001 Internet Software Consortium.
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.
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.
18 /* $Id: secalg.h,v 1.19 2007/06/19 23:47:17 tbox Exp $ */
21 #define DNS_SECALG_H 1
23 /*! \file dns/secalg.h */
27 #include <dns/types.h>
32 dns_secalg_fromtext(dns_secalg_t *secalgp, isc_textregion_t *source);
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
39 *\li 'secalgp' is a valid pointer.
41 *\li 'source' is a valid text region.
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
50 dns_secalg_totext(dns_secalg_t secalg, isc_buffer_t *target);
52 * Put a textual representation of the DNSSEC security algorithm 'secalg'
56 *\li 'secalg' is a valid secalg.
58 *\li 'target' is a valid text buffer.
61 * if the result is success:
62 *\li The used space in 'target' is updated.
65 *\li ISC_R_SUCCESS on success
66 *\li ISC_R_NOSPACE target buffer is too small
71 #endif /* DNS_SECALG_H */