DH: add internal dh_get_method()
[openssl.git] / crypto / dh / dh_lib.c
index c0a2472751f600d5162c50437b953c4c7f8f49f2..7666e77d39423cafb8415723f03eb4f219c1b236 100644 (file)
-/* crypto/dh/dh_lib.c */
-/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
- * All rights reserved.
+/*
+ * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
  *
- * This package is an SSL implementation written
- * by Eric Young (eay@cryptsoft.com).
- * The implementation was written so as to conform with Netscapes SSL.
- * 
- * This library is free for commercial and non-commercial use as long as
- * the following conditions are aheared to.  The following conditions
- * apply to all code found in this distribution, be it the RC4, RSA,
- * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
- * included with this distribution is covered by the same copyright terms
- * except that the holder is Tim Hudson (tjh@cryptsoft.com).
- * 
- * Copyright remains Eric Young's, and as such any Copyright notices in
- * the code are not to be removed.
- * If this package is used in a product, Eric Young should be given attribution
- * as the author of the parts of the library used.
- * This can be in the form of a textual message at program startup or
- * in documentation (online or textual) provided with the package.
- * 
- * 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 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 acknowledgement:
- *    "This product includes cryptographic software written by
- *     Eric Young (eay@cryptsoft.com)"
- *    The word 'cryptographic' can be left out if the rouines from the library
- *    being used are not cryptographic related :-).
- * 4. If you include any Windows specific code (or a derivative thereof) from 
- *    the apps directory (application code) you must include an acknowledgement:
- *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
- * 
- * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
- * ANY EXPRESS 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 AUTHOR OR 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.
- * 
- * The licence and distribution terms for any publically available version or
- * derivative of this code cannot be changed.  i.e. this code cannot simply be
- * copied and put under another distribution licence
- * [including the GNU Public Licence.]
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
  */
 
+/*
+ * DH low level APIs are deprecated for public use, but still ok for
+ * internal use.
+ */
+#include "internal/deprecated.h"
+
 #include <stdio.h>
-#include "cryptlib.h"
 #include <openssl/bn.h>
-#include <openssl/dh.h>
 #include <openssl/engine.h>
+#include <openssl/obj_mac.h>
+#include "internal/cryptlib.h"
+#include "internal/refcount.h"
+#include "crypto/dh.h"
+#include "dh_local.h"
 
-const char *DH_version="Diffie-Hellman" OPENSSL_VERSION_PTEXT;
-
-static const DH_METHOD *default_DH_method;
-static int dh_meth_num = 0;
-static STACK_OF(CRYPTO_EX_DATA_FUNCS) *dh_meth = NULL;
-
-void DH_set_default_openssl_method(const DH_METHOD *meth)
-{
-       ENGINE *e;
-       /* We'll need to notify the "openssl" ENGINE of this
-        * change too. We won't bother locking things down at
-        * our end as there was never any locking in these
-        * functions! */
-       if(default_DH_method != meth)
-               {
-               default_DH_method = meth;
-               e = ENGINE_by_id("openssl");
-               if(e)
-                       {
-                       ENGINE_set_DH(e, meth);
-                       ENGINE_free(e);
-                       }
-               }
-}
-
-const DH_METHOD *DH_get_default_openssl_method(void)
-{
-       if(!default_DH_method) default_DH_method = DH_OpenSSL();
-       return default_DH_method;
-}
-
-#if 0
-DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth)
-{
-        DH_METHOD *mtmp;
-        mtmp = dh->meth;
-        if (mtmp->finish) mtmp->finish(dh);
-        dh->meth = meth;
-        if (meth->init) meth->init(dh);
-        return mtmp;
-}
-#else
-int DH_set_method(DH *dh, ENGINE *engine)
-{
-       ENGINE *mtmp;
-       const DH_METHOD *meth;
-       mtmp = dh->engine;
-       meth = ENGINE_get_DH(mtmp);
-       if (!ENGINE_init(engine))
-               return 0;
-       if (meth->finish) meth->finish(dh);
-       dh->engine= engine;
-       meth = ENGINE_get_DH(engine);
-       if (meth->init) meth->init(dh);
-       /* SHOULD ERROR CHECK THIS!!! */
-       ENGINE_finish(mtmp);
-       return 1;
-}
+static DH *dh_new_intern(ENGINE *engine, OPENSSL_CTX *libctx);
+
+#ifndef FIPS_MODE
+int DH_set_method(DH *dh, const DH_METHOD *meth)
+{
+    /*
+     * NB: The caller is specifically setting a method, so it's not up to us
+     * to deal with which ENGINE it comes from.
+     */
+    const DH_METHOD *mtmp;
+    mtmp = dh->meth;
+    if (mtmp->finish)
+        mtmp->finish(dh);
+#ifndef OPENSSL_NO_ENGINE
+    ENGINE_finish(dh->engine);
+    dh->engine = NULL;
 #endif
+    dh->meth = meth;
+    if (meth->init)
+        meth->init(dh);
+    return 1;
+}
+
+const DH_METHOD *dh_get_method(const DH *dh)
+{
+    return dh->meth;
+}
 
 DH *DH_new(void)
 {
-       return DH_new_method(NULL);
+    return dh_new_intern(NULL, NULL);
 }
 
