contrib/bind9/bin/named/include/named/tsigconf.h

   1 /*
   2  * Copyright (C) 2004-2007, 2009  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: tsigconf.h,v 1.18 2009/06/11 23:47:55 tbox Exp $ */
  19
  20 #ifndef NS_TSIGCONF_H
  21 #define NS_TSIGCONF_H 1
  22
  23 /*! \file */
  24
  25 #include <isc/types.h>
  26 #include <isc/lang.h>
  27
  28 ISC_LANG_BEGINDECLS
  29
  30 isc_result_t
  31 ns_tsigkeyring_fromconfig(const cfg_obj_t *config, const cfg_obj_t *vconfig,
  32                           isc_mem_t *mctx, dns_tsig_keyring_t **ringp);
  33 /*%<
  34  * Create a TSIG key ring and configure it according to the 'key'
  35  * statements in the global and view configuration objects.
  36  *
  37  *      Requires:
  38  *      \li     'config' is not NULL.
  39  *      \li     'vconfig' is not NULL.
  40  *      \li     'mctx' is not NULL
  41  *      \li     'ringp' is not NULL, and '*ringp' is NULL
  42  *
  43  *      Returns:
  44  *      \li     ISC_R_SUCCESS
  45  *      \li     ISC_R_NOMEMORY
  46  */
  47
  48 ISC_LANG_ENDDECLS
  49
  50 #endif /* NS_TSIGCONF_H */