Commit e9224c71 authored by Geoff Thorpe's avatar Geoff Thorpe
Browse files

This is a first-cut at improving the callback mechanisms used in 

key-generation and prime-checking functions. Rather than explicitly passing
callback functions and caller-defined context data for the callbacks, a new
structure BN_GENCB is defined that encapsulates this; a pointer to the
structure is passed to all such functions instead.

This wrapper structure allows the encapsulation of "old" and "new" style
callbacks - "new" callbacks return a boolean result on the understanding
that returning FALSE should terminate keygen/primality processing.  The
BN_GENCB abstraction will allow future callback modifications without
needing to break binary compatibility nor change the API function
prototypes. The new API functions have been given names ending in "_ex" and
the old functions are implemented as wrappers to the new ones.  The
OPENSSL_NO_DEPRECATED symbol has been introduced so that, if defined,
declaration of the older functions will be skipped. NB: Some
openssl-internal code will stick with the older callbacks for now, so
appropriate "#undef" logic will be put in place - this is in case the user
is *building* openssl (rather than *including* its headers) with this
symbol defined.

There is another change in the new _ex functions; the key-generation
functions do not return key structures but operate on structures passed by
the caller, the return value is a boolean. This will allow for a smoother
transition to having key-generation as "virtual function" in the various
***_METHOD tables.
parent e90e7197

CHANGES

+12 −0
Original line number Diff line number Diff line
@@ -4,6 +4,18 @@ 


 Changes between 0.9.7 and 0.9.8  [xx XXX 2002]



  *) Change the "progress" mechanism used in key-generation and

     primality testing to functions that take a new BN_GENCB pointer in

     place of callback/argument pairs. The new API functions have "_ex"

     postfixes and the older functions are reimplemented as wrappers for

     the new ones. The OPENSSL_NO_DEPRECATED symbol can be used to hide

     declarations of the old functions to help (graceful) attempts to

     migrate to the new functions. Also, the new key-generation API

     functions operate on a caller-supplied key-structure and return

     success/failure rather than returning a key or NULL - this is to

     help make "keygen" another member function of RSA_METHOD etc.

     [Geoff Thorpe]



  *) Add the ASN.1 structures and functions for CertificatePair, which

     is defined as follows (according to X.509_4thEditionDraftV6.pdf):

crypto/bn/Makefile.ssl

+4 −2
Original line number Diff line number Diff line
@@ -39,12 +39,14 @@ LIB=$(TOP)/libcrypto.a 
LIBSRC=	bn_add.c bn_div.c bn_exp.c bn_lib.c bn_ctx.c bn_mul.c bn_mod.c \

	bn_print.c bn_rand.c bn_shift.c bn_word.c bn_blind.c \

	bn_kron.c bn_sqrt.c bn_gcd.c bn_prime.c bn_err.c bn_sqr.c bn_asm.c \

	bn_recp.c bn_mont.c bn_mpi.c bn_exp2.c bn_gf2m.c bn_nist.c

	bn_recp.c bn_mont.c bn_mpi.c bn_exp2.c bn_gf2m.c bn_nist.c \

	bn_depr.c



LIBOBJ=	bn_add.o bn_div.o bn_exp.o bn_lib.o bn_ctx.o bn_mul.o bn_mod.o \

	bn_print.o bn_rand.o bn_shift.o bn_word.o bn_blind.o \

	bn_kron.o bn_sqrt.o bn_gcd.o bn_prime.o bn_err.o bn_sqr.o $(BN_ASM) \

	bn_recp.o bn_mont.o bn_mpi.o bn_exp2.o bn_gf2m.o bn_nist.o

	bn_recp.o bn_mont.o bn_mpi.o bn_exp2.o bn_gf2m.o bn_nist.o \

	bn_depr.o



SRC= $(LIBSRC)

crypto/bn/bn.h

+28 −0
Original line number Diff line number Diff line
@@ -287,6 +287,23 @@ typedef struct bn_recp_ctx_st 
	int flags;

	} BN_RECP_CTX;



/* Used for slow "generation" functions. */

typedef struct bn_gencb_st BN_GENCB;

struct bn_gencb_st

	{

	unsigned int ver;	/* To handle binary (in)compatibility */

	void *arg;		/* callback-specific data */

	union

		{

		/* if(ver==1) - handles old style callbacks */

		void (*cb_1)(int, int, void *);

		/* if(ver==2) - new callback style */

		int (*cb_2)(int, int, BN_GENCB *);

		};

	};

/* Wrapper function to make using BN_GENCB easier,  */