-#if 0
-DH *DH_new_method(DH_METHOD *meth)
-#else
 DH *DH_new_method(ENGINE *engine)
+{
+    return dh_new_intern(engine, NULL);
+}
+#endif /* !FIPS_MODE */
+
+DH *dh_new_with_ctx(OPENSSL_CTX *libctx)
+{
+    return dh_new_intern(NULL, libctx);
+}
+
+static DH *dh_new_intern(ENGINE *engine, OPENSSL_CTX *libctx)
+{
+    DH *ret = OPENSSL_zalloc(sizeof(*ret));
+
+    if (ret == NULL) {
+        DHerr(0, ERR_R_MALLOC_FAILURE);
+        return NULL;
+    }
+
+    ret->references = 1;
+    ret->lock = CRYPTO_THREAD_lock_new();
+    if (ret->lock == NULL) {
+        DHerr(0, ERR_R_MALLOC_FAILURE);
+        OPENSSL_free(ret);
+        return NULL;
+    }
+
+    ret->libctx = libctx;
+    ret->meth = DH_get_default_method();
+#if !defined(FIPS_MODE) && !defined(OPENSSL_NO_ENGINE)
+    ret->flags = ret->meth->flags;  /* early default init */
+    if (engine) {
+        if (!ENGINE_init(engine)) {
+            DHerr(0, ERR_R_ENGINE_LIB);
+            goto err;
+        }
+        ret->engine = engine;
+    } else
+        ret->engine = ENGINE_get_default_DH();
+    if (ret->engine) {
+        ret->meth = ENGINE_get_DH(ret->engine);
+        if (ret->meth == NULL) {
+            DHerr(0, ERR_R_ENGINE_LIB);
+            goto err;
+        }
+    }
 #endif
-       {
-       const DH_METHOD *meth;
-       DH *ret;
-       ret=(DH *)OPENSSL_malloc(sizeof(DH));
-
-       if (ret == NULL)
-               {
-               DHerr(DH_F_DH_NEW,ERR_R_MALLOC_FAILURE);
-               return(NULL);
-               }
-       if(engine)
-               ret->engine = engine;
-       else
-               {
-               if((ret->engine=ENGINE_get_default_DH()) == NULL)
-                       {
-                       OPENSSL_free(ret);
-                       return NULL;
-                       }
-               }
-       meth = ENGINE_get_DH(ret->engine);
-       ret->pad=0;
-       ret->version=0;
-       ret->p=NULL;
-       ret->g=NULL;
-       ret->length=0;
-       ret->pub_key=NULL;
-       ret->priv_key=NULL;
-       ret->q=NULL;
-       ret->j=NULL;
-       ret->seed = NULL;
-       ret->seedlen = 0;
-       ret->counter = NULL;
-       ret->method_mont_p=NULL;
-       ret->references = 1;
-       ret->flags=meth->flags;
-       CRYPTO_new_ex_data(dh_meth,ret,&ret->ex_data);
-       if ((meth->init != NULL) && !meth->init(ret))
-               {
-               CRYPTO_free_ex_data(dh_meth,ret,&ret->ex_data);
-               OPENSSL_free(ret);
-               ret=NULL;
-               }
-       return(ret);
-       }
+
+    ret->flags = ret->meth->flags;
+
+#ifndef FIPS_MODE
+    if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_DH, ret, &ret->ex_data))
+        goto err;
+#endif /* FIPS_MODE */
+
+    if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
+        DHerr(0, ERR_R_INIT_FAIL);
+        goto err;
+    }
+
+    return ret;
+
+ err:
+    DH_free(ret);
+    return NULL;
+}
 
 void DH_free(DH *r)
