contrib/bind/bin/named/include/named/tkeyconf.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: tkeyconf.h,v 1.16 2007/06/19 23:46:59 tbox Exp $ */
  19
  20 #ifndef NS_TKEYCONF_H
  21 #define NS_TKEYCONF_H 1
  22
  23 /*! \file */
  24
  25 #include <isc/types.h>
  26 #include <isc/lang.h>
  27
  28 #include <isccfg/cfg.h>
  29
  30 ISC_LANG_BEGINDECLS
  31
  32 isc_result_t
  33 ns_tkeyctx_fromconfig(const cfg_obj_t *options, isc_mem_t *mctx,
  34                       isc_entropy_t *ectx, dns_tkeyctx_t **tctxp);
  35 /*%<
  36  *      Create a TKEY context and configure it, including the default DH key
  37  *      and default domain, according to 'options'.
  38  *
  39  *      Requires:
  40  *\li           'cfg' is a valid configuration options object.
  41  *\li           'mctx' is not NULL
  42  *\li           'ectx' is not NULL
  43  *\li           'tctx' is not NULL
  44  *\li           '*tctx' is NULL
  45  *
  46  *      Returns:
  47  *\li           ISC_R_SUCCESS
  48  *\li           ISC_R_NOMEMORY
  49  */
  50
  51 ISC_LANG_ENDDECLS
  52
  53 #endif /* NS_TKEYCONF_H */