hw_aep.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/*
*/
/* ====================================================================
* Copyright (c) 1999 The OpenSSL Project. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* distribution.
*
* 3. All advertising materials mentioning features or use of this
* software must display the following acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
*
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please contact
* licensing@OpenSSL.org.
*
* 5. Products derived from this software may not be called "OpenSSL"
* nor may "OpenSSL" appear in their names without prior written
* permission of the OpenSSL Project.
*
* 6. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
*
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This product includes cryptographic software written by Eric Young
* (eay@cryptsoft.com). This product includes software written by Tim
* Hudson (tjh@cryptsoft.com).
*
*/
#include <stdio.h>
#include <string.h>
#if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
#include <unistd.h>
#else
#include <process.h>
typedef int pid_t;
#endif
#ifndef OPENSSL_NO_HW
#ifndef OPENSSL_NO_HW_AEP
#ifdef FLAT_INC
#include "aep.h"
#else
#include "vendor_defns/aep.h"
#endif
#define AEP_LIB_NAME "aep engine"
#define FAIL_TO_SW 0x10101010
#include "hw_aep_err.c"
static int aep_finish(ENGINE *e);
static int aep_destroy(ENGINE *e);
/* BIGNUM stuff */
/* RSA stuff */
#ifndef OPENSSL_NO_RSA
#endif
/* This function is aliased to mod_exp (with the mont stuff dropped). */
/* DSA stuff */
#ifndef OPENSSL_NO_DSA
BN_MONT_CTX *m_ctx);
#endif
/* DH stuff */
/* This function is aliased to mod_exp (with the DH and mont dropped). */
#ifndef OPENSSL_NO_DH
#endif
/* rand stuff */
#ifdef AEPRAND
static int aep_rand_status(void);
#endif
/* Bignum conversion stuff */
unsigned char* AEP_BigNum);
unsigned char* AEP_BigNum);
/* The definitions for control commands specific to this engine */
#define AEP_CMD_SO_PATH ENGINE_CMD_BASE
static const ENGINE_CMD_DEFN aep_cmd_defns[] =
{
"SO_PATH",
"Specifies the path to the 'aep' shared library",
},
};
#ifndef OPENSSL_NO_RSA
/* Our internal RSA_METHOD that we provide pointers to */
static RSA_METHOD aep_rsa =
{
"Aep RSA method",
NULL, /*rsa_pub_encrypt*/
NULL, /*rsa_pub_decrypt*/
NULL, /*rsa_priv_encrypt*/
NULL, /*rsa_priv_encrypt*/
aep_rsa_mod_exp, /*rsa_mod_exp*/
aep_mod_exp_mont, /*bn_mod_exp*/
NULL, /*init*/
NULL, /*finish*/
0, /*flags*/
NULL, /*app_data*/
NULL, /*rsa_sign*/
NULL /*rsa_verify*/
};
#endif
#ifndef OPENSSL_NO_DSA
/* Our internal DSA_METHOD that we provide pointers to */
static DSA_METHOD aep_dsa =
{
"Aep DSA method",
NULL, /* dsa_do_sign */
NULL, /* dsa_sign_setup */
NULL, /* dsa_do_verify */
aep_dsa_mod_exp, /* dsa_mod_exp */
aep_mod_exp_dsa, /* bn_mod_exp */
NULL, /* init */
NULL, /* finish */
0, /* flags */
NULL /* app_data */
};
#endif
#ifndef OPENSSL_NO_DH
/* Our internal DH_METHOD that we provide pointers to */
{
"Aep DH method",
NULL,
NULL,
NULL,
NULL,
0,
};
#endif
#ifdef AEPRAND
/* our internal RAND_method that we provide pointers to */
static RAND_METHOD aep_random =
{
/*"AEP RAND method", */
NULL,
NULL,
NULL,
};
#endif
/*Define an array of structures to hold connections*/
/*Used to determine if this is a new process*/
static pid_t recorded_pid = 0;
#ifdef AEPRAND
static AEP_U32 rand_block_bytes = 0;
#endif
/* Constants used when creating the ENGINE */
static const char *engine_aep_id = "aep";
static const char *engine_aep_name = "Aep hardware engine support";
static int max_key_len = 2176;
/* This internal function is used by ENGINE_aep() and possibly by the
* "dynamic" ENGINE support too */
{
#ifndef OPENSSL_NO_RSA
const RSA_METHOD *meth1;
#endif
#ifndef OPENSSL_NO_DSA
const DSA_METHOD *meth2;
#endif
#ifndef OPENSSL_NO_DH
#endif
if(!ENGINE_set_id(e, engine_aep_id) ||
!ENGINE_set_name(e, engine_aep_name) ||
#ifndef OPENSSL_NO_RSA
!ENGINE_set_RSA(e, &aep_rsa) ||
#endif
#ifndef OPENSSL_NO_DSA
!ENGINE_set_DSA(e, &aep_dsa) ||
#endif
#ifndef OPENSSL_NO_DH
!ENGINE_set_DH(e, &aep_dh) ||
#endif
#ifdef AEPRAND
!ENGINE_set_RAND(e, &aep_random) ||
#endif
!ENGINE_set_init_function(e, aep_init) ||
!ENGINE_set_finish_function(e, aep_finish) ||
!ENGINE_set_ctrl_function(e, aep_ctrl) ||
return 0;
#ifndef OPENSSL_NO_RSA
/* We know that the "PKCS1_SSLeay()" functions hook properly
* to the aep-specific mod_exp and mod_exp_crt so we use
* those functions. NB: We don't use ENGINE_openssl() or
* anything "more generic" because something like the RSAref
* code may not hook properly, and if you own one of these
* cards then you have the right to do RSA operations on it
* anyway! */
meth1 = RSA_PKCS1_SSLeay();
#endif
#ifndef OPENSSL_NO_DSA
/* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
* bits. */
meth2 = DSA_OpenSSL();
#endif
#ifndef OPENSSL_NO_DH
/* Much the same for Diffie-Hellman */
meth3 = DH_OpenSSL();
#endif
/* Ensure the aep error handling is set up */
return 1;
}
#ifdef ENGINE_DYNAMIC_SUPPORT
{
return 0;
if(!bind_aep(e))
return 0;
return 1;
}
#else
static ENGINE *engine_aep(void)
{
if(!ret)
return NULL;
{
return NULL;
}
return ret;
}
void ENGINE_load_aep(void)
{
/* Copied from eng_[openssl|dyn].c */
if(!toadd) return;
}
#endif
/* This is a process-global DSO handle used for loading and unloading
* the Aep library. NB: This is only set (or unset) during an
* init() or finish() call (reference counts permitting) and they're
* operating with global locks, so this should be thread-safe
* implicitly. */
/* These are the static string constants for the DSO file name and the function
* symbol names to bind to.
*/
static const char *AEP_LIBNAME = NULL;
static const char *get_AEP_LIBNAME(void)
{
if(AEP_LIBNAME)
return AEP_LIBNAME;
return "aep";
}
static void free_AEP_LIBNAME(void)
{
if(AEP_LIBNAME)
OPENSSL_free((void*)AEP_LIBNAME);
AEP_LIBNAME = NULL;
}
static long set_AEP_LIBNAME(const char *name)
{
}
static const char *AEP_F1 = "AEP_ModExp";
static const char *AEP_F2 = "AEP_ModExpCrt";
#ifdef AEPRAND
static const char *AEP_F3 = "AEP_GenRandom";
#endif
static const char *AEP_F4 = "AEP_Finalize";
static const char *AEP_F5 = "AEP_Initialize";
static const char *AEP_F6 = "AEP_OpenConnection";
static const char *AEP_F7 = "AEP_SetBNCallBacks";
static const char *AEP_F8 = "AEP_CloseConnection";
/* These are the function pointers that are (un)set when the library has
* successfully (un)loaded. */
#ifdef AEPRAND
#endif
/* (de)initialisation functions. */
{
#ifdef AEPRAND
#endif
int to_return = 0;
{
goto err;
}
/* Attempt to load libaep.so. */
{
goto err;
}
#ifdef AEPRAND
#endif
{
goto err;
}
/* Copy the pointers */
p_AEP_ModExp = p1;
#ifdef AEPRAND
#endif
p_AEP_Finalize = p4;
to_return = 1;
return to_return;
err:
if(aep_dso)
p_AEP_ModExp = NULL;
#ifdef AEPRAND
#endif
return to_return;
}
/* Destructor (complements the "ENGINE_aep()" constructor) */
static int aep_destroy(ENGINE *e)
{
return 1;
}
static int aep_finish(ENGINE *e)
{
{
goto err;
}
{
goto err;
}
if (in_use)
{
goto err;
}
rv = p_AEP_Finalize();
{
goto err;
}
{
goto err;
}
p_AEP_ModExp = NULL;
#ifdef AEPRAND
#endif
to_return = 1;
err:
return to_return;
}
{
switch(cmd)
{
case AEP_CMD_SO_PATH:
if(p == NULL)
{
return 0;
}
if(initialised)
{
return 0;
}
return set_AEP_LIBNAME((const char*)p);
default:
break;
}
return 0;
}
{
int to_return = 0;
int r_len = 0;
r_len = BN_num_bits(m);
/* Perform in software if modulus is too large for hardware. */
if (r_len > max_key_len){
return BN_mod_exp(r, a, p, m, ctx);
}
/*Grab a connection from the pool*/
{
return BN_mod_exp(r, a, p, m, ctx);
}
/*To the card with the mod exp*/
{
return BN_mod_exp(r, a, p, m, ctx);
}
/*Return the connection to the pool*/
{
goto err;
}
to_return = 1;
err:
return to_return;
}
{
/*Grab a connection from the pool*/
{
return FAIL_TO_SW;
}
/*To the card with the mod exp*/
{
return FAIL_TO_SW;
}
/*Return the connection to the pool*/
{
goto err;
}
err:
return rv;
}
#ifdef AEPRAND
{
/*Can the request be serviced with what's already in the buffer?*/
if (len <= rand_block_bytes)
{
rand_block_bytes -= len;
}
else
/*If not the get another block of random bytes*/
{
{
goto err_nounlock;
}
if (len > RAND_BLK_SIZE)
{
{
goto err_nounlock;
}
}
else
{
{
goto err;
}
rand_block_bytes -= len;
}
{
goto err_nounlock;
}
}
return 1;
err:
return 0;
}
static int aep_rand_status(void)
{
return 1;
}
#endif
#ifndef OPENSSL_NO_RSA
{
int to_return = 0;
goto err;
if (!aep_dso)
{
goto err;
}
/*See if we have all the necessary bits for a crt*/
{
if (rv == FAIL_TO_SW){
goto err;
}
goto err;
}
else
{
{
goto err;
}
goto err;
}
to_return = 1;
err:
if(ctx)
return to_return;
}
#endif
#ifndef OPENSSL_NO_DSA
{
BIGNUM t;
int to_return = 0;
BN_init(&t);
/* let rr = a1 ^ p1 mod m */
/* let t = a2 ^ p2 mod m */
/* let rr = rr * t mod m */
to_return = 1;
end:
BN_free(&t);
return to_return;
}
{
return aep_mod_exp(r, a, p, m, ctx);
}
#endif
/* This function is aliased to mod_exp (with the mont stuff dropped). */
{
return aep_mod_exp(r, a, p, m, ctx);
}
#ifndef OPENSSL_NO_DH
/* This function is aliased to mod_exp (with the dh and mont dropped). */
{
return aep_mod_exp(r, a, p, m, ctx);
}
#endif
{
int count;
/*Get the current process id*/
/*Check if this is the first time this is being called from the current
process*/
if (recorded_pid != curr_pid)
{
/*Remember our pid so we can check if we're in a new process*/
/*Call Finalize to make sure we have not inherited some data
from a parent process*/
/*Initialise the AEP API*/
{
recorded_pid = 0;
goto end;
}
/*Set the AEP big num call back functions*/
{
recorded_pid = 0;
goto end;
}
#ifdef AEPRAND
/*Reset the rand byte count*/
rand_block_bytes = 0;
#endif
/*Init the structures*/
{
}
/*Open a connection*/
{
recorded_pid = 0;
goto end;
}
goto end;
}
/*Check the existing connections to see if we can find a free one*/
{
{
goto end;
}
}
/*If no connections available, we're going to have to try
to open a new one*/
{
{
/*Open a connection*/
{
goto end;
}
goto end;
}
}
end:
return rv;
}
{
int count;
/*Find the connection item that matches this connection handle*/
{
{
break;
}
}
return AEP_R_OK;
}
{
int count;
/*Find the connection item that matches this connection handle*/
{
{
goto end;
break;
}
}
end:
return rv;
}
{
int count;
*in_use = 0;
{
{
case Connected:
goto end;
break;
case InUse:
(*in_use)++;
break;
case NotConnected:
break;
}
}
end:
return rv;
}
/*BigNum call back functions, used to convert OpenSSL bignums into AEP bignums.
Note only 32bit Openssl build support*/
{
/*Cast the ArbBigNum pointer to our BIGNUM struct*/
#ifdef SIXTY_FOUR_BIT_LONG
#else
/*Size of the bignum in bytes is equal to the bn->top (no of 32 bit
words) multiplies by 4*/
#endif
return AEP_R_OK;
}
unsigned char* AEP_BigNum)
{
#ifndef SIXTY_FOUR_BIT_LONG
unsigned char* buf;
int i;
#endif
/*Cast the ArbBigNum pointer to our BIGNUM struct*/
#ifdef SIXTY_FOUR_BIT_LONG
#else
/*Must copy data into a (monotone) least significant byte first format
performing endian conversion if necessary*/
{
AEP_BigNum += 4;
}
#endif
return AEP_R_OK;
}
/*Turn an AEP Big Num back to a user big num*/
unsigned char* AEP_BigNum)
{
#ifndef SIXTY_FOUR_BIT_LONG
int i;
#endif
/*Expand the result bn so that it can hold our big num.
Size is in bits*/
#ifdef SIXTY_FOUR_BIT_LONG
if((BigNumSize & 7) != 0)
#else
{
AEP_BigNum += 4;
}
#endif
return AEP_R_OK;
}
#endif /* !OPENSSL_NO_HW_AEP */
#endif /* !OPENSSL_NO_HW */