mirror/gmsm
1
0
Fork 0
mirror of https://github.com/emmansun/gmsm.git synced 2025-04-27 12:46:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

ecdh: update comments

Browse Source
This commit is contained in:
Sun Yimin 2024-11-26 17:48:32 +08:00 committed by GitHub
parent 9fd122e614
commit dec688f7cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
ecdh/ecdh.go
View File

@ -5,6 +5,7 @@ package ecdh
import ( import (
"crypto" "crypto"
"crypto/subtle" "crypto/subtle"
"errors"
"hash" "hash"
"io" "io"
"sync" "sync"
@ -13,7 +14,11 @@ import (
) )
type Curve interface { type Curve interface {
// GenerateKey generates a new PrivateKey from rand. // GenerateKey generates a random PrivateKey.
//
// Most applications should use [crypto/rand.Reader] as rand. Note that the
// returned key does not depend deterministically on the bytes read from rand,
// and may change between calls and/or between versions.
GenerateKey(rand io.Reader) (*PrivateKey, error) GenerateKey(rand io.Reader) (*PrivateKey, error)
// NewPrivateKey checks that key is valid and returns a PrivateKey. // NewPrivateKey checks that key is valid and returns a PrivateKey.
@ -108,7 +113,7 @@ func (k *PublicKey) SM2ZA(md hash.Hash, uid []byte) ([]byte, error) {
return k.curve.sm2za(md, k, uid) return k.curve.sm2za(md, k, uid)
} }
// SM2SharedKey performs SM2 key derivation to generate shared keying data, the uv was generated by SM2MQV. // SM2SharedKey performs SM2 key derivation to generate shared keying data, the uv was generated by [SM2MQV].
func (uv *PublicKey) SM2SharedKey(isResponder bool, kenLen int, sPub, sRemote *PublicKey, uid []byte, remoteUID []byte) ([]byte, error) { func (uv *PublicKey) SM2SharedKey(isResponder bool, kenLen int, sPub, sRemote *PublicKey, uid []byte, remoteUID []byte) ([]byte, error) {
var buffer [128]byte var buffer [128]byte
copy(buffer[:], uv.publicKey[1:]) copy(buffer[:], uv.publicKey[1:])
@ -154,11 +159,17 @@ type PrivateKey struct {
// For X25519, this performs ECDH as specified in RFC 7748, Section 6.1. If // For X25519, this performs ECDH as specified in RFC 7748, Section 6.1. If
// the result is the all-zero value, ECDH returns an error. // the result is the all-zero value, ECDH returns an error.
func (k *PrivateKey) ECDH(remote *PublicKey) ([]byte, error) { func (k *PrivateKey) ECDH(remote *PublicKey) ([]byte, error) {
if k.curve != remote.curve {
return nil, errors.New("ecdh: private key and public key curves do not match")
}
return k.curve.ecdh(k, remote) return k.curve.ecdh(k, remote)
} }
// SM2MQV performs a SM2 specific style ECMQV exchange and return the shared secret. // SM2MQV performs a SM2 specific style ECMQV exchange and return the shared secret.
func (k *PrivateKey) SM2MQV(eLocal *PrivateKey, sRemote, eRemote *PublicKey) (*PublicKey, error) { func (k *PrivateKey) SM2MQV(eLocal *PrivateKey, sRemote, eRemote *PublicKey) (*PublicKey, error) {
if k.curve != eLocal.curve || k.curve != sRemote.curve || k.curve != eRemote.curve {
return nil, errors.New("ecdh: private key and public key curves do not match")
}
return k.curve.sm2mqv(k, eLocal, sRemote, eRemote) return k.curve.sm2mqv(k, eLocal, sRemote, eRemote)
} }
@ -173,7 +184,7 @@ func (k *PrivateKey) Bytes() []byte {
// Equal returns whether x represents the same private key as k. // Equal returns whether x represents the same private key as k.
// //
// Note that there can be equivalent private keys with different encodings which // Note that there can be equivalent private keys with different encodings which
// would return false from this check but behave the same way as inputs to ECDH. // would return false from this check but behave the same way as inputs to [ECDH].
// //
// This check is performed in constant time as long as the key types and their // This check is performed in constant time as long as the key types and their
// curve match. // curve match.
@ -198,7 +209,7 @@ func (k *PrivateKey) PublicKey() *PublicKey {
} }
// Public implements the implicit interface of all standard library private // Public implements the implicit interface of all standard library private
// keys. See the docs of crypto.PrivateKey. // keys. See the docs of [crypto.PrivateKey].
func (k *PrivateKey) Public() crypto.PublicKey { func (k *PrivateKey) Public() crypto.PublicKey {
return k.PublicKey() return k.PublicKey()
} }

2
ecdh/sm2ec.go
View File

@ -174,7 +174,7 @@ func (c *sm2Curve) sm2za(md hash.Hash, pub *PublicKey, uid []byte) ([]byte, erro
return md.Sum(nil), nil return md.Sum(nil), nil
} }
// P256 returns a Curve which implements SM2, also known as sm2p256v1 // P256 returns a [Curve] which implements SM2, also known as sm2p256v1
// //
// Multiple invocations of this function will return the same value, so it can // Multiple invocations of this function will return the same value, so it can
// be used for equality checks and switch statements. // be used for equality checks and switch statements.