r_nist.h Source File

00001 /* $Id: r_nist.h,v 1.4 2002/11/28 00:35:30 jmckee Exp $ */
00002 /*
00003  * Copyright (C) 1998-2002 RSA Security Inc. All rights reserved.
00004  *
00005  * This work contains proprietary information of RSA Security.
00006  * Distribution is limited to authorized licensees of RSA
00007  * Security. Any unauthorized reproduction, distribution or
00008  * modification of this work is strictly prohibited.
00009  *
00010  */
00011 
00012 /**
00013  * @file
00014  * This file contains public defines and functions for adding NIST-certified
00015  * cryptographic functionality to a resource list.
00016  */
00017 
00018 #ifndef HEADER_COMMON_R_NIST_H
00019 #define HEADER_COMMON_R_NIST_H
00020 
00021 #ifdef  __cplusplus
00022 extern "C" {
00023 #endif
00024 
00025 #include "cryp_mod.h"
00026 
00027 /*
00028  *  @defgroup NIST_GROUP NIST-certified Cryptographic Functionality
00029  *  This section details the components that provide support for
00030  *  NIST-certified cryptographic functionality.
00031  * @{
00032  */
00033 
00034 /*
00035  *  @}
00036  */
00037 
00038 /*
00039  * The functions that handle the NIST shared library.
00040  */
00041 int R_NIST_library_start(R_RES_LIST *reslist, R_RES_ITEM *resitem,
00042     void **imp_data);
00043 int R_NIST_library_finish(R_RES_LIST *reslist, R_RES_ITEM *resitem,
00044     void **imp_data);
00045 
00046 /*
00047  * The method for NIST cryptographic functionality handling.
00048  */
00049 R_CR_METHOD *R_NIST_get_crypto_method(void *imp_data);
00050 
00051 /**
00052  * @defgroup R_NIST_RES NIST Resource Definitions
00053  * This section details the definition used in the resource list and
00054  * initialization of the library. See @ref RES_LIST_GROUP.
00055  * @ingroup NIST_API_GROUP
00056  *
00057  * @{
00058  */
00059 
00060 /**
00061  * The NIST shared library implementation of the #R_CR interface.
00062  */
00063 #define R_CR_RES_NIST                                                 \
00064     { R_RES_MOD_ID_CRYPTO, R_RES_IMPL_ID_DEF, R_RES_SUB_ID_DEF,       \
00065       R_RES_FLAG_DEF, R_NIST_library_start, R_NIST_library_finish,    \
00066       (void *(*)(void *))R_NIST_get_crypto_method, NULL }
00067 
00068 /**
00069  * @}
00070  */
00071 
00072 #ifdef  __cplusplus
00073 }
00074 #endif
00075 
00076 #endif /* HEADER_COMMON_R_NIST_H */
00077