api documentation for elliptic (v6.4.0)

EC cryptography

table of contents

  1. module elliptic
    1. function elliptic.curve.base (type, conf)
    2. function elliptic.curve.edwards (conf)
    3. function elliptic.curve.mont (conf)
    4. function elliptic.curve.short (conf)
    5. function elliptic.ec (options)
    6. function elliptic.eddsa (curve)
    7. function elliptic.key (ec, options)
    8. function elliptic.rand (len)
    9. function elliptic.rand.Rand (rand)
    10. function elliptic.signature (options, enc)
    11. function elliptic.utils.assert (val, msg)
    12. object elliptic.curve
    13. object elliptic.curve.base.BasePoint.prototype
    14. object elliptic.curve.base.prototype
    15. object elliptic.curve.edwards.prototype
    16. object elliptic.curve.mont.prototype
    17. object elliptic.curve.short.prototype
    18. object elliptic.curves
    19. object elliptic.curves.curve25519
    20. object elliptic.curves.curve25519.hash.prototype
    21. object elliptic.curves.ed25519
    22. object elliptic.curves.p192
    23. object elliptic.curves.p224
    24. object elliptic.curves.p256
    25. object elliptic.curves.p384
    26. object elliptic.curves.p384.hash.prototype
    27. object elliptic.curves.p521
    28. object elliptic.curves.p521.hash.prototype
    29. object elliptic.curves.secp256k1
    30. object elliptic.ec.prototype
    31. object elliptic.eddsa.prototype
    32. object elliptic.key.prototype
    33. object elliptic.rand.Rand.prototype
    34. object elliptic.signature.prototype
    35. object elliptic.utils
    36. string elliptic.version
  2. module elliptic.curve
    1. function elliptic.curve.base (type, conf)
    2. function elliptic.curve.edwards (conf)
    3. function elliptic.curve.mont (conf)
    4. function elliptic.curve.short (conf)
  3. module elliptic.curve.base
    1. function elliptic.curve.base (type, conf)
    2. function elliptic.curve.base.BasePoint (curve, type)
  4. module elliptic.curve.base.BasePoint.prototype
    1. function elliptic.curve.base.BasePoint.prototype._encode (compact)
    2. function elliptic.curve.base.BasePoint.prototype._getBeta ()
    3. function elliptic.curve.base.BasePoint.prototype._getDoubles (step, power)
    4. function elliptic.curve.base.BasePoint.prototype._getNAFPoints (wnd)
    5. function elliptic.curve.base.BasePoint.prototype._hasDoubles (k)
    6. function elliptic.curve.base.BasePoint.prototype.dblp (k)
    7. function elliptic.curve.base.BasePoint.prototype.encode (enc, compact)
    8. function elliptic.curve.base.BasePoint.prototype.encodeCompressed (enc)
    9. function elliptic.curve.base.BasePoint.prototype.eq ()
    10. function elliptic.curve.base.BasePoint.prototype.precompute (power)
    11. function elliptic.curve.base.BasePoint.prototype.validate ()
  5. module elliptic.curve.base.prototype
    1. function elliptic.curve.base.prototype._fixedNafMul (p, k)
    2. function elliptic.curve.base.prototype._wnafMul (p, k)
    3. function elliptic.curve.base.prototype._wnafMulAdd (defW, points, coeffs, len, jacobianResult)
    4. function elliptic.curve.base.prototype.decodePoint (bytes, enc)
    5. function elliptic.curve.base.prototype.point ()
    6. function elliptic.curve.base.prototype.validate ()
  6. module elliptic.curve.edwards
    1. function elliptic.curve.edwards (conf)
    2. function elliptic.curve.edwards.super_ (type, conf)
  7. module elliptic.curve.edwards.prototype
    1. function elliptic.curve.edwards.prototype._mulA (num)
    2. function elliptic.curve.edwards.prototype._mulC (num)
    3. function elliptic.curve.edwards.prototype.jpoint (x, y, z, t)
    4. function elliptic.curve.edwards.prototype.point (x, y, z, t)
    5. function elliptic.curve.edwards.prototype.pointFromJSON (obj)
    6. function elliptic.curve.edwards.prototype.pointFromX (x, odd)
    7. function elliptic.curve.edwards.prototype.pointFromY (y, odd)
    8. function elliptic.curve.edwards.prototype.validate (point)
  8. module elliptic.curve.mont
    1. function elliptic.curve.mont (conf)
    2. function elliptic.curve.mont.super_ (type, conf)
  9. module elliptic.curve.mont.prototype
    1. function elliptic.curve.mont.prototype.decodePoint (bytes, enc)
    2. function elliptic.curve.mont.prototype.point (x, z)
    3. function elliptic.curve.mont.prototype.pointFromJSON (obj)
    4. function elliptic.curve.mont.prototype.validate (point)
  10. module elliptic.curve.short
    1. function elliptic.curve.short (conf)
    2. function elliptic.curve.short.super_ (type, conf)
  11. module elliptic.curve.short.prototype
    1. function elliptic.curve.short.prototype._endoSplit (k)
    2. function elliptic.curve.short.prototype._endoWnafMulAdd (points, coeffs, jacobianResult)
    3. function elliptic.curve.short.prototype._getEndoBasis (lambda)
    4. function elliptic.curve.short.prototype._getEndoRoots (num)
    5. function elliptic.curve.short.prototype._getEndomorphism (conf)
    6. function elliptic.curve.short.prototype.jpoint (x, y, z)
    7. function elliptic.curve.short.prototype.point (x, y, isRed)
    8. function elliptic.curve.short.prototype.pointFromJSON (obj, red)
    9. function elliptic.curve.short.prototype.pointFromX (x, odd)
    10. function elliptic.curve.short.prototype.validate (point)
  12. module elliptic.curves
    1. function elliptic.curves.PresetCurve (options)
    2. object elliptic.curves.curve25519
    3. object elliptic.curves.ed25519
    4. object elliptic.curves.p192
    5. object elliptic.curves.p224
    6. object elliptic.curves.p256
    7. object elliptic.curves.p384
    8. object elliptic.curves.p521
    9. object elliptic.curves.secp256k1
  13. module elliptic.curves.curve25519
    1. function elliptic.curves.curve25519.hash ()
    2. object elliptic.curves.curve25519.curve
    3. object elliptic.curves.curve25519.g
    4. object elliptic.curves.curve25519.n
  14. module elliptic.curves.curve25519.hash.prototype
    1. function elliptic.curves.curve25519.hash.prototype._digest (enc)
    2. function elliptic.curves.curve25519.hash.prototype._update (msg, start)
  15. module elliptic.curves.ed25519
    1. function elliptic.curves.ed25519.hash ()
    2. object elliptic.curves.ed25519.curve
    3. object elliptic.curves.ed25519.g
    4. object elliptic.curves.ed25519.n
  16. module elliptic.curves.p192
    1. function elliptic.curves.p192.hash ()
    2. object elliptic.curves.p192.curve
    3. object elliptic.curves.p192.g
    4. object elliptic.curves.p192.n
  17. module elliptic.curves.p224
    1. function elliptic.curves.p224.hash ()
    2. object elliptic.curves.p224.curve
    3. object elliptic.curves.p224.g
    4. object elliptic.curves.p224.n
  18. module elliptic.curves.p256
    1. function elliptic.curves.p256.hash ()
    2. object elliptic.curves.p256.curve
    3. object elliptic.curves.p256.g
    4. object elliptic.curves.p256.n
  19. module elliptic.curves.p384
    1. function elliptic.curves.p384.hash ()
    2. object elliptic.curves.p384.curve
    3. object elliptic.curves.p384.g
    4. object elliptic.curves.p384.n
  20. module elliptic.curves.p384.hash.prototype
    1. function elliptic.curves.p384.hash.prototype._digest (enc)
  21. module elliptic.curves.p521
    1. function elliptic.curves.p521.hash ()
    2. object elliptic.curves.p521.curve
    3. object elliptic.curves.p521.g
    4. object elliptic.curves.p521.n
  22. module elliptic.curves.p521.hash.prototype
    1. function elliptic.curves.p521.hash.prototype._digest (enc)
    2. function elliptic.curves.p521.hash.prototype._prepareBlock (msg, start)
    3. function elliptic.curves.p521.hash.prototype._update (msg, start)
  23. module elliptic.curves.secp256k1
    1. function elliptic.curves.secp256k1.hash ()
    2. object elliptic.curves.secp256k1.curve
    3. object elliptic.curves.secp256k1.g
    4. object elliptic.curves.secp256k1.n
  24. module elliptic.ec
    1. function elliptic.ec (options)
  25. module elliptic.ec.prototype
    1. function elliptic.ec.prototype._truncateToN (msg, truncOnly)
    2. function elliptic.ec.prototype.genKeyPair (options)
    3. function elliptic.ec.prototype.getKeyRecoveryParam (e, signature, Q, enc)
    4. function elliptic.ec.prototype.keyFromPrivate (priv, enc)
    5. function elliptic.ec.prototype.keyFromPublic (pub, enc)
    6. function elliptic.ec.prototype.keyPair (options)
    7. function elliptic.ec.prototype.recoverPubKey (msg, signature, j, enc)
    8. function elliptic.ec.prototype.sign (msg, key, enc, options)
    9. function elliptic.ec.prototype.verify (msg, signature, key, enc)
  26. module elliptic.eddsa
    1. function elliptic.eddsa (curve)
  27. module elliptic.eddsa.prototype
    1. function elliptic.eddsa.prototype.decodeInt (bytes)
    2. function elliptic.eddsa.prototype.decodePoint (bytes)
    3. function elliptic.eddsa.prototype.encodeInt (num)
    4. function elliptic.eddsa.prototype.encodePoint (point)
    5. function elliptic.eddsa.prototype.hashInt ()
    6. function elliptic.eddsa.prototype.isPoint (val)
    7. function elliptic.eddsa.prototype.keyFromPublic (pub)
    8. function elliptic.eddsa.prototype.keyFromSecret (secret)
    9. function elliptic.eddsa.prototype.makeSignature (sig)
    10. function elliptic.eddsa.prototype.sign (message, secret)
    11. function elliptic.eddsa.prototype.verify (message, sig, pub)
  28. module elliptic.key
    1. function elliptic.key (ec, options)
    2. function elliptic.key.fromPrivate (ec, priv, enc)
    3. function elliptic.key.fromPublic (ec, pub, enc)
  29. module elliptic.key.prototype
    1. function elliptic.key.prototype._importPrivate (key, enc)
    2. function elliptic.key.prototype._importPublic (key, enc)
    3. function elliptic.key.prototype.derive (pub)
    4. function elliptic.key.prototype.getPrivate (enc)
    5. function elliptic.key.prototype.getPublic (compact, enc)
    6. function elliptic.key.prototype.inspect ()
    7. function elliptic.key.prototype.sign (msg, enc, options)
    8. function elliptic.key.prototype.validate ()
    9. function elliptic.key.prototype.verify (msg, signature)
  30. module elliptic.rand
    1. function elliptic.rand (len)
    2. function elliptic.rand.Rand (rand)
  31. module elliptic.rand.Rand
    1. function elliptic.rand.Rand (rand)
  32. module elliptic.rand.Rand.prototype
    1. function elliptic.rand.Rand.prototype._rand (n)
    2. function elliptic.rand.Rand.prototype.generate (len)
  33. module elliptic.signature
    1. function elliptic.signature (options, enc)
  34. module elliptic.signature.prototype
    1. function elliptic.signature.prototype._importDER (data, enc)
    2. function elliptic.signature.prototype.toDER (enc)
  35. module elliptic.utils
    1. function elliptic.utils.assert (val, msg)
    2. function elliptic.utils.cachedProperty (obj, name, computer)
    3. function elliptic.utils.encode (arr, enc)
    4. function elliptic.utils.getJSF (k1, k2)
    5. function elliptic.utils.getNAF (num, w)
    6. function elliptic.utils.intFromLE (bytes)
    7. function elliptic.utils.parseBytes (bytes)
    8. function elliptic.utils.toArray (msg, enc)
    9. function elliptic.utils.toHex (msg)
    10. function elliptic.utils.zero2 (word)
  36. module elliptic.utils.assert
    1. function elliptic.utils.assert (val, msg)
    2. function elliptic.utils.assert.equal (l, r, msg)

