crypto/evp/p_dsa.cc

// Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <openssl/evp.h>

#include <openssl/bn.h>
#include <openssl/bytestring.h>
#include <openssl/digest.h>
#include <openssl/dsa.h>
#include <openssl/err.h>

#include "../dsa/internal.h"
#include "../mem_internal.h"
#include "internal.h"


using namespace bssl;

namespace {

extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meth;

bssl::evp_decode_result_t dsa_pub_decode(const EVP_PKEY_ALG *alg,
                                         EvpPkey *out, CBS *params,
                                         CBS *key) {
  // See RFC 3279, section 2.3.2.

  // Decode parameters. RFC 3279 permits DSA parameters to be omitted, in which
  // case they are implicitly determined from the issuing certificate, or
  // somewhere unspecified and out-of-band. We do not support this mode.
  UniquePtr<DSAImpl> dsa(FromOpaque(DSA_parse_parameters(params)));
  if (dsa == nullptr || CBS_len(params) != 0) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
    return evp_decode_error;
  }

  dsa->pub_key.reset(BN_new());
  if (dsa->pub_key == nullptr) {
    return evp_decode_error;
  }

  if (!BN_parse_asn1_unsigned(key, dsa->pub_key.get()) || CBS_len(key) != 0) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
    return evp_decode_error;
  }

  EVP_PKEY_assign_DSA(out, dsa.release());
  return evp_decode_ok;
}

int dsa_pub_encode(CBB *out, const EvpPkey *key) {
  const DSAImpl *dsa = reinterpret_cast<const DSAImpl *>(key->pkey);
  const int has_params =
      dsa->p != nullptr && dsa->q != nullptr && dsa->g != nullptr;

  // See RFC 5480, section 2.
  CBB spki, algorithm, key_bitstring;
  if (!CBB_add_asn1(out, &spki, CBS_ASN1_SEQUENCE) ||
      !CBB_add_asn1(&spki, &algorithm, CBS_ASN1_SEQUENCE) ||
      !CBB_add_asn1_element(&algorithm, CBS_ASN1_OBJECT, dsa_asn1_meth.oid,
                            dsa_asn1_meth.oid_len) ||
      (has_params && !DSA_marshal_parameters(&algorithm, dsa)) ||
      !CBB_add_asn1(&spki, &key_bitstring, CBS_ASN1_BITSTRING) ||
      !CBB_add_u8(&key_bitstring, 0 /* padding */) ||
      !BN_marshal_asn1(&key_bitstring, dsa->pub_key.get()) || !CBB_flush(out)) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_ENCODE_ERROR);
    return 0;
  }

  return 1;
}

bssl::evp_decode_result_t dsa_priv_decode(const EVP_PKEY_ALG *alg,
                                          EvpPkey *out, CBS *params,
                                          CBS *key) {
  // See PKCS#11, v2.40, section 2.5.

  // Decode parameters.
  UniquePtr<DSAImpl> dsa(FromOpaque(DSA_parse_parameters(params)));
  if (dsa == nullptr || CBS_len(params) != 0) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
    return evp_decode_error;
  }

  dsa->priv_key.reset(BN_new());
  if (dsa->priv_key == nullptr) {
    return evp_decode_error;
  }
  if (!BN_parse_asn1_unsigned(key, dsa->priv_key.get()) || CBS_len(key) != 0) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
    return evp_decode_error;
  }

  // To avoid DoS attacks when importing private keys, check bounds on `dsa`.
  // This bounds `dsa->priv_key` against `dsa->q` and bounds `dsa->q`'s bit
  // width.
  if (!dsa_check_key(dsa.get())) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
    return evp_decode_error;
  }

  // Calculate the public key.
  UniquePtr<BN_CTX> ctx(BN_CTX_new());
  dsa->pub_key.reset(BN_new());
  if (ctx == nullptr || dsa->pub_key == nullptr ||
      !BN_mod_exp_mont_consttime(dsa->pub_key.get(), dsa->g.get(),
                                 dsa->priv_key.get(), dsa->p.get(), ctx.get(),
                                 nullptr)) {
    return evp_decode_error;
  }

  EVP_PKEY_assign_DSA(out, dsa.release());
  return evp_decode_ok;
}

