isabella232 / jerboa

STUN/TURN encoder, decoder and client library in Elixir

Jerboa

Documentation

STUN/TURN encoder, decoder and client library by Erlang Solutions

Jerboa aims to provide simple APIs for common STUN/TURN use cases. It is used by Fennec for encoding and decoding of STUN messages, as well as a testing tool.

Installation

Jerboa is available on Hex. To use it, just add it to your dependencies:

def deps do
  [{:jerboa, "~> 0.3.0"}]
end

Checklist of STUN/TURN/ICE methods supported by Jerboa's encoder/decoder

• Binding
• Allocate
• Refresh
• Send
• Data
• CreatePermission
• ChannelBind

Checklist of STUN/TURN/ICE attributes supported by Jerboa's encoder/decoder

Comprehension Required

• XOR-MAPPED-ADDRESS
• MESSAGE-INTEGRITY
• ERROR-CODE
• UNKNOWN-ATTRIBUTES
• REALM
• NONCE
• CHANNEL-NUMBER
• LIFETIME
• XOR-PEER-ADDRESS
• DATA
• XOR-RELAYED-ADDRESS
• EVEN-PORT
• REQUESTED-TRANSPORT
• DONT-FRAGMENT
• RESERVATION-TOKEN
• PRIORITY
• USE-CANDIDATE
• ICE-CONTROLLED
• ICE-CONTROLLING

Comprehension Optional

• SOFTWARE
• ALTERNATE-SERVER
• FINGERPRINT

License

Copyright 2016-2017 Erlang Solutions Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.