``````package elliptic

Import Path
crypto/elliptic (on golang.org and go.dev)

Dependency Relation
imports 4 packages, and imported by 3 packages

Involved Source Files

d➜ elliptic.go
Package elliptic implements several standard elliptic curves over prime
fields.

p224.go
p256_asm.go
p256_asm_table.go
p521.go
p256_asm_amd64.s
Package-Level Type Names (total 2)

/* sort by: alphabet | popularity */	 type Curve (interface)
A Curve represents a short-form Weierstrass curve with a=-3.

Note that the point at infinity (0, 0) is not considered on the curve, and
although it can be returned by Add, Double, ScalarMult, or ScalarBaseMult, it
can't be marshaled or unmarshaled, and IsOnCurve will return false for it.

Methods (total 6)
( T) Add(x1, y1, x2, y2 *big.Int) (x, y *big.Int)
Add returns the sum of (x1,y1) and (x2,y2)

( T) Double(x1, y1 *big.Int) (x, y *big.Int)
Double returns 2*(x,y)

( T) IsOnCurve(x, y *big.Int) bool
IsOnCurve reports whether the given (x,y) lies on the curve.

( T) Params() *CurveParams
Params returns the parameters for the curve.

( T) ScalarBaseMult(k []byte) (x, 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.

( T) ScalarMult(x1, y1 *big.Int, k []byte) (x, y *big.Int)
ScalarMult returns k*(Bx,By) where k is a number in big-endian form.

Implemented By (at least 3)
*CurveParams
crypto/ecdsa.PrivateKey
crypto/ecdsa.PublicKey
As Outputs Of (at least 4)
func P224() Curve
func P256() Curve
func P384() Curve
func P521() Curve
As Inputs Of (at least 6)
func GenerateKey(curve Curve, rand io.Reader) (priv []byte, x, y *big.Int, err error)
func Marshal(curve Curve, x, y *big.Int) []byte
func MarshalCompressed(curve Curve, x, y *big.Int) []byte
func Unmarshal(curve Curve, data []byte) (x, y *big.Int)
func UnmarshalCompressed(curve Curve, data []byte) (x, y *big.Int)
func crypto/ecdsa.GenerateKey(c Curve, rand io.Reader) (*ecdsa.PrivateKey, error)

type CurveParams (struct)
CurveParams contains the parameters of an elliptic curve and also provides
a generic, non-constant time implementation of Curve.

Fields (total 7)
B *big.Int
// the constant of the curve equation

BitSize int
// the size of the underlying field

Gx *big.Int
// (x,y) of the base point

Gy *big.Int
// (x,y) of the base point

N *big.Int
// the order of the base point

Name string
// the canonical name of the curve

P *big.Int
// the order of the underlying field

Methods (total 6)
(*T) Add(x1, y1, x2, y2 *big.Int) (*big.Int, *big.Int)
(*T) Double(x1, y1 *big.Int) (*big.Int, *big.Int)
(*T) IsOnCurve(x, y *big.Int) bool
(*T) Params() *CurveParams
(*T) ScalarBaseMult(k []byte) (*big.Int, *big.Int)
(*T) ScalarMult(Bx, By *big.Int, k []byte) (*big.Int, *big.Int)
Implements (at least one exported)
*T : Curve
As Outputs Of (at least 2)
func Curve.Params() *CurveParams
func (*CurveParams).Params() *CurveParams

Package-Level Functions (total 9)

func GenerateKey(curve Curve, rand io.Reader) (priv []byte, x, y *big.Int, err error)
GenerateKey returns a public/private key pair. The private key is
generated using the given reader, which must return random data.

func Marshal(curve Curve, x, y *big.Int) []byte
Marshal converts a point on the curve into the uncompressed form specified in
section 4.3.6 of ANSI X9.62.

func MarshalCompressed(curve Curve, x, y *big.Int) []byte
MarshalCompressed converts a point on the curve into the compressed form
specified in section 4.3.6 of ANSI X9.62.

func P224() Curve
P224 returns a Curve which implements P-224 (see FIPS 186-3, section D.2.2).

The cryptographic operations are implemented using constant-time algorithms.

func P256() Curve
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.

ScalarMult and ScalarBaseMult are implemented using constant-time algorithms.

func P384() Curve
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 do not use constant-time algorithms.

func P521() Curve
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 Unmarshal(curve Curve, data []byte) (x, y *big.Int)
Unmarshal converts a point, serialized by Marshal, into an x, y pair.
It is an error if the point is not in uncompressed form or is not on the curve.
On error, x = nil.

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

``````