-       {
-       const DH_METHOD *meth;
-       int i;
-       if(r == NULL) return;
-       i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_DH);
-#ifdef REF_PRINT
-       REF_PRINT("DH",r);
-#endif
-       if (i > 0) return;
-#ifdef REF_CHECK
-       if (i < 0)
-               {
-               fprintf(stderr,"DH_free, bad reference count\n");
-               abort();
-       }
+{
+    int i;
+
+    if (r == NULL)
+        return;
+
+    CRYPTO_DOWN_REF(&r->references, &i, r->lock);
+    REF_PRINT_COUNT("DH", r);
+    if (i > 0)
+        return;
+    REF_ASSERT_ISNT(i < 0);
+
+    if (r->meth != NULL && r->meth->finish != NULL)
+        r->meth->finish(r);
+#if !defined(FIPS_MODE)
+# if !defined(OPENSSL_NO_ENGINE)
+    ENGINE_finish(r->engine);
+# endif
+    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);
 #endif
 
-       meth = ENGINE_get_DH(r->engine);
-       if(meth->finish) meth->finish(r);
-       ENGINE_finish(r->engine);
-
-       CRYPTO_free_ex_data(dh_meth, r, &r->ex_data);
-
-       if (r->p != NULL) BN_clear_free(r->p);
-       if (r->g != NULL) BN_clear_free(r->g);
-       if (r->q != NULL) BN_clear_free(r->q);
-       if (r->j != NULL) BN_clear_free(r->j);
-       if (r->seed) OPENSSL_free(r->seed);
-       if (r->counter != NULL) BN_clear_free(r->counter);
-       if (r->pub_key != NULL) BN_clear_free(r->pub_key);
-       if (r->priv_key != NULL) BN_clear_free(r->priv_key);
-       OPENSSL_free(r);
-       }
-
-int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
-            CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
-        {
-       dh_meth_num++;
-       return(CRYPTO_get_ex_new_index(dh_meth_num-1,
-               &dh_meth,argl,argp,new_func,dup_func,free_func));
-        }
+    CRYPTO_THREAD_lock_free(r->lock);
+
+    ffc_params_cleanup(&r->params);
+    BN_clear_free(r->pub_key);
+    BN_clear_free(r->priv_key);
+    OPENSSL_free(r);
+}
+
+int DH_up_ref(DH *r)
+{
+    int i;
+
+    if (CRYPTO_UP_REF(&r->references, &i, r->lock) <= 0)
+        return 0;
+
+    REF_PRINT_COUNT("DH", r);
+    REF_ASSERT_ISNT(i < 2);
+    return ((i > 1) ? 1 : 0);
+}
 
+#ifndef FIPS_MODE
 int DH_set_ex_data(DH *d, int idx, void *arg)
-       {
-       return(CRYPTO_set_ex_data(&d->ex_data,idx,arg));
-       }
+{
+    return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
+}
 
 void *DH_get_ex_data(DH *d, int idx)
