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