/contrib/bind9/lib/dns/include/dns/secproto.h

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 71 lines · 11 code · 10 blank · 50 comment · 0 complexity · 61a132242814357632ab34a0dc3f8da3 MD5 · raw file

  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. /* $Id: secproto.h,v 1.16 2007/06/19 23:47:17 tbox Exp $ */
  18. #ifndef DNS_SECPROTO_H
  19. #define DNS_SECPROTO_H 1
  20. /*! \file dns/secproto.h */
  21. #include <isc/lang.h>
  22. #include <dns/types.h>
  23. ISC_LANG_BEGINDECLS
  24. isc_result_t
  25. dns_secproto_fromtext(dns_secproto_t *secprotop, isc_textregion_t *source);
  26. /*%<
  27. * Convert the text 'source' refers to into a DNSSEC security protocol value.
  28. * The text may contain either a mnemonic protocol name or a decimal protocol
  29. * number.
  30. *
  31. * Requires:
  32. *\li 'secprotop' is a valid pointer.
  33. *
  34. *\li 'source' is a valid text region.
  35. *
  36. * Returns:
  37. *\li ISC_R_SUCCESS on success
  38. *\li ISC_R_RANGE numeric type is out of range
  39. *\li DNS_R_UNKNOWN mnemonic type is unknown
  40. */
  41. isc_result_t
  42. dns_secproto_totext(dns_secproto_t secproto, isc_buffer_t *target);
  43. /*%<
  44. * Put a textual representation of the DNSSEC security protocol 'secproto'
  45. * into 'target'.
  46. *
  47. * Requires:
  48. *\li 'secproto' is a valid secproto.
  49. *
  50. *\li 'target' is a valid text buffer.
  51. *
  52. * Ensures,
  53. * if the result is success:
  54. * \li The used space in 'target' is updated.
  55. *
  56. * Returns:
  57. *\li ISC_R_SUCCESS on success
  58. *\li ISC_R_NOSPACE target buffer is too small
  59. */
  60. ISC_LANG_ENDDECLS
  61. #endif /* DNS_SECPROTO_H */