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