module elliptic

function elliptic.curve.base (type, conf)

function elliptic.curve.edwards (conf)

function elliptic.curve.mont (conf)

function elliptic.curve.short (conf)

function elliptic.ec (options)

function elliptic.eddsa (curve)

function elliptic.key (ec, options)

function elliptic.rand (len)

function elliptic.rand.Rand (rand)

function elliptic.signature (options, enc)

function elliptic.utils.assert (val, msg)

module elliptic.curve

function elliptic.curve.base (type, conf)

function elliptic.curve.edwards (conf)

function elliptic.curve.mont (conf)

function elliptic.curve.short (conf)

module elliptic.curve.base

function elliptic.curve.base (type, conf)

function elliptic.curve.base.BasePoint (curve, type)

module elliptic.curve.base.BasePoint.prototype

function elliptic.curve.base.BasePoint.prototype._encode (compact)

function elliptic.curve.base.BasePoint.prototype._getBeta ()

function elliptic.curve.base.BasePoint.prototype._getDoubles (step, power)

function elliptic.curve.base.BasePoint.prototype._getNAFPoints (wnd)

function elliptic.curve.base.BasePoint.prototype._hasDoubles (k)

function elliptic.curve.base.BasePoint.prototype.dblp (k)

function elliptic.curve.base.BasePoint.prototype.encode (enc, compact)

