dst_internal.h revision e20788e1216ed720aefa84f3295f7899d9f28c22
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * Portions Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson * Portions Copyright (C) 2000-2002 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * Permission to use, copy, modify, and/or distribute this software for any
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews * purpose with or without fee is hereby granted, provided that the above
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson * copyright notice and this permission notice appear in all copies.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NETWORK ASSOCIATES DISCLAIMS
83a28ca274521e15086fc39febde507bcc4e145eMark Andrews * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Portions Copyright (C) 1995-2000 by Network Associates, Inc.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Permission to use, copy, modify, and/or distribute this software for any
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * purpose with or without fee is hereby granted, provided that the above
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * copyright notice and this permission notice appear in all copies.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NETWORK ASSOCIATES DISCLAIMS
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
194e2dfffa6a167b8eef0ad11864026b423a1c30Mark Andrews * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
194e2dfffa6a167b8eef0ad11864026b423a1c30Mark Andrews * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User/* $Id: dst_internal.h,v 1.31 2011/10/20 21:20:02 marka Exp $ */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein#define VALID_KEY(x) ISC_MAGIC_VALID(x, KEY_MAGIC)
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein#define VALID_CTX(x) ISC_MAGIC_VALID(x, CTX_MAGIC)
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacmd5_key dst_hmacmd5_key_t;
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacsha1_key dst_hmacsha1_key_t;
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacsha224_key dst_hmacsha224_key_t;
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacsha256_key dst_hmacsha256_key_t;
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacsha384_key dst_hmacsha384_key_t;
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssontypedef struct dst_hmacsha512_key dst_hmacsha512_key_t;
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson * Indicate whether a DST context will be used for signing
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * or for verification
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein/*% DST Key Structure */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned int magic;
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned int key_size; /*%< size of the key in bits */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned int key_proto; /*%< protocols this key is used for */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned int key_alg; /*%< algorithm of the key */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_uint32_t key_flags; /*%< flags of the public key */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_uint16_t key_id; /*%< identifier of the key */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_uint16_t key_rid; /*%< identifier of the key when
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein dns_rdataclass_t key_class; /*%< class of the key record */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein dns_ttl_t key_ttl; /*%< default/initial dnskey ttl */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein } keydata; /*%< pointer to key in crypto pkg fmt */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_stdtime_t times[DST_MAX_TIMES + 1]; /*%< timing metadata */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t timeset[DST_MAX_TIMES + 1]; /*%< data set? */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_stdtime_t nums[DST_MAX_NUMERIC + 1]; /*%< numeric metadata */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t numset[DST_MAX_NUMERIC + 1]; /*%< data set? */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t inactive; /*%< private key not present as it is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein int fmt_major; /*%< private key format, major version */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein int fmt_minor; /*%< private key format, minor version */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein dst_func_t * func; /*%< crypto package specific functions */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_buffer_t *key_tkeytoken; /*%< TKEY token data */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned int magic;
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Context functions
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*createctx)(dst_key_t *key, dst_context_t *dctx);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*createctx2)(dst_key_t *key, int maxbits,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*adddata)(dst_context_t *dctx, const isc_region_t *data);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Key operations
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*sign)(dst_context_t *dctx, isc_buffer_t *sig);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*verify)(dst_context_t *dctx, const isc_region_t *sig);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*verify2)(dst_context_t *dctx, int maxbits,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*computesecret)(const dst_key_t *pub,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t (*compare)(const dst_key_t *key1, const dst_key_t *key2);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t (*paramcompare)(const dst_key_t *key1,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*generate)(dst_key_t *key, int parms,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein void (*callback)(int));
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_boolean_t (*isprivate)(const dst_key_t *key);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein /* conversion functions */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*todns)(const dst_key_t *key, isc_buffer_t *data);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*fromdns)(dst_key_t *key, isc_buffer_t *data);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*tofile)(const dst_key_t *key, const char *directory);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein /* cleanup */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein void (*cleanup)(void);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*fromlabel)(dst_key_t *key, const char *engine,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*dump)(dst_key_t *key, isc_mem_t *mctx, char **buffer,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein isc_result_t (*restore)(dst_key_t *key, const char *keystr);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Initializers
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__openssl_init(const char *engine);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinvoid dst__pkcs11_init(isc_mem_t *mctx, const char *engine);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacmd5_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacsha1_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacsha224_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacsha256_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacsha384_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__hmacsha512_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__opensslrsa_init(struct dst_func **funcp,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein unsigned char algorithm);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__pkcs11rsa_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__openssldsa_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__pkcs11dsa_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__openssldh_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__pkcs11dh_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__gssapi_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__opensslecdsa_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__pkcs11ecdsa_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__opensslgost_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__pkcs11gost_init(struct dst_func **funcp);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Destructors
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson * Memory allocators using the DST memory pool.
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrewsvoid * dst__mem_realloc(void *ptr, size_t size);
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Entropy retriever using the DST entropy pool.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinisc_result_t dst__entropy_getdata(void *buf, unsigned int len,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein * Entropy status hook.
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafssonunsigned int dst__entropy_status(void);