openssl fipsinstall: fix cosmetic wart
[openssl.git] / crypto / dsa / dsa_lib.c
index 5ce81fb8562ad85835491f59382cf30b5ab452ed..7997c2ac25e459d04acf71828864ed3ac3a5f939 100644 (file)
-/* crypto/dsa/dsa_lib.c */
-/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
- * All rights reserved.
+/*
+ * Copyright 1995-2023 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
  */
 
-/* Original version from Steven Schoch <schoch@sheba.arc.nasa.gov> */
+/*
+ * DSA 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/dsa.h>
-#include <openssl/asn1.h>
+#ifndef FIPS_MODULE
+# include <openssl/engine.h>
+#endif
+#include "internal/cryptlib.h"
+#include "internal/refcount.h"
+#include "crypto/dsa.h"
+#include "crypto/dh.h" /* required by DSA_dup_DH() */
+#include "dsa_local.h"
 
-const char *DSA_version="DSA" OPENSSL_VERSION_PTEXT;
+static DSA *dsa_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx);
 
-static DSA_METHOD *default_DSA_method;
-static int dsa_meth_num = 0;
-static STACK *dsa_meth = NULL;
+#ifndef FIPS_MODULE
 
-void DSA_set_default_method(DSA_METHOD *meth)
+int DSA_set_ex_data(DSA *d, int idx, void *arg)
 {
-       default_DSA_method = meth;
+    return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
 }
 
-DSA_METHOD *DSA_get_default_method(void)
+void *DSA_get_ex_data(const DSA *d, int idx)
 {
-       if(!default_DSA_method) default_DSA_method = DSA_OpenSSL();
-       return default_DSA_method;
+    return CRYPTO_get_ex_data(&d->ex_data, idx);
 }
 
-DSA *DSA_new(void)
+# ifndef OPENSSL_NO_DH
+DH *DSA_dup_DH(const DSA *r)
 {
-       return DSA_new_method(NULL);
-}
-
-DSA_METHOD *DSA_set_method(DSA *dsa, DSA_METHOD *meth)
-{
-        DSA_METHOD *mtmp;
-        mtmp = dsa->meth;
-        if (mtmp->finish) mtmp->finish(dsa);
-        dsa->meth = meth;
-        if (meth->init) meth->init(dsa);
-        return mtmp;
-}
-
-
-DSA *DSA_new_method(DSA_METHOD *meth)
-       {
-       DSA *ret;
-
-       ret=(DSA *)Malloc(sizeof(DSA));
-       if (ret == NULL)
-               {
-               DSAerr(DSA_F_DSA_NEW,ERR_R_MALLOC_FAILURE);
-               return(NULL);
-               }
-       if(!default_DSA_method) default_DSA_method = DSA_OpenSSL();
-       if(meth) ret->meth = meth;
-       else ret->meth = default_DSA_method;
-       ret->pad=0;
-       ret->version=0;
-       ret->write_params=1;
-       ret->p=NULL;
-       ret->q=NULL;
-       ret->g=NULL;
-
-       ret->pub_key=NULL;
-       ret->priv_key=NULL;
-
-       ret->kinv=NULL;
-       ret->r=NULL;
-       ret->method_mont_p=NULL;
-
-       ret->references=1;
-       ret->flags=ret->meth->flags;
-       if ((ret->meth->init != NULL) && !ret->meth->init(ret))
-               {
-               Free(ret);
-               ret=NULL;
-               }
-       else
-               CRYPTO_new_ex_data(dsa_meth,(char *)ret,&ret->ex_data);
-       
-       return(ret);
-       }
+    /*
+     * DSA has p, q, g, optional pub_key, optional priv_key.
+     * DH has p, optional length, g, optional pub_key,
+     * optional priv_key, optional q.
+     */
+    DH *ret = NULL;
+    BIGNUM *pub_key = NULL, *priv_key = NULL;
 