function elliptic.curve.base.BasePoint.prototype.encodeCompressed (enc)

function elliptic.curve.base.BasePoint.prototype.eq ()

function elliptic.curve.base.BasePoint.prototype.precompute (power)

function elliptic.curve.base.BasePoint.prototype.validate ()

module elliptic.curve.base.prototype

function elliptic.curve.base.prototype._fixedNafMul (p, k)

function elliptic.curve.base.prototype._wnafMul (p, k)

function elliptic.curve.base.prototype._wnafMulAdd (defW, points, coeffs, len, jacobianResult)

function elliptic.curve.base.prototype.decodePoint (bytes, enc)

function elliptic.curve.base.prototype.point ()

function elliptic.curve.base.prototype.validate ()

module elliptic.curve.edwards

function elliptic.curve.edwards (conf)

function elliptic.curve.edwards.super_ (type, conf)

module elliptic.curve.edwards.prototype

function elliptic.curve.edwards.prototype._mulA (num)

function elliptic.curve.edwards.prototype._mulC (num)

function elliptic.curve.edwards.prototype.jpoint (x, y, z, t)

function elliptic.curve.edwards.prototype.point (x, y, z, t)

function elliptic.curve.edwards.prototype.pointFromJSON (obj)

function elliptic.curve.edwards.prototype.pointFromX (x, odd)

