00001 /* 00002 * Copyright (C) 2004-2007, 2009 Internet Systems Consortium, Inc. ("ISC") 00003 * Copyright (C) 1999-2001 Internet Software Consortium. 00004 * 00005 * Permission to use, copy, modify, and/or distribute this software for any 00006 * purpose with or without fee is hereby granted, provided that the above 00007 * copyright notice and this permission notice appear in all copies. 00008 * 00009 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 00010 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 00011 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 00012 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 00013 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 00014 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 00015 * PERFORMANCE OF THIS SOFTWARE. 00016 */ 00017 00018 /* $Id: secalg.h,v 1.21 2009/10/12 23:48:02 tbox Exp $ */ 00019 00020 #ifndef DNS_SECALG_H 00021 #define DNS_SECALG_H 1 00022 00023 /*! \file dns/secalg.h */ 00024 00025 #include <isc/lang.h> 00026 00027 #include <dns/types.h> 00028 00029 ISC_LANG_BEGINDECLS 00030 00031 isc_result_t 00032 dns_secalg_fromtext(dns_secalg_t *secalgp, isc_textregion_t *source); 00033 /*%< 00034 * Convert the text 'source' refers to into a DNSSEC security algorithm value. 00035 * The text may contain either a mnemonic algorithm name or a decimal algorithm 00036 * number. 00037 * 00038 * Requires: 00039 *\li 'secalgp' is a valid pointer. 00040 * 00041 *\li 'source' is a valid text region. 00042 * 00043 * Returns: 00044 *\li ISC_R_SUCCESS on success 00045 *\li ISC_R_RANGE numeric type is out of range 00046 *\li DNS_R_UNKNOWN mnemonic type is unknown 00047 */ 00048 00049 isc_result_t 00050 dns_secalg_totext(dns_secalg_t secalg, isc_buffer_t *target); 00051 /*%< 00052 * Put a textual representation of the DNSSEC security algorithm 'secalg' 00053 * into 'target'. 00054 * 00055 * Requires: 00056 *\li 'secalg' is a valid secalg. 00057 * 00058 *\li 'target' is a valid text buffer. 00059 * 00060 * Ensures, 00061 * if the result is success: 00062 *\li The used space in 'target' is updated. 00063 * 00064 * Returns: 00065 *\li ISC_R_SUCCESS on success 00066 *\li ISC_R_NOSPACE target buffer is too small 00067 */ 00068 00069 #define DNS_SECALG_FORMATSIZE 20 00070 void 00071 dns_secalg_format(dns_secalg_t alg, char *cp, unsigned int size); 00072 /*%< 00073 * Wrapper for dns_secalg_totext(), writing text into 'cp' 00074 */ 00075 00076 ISC_LANG_ENDDECLS 00077 00078 #endif /* DNS_SECALG_H */