-void DSA_free(DSA *r)
-       {
-       int i;
+    if (r == NULL)
+        goto err;
+    ret = DH_new();
+    if (ret == NULL)
+        goto err;
 
-       if (r == NULL) return;
+    if (!ossl_ffc_params_copy(ossl_dh_get0_params(ret), &r->params))
+        goto err;
 
-       i=CRYPTO_add(&r->references,-1,CRYPTO_LOCK_DSA);
-#ifdef REF_PRINT
-       REF_PRINT("DSA",r);
-#endif
-       if (i > 0) return;
-#ifdef REF_CHECK
-       if (i < 0)
-               {
-               fprintf(stderr,"DSA_free, bad reference count\n");
-               abort();
-               }
+    if (r->pub_key != NULL) {
+        pub_key = BN_dup(r->pub_key);
+        if (pub_key == NULL)
+            goto err;
+        if (r->priv_key != NULL) {
+            priv_key = BN_dup(r->priv_key);
+            if (priv_key == NULL)
+                goto err;
+        }
+        if (!DH_set0_key(ret, pub_key, priv_key))
+            goto err;
+    } else if (r->priv_key != NULL) {
+        /* Shouldn't happen */
+        goto err;
+    }
+
+    return ret;
+
+ err:
+    BN_free(pub_key);
+    BN_free(priv_key);
+    DH_free(ret);
+    return NULL;
+}
+# endif /*  OPENSSL_NO_DH */
+
+void DSA_clear_flags(DSA *d, int flags)
+{
+    d->flags &= ~flags;
+}
+
+int DSA_test_flags(const DSA *d, int flags)
+{
+    return d->flags & flags;
+}
+
+void DSA_set_flags(DSA *d, int flags)
+{
+    d->flags |= flags;
+}
+
+ENGINE *DSA_get0_engine(DSA *d)
+{
+    return d->engine;
+}
+
+int DSA_set_method(DSA *dsa, const DSA_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 DSA_METHOD *mtmp;
+    mtmp = dsa->meth;
+    if (mtmp->finish)
+        mtmp->finish(dsa);
+#ifndef OPENSSL_NO_ENGINE
+    ENGINE_finish(dsa->engine);
+    dsa->engine = NULL;
 #endif
+    dsa->meth = meth;
+    if (meth->init)
+        meth->init(dsa);
+    return 1;
+}
+#endif /* FIPS_MODULE */
+
+
+const DSA_METHOD *DSA_get_method(DSA *d)
+{
+    return d->meth;
+}
 