int dsa_priv_encode(CBB *out, const EvpPkey *key) {
  const DSAImpl *dsa = reinterpret_cast<const DSAImpl *>(key->pkey);
  if (dsa == nullptr || dsa->priv_key == nullptr) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_MISSING_PARAMETERS);
    return 0;
  }

  // See PKCS#11, v2.40, section 2.5.
  CBB pkcs8, algorithm, private_key;
  if (!CBB_add_asn1(out, &pkcs8, CBS_ASN1_SEQUENCE) ||
      !CBB_add_asn1_uint64(&pkcs8, 0 /* version */) ||
      !CBB_add_asn1(&pkcs8, &algorithm, CBS_ASN1_SEQUENCE) ||
      !CBB_add_asn1_element(&algorithm, CBS_ASN1_OBJECT, dsa_asn1_meth.oid,
                            dsa_asn1_meth.oid_len) ||
      !DSA_marshal_parameters(&algorithm, dsa) ||
      !CBB_add_asn1(&pkcs8, &private_key, CBS_ASN1_OCTETSTRING) ||
      !BN_marshal_asn1(&private_key, dsa->priv_key.get()) || !CBB_flush(out)) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_ENCODE_ERROR);
    return 0;
  }

  return 1;
}

int int_dsa_size(const EvpPkey *pkey) {
  const DSAImpl *dsa = reinterpret_cast<const DSAImpl *>(pkey->pkey);
  return DSA_size(dsa);
}

int dsa_bits(const EvpPkey *pkey) {
  const DSAImpl *dsa = reinterpret_cast<const DSAImpl *>(pkey->pkey);
  return BN_num_bits(DSA_get0_p(dsa));
}

int dsa_missing_parameters(const EvpPkey *pkey) {
  const DSAImpl *dsa = reinterpret_cast<const DSAImpl *>(pkey->pkey);
  if (DSA_get0_p(dsa) == nullptr || DSA_get0_q(dsa) == nullptr ||
      DSA_get0_g(dsa) == nullptr) {
    return 1;
  }
  return 0;
}

int dup_bn_into(UniquePtr<BIGNUM> *out, const BIGNUM *src) {
  UniquePtr<BIGNUM> copy(BN_dup(src));
  if (copy == nullptr) {
    return 0;
  }
  *out = std::move(copy);
  return 1;
}

int dsa_copy_parameters(EvpPkey *to, const EvpPkey *from) {
  if (to->pkey == nullptr) {
    to->pkey = DSA_new();
    if (to->pkey == nullptr) {
      return 0;
    }
  }
  DSAImpl *to_dsa = reinterpret_cast<DSAImpl *>(to->pkey);
  const DSAImpl *from_dsa = reinterpret_cast<const DSAImpl *>(from->pkey);
  if (!dup_bn_into(&to_dsa->p, from_dsa->p.get()) ||
      !dup_bn_into(&to_dsa->q, from_dsa->q.get()) ||
      !dup_bn_into(&to_dsa->g, from_dsa->g.get())) {
    return 0;
  }

  return 1;
}

bool dsa_equal_parameters(const EvpPkey *a, const EvpPkey *b) {
  const DSAImpl *a_dsa = reinterpret_cast<const DSAImpl *>(a->pkey);
  const DSAImpl *b_dsa = reinterpret_cast<const DSAImpl *>(b->pkey);
  return BN_cmp(DSA_get0_p(a_dsa), DSA_get0_p(b_dsa)) == 0 &&
         BN_cmp(DSA_get0_q(a_dsa), DSA_get0_q(b_dsa)) == 0 &&
         BN_cmp(DSA_get0_g(a_dsa), DSA_get0_g(b_dsa)) == 0;
}

bool dsa_pub_equal(const EvpPkey *a, const EvpPkey *b) {
  const DSAImpl *a_dsa = reinterpret_cast<const DSAImpl *>(a->pkey);
  const DSAImpl *b_dsa = reinterpret_cast<const DSAImpl *>(b->pkey);
  return BN_cmp(DSA_get0_pub_key(b_dsa), DSA_get0_pub_key(a_dsa)) == 0;
}

bool dsa_pub_present(const EvpPkey *pk) {
  const DSA *pk_dsa = reinterpret_cast<const DSA *>(pk->pkey);
  return DSA_get0_pub_key(pk_dsa) != nullptr;
}