function elliptic.curve.edwards.prototype.pointFromY (y, odd)

function elliptic.curve.edwards.prototype.validate (point)

module elliptic.curve.mont

function elliptic.curve.mont (conf)

function elliptic.curve.mont.super_ (type, conf)

module elliptic.curve.mont.prototype

function elliptic.curve.mont.prototype.decodePoint (bytes, enc)

function elliptic.curve.mont.prototype.point (x, z)

function elliptic.curve.mont.prototype.pointFromJSON (obj)

function elliptic.curve.mont.prototype.validate (point)

module elliptic.curve.short

function elliptic.curve.short (conf)

function elliptic.curve.short.super_ (type, conf)

module elliptic.curve.short.prototype

function elliptic.curve.short.prototype._endoSplit (k)

function elliptic.curve.short.prototype._endoWnafMulAdd (points, coeffs, jacobianResult)

function elliptic.curve.short.prototype._getEndoBasis (lambda)

function elliptic.curve.short.prototype._getEndoRoots (num)

function elliptic.curve.short.prototype._getEndomorphism (conf)

function elliptic.curve.short.prototype.jpoint (x, y, z)

function elliptic.curve.short.prototype.point (x, y, isRed)

function elliptic.curve.short.prototype.pointFromJSON (obj, red)

function elliptic.curve.short.prototype.pointFromX (x, odd)

function elliptic.curve.short.prototype.validate (point)

module elliptic.curves

function elliptic.curves.PresetCurve (options)

module elliptic.curves.curve25519

function elliptic.curves.curve25519.hash ()

module elliptic.curves.curve25519.hash.prototype

function elliptic.curves.curve25519.hash.prototype._digest (enc)

function elliptic.curves.curve25519.hash.prototype._update (msg, start)

module elliptic.curves.ed25519

function elliptic.curves.ed25519.hash ()