-       CRYPTO_free_ex_data(dsa_meth, (char *)r, &r->ex_data);
-
-       if(r->meth->finish) r->meth->finish(r);
-
-       if (r->p != NULL) BN_clear_free(r->p);
-       if (r->q != NULL) BN_clear_free(r->q);
-       if (r->g != NULL) BN_clear_free(r->g);
-       if (r->pub_key != NULL) BN_clear_free(r->pub_key);
-       if (r->priv_key != NULL) BN_clear_free(r->priv_key);
-       if (r->kinv != NULL) BN_clear_free(r->kinv);
-       if (r->r != NULL) BN_clear_free(r->r);
-       Free(r);
-       }
-
-int DSA_size(DSA *r)
-       {
-       int ret,i;
-       ASN1_INTEGER bs;
-       unsigned char buf[4];
-
-       i=BN_num_bits(r->q);
-       bs.length=(i+7)/8;
-       bs.data=buf;
-       bs.type=V_ASN1_INTEGER;
-       /* If the top bit is set the asn1 encoding is 1 larger. */
-       buf[0]=0xff;    
-
-       i=i2d_ASN1_INTEGER(&bs,NULL);
-       i+=i; /* r and s */
-       ret=ASN1_object_size(1,i,V_ASN1_SEQUENCE);
-       return(ret);
-       }
-
-int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
-            int (*dup_func)(), void (*free_func)())
-        {
-       dsa_meth_num++;
-       return(CRYPTO_get_ex_new_index(dsa_meth_num-1,
-               &dsa_meth,argl,argp,new_func,dup_func,free_func));
+static DSA *dsa_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx)
+{
+    DSA *ret = OPENSSL_zalloc(sizeof(*ret));
+
+    if (ret == NULL)
+        return NULL;
+
+    ret->lock = CRYPTO_THREAD_lock_new();
+    if (ret->lock == NULL) {
+        ERR_raise(ERR_LIB_DSA, ERR_R_CRYPTO_LIB);
+        OPENSSL_free(ret);
+        return NULL;
+    }
+
+    if (!CRYPTO_NEW_REF(&ret->references, 1)) {
+        CRYPTO_THREAD_lock_free(ret->lock);
+        OPENSSL_free(ret);
+        return NULL;
+    }
+
+    ret->libctx = libctx;
+    ret->meth = DSA_get_default_method();
+#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
+    ret->flags = ret->meth->flags & ~DSA_FLAG_NON_FIPS_ALLOW; /* early default init */
+    if (engine) {
+        if (!ENGINE_init(engine)) {
+            ERR_raise(ERR_LIB_DSA, ERR_R_ENGINE_LIB);
+            goto err;
+        }
+        ret->engine = engine;
+    } else
+        ret->engine = ENGINE_get_default_DSA();
+    if (ret->engine) {
+        ret->meth = ENGINE_get_DSA(ret->engine);
+        if (ret->meth == NULL) {
+            ERR_raise(ERR_LIB_DSA, ERR_R_ENGINE_LIB);
+            goto err;
         }
+    }
+#endif
 
-int DSA_set_ex_data(DSA *d, int idx, char *arg)
-       {
-       return(CRYPTO_set_ex_data(&d->ex_data,idx,arg));
-       }
-
-char *DSA_get_ex_data(DSA *d, int idx)
-       {
-       return(CRYPTO_get_ex_data(&d->ex_data,idx));
-       }
-
-#ifndef NO_DH
-DH *DSA_dup_DH(DSA *r)
-       {
-       /* DSA has p, q, g, optional pub_key, optional priv_key.
-        * DH has p, optional length, g, optional pub_key, optional priv_key.
-        */ 
-
-       DH *ret = NULL;
-
-       if (r == NULL)
-               goto err;
-       ret = DH_new();
-       if (ret == NULL)
-               goto err;
-       if (r->p != NULL) 
-               if ((ret->p = BN_dup(r->p)) == NULL)
-                       goto err;
-       if (r->q != NULL)
-               ret->length = BN_num_bits(r->q);
-       if (r->g != NULL)
-               if ((ret->g = BN_dup(r->g)) == NULL)
-                       goto err;
-       if (r->pub_key != NULL)
-               if ((ret->pub_key = BN_dup(r->pub_key)) == NULL)
-                       goto err;
-       if (r->priv_key != NULL)
-               if ((ret->priv_key = BN_dup(r->priv_key)) == NULL)
-                       goto err;
-
-       return ret;
+    ret->flags = ret->meth->flags & ~DSA_FLAG_NON_FIPS_ALLOW;
+
+#ifndef FIPS_MODULE
+    if (!ossl_crypto_new_ex_data_ex(libctx, CRYPTO_EX_INDEX_DSA, ret,
+                                    &ret->ex_data))
+        goto err;
+#endif
+
+    ossl_ffc_params_init(&ret->params);
+
+    if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
+        ERR_raise(ERR_LIB_DSA, ERR_R_INIT_FAIL);
+        goto err;
+    }
+
+    return ret;
 
  err:
-       if (ret != NULL)
-               DH_free(ret);
-       return NULL;
-       }
+    DSA_free(ret);
+    return NULL;
+}
+
+DSA *DSA_new_method(ENGINE *engine)
+{
+    return dsa_new_intern(engine, NULL);
+}
+
+DSA *ossl_dsa_new(OSSL_LIB_CTX *libctx)
+{
+    return dsa_new_intern(NULL, libctx);
+}
+
+#ifndef FIPS_MODULE
+DSA *DSA_new(void)
+{
+    return dsa_new_intern(NULL, NULL);
+}
 #endif
