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