int BN_GENCB_call(BN_GENCB *cb, int a, int b);



#define BN_prime_checks 0 /* default: select number of iterations

			     based on the size of the number */
@@ -431,6 +448,9 @@ BIGNUM *BN_mod_inverse(BIGNUM *ret, 
	const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);

BIGNUM *BN_mod_sqrt(BIGNUM *ret,

	const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);



/* Deprecated versions */

#ifndef OPENSSL_NO_DEPRECATED

BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,

	const BIGNUM *add, const BIGNUM *rem,

	void (*callback)(int,int,void *),void *cb_arg);
@@ -440,6 +460,14 @@ int BN_is_prime(const BIGNUM *p,int nchecks, 
int	BN_is_prime_fasttest(const BIGNUM *p,int nchecks,

	void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,

	int do_trial_division);

#endif /* !defined(OPENSSL_NO_DEPRECATED) */



/* Newer versions */

int	BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,

		const BIGNUM *rem, BN_GENCB *cb);

int	BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);

int	BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,

		int do_trial_division, BN_GENCB *cb);



BN_MONT_CTX *BN_MONT_CTX_new(void );

void BN_MONT_CTX_init(BN_MONT_CTX *ctx);

crypto/bn/bn_depr.c

0 → 100644
+114 −0
Original line number Diff line number Diff line 
/* crypto/bn/bn_depr.c */

/* ====================================================================

 * Copyright (c) 1998-2002 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

 *    the documentation and/or other materials provided with the

 *    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

 *    openssl-core@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).

 *

 */



/* Support for deprecated functions goes here - static linkage will only slurp

 * this code if applications are using them directly. */



#include <stdio.h>

#include <time.h>

#include "cryptlib.h"

#include "bn_lcl.h"

#include <openssl/rand.h>



BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,

	const BIGNUM *add, const BIGNUM *rem,

	void (*callback)(int,int,void *), void *cb_arg)

	{

	BN_GENCB cb;

	BIGNUM *rnd=NULL;

	int found = 0;



	cb.ver = 1;

	cb.arg = cb_arg;

	cb.cb_1 = callback;



	if (ret == NULL)

		{

		if ((rnd=BN_new()) == NULL) goto err;

		}

	else

		rnd=ret;

	if(!BN_generate_prime_ex(rnd, bits, safe, add, rem, &cb))

		goto err;



	/* we have a prime :-) */

	found = 1;

err:

	if (!found && (ret == NULL) && (rnd != NULL)) BN_free(rnd);

	return(found ? rnd : NULL);

	}



int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int,int,void *),

	BN_CTX *ctx_passed, void *cb_arg)

	{

	BN_GENCB cb;

	cb.ver = 1;

	cb.arg = cb_arg;

	cb.cb_1 = callback;

	return BN_is_prime_ex(a, checks, ctx_passed, &cb);

	}



int BN_is_prime_fasttest(const BIGNUM *a, int checks,

		void (*callback)(int,int,void *),

		BN_CTX *ctx_passed, void *cb_arg,

		int do_trial_division)

	{

	BN_GENCB cb;

	cb.ver = 1;

	cb.arg = cb_arg;

	cb.cb_1 = callback;

	return BN_is_prime_fasttest_ex(a, checks, ctx_passed,

				do_trial_division, &cb);

	}

crypto/bn/bn_prime.c

+49 −31
Original line number Diff line number Diff line
@@ -115,6 +115,11 @@ 
#include "bn_lcl.h"

#include <openssl/rand.h>



/* NB: these functions have been "upgraded", the deprecated versions (which are

 * compatibility wrappers using these functions) are in bn_depr.c.

 * - Geoff

 */



/* The quick sieve algorithm approach to weeding out primes is

 * Philip Zimmermann's, as implemented in PGP.  I have had a read of

 * his comments and implemented my own version.
@@ -129,11 +134,29 @@ static int probable_prime_dh(BIGNUM *rnd, int bits, 
static int probable_prime_dh_safe(BIGNUM *rnd, int bits,

	const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx);



BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,

	const BIGNUM *add, const BIGNUM *rem,

	void (*callback)(int,int,void *), void *cb_arg)

int BN_GENCB_call(BN_GENCB *cb, int a, int b)

	{

	/* No callback means continue */

	if(!cb) return 1;

	switch(cb->ver)

		{

	case 1:

		/* Deprecated-style callbacks */

		cb->cb_1(a, b, cb->arg);

		return 1;

	case 2:

		/* New-style callbacks */

		return cb->cb_2(a, b, cb);

	default:

		break;

		}

	/* Unrecognised callback type */

	return 0;

	}



