Package org.webpki.cbor

Class CBORDecoder

java.lang.Object
org.webpki.cbor.CBORDecoder
public class CBORDecoder extends Object
CBOR decoder class.

  • Field Details

  • Constructor Details

    • CBORDecoder

      public CBORDecoder(InputStream inputStream, int options, int maxInputLength)
      Create a customized CBOR decoder.

      Note that irrespective of options, the decoder maintains parsed data in the form required for Deterministic Encoding.

      This constructor presumes that the actual decoding is performed by one or more (for sequences only) calls to decodeWithOptions().

      Customization is provided through an options parameter. Multiple options can be combined using the binary OR-operator ("|"). A zero (0) sets the decoder default mode. The options are defined by the following constants:

      If the SEQUENCE_MODE option is defined, the following apply:
      • The decoder returns after having decoded a single CBOR object, while preparing for the next object.
      • If no data is found (EOF), null is returned (empty sequences are permitted).
      Note that data that has not yet been decoded, is not verified for correctness.
      By default, the decoder requires that CBOR maps conform to the Deterministic Encoding rules.
      The LENIENT_MAP_DECODING option makes the decoder accept CBOR maps with arbitrary key ordering. Note that duplicate keys still cause a CBORException to be thrown.
      By default, the decoder requires that CBOR numbers conform to the Deterministic Encoding rules.
      The LENIENT_NUMBER_DECODING option makes the decoder accept different representations of CBOR int, bigint, and float items, only limited by RFC 8949.

      Exceeding maxInputLength during decoding throws a CBORException. It is recommendable setting this as low as possible, since malformed CBOR objects may request any amount of memory.

      Parameters:
      inputStream - Stream holding CBOR data.
      options - The decoder options.
      maxInputLength - Upper limit in bytes.
      Throws:
      CBORException
      See Also:

    • CBORDecoder

      public CBORDecoder(byte[] cbor, int options)
      Create a customized CBOR decoder.

      This constructor is identical to: 
        CBORDecoder(new ByteArrayInputStream(cbor), 0, cbor.length);
      Parameters:
      cbor - CBOR binary data
      options - The decoder options.
      Throws:
      CBORException
      See Also:

  • Method Details

    • decodeWithOptions

      public CBORObject decodeWithOptions()
      Decode CBOR data with options.

      Unsupported or malformed CBOR data cause a CBORException to be thrown.

      Returns:
      CBORObject or null (for EOF sequences only).
      Throws:
      CBORException

    • getByteCount

      public int getByteCount()
      Get CBOR decoder byte count.

      This is equivalent to the position of the next item to be read.

      Returns:
      The number of bytes read so far.

    • decode

      public static CBORObject decode(byte[] cbor)
      Decode CBOR data.

      This conveniance method is identical to: 
        new CBORDecoder(new ByteArrayInputStream(cbor), 0, cbor.length)
      .decodeWithOptions();
      Parameters:
      cbor - CBOR binary data holding exactly one CBOR object.
      Returns:
      CBORObject
      Throws:
      CBORException