contrib/bind-9.2.4rc7/lib/dns/include/dns/secproto.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: secproto.h,v 1.9.2.1 2004/03/09 06:11:22 marka Exp $ */
  19
  20 #ifndef DNS_SECPROTO_H
  21 #define DNS_SECPROTO_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_secproto_fromtext(dns_secproto_t *secprotop, isc_textregion_t *source);
  31 /*
  32  * Convert the text 'source' refers to into a DNSSEC security protocol value.
  33  * The text may contain either a mnemonic protocol name or a decimal protocol
  34  * number.
  35  *
  36  * Requires:
  37  *      'secprotop' is a valid pointer.
  38  *
  39  *      'source' is a valid text region.
  40  *
  41  * Returns:
  42  *      ISC_R_SUCCESS                   on success
  43  *      ISC_R_RANGE                     numeric type is out of range
  44  *      DNS_R_UNKNOWN                   mnemonic type is unknown
  45  */
  46
  47 isc_result_t
  48 dns_secproto_totext(dns_secproto_t secproto, isc_buffer_t *target);
  49 /*
  50  * Put a textual representation of the DNSSEC security protocol 'secproto'
  51  * into 'target'.
  52  *
  53  * Requires:
  54  *      'secproto' is a valid secproto.
  55  *
  56  *      'target' is a valid text buffer.
  57  *
  58  * Ensures:
  59  *      If the result is success:
  60  *              The used space in 'target' is updated.
  61  *
  62  * Returns:
  63  *      ISC_R_SUCCESS                   on success
  64  *      ISC_R_NOSPACE                   target buffer is too small
  65  */
  66
  67 ISC_LANG_ENDDECLS
  68
  69 #endif /* DNS_SECPROTO_H */