Package com.github.toolarium.security.pki.impl.rsa.der

Class DEROutputStream

  • All Implemented Interfaces:
    DEREncoder, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class DEROutputStream
extends java.io.ByteArrayOutputStream
implements DEREncoder
    Output stream marshaling DER-encoded data. This is eventually provided in the form of a byte array; there is no advance limit on the size of that byte array.

    At this time, this class supports only a subset of the types of DER data encodings which are defined. That subset is sufficient for generating most X.509 certificates.

    • Field Summary

      • Fields inherited from class java.io.ByteArrayOutputStream

        buf, count

    • Constructor Summary

      Constructors 
      Constructor Description
      DEROutputStream()
      Construct an DER output stream.
      DEROutputStream​(int size)
      Construct an DER output stream.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void derEncode​(java.io.OutputStream out)
      Write the current contents of this DerOutputStream to an OutputStream.
      void putBitString​(byte[] bits)
      Marshals a DER bit string on the output stream.
      void putBMPString​(java.lang.String s)
      Marshals a string as a DER encoded BMPString.
      void putBoolean​(boolean val)
      Marshals a DER boolean on the output stream.
      void putDERValue​(DERValue val)
      Marshals pre-encoded DER value onto the output stream.
      void putEnumerated​(BigInt i)
      Marshals a DER enumerated on the output stream.
      void putGeneralizedTime​(java.util.Date d)
      Marshals a DER Generalized Time/date value.
      void putIA5String​(java.lang.String s)
      Marshals a string as a DER encoded IA5String.
      void putInteger​(BigInt i)
      Marshals a DER unsigned integer on the output stream.
      void putLength​(int len)
      Put the encoding of the length in the stream.
      void putNull()
      Marshals a DER "null" value on the output stream.
      void putOctetString​(byte[] octets)
      DER-encodes an ASN.1 OCTET STRING value on the output stream.
      void putOID​(ObjectIdentifier oid)
      Marshals an object identifier (OID) on the output stream.
      void putOrderedSet​(byte tag, DEREncoder[] set)
      Marshals the contents of a set on the output stream.
      void putOrderedSetOf​(byte tag, DEREncoder[] set)
      Marshals the contents of a set on the output stream.
      void putPrintableString​(java.lang.String s)
      Marshals a string as a DER encoded PrintableString.
      void putSequence​(DERValue[] seq)
      Marshals a sequence on the output stream.
      void putSet​(DERValue[] set)
      Marshals the contents of a set on the output stream without ordering the elements.
      void putT61String​(java.lang.String s)
      Marshals a string as a DER encoded T61String.
      void putTag​(byte tagClass, boolean form, byte val)
      Put the tag of the attribute in the stream.
      void putUnalignedBitString​(BitArray b)
      Marshals a DER bit string on the output stream.
      void putUTCTime​(java.util.Date d)
      Marshals a DER UTC time/date value.
      void putUTF8String​(java.lang.String s)
      Marshals a string as a DER encoded UTF8String.
      void write​(byte tag, byte[] b)
      Writes tagged, pre-marshaled data.
      void write​(byte tag, DEROutputStream out)
      Writes tagged data using buffer-to-buffer copy.
      void writeImplicit​(byte tag, DEROutputStream value)
      Writes implicitly tagged data using buffer-to-buffer copy.

      • Methods inherited from class java.io.ByteArrayOutputStream

        close, reset, size, toByteArray, toString, toString, toString, toString, write, write, writeBytes, writeTo

      • Methods inherited from class java.io.OutputStream

        flush, nullOutputStream, write

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DEROutputStream

        public DEROutputStream​(int size)
        Construct an DER output stream.
        Parameters:
        size - how large a buffer to preallocate.

      • DEROutputStream

        public DEROutputStream()
        Construct an DER output stream.

    • Method Detail

      • write

        public void write​(byte tag,
                  byte[] b)
        Writes tagged, pre-marshaled data. This calcuates and encodes the length, so that the output data is the standard triple of { tag, length, data } used by all DER values.
        Parameters:
        tag - the DER value tag for the data, such as DerValue.tag_Sequence
        b - buffered data, which must be DER-encoded

      • write

        public void write​(byte tag,
                  DEROutputStream out)
        Writes tagged data using buffer-to-buffer copy. As above, this writes a standard DER record. This is often used when efficiently encapsulating values in sequences.
        Parameters:
        tag - the DER value tag for the data, such as DERValue.tag_Sequence
        out - buffered data

      • writeImplicit

        public void writeImplicit​(byte tag,
                          DEROutputStream value)
        Writes implicitly tagged data using buffer-to-buffer copy. As above, this writes a standard DER record. This is often used when efficiently encapsulating implicitly tagged values.
        Parameters:
        tag - the DER value of the context-specific tag that replaces original tag of the value in the output, such as in [field] [N] IMPLICIT [type] For example, FooLength [1] IMPLICIT INTEGER, with value=4; would be encoded as "81 01 04" whereas in explicit tagging it would be encoded as "A1 03 02 01 04". Notice that the tag is A1 and not 81, this is because with explicit tagging the form is always constructed.
        value - original value being implicitly tagged

      • putDERValue

        public void putDERValue​(DERValue val)
                 throws java.io.IOException
        Marshals pre-encoded DER value onto the output stream.
        Parameters:
        val - the value
        Throws:
        java.io.IOException - in case of error

      • putBoolean

        public void putBoolean​(boolean val)
        Marshals a DER boolean on the output stream.
        Parameters:
        val - the value

      • putInteger

        public void putInteger​(BigInt i)
        Marshals a DER unsigned integer on the output stream.
        Parameters:
        i - the value

      • putEnumerated

        public void putEnumerated​(BigInt i)
        Marshals a DER enumerated on the output stream.
        Parameters:
        i - the value

      • putBitString

        public void putBitString​(byte[] bits)
                  throws java.io.IOException
        Marshals a DER bit string on the output stream. The bit string must be byte-aligned.
        Parameters:
        bits - the bit string, MSB first
        Throws:
        java.io.IOException - in case of error

      • putUnalignedBitString

        public void putUnalignedBitString​(BitArray b)
                           throws java.io.IOException
        Marshals a DER bit string on the output stream. The bit strings need not be byte-aligned.
        Parameters:
        b - the bit string, MSB first
        Throws:
        java.io.IOException - in case of error

      • putOctetString

        public void putOctetString​(byte[] octets)
        DER-encodes an ASN.1 OCTET STRING value on the output stream.
        Parameters:
        octets - the octet string

      • putNull

        public void putNull()
        Marshals a DER "null" value on the output stream. These are often used to indicate optional values which have been omitted.

      • putOID

        public void putOID​(ObjectIdentifier oid)
        Marshals an object identifier (OID) on the output stream. Corresponds to the ASN.1 "OBJECT IDENTIFIER" construct.
        Parameters:
        oid - the id

      • putSequence

        public void putSequence​(DERValue[] seq)
                 throws java.io.IOException
        Marshals a sequence on the output stream. This supports both the ASN.1 "SEQUENCE" (zero to N values) and "SEQUENCE OF" (one to N values) constructs.
        Parameters:
        seq - the sequence
        Throws:
        java.io.IOException - in case of error

      • putSet

        public void putSet​(DERValue[] set)
            throws java.io.IOException
        Marshals the contents of a set on the output stream without ordering the elements. Ok for BER encoding, but not for DER encoding. For DER encoding, use orderedPutSet() or orderedPutSetOf().
        Parameters:
        set - the values
        Throws:
        java.io.IOException - in case of error

      • putOrderedSetOf

        public void putOrderedSetOf​(byte tag,
                            DEREncoder[] set)
                     throws java.io.IOException
        Marshals the contents of a set on the output stream. Sets are semantically unordered, but DER requires that encodings of set elements be sorted into ascending lexicographical order before being output. Hence sets with the same tags and elements have the same DER encoding. This method supports the ASN.1 "SET OF" construct, but not "SET", which uses a different order.
        Parameters:
        tag - the tag
        set - the set
        Throws:
        java.io.IOException - in case of error

      • putOrderedSet

        public void putOrderedSet​(byte tag,
                          DEREncoder[] set)
                   throws java.io.IOException
        Marshals the contents of a set on the output stream. Sets are semantically unordered, but DER requires that encodings of set elements be sorted into ascending tag order before being output. Hence sets with the same tags and elements have the same DER encoding. This method supports the ASN.1 "SET" construct, but not "SET OF", which uses a different order.
        Parameters:
        tag - the tag
        set - the set
        Throws:
        java.io.IOException - in case of error

      • putUTF8String

        public void putUTF8String​(java.lang.String s)
                   throws java.io.IOException
        Marshals a string as a DER encoded UTF8String.
        Parameters:
        s - the string
        Throws:
        java.io.IOException - in case of error

      • putPrintableString

        public void putPrintableString​(java.lang.String s)
                        throws java.io.IOException
        Marshals a string as a DER encoded PrintableString.
        Parameters:
        s - the string
        Throws:
        java.io.IOException - in case of error

      • putT61String

        public void putT61String​(java.lang.String s)
                  throws java.io.IOException
        Marshals a string as a DER encoded T61String.
        Parameters:
        s - the string
        Throws:
        java.io.IOException - in case of error

      • putIA5String

        public void putIA5String​(java.lang.String s)
                  throws java.io.IOException
        Marshals a string as a DER encoded IA5String.
        Parameters:
        s - the string
        Throws:
        java.io.IOException - in case of error

      • putBMPString

        public void putBMPString​(java.lang.String s)
                  throws java.io.IOException
        Marshals a string as a DER encoded BMPString.
        Parameters:
        s - the string
        Throws:
        java.io.IOException - in case of error

      • putUTCTime

        public void putUTCTime​(java.util.Date d)
                throws java.io.IOException
        Marshals a DER UTC time/date value.

        YYMMDDhhmmss{Z|+hhmm|-hhmm} ... emits only using Zulu time and with seconds (even if seconds=0) as per RFC 2459.

        Parameters:
        d - the date
        Throws:
        java.io.IOException - in case of error

      • putGeneralizedTime

        public void putGeneralizedTime​(java.util.Date d)
                        throws java.io.IOException
        Marshals a DER Generalized Time/date value.

        YYYYMMDDhhmmss{Z|+hhmm|-hhmm} ... emits only using Zulu time and with seconds (even if seconds=0) as per RFC 2459.

        Parameters:
        d - the date
        Throws:
        java.io.IOException - in case of error

      • putLength

        public void putLength​(int len)
        Put the encoding of the length in the stream.
        Parameters:
        len - the length of the attribute.

      • putTag

        public void putTag​(byte tagClass,
                   boolean form,
                   byte val)
        Put the tag of the attribute in the stream.
        Parameters:
        tagClass - the tag class type, one of UNIVERSAL, CONTEXT, APPLICATION or PRIVATE
        form - if true, the value is constructed, otherwise it is primitive.
        val - the tag value

      • derEncode

        public void derEncode​(java.io.OutputStream out)
               throws java.io.IOException
        Write the current contents of this DerOutputStream to an OutputStream.
        Specified by:
        derEncode in interface DEREncoder
        Parameters:
        out - the stream
        Throws:
        java.io.IOException - on output error.