+
+void DSA_free(DSA *r)
+{
+    int i;
+
+    if (r == NULL)
+        return;
+
+    CRYPTO_DOWN_REF(&r->references, &i);
+    REF_PRINT_COUNT("DSA", 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_MODULE) && !defined(OPENSSL_NO_ENGINE)
+    ENGINE_finish(r->engine);
+#endif
+
+#ifndef FIPS_MODULE
+    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DSA, r, &r->ex_data);
+#endif
+
+    CRYPTO_THREAD_lock_free(r->lock);
+    CRYPTO_FREE_REF(&r->references);
+
+    ossl_ffc_params_cleanup(&r->params);
+    BN_clear_free(r->pub_key);
+    BN_clear_free(r->priv_key);
+    OPENSSL_free(r);
+}
+
+int DSA_up_ref(DSA *r)
+{
+    int i;
+
+    if (CRYPTO_UP_REF(&r->references, &i) <= 0)
+        return 0;
+
+    REF_PRINT_COUNT("DSA", r);
+    REF_ASSERT_ISNT(i < 2);
+    return ((i > 1) ? 1 : 0);
+}
+
+void ossl_dsa_set0_libctx(DSA *d, OSSL_LIB_CTX *libctx)
+{
+    d->libctx = libctx;
+}
+
+void DSA_get0_pqg(const DSA *d,
+                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
+{
+    ossl_ffc_params_get0_pqg(&d->params, p, q, g);
+}
+
+int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g)
+{
+    /* If the fields p, q and g in d are NULL, the corresponding input
+     * parameters MUST be non-NULL.
+     */
+    if ((d->params.p == NULL && p == NULL)
+        || (d->params.q == NULL && q == NULL)
+        || (d->params.g == NULL && g == NULL))
+        return 0;
+
+    ossl_ffc_params_set0_pqg(&d->params, p, q, g);
+    d->dirty_cnt++;
+
+    return 1;
+}
+
+const BIGNUM *DSA_get0_p(const DSA *d)
+{
+    return d->params.p;
+}
+
+const BIGNUM *DSA_get0_q(const DSA *d)
+{
+    return d->params.q;
+}
+
+const BIGNUM *DSA_get0_g(const DSA *d)
+{
+    return d->params.g;
+}
+
+const BIGNUM *DSA_get0_pub_key(const DSA *d)
+{
+    return d->pub_key;
+}
+
+const BIGNUM *DSA_get0_priv_key(const DSA *d)
+{
+    return d->priv_key;
+}
+
+void DSA_get0_key(const DSA *d,
+                  const BIGNUM **pub_key, const BIGNUM **priv_key)
+{
+    if (pub_key != NULL)
+        *pub_key = d->pub_key;
+    if (priv_key != NULL)
+        *priv_key = d->priv_key;
+}
+
+int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key)
+{
+    if (pub_key != NULL) {
+        BN_free(d->pub_key);
+        d->pub_key = pub_key;
+    }
+    if (priv_key != NULL) {
+        BN_free(d->priv_key);
+        d->priv_key = priv_key;
+    }
+    d->dirty_cnt++;
+
+    return 1;
+}
+
+int DSA_security_bits(const DSA *d)
+{
+    if (d->params.p != NULL && d->params.q != NULL)
+        return BN_security_bits(BN_num_bits(d->params.p),
+                                BN_num_bits(d->params.q));
+    return -1;
+}
+
+int DSA_bits(const DSA *dsa)
+{
+    if (dsa->params.p != NULL)
+        return BN_num_bits(dsa->params.p);
+    return -1;
+}
+
+FFC_PARAMS *ossl_dsa_get0_params(DSA *dsa)
+{
+    return &dsa->params;
+}
+
+int ossl_dsa_ffc_params_fromdata(DSA *dsa, const OSSL_PARAM params[])
+{
+    int ret;
+    FFC_PARAMS *ffc = ossl_dsa_get0_params(dsa);
+
+    ret = ossl_ffc_params_fromdata(ffc, params);
+    if (ret)
+        dsa->dirty_cnt++;
+    return ret;
+}