bool dsa_pub_copy(EvpPkey *out, const EvpPkey *pk) {
  const DSA *pk_dsa = reinterpret_cast<const DSA *>(pk->pkey);
  const BIGNUM *public_key = DSA_get0_pub_key(pk_dsa);
  if (public_key == nullptr) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_MISSING_PUBLIC_KEY);
    return false;
  }
  UniquePtr<DSA> public_copy_dsa(DSAparams_dup(pk_dsa));
  BIGNUM *public_key_copy = BN_dup(public_key);
  if (public_copy_dsa == nullptr || public_key_copy == nullptr ||
      !DSA_set0_key(public_copy_dsa.get(), public_key_copy, nullptr)) {
    BN_free(public_key_copy);
    OPENSSL_PUT_ERROR(EVP, ERR_R_INTERNAL_ERROR);
    return false;
  }
  evp_pkey_set0(out, pk->ameth, public_copy_dsa.release());
  return true;
}

bool dsa_priv_present(const EvpPkey *pk) {
  const DSA *pk_dsa = reinterpret_cast<const DSA *>(pk->pkey);
  return DSA_get0_priv_key(pk_dsa) != nullptr;
}

void int_dsa_free(EvpPkey *pkey) {
  DSA_free(reinterpret_cast<DSAImpl *>(pkey->pkey));
  pkey->pkey = nullptr;
}

const EVP_PKEY_ASN1_METHOD dsa_asn1_meth = {
    EVP_PKEY_DSA,
    // 1.2.840.10040.4.1
    {0x2a, 0x86, 0x48, 0xce, 0x38, 0x04, 0x01},
    7,

    /*pkey_method=*/nullptr,

    dsa_pub_decode,
    dsa_pub_encode,
    dsa_pub_equal,
    dsa_pub_present,
    dsa_pub_copy,

    dsa_priv_decode,
    dsa_priv_encode,
    dsa_priv_present,

    /*set_priv_raw=*/nullptr,
    /*set_priv_seed=*/nullptr,
    /*set_pub_raw=*/nullptr,
    /*get_priv_raw=*/nullptr,
    /*get_priv_seed=*/nullptr,
    /*get_pub_raw=*/nullptr,
    /*set1_tls_encodedpoint=*/nullptr,
    /*get1_tls_encodedpoint=*/nullptr,

    /*pkey_opaque=*/nullptr,

    int_dsa_size,
    dsa_bits,

    dsa_missing_parameters,
    dsa_copy_parameters,
    dsa_equal_parameters,

    int_dsa_free,
};

}  // namespace

const EVP_PKEY_ALG *EVP_pkey_dsa() {
  static const EVP_PKEY_ALG kAlg = {&dsa_asn1_meth, nullptr};
  return &kAlg;
}

int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits) {
  // BoringSSL does not support DSA in `EVP_PKEY_CTX`.
  OPENSSL_PUT_ERROR(EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
  return 0;
}

int EVP_PKEY_CTX_set_dsa_paramgen_q_bits(EVP_PKEY_CTX *ctx, int qbits) {
  // BoringSSL does not support DSA in `EVP_PKEY_CTX`.
  OPENSSL_PUT_ERROR(EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
  return 0;
}

int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, const DSA *key) {
  return EVP_PKEY_assign_DSA(pkey, DSA_dup_ref(key));
}

int EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key) {
  if (key == nullptr) {
    return 0;
  }
  evp_pkey_set0(FromOpaque(pkey), &dsa_asn1_meth, key);
  return 1;
}

DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey) {
  if (EVP_PKEY_id(pkey) != EVP_PKEY_DSA) {
    OPENSSL_PUT_ERROR(EVP, EVP_R_EXPECTING_A_DSA_KEY);
    return nullptr;
  }
  return reinterpret_cast<DSA *>(FromOpaque(pkey)->pkey);
}

DSA *EVP_PKEY_get1_DSA(const EVP_PKEY *pkey) {
  DSA *dsa = EVP_PKEY_get0_DSA(pkey);
  if (dsa != nullptr) {
    DSA_up_ref(dsa);
  }
  return dsa;
}