first commit

LICENSE-APACHEv2

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Status Research & Development GmbH
+
+   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.

LICENSE-MIT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Status Research & Development GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,45 @@
+# nim-binary-serialization
+
+Binary packed serialization compatible with the [nim-serialization](https://github.com/status-im/nim-serialization) framework.
+
+## Usage
+
+```nim
+type
+  Example = object
+    first: uint8
+    second: uint16
+
+let ex = Example(first: 5.uint8, second: 12.uint16)
+assert Binary.encode(ex) == @[5.uint8, 0, 12]
+
+type
+  SeqHolder = object
+    # bin_value is used during encoding instead of the actual value
+    seqLength {.bin_value: it.vals.len.}: uint8
+    # bin_len is the length of the sequence in element, used during decoding
+    vals {.bin_len: it.seqLength.}: seq[Example]
+
+assert Binary.encode(SeqHolder(vals: @[ex, ex])) == @[2.uint8, 5, 0, 12, 5, 0, 12]
+
+type
+  ByteSharing = object
+    a {.bin_bitsize: 3.}: uint8
+    b {.bin_bitsize: 5.}: uint8
+
+assert Binary.encode(ByteSharing(a: 2.uint8, b: 4.uint8)) == @[68.uint8]
+```
+
+You can find real examples in the tests (including IP frames, Yamux header, more to come)
+
+## License
+
+Licensed and distributed under either of
+
+* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
+
+or
+
+* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
+
+at your option. These files may not be copied, modified, or distributed except according to those terms.

binary_serialization.nim

@@ -0,0 +1,6 @@
+import
+  serialization, binary_serialization/[format, reader, writer]
+
+export
+  serialization, format, reader, writer
+

binary_serialization.nimble

@@ -0,0 +1,10 @@
+packageName   = "binary_serialization"
+version       = "0.1.0"
+author        = "Status Research & Development GmbH"
+description   = "Flexible binary serialization not relying on run-time type information"
+license       = "Apache License 2.0"
+skipDirs      = @["tests"]
+
+requires "nim >= 1.2.16",
+         "serialization",
+         "stew"

binary_serialization/format.nim

@@ -0,0 +1,12 @@
+import
+  serialization/formats
+
+serializationFormat Binary,
+                    mimeType = "application/octet-stream"
+
+template supports*(_: type Binary, T: type): bool =
+  false
+
+template bin_bitsize*(size: int) {.pragma.}
+template bin_len*(size: untyped) {.pragma.}
+template bin_value*(size: untyped) {.pragma.}

binary_serialization/reader.nim

@@ -0,0 +1,84 @@
+
+import
+  std/[tables, strutils, typetraits, macros, strformat],
+  stew/[endians2, objects],
+  faststreams/inputs, serialization/[formats, object_serialization, errors],
+  format
+
+export
+  inputs
+
+type
+  BinaryReader* = object
+    stream: InputStream
+    arrayLen: int
+
+    bitSize: int
+    workingByte: byte
+    remaining: int
+
+Binary.setReader BinaryReader
+
+proc init*(T: type BinaryReader, stream: InputStream): T =
+  T(stream: stream)
+
+proc readValue*[T](r: var BinaryReader, value: var T) =
+  when sizeof(value) == 1:
+    type E = uint8
+  elif sizeof(value) == 2:
+    type E = uint16
+  elif sizeof(value) == 4:
+    type E = uint32
+  elif sizeof(value) == 8:
+    type E = uint64
+
+  when value is SomeUnsignedInt:
+    when value is uint8:
+      if r.bitSize > 0:
+        let mask = ((1 shl r.bitSize) - 1).uint8
+        r.remaining.dec(r.bitSize)
+        value = (r.workingByte shr r.remaining) and mask
+        return
+    let length = sizeof(value)
+    value = fromBytes(type value, r.stream.read(length), bigEndian)
+  elif value is enum:
+    var asUInt: E
+    r.readValue(asUint)
+    #TODO raise instead
+    assert value.checkedEnumAssign(asUInt):
+  elif value is set:
+    var asUInt: E
+    r.readValue(asUint)
+    #TODO is this safe enough?
+    value = cast[type(value)](asUInt)
+  elif value is object:
+    value.enumInstanceSerializedFields(fieldName, field):
+      when field.hasCustomPragma(bin_len):
+        let it = value
+        #TODO safer conversion
+        r.arrayLen = int(field.getCustomPragmaVal(bin_len))
+
+      when field.hasCustomPragma(bin_bitsize):
+        when field isnot uint8:
+          {.error: "bit_bitsize only applies to byte".}
+        r.bitSize = (int)field.getCustomPragmaVal(bin_bitsize)
+        assert r.bitSize in 1 ..< 8
+
+        if r.remaining == 0:
+          r.workingByte = r.stream.read
+          r.remaining = 8
+
+      var vall: type(field)
+      r.readValue(vall)
+      field = vall
+      r.bitSize = 0
+  elif value is seq:
+    for _ in 0 ..< r.arrayLen:
+      var subValue: type(value[0])
+      r.readValue(subValue)
+      value.add(subValue)
+  elif value is array:
+    for i in 0 ..< value.len:
+      r.readValue(value[i])
+  else:
+    {.error: "Unsupported type " & $type(value).}

binary_serialization/writer.nim

@@ -0,0 +1,83 @@
+import
+  std/[typetraits, macros],
+  stew/endians2,
+  faststreams/[outputs], serialization,
+  format
+
+export outputs
+
+type
+  BinaryWriter* = object
+    stream: OutputStream
+    bitSize: int
+    workingByte: byte
+    position: int
+
+Binary.setWriter BinaryWriter,
+                 PreferredOutput = seq[byte]
+
+proc init*(W: type BinaryWriter, stream: OutputStream,
+           pretty = false, typeAnnotations = false): W =
+  W(stream: stream)
+
+proc writeValue*(w: var BinaryWriter, value: auto) =
+  let it = value
+
+  assert (value is uint8 and w.bitSize != 0) or w.position == 0 or value is object
+
+  when sizeof(value) == 1:
+    type E = uint8
+  elif sizeof(value) == 2:
+    type E = uint16
+  elif sizeof(value) == 4:
+    type E = uint32
+  elif sizeof(value) == 8:
+    type E = uint64
+
+  when value is SomeUnsignedInt:
+    when value is uint8:
+      if w.bitSize > 0:
+        assert w.position + w.bitSize <= 8
+        let
+          mask = ((1 shl w.bitSize) - 1).uint8
+          masked = value and mask
+          shifted = masked shl (8 - w.position - w.bitSize)
+        assert masked == value
+        w.workingByte = w.workingByte or shifted
+        w.position.inc(w.bitSize)
+        if w.position == 8:
+          w.stream.write w.workingByte
+          w.position = 0
+          w.workingByte = 0
+        return
+
+    w.stream.write toBytes(value, bigEndian)
+  elif value is enum:
+    w.writeValue(E(value))
+  elif value is set:
+    w.writeValue(cast[E](value))
+  elif value is object:
+    value.enumInstanceSerializedFields(fieldName, field):
+      var fieldVal = field
+
+      when field.hasCustomPragma(bin_bitsize):
+        when field isnot uint8:
+          {.error: "bit_bitsize only applies to byte".}
+        w.bitSize = (int)field.getCustomPragmaVal(bin_bitsize)
+        assert w.bitSize in 1 ..< 8
+
+      when field.hasCustomPragma(bin_value):
+        #TODO safer conversion
+        fieldVal = (type field)field.getCustomPragmaVal(bin_value)
+      w.writeFieldIMPL(FieldTag[type value, fieldName], fieldVal, value)
+      w.bitSize = 0
+
+    if w.position > 0:
+      w.stream.write w.workingByte
+      w.position = 0
+      w.workingByte = 0
+  elif value is seq | array | openarray:
+    for subV in value:
+      w.writeValue(subV)
+  else:
+    {.error: "Unsupported type " & $type(value).}

nim.cfg

@@ -0,0 +1 @@
+-d:nimOldCaseObjects

tests/test_serialization.nim

@@ -0,0 +1,92 @@
+import
+  strutils, unittest, stew/byteutils,
+  serialization/object_serialization,
+  serialization/testing/generic_suite,
+  ../binary_serialization
+
+## IP
+type
+  Ip4Packet = object
+    ihl {.bin_bitsize: 4, bin_value: (20 + it.options.len) div 4.}: uint8
+    dscp {.bin_bitsize: 6.}: uint8
+    ecn {.bin_bitsize: 2.}: uint8
+    totalLength {.bin_value: it.payload.len + 20 + it.options.len.}: uint16
+    identification: uint16
+    flags {.bin_bitsize: 3.}: uint8
+    # doesn't handle bitsize > 8 for now
+    fragmentOffset1 {.bin_bitsize: 5.}: uint8
+    fragmentOffset2: uint8
+    ttl: uint8
+    protocol: uint8
+    headerChecksum: uint16
+    sourceIpAddress: array[4, byte]
+    targetIpAddress: array[4, byte]
+    options {.bin_len: it.ihl * 4 - 20.}: seq[byte]
+    payload {.bin_len: it.totalLength - it.ihl * 4.}: seq[byte]
+
+  Ip6Packet = object
+    # doesn't handle bitsize > 8 for now
+    trafficClass1 {.bin_bitsize: 4.}: uint8
+    trafficClass2 {.bin_bitsize: 4.}: uint8
+    flowLabel1 {.bin_bitsize: 4.}: uint8
+    flowLabel2: uint16
+    payloadLength {.bin_value: it.payload.len.}: uint16
+    nextHeader: uint8
+    hopLimit: uint8
+    sourceIpAddress: array[16, byte]
+    targetIpAddress: array[16, byte]
+    payload {.bin_len: it.payloadLength.}: seq[byte]
+
+  IpPacket = object
+    case version {.bin_bitsize: 4.}: uint8
+    of 4: ip4Packet: Ip4Packet
+    of 6: ip6Packet: Ip6Packet
+    else: discard
+
+## Yamux
+
+type
+  MsgType {.size: 2.} = enum
+    Data = 0x0
+    WindowUpdate = 0x1
+    Ping = 0x2
+    GoAway = 0x3
+
+  MsgFlags {.size: 2.} = enum
+    Syn
+    Ack
+    Fin
+    Rst
+
+  YamuxHeader = object
+    version: uint8
+    msgType: MsgType
+    flags: set[MsgFlags]
+    streamId: uint32
+    length: uint32
+
+
+
+suite "simple tests":
+  test "Ip":
+    let
+      # we don't need to specify ihl & totalLength, but `==` would fail without them
+      ipPacket = IpPacket(version: 4, ip4Packet: Ip4Packet(ihl: 5, totalLength: 20))
+      asBin = Binary.encode(ipPacket)
+      rt = Binary.decode(asBin, IpPacket)
+    check $ipPacket == $rt
+    check $Binary.decode("45000014dc14400037067a0fa35f87eac0a80113".hexToSeqByte(), IpPacket) ==
+      $IpPacket(version: 4, ip4Packet:
+        Ip4Packet(ihl: 5,
+        dscp: 0, ecn: 0, totalLength: 20,
+        identification: 56340, flags: 2, fragmentOffset1: 0, fragmentOffset2: 0,
+        ttl: 55, protocol: 6, headerChecksum: 31247,
+        sourceIpAddress: [163.byte, 95, 135, 234], targetIpAddress: [192.byte, 168, 1, 19], options: @[], payload: @[]))
+
+  test "Yamux":
+    let
+      ipPacket = YamuxHeader()
+      asBin = Binary.encode(ipPacket)
+      rt = Binary.decode(asBin, YamuxHeader)
+
+    check $rt == $ipPacket