1 /* $NetBSD: secproto.h,v 1.4 2014/12/10 04:37:58 christos Exp $ */ 2 3 /* 4 * Copyright (C) 2004-2007 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: secproto.h,v 1.16 2007/06/19 23:47:17 tbox Exp */ 21 22 #ifndef DNS_SECPROTO_H 23 #define DNS_SECPROTO_H 1 24 25 /*! \file dns/secproto.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_secproto_fromtext(dns_secproto_t *secprotop, isc_textregion_t *source); 35 /*%< 36 * Convert the text 'source' refers to into a DNSSEC security protocol value. 37 * The text may contain either a mnemonic protocol name or a decimal protocol 38 * number. 39 * 40 * Requires: 41 *\li 'secprotop' 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_secproto_totext(dns_secproto_t secproto, isc_buffer_t *target); 53 /*%< 54 * Put a textual representation of the DNSSEC security protocol 'secproto' 55 * into 'target'. 56 * 57 * Requires: 58 *\li 'secproto' is a valid secproto. 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 ISC_LANG_ENDDECLS 72 73 #endif /* DNS_SECPROTO_H */ 74