contrib/bind-9.5.2/lib/dns/include/dns/keyflags.h

   1 /*
   2  * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   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.
   8  *
   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.
  16  */
  17
  18 /* $Id: keyflags.h,v 1.16 2007/06/19 23:47:16 tbox Exp $ */
  19
  20 #ifndef DNS_KEYFLAGS_H
  21 #define DNS_KEYFLAGS_H 1
  22
  23 /*! \file dns/keyflags.h */
  24
  25 #include <isc/lang.h>
  26
  27 #include <dns/types.h>
  28
  29 ISC_LANG_BEGINDECLS
  30
  31 isc_result_t
  32 dns_keyflags_fromtext(dns_keyflags_t *flagsp, isc_textregion_t *source);
  33 /*%<
  34  * Convert the text 'source' refers to into a DNSSEC KEY flags value.
  35  * The text may contain either a set of flag mnemonics separated by
  36  * vertical bars or a decimal flags value.  For compatibility with
  37  * older versions of BIND and the DNSSEC signer, octal values
  38  * prefixed with a zero and hexadecimal values prefixed with "0x"
  39  * are also accepted.
  40  *
  41  * Requires:
  42  *\li   'flagsp' is a valid pointer.
  43  *
  44  *\li   'source' is a valid text region.
  45  *
  46  * Returns:
  47  *\li   ISC_R_SUCCESS                   on success
  48  *\li   ISC_R_RANGE                     numeric flag value is out of range
  49  *\li   DNS_R_UNKNOWN                   mnemonic flag is unknown
  50  */
  51
  52 ISC_LANG_ENDDECLS
  53
  54 #endif /* DNS_KEYFLAGS_H */