-       {
-       return(CRYPTO_get_ex_data(&d->ex_data,idx));
-       }
+{
+    return CRYPTO_get_ex_data(&d->ex_data, idx);
+}
+#endif
+
+int DH_bits(const DH *dh)
+{
+    return BN_num_bits(dh->params.p);
+}
 
 int DH_size(const DH *dh)
-       {
-       return(BN_num_bytes(dh->p));
-       }
+{
+    return BN_num_bytes(dh->params.p);
+}
+
+int DH_security_bits(const DH *dh)
+{
+    int N;
+    if (dh->params.q != NULL)
+        N = BN_num_bits(dh->params.q);
+    else if (dh->length)
+        N = dh->length;
+    else
+        N = -1;
+    return BN_security_bits(BN_num_bits(dh->params.p), N);
+}
+
+void DH_get0_pqg(const DH *dh,
+                 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
+{
+    ffc_params_get0_pqg(&dh->params, p, q, g);
+}
+
+int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
+{
+    /* If the fields p and g in d are NULL, the corresponding input
+     * parameters MUST be non-NULL.  q may remain NULL.
+     */
+    if ((dh->params.p == NULL && p == NULL)
+        || (dh->params.g == NULL && g == NULL))
+        return 0;
+
+    ffc_params_set0_pqg(&dh->params, p, q, g);
+    dh->params.nid = NID_undef;
+    /*
+     * Check if this is a named group. If it finds a named group then the
+     * 'q' and 'length' value are either already set or are set by the
+     * call.
+     */
+    if (DH_get_nid(dh) == NID_undef) {
+        /* If its not a named group then set the 'length' if q is not NULL */
+        if (q != NULL)
+            dh->length = BN_num_bits(q);
+    }
+    dh->dirty_cnt++;
+    return 1;
+}
+
+long DH_get_length(const DH *dh)
+{
+    return dh->length;
+}
+
+int DH_set_length(DH *dh, long length)
+{
+    dh->length = length;
+    return 1;
+}
+
+void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)
+{
+    if (pub_key != NULL)
+        *pub_key = dh->pub_key;
+    if (priv_key != NULL)
+        *priv_key = dh->priv_key;
+}
+
+int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)
+{
+    if (pub_key != NULL) {
+        BN_clear_free(dh->pub_key);
+        dh->pub_key = pub_key;
+    }
+    if (priv_key != NULL) {
+        BN_clear_free(dh->priv_key);
+        dh->priv_key = priv_key;
+    }
+
+    dh->dirty_cnt++;
+    return 1;
+}
+
+const BIGNUM *DH_get0_p(const DH *dh)
+{
+    return dh->params.p;
+}
+
+const BIGNUM *DH_get0_q(const DH *dh)
+{
+    return dh->params.q;
+}
+
+const BIGNUM *DH_get0_g(const DH *dh)
+{
+    return dh->params.g;
+}
+
+const BIGNUM *DH_get0_priv_key(const DH *dh)
+{
+    return dh->priv_key;
+}
+
+const BIGNUM *DH_get0_pub_key(const DH *dh)
+{
+    return dh->pub_key;
+}
+
+void DH_clear_flags(DH *dh, int flags)
+{
+    dh->flags &= ~flags;
+}
+
+int DH_test_flags(const DH *dh, int flags)
+{
+    return dh->flags & flags;
+}
+
+void DH_set_flags(DH *dh, int flags)
+{
+    dh->flags |= flags;
+}
+
+#ifndef FIPS_MODE
+ENGINE *DH_get0_engine(DH *dh)
+{
+    return dh->engine;
+}
+#endif /*FIPS_MODE */
+
+FFC_PARAMS *dh_get0_params(DH *dh)
+{
+    return &dh->params;
+}
+int dh_get0_nid(const DH *dh)
+{
+    return dh->params.nid;
+}