ex_wire

v0.1.1

ex_wire v0.1.1 ExWire.Protocol

Functions to handle encoding and decoding messages for over the wire transfer.

Link to this section Summary

Functions

encode(message, private_key)

Encodes a given message by appending it to a hash of its contents

sign_binary(value, private_key)

Given a binary, returns an signed version encoded into a binary with signature, recovery id and the message itself

sign_message(message, private_key)

Returns a signed version of a message. This encodes the message type, the encoded message itself, and a signature for the message

Link to this section Functions

Link to this function encode(message, private_key) 
encode(ExWire.Message.t, ExWire.Crypto.private_key) :: binary

Encodes a given message by appending it to a hash of its contents.

Examples 

iex> message = %ExWire.Message.Ping{
...>   version: 1,
...>   from: %ExWire.Struct.Endpoint{ip: [1, 2, 3, 4], tcp_port: 5, udp_port: nil},
...>   to: %ExWire.Struct.Endpoint{ip: [5, 6, 7, 8], tcp_port: nil, udp_port: 6},
...>   timestamp: 4
...> }
iex> ExWire.Protocol.encode(message, <<1::256>>)
<<104, 61, 189, 241, 64, 191, 8, 245, 109, 115, 6, 97, 59, 110, 31, 152, 252,
  162, 30, 138, 113, 255, 207, 36, 58, 151, 75, 222, 78, 137, 173, 70, 175,
  219, 61, 45, 146, 70, 181, 105, 123, 166, 37, 216, 218, 140, 54, 18, 169, 21,
  90, 15, 243, 105, 2, 101, 154, 148, 117, 74, 182, 40, 112, 46, 84, 245, 102,
  67, 159, 38, 71, 218, 230, 40, 55, 83, 200, 180, 236, 192, 53, 50, 235, 198,
  152, 152, 127, 241, 82, 7, 92, 202, 59, 197, 237, 102, 1, 1, 214, 1, 201,
  132, 1, 2, 3, 4, 128, 130, 0, 5, 201, 132, 5, 6, 7, 8, 130, 0, 6, 128, 4>>
Link to this function sign_binary(value, private_key) 
sign_binary(binary, ExWire.Crypto.private_key) :: binary

Given a binary, returns an signed version encoded into a binary with signature, recovery id and the message itself.

Examples 

iex> signature = ExWire.Protocol.sign_binary("mace windu", ExthCrypto.Test.private_key())
iex> ExthCrypto.Signature.verify(ExWire.Crypto.hash("mace windu"), signature, ExthCrypto.Test.public_key())
true
Link to this function sign_message(message, private_key) 
sign_message(ExWire.Message.t, ExWire.Crypto.private_key) :: binary

Returns a signed version of a message. This encodes the message type, the encoded message itself, and a signature for the message.

Examples 

iex> message = %ExWire.Message.Ping{
...>   version: 1,
...>   from: %ExWire.Struct.Endpoint{ip: [1, 2, 3, 4], tcp_port: 5, udp_port: nil},
...>   to: %ExWire.Struct.Endpoint{ip: [5, 6, 7, 8], tcp_port: nil, udp_port: 6},
...>   timestamp: 4
...> }
iex> signature = ExWire.Protocol.sign_message(message, ExthCrypto.Test.private_key())
iex> ExthCrypto.Signature.verify(message |> ExWire.Message.encode |> ExWire.Crypto.hash, signature, ExthCrypto.Test.public_key())
true