doc/man7/SM2.pod

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