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

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