module elliptic.curves.p192

function elliptic.curves.p192.hash ()

module elliptic.curves.p224

function elliptic.curves.p224.hash ()

module elliptic.curves.p256

function elliptic.curves.p256.hash ()

module elliptic.curves.p384

function elliptic.curves.p384.hash ()

module elliptic.curves.p384.hash.prototype

function elliptic.curves.p384.hash.prototype._digest (enc)

module elliptic.curves.p521

function elliptic.curves.p521.hash ()

module elliptic.curves.p521.hash.prototype

function elliptic.curves.p521.hash.prototype._digest (enc)

function elliptic.curves.p521.hash.prototype._prepareBlock (msg, start)

function elliptic.curves.p521.hash.prototype._update (msg, start)

module elliptic.curves.secp256k1

function elliptic.curves.secp256k1.hash ()

module elliptic.ec

function elliptic.ec (options)

module elliptic.ec.prototype

function elliptic.ec.prototype._truncateToN (msg, truncOnly)

function elliptic.ec.prototype.genKeyPair (options)

function elliptic.ec.prototype.getKeyRecoveryParam (e, signature, Q, enc)

function elliptic.ec.prototype.keyFromPrivate (priv, enc)

function elliptic.ec.prototype.keyFromPublic (pub, enc)

function elliptic.ec.prototype.keyPair (options)

function elliptic.ec.prototype.recoverPubKey (msg, signature, j, enc)

function elliptic.ec.prototype.sign (msg, key, enc, options)

function elliptic.ec.prototype.verify (msg, signature, key, enc)

module elliptic.eddsa

function elliptic.eddsa (curve)

module elliptic.eddsa.prototype

function elliptic.eddsa.prototype.decodeInt (bytes)

function elliptic.eddsa.prototype.decodePoint (bytes)

function elliptic.eddsa.prototype.encodeInt (num)

function elliptic.eddsa.prototype.encodePoint (point)

function elliptic.eddsa.prototype.hashInt ()

function elliptic.eddsa.prototype.isPoint (val)

function elliptic.eddsa.prototype.keyFromPublic (pub)

function elliptic.eddsa.prototype.keyFromSecret (secret)

function elliptic.eddsa.prototype.makeSignature (sig)

function elliptic.eddsa.prototype.sign (message, secret)

function elliptic.eddsa.prototype.verify (message, sig, pub)

module elliptic.key

function elliptic.key (ec, options)

function elliptic.key.fromPrivate (ec, priv, enc)

function elliptic.key.fromPublic (ec, pub, enc)

module elliptic.key.prototype

function elliptic.key.prototype._importPrivate (key, enc)

function elliptic.key.prototype._importPublic (key, enc)

function elliptic.key.prototype.derive (pub)

function elliptic.key.prototype.getPrivate (enc)

function elliptic.key.prototype.getPublic (compact, enc)

function elliptic.key.prototype.inspect ()

function elliptic.key.prototype.sign (msg, enc, options)

function elliptic.key.prototype.validate ()

function elliptic.key.prototype.verify (msg, signature)

module elliptic.rand

function elliptic.rand (len)

function elliptic.rand.Rand (rand)

module elliptic.rand.Rand

function elliptic.rand.Rand (rand)

module elliptic.rand.Rand.prototype

function elliptic.rand.Rand.prototype._rand (n)

function elliptic.rand.Rand.prototype.generate (len)

module elliptic.signature

function elliptic.signature (options, enc)

module elliptic.signature.prototype

function elliptic.signature.prototype._importDER (data, enc)

function elliptic.signature.prototype.toDER (enc)

module elliptic.utils

function elliptic.utils.assert (val, msg)

function elliptic.utils.cachedProperty (obj, name, computer)

function elliptic.utils.encode (arr, enc)

function elliptic.utils.getJSF (k1, k2)

function elliptic.utils.getNAF (num, w)

function elliptic.utils.intFromLE (bytes)

function elliptic.utils.parseBytes (bytes)

function elliptic.utils.toArray (msg, enc)

function elliptic.utils.toHex (msg)

function elliptic.utils.zero2 (word)

module elliptic.utils.assert

function elliptic.utils.assert (val, msg)

function elliptic.utils.assert.equal (l, r, msg)

[ this document was created with utility2 ]