xref: /minix3/external/bsd/bind/dist/lib/dns/include/dns/keyflags.h (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1 /*	$NetBSD: keyflags.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: keyflags.h,v 1.16 2007/06/19 23:47:16 tbox Exp  */
21 
22 #ifndef DNS_KEYFLAGS_H
23 #define DNS_KEYFLAGS_H 1
24 
25 /*! \file dns/keyflags.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_keyflags_fromtext(dns_keyflags_t *flagsp, isc_textregion_t *source);
35 /*%<
36  * Convert the text 'source' refers to into a DNSSEC KEY flags value.
37  * The text may contain either a set of flag mnemonics separated by
38  * vertical bars or a decimal flags value.  For compatibility with
39  * older versions of BIND and the DNSSEC signer, octal values
40  * prefixed with a zero and hexadecimal values prefixed with "0x"
41  * are also accepted.
42  *
43  * Requires:
44  *\li	'flagsp' is a valid pointer.
45  *
46  *\li	'source' is a valid text region.
47  *
48  * Returns:
49  *\li	ISC_R_SUCCESS			on success
50  *\li	ISC_R_RANGE			numeric flag value is out of range
51  *\li	DNS_R_UNKNOWN			mnemonic flag is unknown
52  */
53 
54 ISC_LANG_ENDDECLS
55 
56 #endif /* DNS_KEYFLAGS_H */
57