secure/lib/libcrypto/man/man7/SM2.7

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SM2 7"
 136 .TH SM2 7 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SM2 \- Chinese SM2 signature and encryption algorithm support
 143 .SH "DESCRIPTION"
 144 .IX Header "DESCRIPTION"
 145 The \fB\s-1SM2\s0\fR algorithm was first defined by the Chinese national standard \s-1GM/T
 146 0003\-2012\s0 and was later standardized by \s-1ISO\s0 as \s-1ISO/IEC 14888.\s0 \fB\s-1SM2\s0\fR is actually
 147 an elliptic curve based algorithm. The current implementation in OpenSSL supports
 148 both signature and encryption schemes via the \s-1EVP\s0 interface.
 149 .PP
 150 When doing the \fB\s-1SM2\s0\fR signature algorithm, it requires a distinguishing identifier
 151 to form the message prefix which is hashed before the real message is hashed.
 152 .SH "NOTES"
 153 .IX Header "NOTES"
 154 \&\fB\s-1SM2\s0\fR signatures can be generated by using the 'DigestSign' series of APIs, for
 155 instance, \fBEVP_DigestSignInit()\fR, \fBEVP_DigestSignUpdate()\fR and \fBEVP_DigestSignFinal()\fR.
 156 Ditto for the verification process by calling the 'DigestVerify' series of APIs.
 157 .PP
 158 There are several special steps that need to be done before computing an \fB\s-1SM2\s0\fR
 159 signature.
 160 .PP
 161 The \fB\s-1EVP_PKEY\s0\fR structure will default to using \s-1ECDSA\s0 for signatures when it is
 162 created. It should be set to \fB\s-1EVP_PKEY_SM2\s0\fR by calling:
 163 .PP
 164 .Vb 1
 165 \& EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2);
 166 .Ve
 167 .PP
 168 Then an \s-1ID\s0 should be set by calling:
 169 .PP
 170 .Vb 1
 171 \& EVP_PKEY_CTX_set1_id(pctx, id, id_len);
 172 .Ve
 173 .PP
 174 When calling the \fBEVP_DigestSignInit()\fR or \fBEVP_DigestVerifyInit()\fR functions, a
 175 preallocated \fB\s-1EVP_PKEY_CTX\s0\fR should be assigned to the \fB\s-1EVP_MD_CTX\s0\fR. This is
 176 done by calling:
 177 .PP
 178 .Vb 1
 179 \& EVP_MD_CTX_set_pkey_ctx(mctx, pctx);
 180 .Ve
 181 .PP
 182 And normally there is no need to pass a \fBpctx\fR parameter to \fBEVP_DigestSignInit()\fR
 183 or \fBEVP_DigestVerifyInit()\fR in such a scenario.
 184 .SH "EXAMPLES"
 185 .IX Header "EXAMPLES"
 186 This example demonstrates the calling sequence for using an \fB\s-1EVP_PKEY\s0\fR to verify
 187 a message with the \s-1SM2\s0 signature algorithm and the \s-1SM3\s0 hash algorithm:
 188 .PP
 189 .Vb 1
 190 \& #include <openssl/evp.h>
 191 \&
 192 \& /* obtain an EVP_PKEY using whatever methods... */
 193 \& EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2);
 194 \& mctx = EVP_MD_CTX_new();
 195 \& pctx = EVP_PKEY_CTX_new(pkey, NULL);
 196 \& EVP_PKEY_CTX_set1_id(pctx, id, id_len);
 197 \& EVP_MD_CTX_set_pkey_ctx(mctx, pctx);;
 198 \& EVP_DigestVerifyInit(mctx, NULL, EVP_sm3(), NULL, pkey);
 199 \& EVP_DigestVerifyUpdate(mctx, msg, msg_len);
 200 \& EVP_DigestVerifyFinal(mctx, sig, sig_len)
 201 .Ve
 202 .SH "SEE ALSO"
 203 .IX Header "SEE ALSO"
 204 \&\fBEVP_PKEY_CTX_new\fR\|(3),
 205 \&\fBEVP_PKEY_set_alias_type\fR\|(3),
 206 \&\fBEVP_DigestSignInit\fR\|(3),
 207 \&\fBEVP_DigestVerifyInit\fR\|(3),
 208 \&\fBEVP_PKEY_CTX_set1_id\fR\|(3),
 209 \&\fBEVP_MD_CTX_set_pkey_ctx\fR\|(3)
 210 .SH "COPYRIGHT"
 211 .IX Header "COPYRIGHT"
 212 Copyright 2018\-2020 The OpenSSL Project Authors. All Rights Reserved.
 213 .PP
 214 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 215 this file except in compliance with the License.  You can obtain a copy
 216 in the file \s-1LICENSE\s0 in the source distribution or at
 217 <https://www.openssl.org/source/license.html>.