go1.20.5
GoThrough

elliptic.Curve

// A Curve represents a short-form Weierstrass curve with a=-3. // // The behavior of Add, Double, and ScalarMult when the input is not a point on // the curve is undefined. // // Note that the conventional point at infinity (0, 0) is not considered on the // curve, although it can be returned by Add, Double, ScalarMult, or // ScalarBaseMult (but not the Unmarshal or UnmarshalCompressed functions). type Curve interface { // Params returns the parameters for the curve. Params() *CurveParams // IsOnCurve reports whether the given (x,y) lies on the curve. // // Note: this is a low-level unsafe API. For ECDH, use the crypto/ecdh // package. The NewPublicKey methods of NIST curves in crypto/ecdh accept // the same encoding as the Unmarshal function, and perform on-curve checks. IsOnCurve(x *big.Int, y *big.Int) bool // Add returns the sum of (x1,y1) and (x2,y2). // // Note: this is a low-level unsafe API. Add(x1 *big.Int, y1 *big.Int, x2 *big.Int, y2 *big.Int) (x *big.Int, y *big.Int) // Double returns 2*(x,y). // // Note: this is a low-level unsafe API. Double(x1 *big.Int, y1 *big.Int) (x *big.Int, y *big.Int) // ScalarMult returns k*(x,y) where k is an integer in big-endian form. // // Note: this is a low-level unsafe API. For ECDH, use the crypto/ecdh // package. Most uses of ScalarMult can be replaced by a call to the ECDH // methods of NIST curves in crypto/ecdh. ScalarMult(x1 *big.Int, y1 *big.Int, k []byte) (x *big.Int, y *big.Int) // ScalarBaseMult returns k*G, where G is the base point of the group // and k is an integer in big-endian form. // // Note: this is a low-level unsafe API. For ECDH, use the crypto/ecdh // package. Most uses of ScalarBaseMult can be replaced by a call to the // PrivateKey.PublicKey method in crypto/ecdh. ScalarBaseMult(k []byte) (x *big.Int, y *big.Int) }

elliptic.GenerateKey

// GenerateKey returns a public/private key pair. The private key is // generated using the given reader, which must return random data. // // Note: for ECDH, use the GenerateKey methods of the crypto/ecdh package; // for ECDSA, use the GenerateKey function of the crypto/ecdsa package. func GenerateKey(curve Curve, rand io.Reader) (priv []byte, x *big.Int, y *big.Int, err error)

elliptic.Marshal

// Marshal converts a point on the curve into the uncompressed form specified in // SEC 1, Version 2.0, Section 2.3.3. If the point is not on the curve (or is // the conventional point at infinity), the behavior is undefined. // // Note: for ECDH, use the crypto/ecdh package. This function returns an // encoding equivalent to that of PublicKey.Bytes in crypto/ecdh. func Marshal(curve Curve, x *big.Int, y *big.Int) []byte

elliptic.MarshalCompressed

// MarshalCompressed converts a point on the curve into the compressed form // specified in SEC 1, Version 2.0, Section 2.3.3. If the point is not on the // curve (or is the conventional point at infinity), the behavior is undefined. func MarshalCompressed(curve Curve, x *big.Int, y *big.Int) []byte

elliptic.P224

// P224 returns a Curve which implements NIST P-224 (FIPS 186-3, section D.2.2), // also known as secp224r1. The CurveParams.Name of this Curve is "P-224". // // Multiple invocations of this function will return the same value, so it can // be used for equality checks and switch statements. // // The cryptographic operations are implemented using constant-time algorithms. func P224() Curve

elliptic.P256

// P256 returns a Curve which implements NIST P-256 (FIPS 186-3, section D.2.3), // also known as secp256r1 or prime256v1. The CurveParams.Name of this Curve is // "P-256". // // Multiple invocations of this function will return the same value, so it can // be used for equality checks and switch statements. // // The cryptographic operations are implemented using constant-time algorithms. func P256() Curve

elliptic.P384

// P384 returns a Curve which implements NIST P-384 (FIPS 186-3, section D.2.4), // also known as secp384r1. The CurveParams.Name of this Curve is "P-384". // // Multiple invocations of this function will return the same value, so it can // be used for equality checks and switch statements. // // The cryptographic operations are implemented using constant-time algorithms. func P384() Curve

elliptic.P521

// P521 returns a Curve which implements NIST P-521 (FIPS 186-3, section D.2.5), // also known as secp521r1. The CurveParams.Name of this Curve is "P-521". // // Multiple invocations of this function will return the same value, so it can // be used for equality checks and switch statements. // // The cryptographic operations are implemented using constant-time algorithms. func P521() Curve

elliptic.Unmarshal

// Unmarshal converts a point, serialized by Marshal, into an x, y pair. It is // an error if the point is not in uncompressed form, is not on the curve, or is // the point at infinity. On error, x = nil. // // Note: for ECDH, use the crypto/ecdh package. This function accepts an // encoding equivalent to that of the NewPublicKey methods in crypto/ecdh. func Unmarshal(curve Curve, data []byte) (x *big.Int, y *big.Int)

elliptic.UnmarshalCompressed

// UnmarshalCompressed converts a point, serialized by MarshalCompressed, into // an x, y pair. It is an error if the point is not in compressed form, is not // on the curve, or is the point at infinity. On error, x = nil. func UnmarshalCompressed(curve Curve, data []byte) (x *big.Int, y *big.Int)