doc/man7/EVP_PKEY-SM2.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY-SM2, EVP_KEYMGMT-SM2, SM2
   6 - EVP_PKEY keytype support for the Chinese SM2 signature and encryption algorithms
   7
   8 =head1 DESCRIPTION
   9
  10 The B<SM2> algorithm was first defined by the Chinese national standard GM/T
  11 0003-2012 and was later standardized by ISO as ISO/IEC 14888. B<SM2> is actually
  12 an elliptic curve based algorithm. The current implementation in OpenSSL supports
  13 both signature and encryption schemes via the EVP interface.
  14
  15 When doing the B<SM2> signature algorithm, it requires a distinguishing identifier
  16 to form the message prefix which is hashed before the real message is hashed.
  17
  18 =head1 NOTES
  19
  20 B<SM2> signatures can be generated by using the 'DigestSign' series of APIs, for
  21 instance, EVP_DigestSignInit(), EVP_DigestSignUpdate() and EVP_DigestSignFinal().
  22 Ditto for the verification process by calling the 'DigestVerify' series of APIs.
  23
  24 Before computing an B<SM2> signature, an B<EVP_PKEY_CTX> needs to be created,
  25 and an B<SM2> ID must be set for it, like this:
  26
  27  EVP_PKEY_CTX_set1_id(pctx, id, id_len);
  28
  29 Before calling the EVP_DigestSignInit() or EVP_DigestVerifyInit() functions,
  30 that B<EVP_PKEY_CTX> should be assigned to the B<EVP_MD_CTX>, like this:
  31
  32  EVP_MD_CTX_set_pkey_ctx(mctx, pctx);
  33
  34 There is normally no need to pass a B<pctx> parameter to EVP_DigestSignInit()
  35 or EVP_DigestVerifyInit() in such a scenario.
  36
  37 SM2 can be tested with the L<openssl-speed(1)> application since version 3.0.
  38 Currently, the only valid algorithm name is B<sm2>.
  39
  40 =head1 EXAMPLES
  41
  42 This example demonstrates the calling sequence for using an B<EVP_PKEY> to verify
  43 a message with the SM2 signature algorithm and the SM3 hash algorithm:
  44
  45  #include <openssl/evp.h>
  46
  47  /* obtain an EVP_PKEY using whatever methods... */
  48  mctx = EVP_MD_CTX_new();
  49  pctx = EVP_PKEY_CTX_new(pkey, NULL);
  50  EVP_PKEY_CTX_set1_id(pctx, id, id_len);
  51  EVP_MD_CTX_set_pkey_ctx(mctx, pctx);
  52  EVP_DigestVerifyInit(mctx, NULL, EVP_sm3(), NULL, pkey);
  53  EVP_DigestVerifyUpdate(mctx, msg, msg_len);
  54  EVP_DigestVerifyFinal(mctx, sig, sig_len)
  55
  56 =head1 SEE ALSO
  57
  58 L<EVP_PKEY_CTX_new(3)>,
  59 L<EVP_DigestSignInit(3)>,
  60 L<EVP_DigestVerifyInit(3)>,
  61 L<EVP_PKEY_CTX_set1_id(3)>,
  62 L<EVP_MD_CTX_set_pkey_ctx(3)>
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
  67
  68 Licensed under the Apache License 2.0 (the "License").  You may not use
  69 this file except in compliance with the License.  You can obtain a copy
  70 in the file LICENSE in the source distribution or at
  71 L<https://www.openssl.org/source/license.html>.
  72
  73 =cut