rlpx_ecies.ecies.md

@ethereumjs/devp2p / rlpx/ecies / ECIES

Class: ECIES

rlpx/ecies.ECIES

Table of contents

Constructors

• constructor

Properties

• _bodySize
• _egressAes
• _egressMac
• _ephemeralPrivateKey
• _ephemeralPublicKey
• _ephemeralSharedSecret
• _gotEIP8Ack
• _gotEIP8Auth
• _ingressAes
• _ingressMac
• _initMsg
• _nonce
• _privateKey
• _publicKey
• _remoteEphemeralPublicKey
• _remoteInitMsg
• _remoteNonce
• _remotePublicKey

Methods

• _decryptMessage
• _encryptMessage
• _setupFrame
• createAckEIP8
• createAckOld
• createAuthEIP8
• createAuthNonEIP8
• createBody
• createHeader
• parseAckEIP8
• parseAckPlain
• parseAuthEIP8
• parseAuthPlain
• parseBody
• parseHeader

Constructors

constructor

• new ECIES(privateKey, id, remoteId)

Parameters

Name	Type
privateKey	Buffer
id	Buffer
remoteId	Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:73

Properties

_bodySize

• _bodySize: null | number = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:73

---

_egressAes

• _egressAes: null | Decipher = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:66

---

_egressMac

• _egressMac: null | MAC = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:68

---

_ephemeralPrivateKey

• _ephemeralPrivateKey: Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:69

---

_ephemeralPublicKey

• _ephemeralPublicKey: Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:70

---

_ephemeralSharedSecret

• _ephemeralSharedSecret: null | Buffer = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:72

---

_gotEIP8Ack

• _gotEIP8Ack: boolean = false

Defined in

packages/devp2p/src/rlpx/ecies.ts:64

---

_gotEIP8Auth

• _gotEIP8Auth: boolean = false

Defined in

packages/devp2p/src/rlpx/ecies.ts:63

---

_ingressAes

• _ingressAes: null | Decipher = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:65

---

_ingressMac

• _ingressMac: null | MAC = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:67

---

_initMsg

• _initMsg: undefined | null | Buffer = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:61

---

_nonce

• _nonce: Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:59

---

_privateKey

• _privateKey: Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:56

---

_publicKey

• _publicKey: Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:57

---

_remoteEphemeralPublicKey

• _remoteEphemeralPublicKey: null | Buffer = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:71

---

_remoteInitMsg

• _remoteInitMsg: null | Buffer = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:62

---

_remoteNonce

• _remoteNonce: null | Buffer = null

Defined in

packages/devp2p/src/rlpx/ecies.ts:60

---

_remotePublicKey

• _remotePublicKey: null | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:58

Methods

_decryptMessage

▸ _decryptMessage(data, sharedMacData?): Buffer

Parameters

Name	Type	Default value
data	Buffer	undefined
sharedMacData	null | Buffer	null

Returns

Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:112

---

_encryptMessage

▸ _encryptMessage(data, sharedMacData?): undefined | Buffer

Parameters

Name	Type	Default value
data	Buffer	undefined
sharedMacData	null | Buffer	null

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:85

---

_setupFrame

▸ _setupFrame(remoteData, incoming): void

Parameters

Name	Type
remoteData	Buffer
incoming	boolean

Returns

void

Defined in

packages/devp2p/src/rlpx/ecies.ts:147

---

createAckEIP8

▸ createAckEIP8(): undefined | Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:269

---

createAckOld

▸ createAckOld(): undefined | Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:286

---

createAuthEIP8

▸ createAuthEIP8(): undefined | Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:171

---

createAuthNonEIP8

▸ createAuthNonEIP8(): undefined | Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:194

---

createBody

▸ createBody(data): undefined | Buffer

Parameters

Name	Type
data	Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:363

---

createHeader

▸ createHeader(size): undefined | Buffer

Parameters

Name	Type
size	number

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:333

---

parseAckEIP8

▸ parseAckEIP8(data): void

Parameters

Name	Type
data	Buffer

Returns

void

Defined in

packages/devp2p/src/rlpx/ecies.ts:326

---

parseAckPlain

▸ parseAckPlain(data, sharedMacData?): void

Parameters

Name	Type	Default value
data	Buffer	undefined
sharedMacData	null | Buffer	null

Returns

void

Defined in

packages/devp2p/src/rlpx/ecies.ts:296

---

parseAuthEIP8

▸ parseAuthEIP8(data): void

Parameters

Name	Type
data	Buffer

Returns

void

Defined in

packages/devp2p/src/rlpx/ecies.ts:263

---

parseAuthPlain

▸ parseAuthPlain(data, sharedMacData?): undefined | Buffer

Parameters

Name	Type	Default value
data	Buffer	undefined
sharedMacData	null | Buffer	null

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:211

---

parseBody

▸ parseBody(data): undefined | Buffer

Parameters

Name	Type
data	Buffer

Returns

undefined | Buffer

Defined in

packages/devp2p/src/rlpx/ecies.ts:374

---

parseHeader

▸ parseHeader(data): undefined | number

Parameters

Name	Type
data	Buffer

Returns

undefined | number

Defined in

packages/devp2p/src/rlpx/ecies.ts:347