mirror/gmsm
1
0
Fork 0
mirror of https://github.com/emmansun/gmsm.git synced 2025-05-14 04:56:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

sm2: update comments

Browse Source
This commit is contained in:
Sun Yimin 2023-03-22 10:18:06 +08:00 committed by GitHub
parent adec7ac7e2
commit 6254f0a5cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkcs7/sign_enveloped.go
View File

@ -221,7 +221,7 @@ func (saed *SignedAndEnvelopedData) AddSignerChain(ee *smx509.Certificate, pkey
var tobeSigned []byte var tobeSigned []byte
if saed.isSM { if saed.isSM {
signOpt = sm2.NewSM2SignerOption(true, nil) signOpt = sm2.DefaultSM2SignerOpts
tobeSigned = saed.data tobeSigned = saed.data
} else { } else {
signOpt = hasher signOpt = hasher

2
sm2/example_test.go
View File

@ -98,7 +98,7 @@ func ExamplePrivateKey_Sign_forceSM2() {
testkey.PublicKey.X, testkey.PublicKey.Y = testkey.ScalarBaseMult(testkey.D.Bytes()) testkey.PublicKey.X, testkey.PublicKey.Y = testkey.ScalarBaseMult(testkey.D.Bytes())
// force SM2 sign standard and use default UID // force SM2 sign standard and use default UID
sig, err := testkey.Sign(rand.Reader, toSign, sm2.NewSM2SignerOption(true, nil)) sig, err := testkey.Sign(rand.Reader, toSign, sm2.DefaultSM2SignerOpts)
if err != nil { if err != nil {
fmt.Fprintf(os.Stderr, "Error from sign: %s\n", err) fmt.Fprintf(os.Stderr, "Error from sign: %s\n", err)
return return

25
sm2/sm2.go
View File

@ -87,10 +87,12 @@ type DecrypterOpts struct {
CipherTextSplicingOrder ciphertextSplicingOrder CipherTextSplicingOrder ciphertextSplicingOrder
} }
// NewPlainEncrypterOpts creates a SM2 non-ASN1 encrypter options.
func NewPlainEncrypterOpts(marhsalMode pointMarshalMode, splicingOrder ciphertextSplicingOrder) *EncrypterOpts { func NewPlainEncrypterOpts(marhsalMode pointMarshalMode, splicingOrder ciphertextSplicingOrder) *EncrypterOpts {
return &EncrypterOpts{ENCODING_PLAIN, marhsalMode, splicingOrder} return &EncrypterOpts{ENCODING_PLAIN, marhsalMode, splicingOrder}
} }
// NewPlainDecrypterOpts creates a SM2 non-ASN1 decrypter options.
func NewPlainDecrypterOpts(splicingOrder ciphertextSplicingOrder) *DecrypterOpts { func NewPlainDecrypterOpts(splicingOrder ciphertextSplicingOrder) *DecrypterOpts {
return &DecrypterOpts{ENCODING_PLAIN, splicingOrder} return &DecrypterOpts{ENCODING_PLAIN, splicingOrder}
} }
@ -124,7 +126,7 @@ type SM2SignerOption struct {
ForceGMSign bool ForceGMSign bool
} }
// NewSM2SignerOption create a SM2 specific signer option. // NewSM2SignerOption creates a SM2 specific signer option.
// forceGMSign - if use GM specific sign logic, if yes, should pass raw message to sign. // forceGMSign - if use GM specific sign logic, if yes, should pass raw message to sign.
// uid - if forceGMSign is true, then you can pass uid, if no uid is provided, system will use default one. // uid - if forceGMSign is true, then you can pass uid, if no uid is provided, system will use default one.
func NewSM2SignerOption(forceGMSign bool, uid []byte) *SM2SignerOption { func NewSM2SignerOption(forceGMSign bool, uid []byte) *SM2SignerOption {
@ -138,6 +140,9 @@ func NewSM2SignerOption(forceGMSign bool, uid []byte) *SM2SignerOption {
return opt return opt
} }
// DefaultSM2SignerOpts uses default UID and forceGMSign is true.
var DefaultSM2SignerOpts = NewSM2SignerOption(true, nil)
func (*SM2SignerOption) HashFunc() crypto.Hash { func (*SM2SignerOption) HashFunc() crypto.Hash {
return directSigning return directSigning
} }
@ -171,8 +176,7 @@ func bigIntEqual(a, b *big.Int) bool {
// digest argument will be treated as raw data and UID will be taken from opts. // digest argument will be treated as raw data and UID will be taken from opts.
// //
// This method implements crypto.Signer, which is an interface to support keys // This method implements crypto.Signer, which is an interface to support keys
// where the private part is kept in, for example, a hardware module. Common // where the private part is kept in, for example, a hardware module.
// uses can use the SignASN1 function in this package directly.
func (priv *PrivateKey) Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) ([]byte, error) { func (priv *PrivateKey) Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) ([]byte, error) {
return SignASN1(rand, priv, digest, opts) return SignASN1(rand, priv, digest, opts)
} }
@ -446,7 +450,9 @@ func parseCiphertextASN1(c *sm2Curve, ciphertext []byte) (*_sm2ec.SM2P256Point,
var defaultUID = []byte{0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38} var defaultUID = []byte{0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38}
// CalculateZA ZA = H256(ENTLA || IDA || a || b || xG || yG || xA || yA). // CalculateZA ZA = H256(ENTLA || IDA || a || b || xG || yG || xA || yA).
// Compliance with GB/T 32918.2-2016 5.5 // Compliance with GB/T 32918.2-2016 5.5.
//
// This function will not use default UID even the uid argument is empty.
func CalculateZA(pub *ecdsa.PublicKey, uid []byte) ([]byte, error) { func CalculateZA(pub *ecdsa.PublicKey, uid []byte) ([]byte, error) {
uidLen := len(uid) uidLen := len(uid)
if uidLen >= 0x2000 { if uidLen >= 0x2000 {
@ -486,7 +492,9 @@ func calculateSM2Hash(pub *ecdsa.PublicKey, data, uid []byte) ([]byte, error) {
// using the private key, priv. If the hash is longer than the bit-length of the // using the private key, priv. If the hash is longer than the bit-length of the
// private key's curve order, the hash will be truncated to that length. It // private key's curve order, the hash will be truncated to that length. It
// returns the ASN.1 encoded signature. // returns the ASN.1 encoded signature.
// It invokes priv.Sign directly. //
// If the opts argument is instance of [*SM2SignerOption], and its ForceGMSign is true,
// then the hash will be treated as raw message.
func SignASN1(rand io.Reader, priv *PrivateKey, hash []byte, opts crypto.SignerOpts) ([]byte, error) { func SignASN1(rand io.Reader, priv *PrivateKey, hash []byte, opts crypto.SignerOpts) ([]byte, error) {
if sm2Opts, ok := opts.(*SM2SignerOption); ok && sm2Opts.ForceGMSign { if sm2Opts, ok := opts.(*SM2SignerOption); ok && sm2Opts.ForceGMSign {
newHash, err := calculateSM2Hash(&priv.PublicKey, hash, sm2Opts.UID) newHash, err := calculateSM2Hash(&priv.PublicKey, hash, sm2Opts.UID)
@ -605,7 +613,8 @@ func addASN1IntBytes(b *cryptobyte.Builder, bytes []byte) {
// public key, pub. Its return value records whether the signature is valid. // public key, pub. Its return value records whether the signature is valid.
// //
// Compliance with GB/T 32918.2-2016 regardless it's SM2 curve or not. // Compliance with GB/T 32918.2-2016 regardless it's SM2 curve or not.
// Caller should make sure the hash's correctness. // Caller should make sure the hash's correctness, in other words,
// the caller must pre-calculate the hash value.
func VerifyASN1(pub *ecdsa.PublicKey, hash, sig []byte) bool { func VerifyASN1(pub *ecdsa.PublicKey, hash, sig []byte) bool {
switch pub.Curve.Params() { switch pub.Curve.Params() {
case P256().Params(): case P256().Params():
@ -668,7 +677,7 @@ func verifySM2EC(c *sm2Curve, pub *ecdsa.PublicKey, hash, sig []byte) bool {
} }
// VerifyASN1WithSM2 verifies the signature in ASN.1 encoding format sig of raw msg // VerifyASN1WithSM2 verifies the signature in ASN.1 encoding format sig of raw msg
// and uid using the public key, pub. // and uid using the public key, pub. The uid can be empty, meaning to use the default value.
// //
// It returns value records whether the signature is valid. Compliance with GB/T 32918.2-2016. // It returns value records whether the signature is valid. Compliance with GB/T 32918.2-2016.
func VerifyASN1WithSM2(pub *ecdsa.PublicKey, uid, msg, sig []byte) bool { func VerifyASN1WithSM2(pub *ecdsa.PublicKey, uid, msg, sig []byte) bool {
@ -780,7 +789,7 @@ func IsSM2PublicKey(publicKey interface{}) bool {
return ok && pub.Curve == sm2ec.P256() return ok && pub.Curve == sm2ec.P256()
} }
// P256 return sm2 curve signleton, this function is for backward compatibility. // P256 returns sm2 curve signleton, this function is for backward compatibility.
func P256() elliptic.Curve { func P256() elliptic.Curve {
return sm2ec.P256() return sm2ec.P256()
} }

8
smx509/x509.go
View File

@ -1513,7 +1513,7 @@ func CreateCertificate(rand io.Reader, template, parent, pub, priv interface{})
Hash: hashFunc, Hash: hashFunc,
} }
} else if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) { } else if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) {
signerOpts = sm2.NewSM2SignerOption(true, nil) signerOpts = sm2.DefaultSM2SignerOpts
} }
signature, err = key.Sign(rand, signed, signerOpts) signature, err = key.Sign(rand, signed, signerOpts)
if err != nil { if err != nil {
@ -1612,7 +1612,7 @@ func (c *Certificate) CreateCRL(rand io.Reader, priv interface{}, revokedCerts [
signed := tbsCertListContents signed := tbsCertListContents
var opts crypto.SignerOpts = hashFunc var opts crypto.SignerOpts = hashFunc
if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) { if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) {
opts = sm2.NewSM2SignerOption(true, nil) opts = sm2.DefaultSM2SignerOpts
} }
if hashFunc != 0 { if hashFunc != 0 {
h := hashFunc.New() h := hashFunc.New()
@ -1899,7 +1899,7 @@ func CreateCertificateRequest(rand io.Reader, template *x509.CertificateRequest,
signed = h.Sum(nil) signed = h.Sum(nil)
} }
if sigAlgo.Algorithm.Equal(oidSignatureSM2WithSM3) { if sigAlgo.Algorithm.Equal(oidSignatureSM2WithSM3) {
opts = sm2.NewSM2SignerOption(true, nil) opts = sm2.DefaultSM2SignerOpts
} }
var signature []byte var signature []byte
@ -2130,7 +2130,7 @@ func CreateRevocationList(rand io.Reader, template *x509.RevocationList, issuer
Hash: hashFunc, Hash: hashFunc,
} }
} else if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) { } else if signatureAlgorithm.Algorithm.Equal(oidSignatureSM2WithSM3) {
signerOpts = sm2.NewSM2SignerOption(true, nil) signerOpts = sm2.DefaultSM2SignerOpts
} }
signature, err := priv.Sign(rand, input, signerOpts) signature, err := priv.Sign(rand, input, signerOpts)