int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe,

	const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb)

	{

	BIGNUM *rnd=NULL;

	BIGNUM t;

	int found=0;

	int i,j,c1=0;
@@ -142,38 +165,34 @@ BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe, 


	ctx=BN_CTX_new();

	if (ctx == NULL) goto err;

	if (ret == NULL)

		{

		if ((rnd=BN_new()) == NULL) goto err;

		}

	else

		rnd=ret;

	BN_init(&t);

loop: 

	/* make a random number and set the top and bottom bits */

	if (add == NULL)

		{

		if (!probable_prime(rnd,bits)) goto err;

		if (!probable_prime(ret,bits)) goto err;

		}

	else

		{

		if (safe)

			{

			if (!probable_prime_dh_safe(rnd,bits,add,rem,ctx))

			if (!probable_prime_dh_safe(ret,bits,add,rem,ctx))

				 goto err;

			}

		else

			{

			if (!probable_prime_dh(rnd,bits,add,rem,ctx))

			if (!probable_prime_dh(ret,bits,add,rem,ctx))

				goto err;

			}

		}

	/* if (BN_mod_word(rnd,(BN_ULONG)3) == 1) goto loop; */

	if (callback != NULL) callback(0,c1++,cb_arg);

	/* if (BN_mod_word(ret,(BN_ULONG)3) == 1) goto loop; */

	if(!BN_GENCB_call(cb, 0, c1++))

		/* aborted */

		goto err;



	if (!safe)

		{

		i=BN_is_prime_fasttest(rnd,checks,callback,ctx,cb_arg,0);

		i=BN_is_prime_fasttest_ex(ret,checks,ctx,0,cb);

		if (i == -1) goto err;

		if (i == 0) goto loop;

		}
@@ -183,41 +202,38 @@ loop: 
		 * check that (p-1)/2 is prime.

		 * Since a prime is odd, We just

		 * need to divide by 2 */

		if (!BN_rshift1(&t,rnd)) goto err;

		if (!BN_rshift1(&t,ret)) goto err;



		for (i=0; i<checks; i++)

			{

			j=BN_is_prime_fasttest(rnd,1,callback,ctx,cb_arg,0);

			j=BN_is_prime_fasttest_ex(ret,1,ctx,0,cb);

			if (j == -1) goto err;

			if (j == 0) goto loop;



			j=BN_is_prime_fasttest(&t,1,callback,ctx,cb_arg,0);

			j=BN_is_prime_fasttest_ex(&t,1,ctx,0,cb);

			if (j == -1) goto err;

			if (j == 0) goto loop;



			if (callback != NULL) callback(2,c1-1,cb_arg);

			if(!BN_GENCB_call(cb, 2, c1-1))

				goto err;

			/* We have a safe prime test pass */

			}

		}

	/* we have a prime :-) */

	found = 1;

err:

	if (!found && (ret == NULL) && (rnd != NULL)) BN_free(rnd);

	BN_free(&t);

	if (ctx != NULL) BN_CTX_free(ctx);

	return(found ? rnd : NULL);

	return found;

	}



int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int,int,void *),

	BN_CTX *ctx_passed, void *cb_arg)

int BN_is_prime_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed, BN_GENCB *cb)

	{

	return BN_is_prime_fasttest(a, checks, callback, ctx_passed, cb_arg, 0);

	return BN_is_prime_fasttest_ex(a, checks, ctx_passed, 0, cb);

	}



int BN_is_prime_fasttest(const BIGNUM *a, int checks,

		void (*callback)(int,int,void *),

		BN_CTX *ctx_passed, void *cb_arg,

		int do_trial_division)

int BN_is_prime_fasttest_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed,

		int do_trial_division, BN_GENCB *cb)

	{

	int i, j, ret = -1;

	int k;
@@ -240,7 +256,8 @@ int BN_is_prime_fasttest(const BIGNUM *a, int checks, 
		for (i = 1; i < NUMPRIMES; i++)

			if (BN_mod_word(a, primes[i]) == 0) 

				return 0;

		if (callback != NULL) callback(1, -1, cb_arg);

		if(!BN_GENCB_call(cb, 1, -1))

			goto err;

		}



	if (ctx_passed != NULL)
@@ -306,7 +323,8 @@ int BN_is_prime_fasttest(const BIGNUM *a, int checks, 
			ret=0;

			goto err;

			}

		if (callback != NULL) callback(1,i,cb_arg);

		if(!BN_GENCB_call(cb, 1, i))

			goto err;

		}

	ret=1;

err: