Netstrings (1997)

(cr.yp.to)

31 points | by signa11 2 days ago ago

29 comments

  • regularfry 2 days ago ago

    Tagged Netstrings (tnetstrings) was a related proposal from 15 years ago or so. It replaces the comma with a single-character type definition so you can do JSON-like objects with a couple of recursive types: you had ',', '#', '^', '!', and '~' for strings, integers, floats, booleans, and nulls, then ']' and '}' for lists and dictionaries.

    Most of the links have bitrotted and I don't think it ever got much traction, but I did always like how simple it was. There's a copy someone grabbed of the original spec here: https://raw.githubusercontent.com/ged/tnetstrings.info/refs/...

  • Joker_vD 2 days ago ago

        if (scanf("%9lu",&len) < 1) barf();  /* >999999999 bytes is bad */
        if (getchar() != ':') barf();
        buf = malloc(len + 1);       /* malloc(0) is not portable */
        if (!buf) barf();
        if (fread(buf,1,len,stdin) < len) barf();
        if (getchar() != ',') barf();
    
    Ah, the wonders of error-handling in C. Also, I wonder what's wrong with

        buf = malloc(len ? len : 1);
    • kazinator a day ago ago

      Or even:

        if (len == 0)
          return null_buffer_singleton; /* special shared representation for 0: */
      • repiret 20 hours ago ago

        Because then the caller needs to treat it differently from non-empty buffers.

        • kazinator 14 hours ago ago

          No, it doesn't. It calls:

            void buffer_free(void *buf)
            {
               if (buf != null_buffer_singleton)
                 free(buf);
            }
          • Joker_vD 10 hours ago ago

            ...which treats it differently from non-empty buffers :)

            But frankly, having a 1-byte buffer, pointer to which can serve as a sentinel value à la NULL (but dereferenceable!), and which you can pass to free() without it being deallocated is indeed rather useful.

    • undefined 2 days ago ago
      [deleted]
  • weinzierl a day ago ago

    Making the thing that describes the bounds of an arbitrary length thing itself arbitrary length sound like an unnecessarily risky complication to me.

    Especially since it only grows with the log of the thing it bounds. So, we could easily have s fixed length length field that covers all ever possible length values.

    • kazinator a day ago ago

      Or you could just have the standard have a "Conformance Limits" section where it says something similar to "Every implementation shall support a length field value of at least 9223372036854775807, with an unlimited number of leading zeros".

      In other words, values beyond that are not forbidden by the spec, but are outside of the conformance requirements. It is a quality of implementation issue whether a given implementation handles more than required.

      • weinzierl 10 hours ago ago

        That the spec is lenient and the conformance test strict makes ot only worse.

    • repiret 20 hours ago ago

      It's mathematically impossible to describe an arbitrary length in a fixed length.

      • weinzierl 10 hours ago ago

        Luckily in math we do not have to allocate memory and worry about buffer overflows.

  • dayjah a day ago ago

    I’ve near infinite respect for DJB, so I’m assuming I’ve missed something obvious here. Why is ‘,’ being used as a termination byte. Is it just a backstop? If buf[len+1] != ‘,’ then there’s a line error?

    I’ve done plenty of wire protocol work, and length prefixed strings are great to work with. I’ve also been lucky that those strings were typically contained within a broader payload. To that end, I’ve not had to think about the case of many strings one after another.

  • kazinator a day ago ago

    This is very similar to a notation occuring in Ronald Rivest's S-Expression proposal from 1996.

    https://people.csail.mit.edu/rivest/pubs/RL96.ver-1.0.pdf

    He has it as a hexadecimal length preceded by a pound sign (#), a colon, and the raw octet data.

  • account42 a day ago ago

    I don't like formats that look like text buy may actually contain binary data - that's only going to tempt implementations that will choke when the string actually contains arbitrary data. Would be safer to encode the length and/or separator as something more obviously binary, which will also make the thing easier to parse in low-level implementations.

    • GoblinSlayer a day ago ago

      For this I made a tlv format, where string is encoded in byte prefixed chunks with length between 0 and 222 for final chunk and between 223 and 255 for intermediate chunks.

  • ocrow 2 days ago ago

    Seems like a coherent, sensible proposal, as one might expect from djb. Any notable protocols use them?

    • Scaevolus 2 days ago ago

      BitTorrent's bencoding format, used in .torrent files, effectively uses netstrings-- but without the trailing commas, so it uses "5:hello" to represent filenames and similar.

    • undefined 2 days ago ago
      [deleted]
    • asalahli 2 days ago ago

      Not sure if it counts as notable, but SCGI uses it too: https://python.ca/scgi/protocol.txt

    • toast0 2 days ago ago

      Php serialized uses

         s:size:value;
      
      For strings, which is pretty similar. Size is in bytes.
    • Asmod4n 2 days ago ago

      zurl and mongrel2 are using it.

  • johnea a day ago ago

    So much of the terse, utilitarian, DJB Way was overpowered by bloated corporate crap 8-/

    One still functional example exists in voidlinux's init system.

    There was never any need for systemd 8-/

    Except leveraging RedHat/IBM's domination of the linux user space ecosystem...

  • gnabgib 2 days ago ago

    (1997) -DJB

  • burnt-resistor a day ago ago

    Another string length O(1) encoding format like Pascal strings that were len (unsigned byte) + data. Limited to 255 characters however.

    Dollar, NUL, and other terminated strings, by contrast, are string length O(N).

    • cowboylowrez a day ago ago

      fast cgi has a good one, length then binary follows, if the length is 127 or less, the length is contained within one byte, if not the length is contained in 4 bytes, then the data follows. Midi has a similar scheme for representing some numbers, the high order bit denotes if there's another byte of the number following or something like that lol

    • repiret 20 hours ago ago

      strlen for netstring is O(log n).